Zoom Public API Documentation
Get user's SMS sessions
GET {{baseUrl}}/phone/users/:userId/sms/sessions?page_size=30&next_page_token=<string>&session_type=user&from=<date>&to=<date>&phone_number=<string>&filter_type=last_message_time
Returns details about SMS sessions for a user. For user-level apps, pass the Prerequisites:
* Paid account
* User-enabled Zoom phone Scopes: Granular Scopes: Rate Limit Label: me value instead of the userId parameter.phone:read:admin,phone:read,phone_sms:read:admin,phone_sms:readphone:read:list_sms_sessions,phone:read:list_sms_sessions:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The current page number of returned records. | |
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` | |
from
|
string | The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, it returns data from the past 30 days. | |
to
|
string | This field is required only when the `from` parameter is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format is the same format as the `from` parameter. | |
phone_number
|
string | The sender's or receiver's phone number that limits the list of SMS sessions. | |
filter_type
|
string | This field filters by `sent_message_time`, `received_message_time`, or `last_message_time` for the From and To dates. * `last_message_time`: can query which sessions last messages between From and To dates. * `sent_message_time`: can query which sessions have sent messages between From and To dates. * `received_message_time`: can query which sessions have received messages between From and To dates. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": "<integer>",
"sms_sessions": [
{
"last_access_time": "<string>",
"participants": [
{
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "user"
},
"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>"
},
{
"last_access_time": "<string>",
"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>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/sms/sessions?page_size=30&next_page_token=<string>&session_type=user&from=<date>&to=<date>&phone_number=<string>&filter_type=last_message_time?page_size=30&next_page_token=<string>&session_type=user&from=<date>&to=<date>&phone_number=<string>&filter_type=last_message_time' -H 'Accept: application/json'
ENDPOINTS