PhoneController
List SMS messages for a phone number
Get SMS messages for a phone number
get/phone/numbers/{phoneNumberId}/sms
Request
- Base URL: https://api.mailslurp.com
- URL: https://api.mailslurp.com/phone/numbers/{phoneNumberId}/sms
- Auth: API key in header x-api-key
Path parameters
phoneNumberIdstring uuid required
Query parameters
pageinteger
Optional page index in SMS list pagination
sizeinteger
Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
sort'ASC' | 'DESC'
Optional createdAt sort direction ASC or DESC
unreadOnlyboolean
Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly
sincestring date-time
Optional filter SMSs received after given date time
beforestring date-time
Optional filter SMSs received before given date time
searchstring
Optional search filter
favouriteboolean
Optionally filter results for favourites only
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.