Sync SMS by session ID
GET {{baseUrl}}/phone/sms/sessions/:sessionId/sync?sync_type=BSync&count=<integer>&sync_token=<string>
Use this API to sync SMS messages in a 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 |
| sync_type | string | | Options for synchronizing sms message:
FSync - Full sync
ISync - Increase sync
BSync - Backward sync |
| count | string | | The number of records returned within a single API call. |
| sync_token | string | | The time range for returned records. Used for locating where the next retrieval will begin. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"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":"VIDEO"}],"date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","message":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":4,"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":"user"}},{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"sharedLineGroup"}}]},{"attachments":[{"download_url":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"GIF"},{"download_url":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"JPG"}],"date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","message":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":3,"sender":{"phone_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","owner":{"id":"\u003cstring\u003e","type":"autoReceptionist"}},"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"}}]}],"sync_token":"\u003cstring\u003e"}