Logo
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: contact_center_sms:read:admin

Rate Limit Label: HEAVY

 

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
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