Get SMS session details
GET {{baseUrl}}/phone/sms/sessions/:sessionId?page_size=30&next_page_token=2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe2&from=2021-12-01&to=2021-12-31&sort=1
Get details about an SMS session.
Scopes:
phone_sms:read
,
phone_sms:read:admin
,
phone_sms:master
Rate Limit Label
:
Heavy
Prerequisites
- Paid account
- User-enabled Zoom phone
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 | | 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 | number | | 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":"2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe4","page_size":30,"sms_histories":[{"attachments":[{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDA1NH0.eCURcan9QOOw9wvBdSn_-TBzgT5HWBzp04IfsK19Oto","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"GIF"},{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDA1NH0.eCURcan9QOOw9wvBdSn_-TBzgT5HWBzp04IfsK19Oto","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"GIF"}],"date_time":"2022-03-23T02:58:01Z","direction":"In","message":"welcome","message_id":"IQ-cRH5P5EiTWCwpNzScnECJw","message_type":2,"sender":{"phone_number":"18108001001","display_name":"test api","owner":{"id":"DnEopNmXQEGU2uvvzjgojw","type":"user"}},"to_members":[{"phone_number":"12092693625","display_name":"ezreal mao","owner":{"id":"WeD59Hn7SvqNRB9jcxz5NQ","type":"user"}},{"phone_number":"12092693625","display_name":"ezreal mao","owner":{"id":"WeD59Hn7SvqNRB9jcxz5NQ","type":"user"}}]},{"attachments":[{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDA1NH0.eCURcan9QOOw9wvBdSn_-TBzgT5HWBzp04IfsK19Oto","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"AUDIO"},{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDA1NH0.eCURcan9QOOw9wvBdSn_-TBzgT5HWBzp04IfsK19Oto","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"JPG"}],"date_time":"2022-03-23T02:58:01Z","direction":"In","message":"welcome","message_id":"IQ-cRH5P5EiTWCwpNzScnECJw","message_type":2,"sender":{"phone_number":"18108001001","display_name":"test api","owner":{"id":"DnEopNmXQEGU2uvvzjgojw","type":"user"}},"to_members":[{"phone_number":"12092693625","display_name":"ezreal mao","owner":{"id":"WeD59Hn7SvqNRB9jcxz5NQ","type":"user"}},{"phone_number":"12092693625","display_name":"ezreal mao","owner":{"id":"WeD59Hn7SvqNRB9jcxz5NQ","type":"user"}}]}]}