Get user's SMS sessions
GET {{baseUrl}}/phone/users/:userId/sms/sessions?page_size=30&next_page_token=<string>&session_type=user&from=<date>&to=<date>&phone_number=<string>&filter_type=last_message_time
Returns details about SMS sessions for a user.
For user-level apps, pass
the
me
value
instead of the
userId
parameter.
Prerequisites:
- Paid account
- User-enabled Zoom phone
Scopes:
phone:read:admin
,
phone:read
,
phone_sms:read:admin
,
phone_sms:read
Granular Scopes:
phone:read:list_sms_sessions
,
phone:read:list_sms_sessions:admin
Rate Limit Label
:
HEAVY
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. |
| session_type | string | | This field filters the specific session list by a session type.
The value for this field can be one of the following:
user
call_queue
auto_receptionist
all |
| 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, it returns data from the past 30 days. |
| to | string | | This field is required only when the from parameter is specified.
The end time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format is the same format as the from parameter. |
| phone_number | string | | The sender's or receiver's phone number that limits the list of SMS sessions. |
| filter_type | string | | This field filters by sent_message_time, received_message_time, or last_message_time for the From and To dates.
last_message_time: can query which sessions last messages between From and To dates.sent_message_time: can query which sessions have sent messages between From and To dates.received_message_time: can query which sessions have received messages between From and To dates. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","sms_sessions":[{"last_access_time":"\u003cstring\u003e","participants":[{"display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"user"},"phone_number":"\u003cstring\u003e","is_session_owner":"\u003cboolean\u003e"},{"display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"callQueue"},"phone_number":"\u003cstring\u003e","is_session_owner":"\u003cboolean\u003e"}],"session_id":"\u003cstring\u003e","session_type":"\u003cstring\u003e"},{"last_access_time":"\u003cstring\u003e","participants":[{"display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"autoReceptionist"},"phone_number":"\u003cstring\u003e","is_session_owner":"\u003cboolean\u003e"},{"display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"callQueue"},"phone_number":"\u003cstring\u003e","is_session_owner":"\u003cboolean\u003e"}],"session_id":"\u003cstring\u003e","session_type":"\u003cstring\u003e"}]}