Sync SMS by session ID
GET {{baseUrl}}/phone/sms/sessions/:sessionId/sync?sync_type=FSync&count=100&sync_token=MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ=
Use this API to sync SMS messages in a 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 |
| sync_type | string | | Options for synchronizing sms message:<br>
FSync - Full sync<br>
ISync - Increase sync<br>
BSync - Backward sync |
| count | number | | 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":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDk4OH0.kAh1EnCkjpwAOX_GUfWVPLK2xhnVPRiwm8vDbD-oyVY","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"OTHER"},{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDk4OH0.kAh1EnCkjpwAOX_GUfWVPLK2xhnVPRiwm8vDbD-oyVY","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":"12762924594","display_name":"callhandling0001@testapi.com","owner":{"id":"rYgfsrduSXWCxr94poMN5g","type":"user"}},{"phone_number":"12762924594","display_name":"callhandling0001@testapi.com","owner":{"id":"rYgfsrduSXWCxr94poMN5g","type":"user"}}]},{"attachments":[{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDk4OH0.kAh1EnCkjpwAOX_GUfWVPLK2xhnVPRiwm8vDbD-oyVY","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"JPG"},{"download_url":"https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDk4OH0.kAh1EnCkjpwAOX_GUfWVPLK2xhnVPRiwm8vDbD-oyVY","id":"x18dcVWxTcCzbp4zr2AT3A","name":"FWDHOMaNRaqIvNc3aIdisg.jpg","size":225740,"type":"AUDIO"}],"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":"12762924594","display_name":"callhandling0001@testapi.com","owner":{"id":"rYgfsrduSXWCxr94poMN5g","type":"user"}},{"phone_number":"12762924594","display_name":"callhandling0001@testapi.com","owner":{"id":"rYgfsrduSXWCxr94poMN5g","type":"user"}}]}],"sync_token":"MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ="}