List user's SMS sessions in descending order
GET {{baseUrl}}/phone/users/:userId/sms/sessions/sync?sync_type=FSync&sync_token=<string>&count=<integer>&session_type=user
Retrieves the user's SMS sessions in descending order. Mirrors the ZP client behavior with the most recent on top.
Prerequisites:
- Paid account
- User-enabled Zoom phone
Scopes:
phone:read:admin
,
phone:read
,
phone_sms:read:admin
,
phone_sms:read
Granular Scopes:
phone:read:sms_session
,
phone:read:sms_session:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| sync_type | string | | (Required) FSync: Full sync BSync: Backward sync ISync: Forward sync |
| sync_token | string | | The sync token. Use if requesting a backward (BSync) or forward (ISync) sync. |
| count | string | | The record count of each query |
| 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 |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"sms_sessions":[{"last_access_time":"\u003cstring\u003e","latest_message":{"attachments":[{"id":"\u003cstring\u003e","type":"PNG"},{"id":"\u003cstring\u003e","type":"OTHER"}],"date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","message":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":1,"sender":{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"user"}},"to_members":[{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"autoReceptionist"}},{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"autoReceptionist"}}]},"participants":[{"display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"sharedLineGroup"},"phone_number":"\u003cstring\u003e","is_session_owner":"\u003cboolean\u003e"},{"display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"user"},"phone_number":"\u003cstring\u003e","is_session_owner":"\u003cboolean\u003e"}],"session_id":"\u003cstring\u003e","session_type":"\u003cstring\u003e","unread_message_count":"\u003cinteger\u003e"},{"last_access_time":"\u003cstring\u003e","latest_message":{"attachments":[{"id":"\u003cstring\u003e","type":"GIF"},{"id":"\u003cstring\u003e","type":"JPG/JPEG"}],"date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","message":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":5,"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":"autoReceptionist"}},{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"autoReceptionist"}}]},"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","unread_message_count":"\u003cinteger\u003e"}],"sync_token":"\u003cstring\u003e"}