Zoom Public API Documentation
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: Granular Scopes: Rate Limit Label: phone:read:admin,phone:read,phone_sms:read,phone_sms:read:adminphone:read:sms_session,phone:read:sms_session:adminMedium
Body
PARAM
| 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": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "PNG"
},
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "VIDEO"
}
],
"date_time": "<string>",
"direction": "<string>",
"message": "<string>",
"message_id": "<string>",
"message_type": 4,
"sender": {
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "sharedLineGroup"
}
},
"to_members": [
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "user"
}
},
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "sharedLineGroup"
}
}
]
},
{
"attachments": [
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "GIF"
},
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "JPG"
}
],
"date_time": "<string>",
"direction": "<string>",
"message": "<string>",
"message_id": "<string>",
"message_type": 3,
"sender": {
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
},
"to_members": [
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "callQueue"
}
},
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
}
]
}
],
"sync_token": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sms/sessions/:sessionId/sync?sync_type=BSync&count=<integer>&sync_token=<string>?sync_type=BSync&count=<integer>&sync_token=<string>' -H 'Accept: application/json'
ENDPOINTS