List SMS logs
GET {{baseUrl}}/contact_center/sms?next_page_token=<string>&page_size=10&from=<date>&to=<date>&country_iso_codes=<string>&country_iso_codes=<string>&direction=outbound&user_id=<string>&engagement_id=<string>&consumer_number=<string>
Returns a list of SMS.
Scopes: contact_center_sms:read:admin
Rate Limit Label: HEAVY
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
next_page_token | string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size | number | The number of items returned per page. | |
from | string | The start time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'). The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours. | |
to | string | Required only when the from parameter is specified. The end time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'). | |
country_iso_codes | string | Two-letter country code. | |
country_iso_codes | string | Two-letter country code. | |
direction | string | The engagement's direction. | |
user_id | string | The agent's ID. | |
engagement_id | string | The engagement's ID. | |
consumer_number | string | The consumer's phone number. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e","sms":[{"direction":"inbound","engagement_id":"\u003cstring\u003e","contact_center_number":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e","consumer_number":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","queues":[{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"},{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"}],"agents":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"}],"country_name":"\u003cstring\u003e","sms_types":["sms","mms"],"total_sent_messages":"\u003clong\u003e","total_received_messages":"\u003clong\u003e","total_sent_files":"\u003clong\u003e","total_received_files":"\u003clong\u003e"},{"direction":"inbound","engagement_id":"\u003cstring\u003e","contact_center_number":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e","consumer_number":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","queues":[{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"},{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"}],"agents":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"}],"country_name":"\u003cstring\u003e","sms_types":["sms","mms"],"total_sent_messages":"\u003clong\u003e","total_received_messages":"\u003clong\u003e","total_sent_files":"\u003clong\u003e","total_received_files":"\u003clong\u003e"}]}