Zoom Public API Documentation
List user's SMS sessions in descending order
GET {{baseUrl}}/phone/users/:userId/sms/sessions/sync?sync_type=FSync&sync_token=MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ=&count=50
Use this API to retrieve 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: Rate Limit Label: phone_sms:read, phone_sms:read:admin, phone_sms:masterHeavy
Body
PARAM
| Key | Datatype | Required | Description |
sync_type
|
string | (Required) FSync: Full sync BSync: Backward sync ISync: Forward sync | |
sync_token
|
string | Sync token. Use if requesting a backward (`BSync`) or forward (`ISync`) sync. | |
count
|
number | Record count of each query |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"sms_sessions": [
{
"last_access_time": "2022-03-25T02:11:27Z",
"latest_message": {
"attachments": [
{
"id": "ttllslww",
"type": "GIF"
},
{
"id": "ttllslww",
"type": "GIF"
}
],
"date_time": "2022-03-25T02:11:27Z",
"direction": "Out",
"message": "hello",
"message_id": "cfc07047-123e-4097-91d4-ac2635d646af",
"message_type": null,
"sender": {
"phone_number": "+18108001001",
"display_name": "usersubsetting0001@testapi.com",
"owner": {
"id": "DnEopNmXQEGU2uvvzjgojw",
"type": "user"
}
},
"to_members": [
{
"phone_number": "+13522348840",
"display_name": "test api",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
}
},
{
"phone_number": "+13522348840",
"display_name": "test api",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
}
}
]
},
"participants": [
{
"display_name": "usersubsetting0001@testapi.com",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
},
"phone_number": "+13522348840"
},
{
"display_name": "usersubsetting0001@testapi.com",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
},
"phone_number": "+13522348840"
}
],
"session_id": "67e261d9eefb2f87dc8193b4c2aeb1d8"
},
{
"last_access_time": "2022-03-25T02:11:27Z",
"latest_message": {
"attachments": [
{
"id": "ttllslww",
"type": "GIF"
},
{
"id": "ttllslww",
"type": "GIF"
}
],
"date_time": "2022-03-25T02:11:27Z",
"direction": "Out",
"message": "hello",
"message_id": "cfc07047-123e-4097-91d4-ac2635d646af",
"message_type": "6",
"sender": {
"phone_number": "+18108001001",
"display_name": "usersubsetting0001@testapi.com",
"owner": {
"id": "DnEopNmXQEGU2uvvzjgojw",
"type": "user"
}
},
"to_members": [
{
"phone_number": "+13522348840",
"display_name": "test api",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
}
},
{
"phone_number": "+13522348840",
"display_name": "test api",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
}
}
]
},
"participants": [
{
"display_name": "usersubsetting0001@testapi.com",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
},
"phone_number": "+13522348840"
},
{
"display_name": "usersubsetting0001@testapi.com",
"owner": {
"id": "QOFvOvk7SJeOR2VBfL79_g",
"type": "user"
},
"phone_number": "+13522348840"
}
],
"session_id": "67e261d9eefb2f87dc8193b4c2aeb1d8"
}
],
"sync_token": "TVR5cXB2b2dmSl8xNjIxNTc0ODQ0MDY3XzE2NDgxNzQyODcwMDk="
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/sms/sessions/sync?sync_type=FSync&sync_token=MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ=&count=50?sync_type=FSync&sync_token=MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ=&count=50' -H 'Accept: application/json'
ENDPOINTS