Zoom Public API Documentation
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: Rate Limit Label: contact_center_sms:read:adminHEAVY
Body
PARAM
| 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](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). | |
country_iso_codes
|
string | Two-letter country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). | |
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": "<string>",
"page_size": 10,
"total_records": "<integer>",
"from": "<dateTime>",
"to": "<dateTime>",
"sms": [
{
"direction": "inbound",
"engagement_id": "<string>",
"contact_center_number": "<string>",
"start_time": "<dateTime>",
"end_time": "<dateTime>",
"consumer_number": "<string>",
"consumer_display_name": "<string>",
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"country_name": "<string>",
"sms_types": [
"sms",
"mms"
],
"total_sent_messages": "<long>",
"total_received_messages": "<long>",
"total_sent_files": "<long>",
"total_received_files": "<long>"
},
{
"direction": "inbound",
"engagement_id": "<string>",
"contact_center_number": "<string>",
"start_time": "<dateTime>",
"end_time": "<dateTime>",
"consumer_number": "<string>",
"consumer_display_name": "<string>",
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"country_name": "<string>",
"sms_types": [
"sms",
"mms"
],
"total_sent_messages": "<long>",
"total_received_messages": "<long>",
"total_sent_files": "<long>",
"total_received_files": "<long>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/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>?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>' -H 'Accept: application/json'
ENDPOINTS