Zoom Public API Documentation
Get SMS session details
GET {{baseUrl}}/phone/sms/sessions/:sessionId?page_size=30&next_page_token=<string>&from=<date>&to=<date>&sort=<integer>
Get details about an SMS 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 |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The current page number of returned records. | |
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, returns data from the past 30 days. | |
to
|
string | **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter. | |
sort
|
string | Order of SMS to return based on creation time. `1`: ascending `2`: descending |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": "<integer>",
"sms_histories": [
{
"attachments": [
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "PNG"
},
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "OTHER"
}
],
"date_time": "<string>",
"direction": "<string>",
"message": "<string>",
"message_id": "<string>",
"message_type": 2,
"sender": {
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "sharedLineGroup"
}
},
"to_members": [
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "callQueue"
}
},
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "user"
}
}
]
},
{
"attachments": [
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "OTHER"
},
{
"download_url": "<string>",
"id": "<string>",
"name": "<string>",
"size": "<integer>",
"type": "PNG"
}
],
"date_time": "<string>",
"direction": "<string>",
"message": "<string>",
"message_id": "<string>",
"message_type": 6,
"sender": {
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "callQueue"
}
},
"to_members": [
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "callQueue"
}
},
{
"phone_number": "<string>",
"display_name": "<string>",
"owner": {
"id": "<string>",
"type": "autoReceptionist"
}
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sms/sessions/:sessionId?page_size=30&next_page_token=<string>&from=<date>&to=<date>&sort=<integer>?page_size=30&next_page_token=<string>&from=<date>&to=<date>&sort=<integer>' -H 'Accept: application/json'
ENDPOINTS