Get SMS session details
GET {{baseUrl}}/phone/sms/sessions/:sessionId?page_size=30&next_page_token=<string>&from=<date>&to=<date>&sort=<integer>
Get details about an SMS session.
Prerequisites * Paid account * User-enabled Zoom phone
Scopes: phone:read:admin,phone:read,phone_sms:read,phone_sms:read:admin
Granular Scopes: phone:read:sms_session,phone:read:sms_session:admin
Rate Limit Label: Medium
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | number | The number of records returned within a single API call. | |
next_page_token | string | The current page number of returned records. | |
from | string | The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. The date range defined by the from and to parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days. | |
to | string | Required only when the from parameter is specified. End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, the same format as the from parameter. | |
sort | string | Order of SMS to return based on creation time. 1: ascending 2: descending |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","sms_histories":[{"attachments":[{"download_url":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"PNG"},{"download_url":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"OTHER"}],"date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","message":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":2,"sender":{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"sharedLineGroup"}},"to_members":[{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"callQueue"}},{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"user"}}]},{"attachments":[{"download_url":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"OTHER"},{"download_url":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"PNG"}],"date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","message":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":6,"sender":{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"callQueue"}},"to_members":[{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"callQueue"}},{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"autoReceptionist"}}]}]}