Skip to content

\SmsControllerApi

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

Method HTTP request Description
delete_sms_message delete /sms/{smsId} Delete SMS message.
delete_sms_messages delete /sms Delete all SMS messages
get_sms_message 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.
get_sms_messages_paginated get /sms Get all SMS messages in all phone numbers in paginated form. .

delete_sms_message

delete_sms_message(sms_id) Delete SMS message.

Delete an SMS message

Parameters

Name Type Description Required Notes
sms_id String [required]

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 ]

delete_sms_messages

delete_sms_messages(phone_number_id) Delete all SMS messages

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

Parameters

Name Type Description Required Notes
phone_number_id Option<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 ]

get_sms_message

crate::models::SmsDto get_sms_message(sms_id) 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.

Parameters

Name Type Description Required Notes
sms_id String [required]

Return type

crate::models::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 ]

get_sms_messages_paginated

crate::models::PageSmsProjection get_sms_messages_paginated(phone_number, page, size, sort, unread_only, since, before) 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

Parameters

Name Type Description Required Notes
phone_number Option<String> Optional receiving phone number to filter SMS messages for
page Option<i32> Optional page in SMS list pagination [default to 0]
size Option<i32> Optional page size in SMS list pagination. Maximum size is 100. Use page and sort to page through larger results [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
unread_only Option<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 Option<String> Optional filter SMSs received after given date time
before Option<String> Optional filter SMSs received before given date time

Return type

crate::models::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 ]