Skip to content

MailSlurp\SmsControllerApi

All URIs are relative to https://golang.api.mailslurp.com

Method HTTP request Description
DeleteSmsMessage Delete /sms/{smsId} Delete SMS message.
DeleteSmsMessages Delete /sms Delete all SMS messages
GetSmsMessage Get /sms/{smsId} Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
GetSmsMessagesPaginated Get /sms Get all SMS messages in all phone numbers in paginated form. .

DeleteSmsMessage

DeleteSmsMessage(ctx, smsId)

Delete SMS message.

Delete an SMS message

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
smsId string

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DeleteSmsMessages

DeleteSmsMessages(ctx, optional)

Delete all SMS messages

Delete all SMS messages or all messages for a given phone number

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DeleteSmsMessagesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteSmsMessagesOpts struct

Name Type Description Notes
phoneNumberId optional.Interface of string

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetSmsMessage

SmsDto GetSmsMessage(ctx, smsId)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Returns a SMS summary object with content.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
smsId string

Return type

SmsDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetSmsMessagesPaginated

PageSmsProjection GetSmsMessagesPaginated(ctx, optional)

Get all SMS messages in all phone numbers in paginated form. .

By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetSmsMessagesPaginatedOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSmsMessagesPaginatedOpts struct

Name Type Description Notes
phoneNumber optional.Interface of string Optional receiving phone number to filter SMS messages for
page optional.Int32 Optional page in SMS list pagination [default to 0]
size optional.Int32 Optional page size in SMS list pagination. Maximum size is 100. Use page and sort to page through larger results [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
unreadOnly optional.Bool Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly [default to false]
since optional.Time Optional filter SMSs received after given date time
before optional.Time Optional filter SMSs received before given date time

Return type

PageSmsProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]