Logo
Zoom Public API Documentation

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

 

Body PARAM

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_GUfWV
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sms/sessions/:sessionId/sync?sync_type=FSync&count=100&sync_token=MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ=?sync_type=FSync&count=100&sync_token=MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ=' -H 'Accept: application/json'

ENDPOINTS