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=<string>&count=<integer>&session_type=user
Retrieves the 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: Granular Scopes: Rate Limit Label: phone:read:admin,phone:read,phone_sms:read:admin,phone_sms:readphone:read:sms_session,phone:read:sms_session:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
sync_type
|
string | (Required) FSync: Full sync BSync: Backward sync ISync: Forward sync | |
sync_token
|
string | The sync token. Use if requesting a backward (`BSync`) or forward (`ISync`) sync. | |
count
|
string | The record count of each query | |
session_type
|
string | This field filters the specific session list by a session type. The value for this field can be one of the following: `user` `call_queue` `auto_receptionist` `all` |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"sms_sessions": [
{
"last_access_time": "<string>",
"latest_message": {
"attachments": [
{
"id": "<string>",
"type": "PNG"
},
{
"id": "<string>",
"type": "OTHER"
}
],
"date_time": "<string>",
"direction": "<string>",
"message": "<string>",
"message_id": "<string>",
"message_type": 1,
"sender": {
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "user"
}
},
"to_members": [
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
},
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
}
]
},
"participants": [
{
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "sharedLineGroup"
},
"phone_number": "<string>",
"is_session_owner": "<boolean>"
},
{
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "user"
},
"phone_number": "<string>",
"is_session_owner": "<boolean>"
}
],
"session_id": "<string>",
"session_type": "<string>",
"unread_message_count": "<integer>"
},
{
"last_access_time": "<string>",
"latest_message": {
"attachments": [
{
"id": "<string>",
"type": "GIF"
},
{
"id": "<string>",
"type": "JPG/JPEG"
}
],
"date_time": "<string>",
"direction": "<string>",
"message": "<string>",
"message_id": "<string>",
"message_type": 5,
"sender": {
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "sharedLineGroup"
}
},
"to_members": [
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
},
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
}
]
},
"participants": [
{
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
},
"phone_number": "<string>",
"is_session_owner": "<boolean>"
},
{
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "callQueue"
},
"phone_number": "<string>",
"is_session_owner": "<boolean>"
}
],
"session_id": "<string>",
"session_type": "<string>",
"unread_message_count": "<integer>"
}
],
"sync_token": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/sms/sessions/sync?sync_type=FSync&sync_token=<string>&count=<integer>&session_type=user?sync_type=FSync&sync_token=<string>&count=<integer>&session_type=user' -H 'Accept: application/json'
ENDPOINTS