Zoom Public API Documentation
Get user's SMS sessions
GET {{baseUrl}}/phone/users/:userId/sms/sessions?page_size=30&next_page_token=nav48KOj42vYPSG4f0cCdT575bZ980did22&from=2021-12-01&to=2021-12-31&phone_number=18108001001
Get details about SMS sessions for a user. For user-level apps, pass the Scopes: Rate Limit Label: Prerequisites:
* Paid account
* User-enabled Zoom phoneme value instead of the userId parameter.phone_sms:read, phone_sms:read:admin, phone_sms:masterHeavy
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 | 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. | |
phone_number
|
number | Either the sender's or receiver's phone number, to limit the list of SMS sessions. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe4",
"page_size": 30,
"sms_sessions": [
{
"last_access_time": "2022-03-25T02:11:27Z",
"participants": [
{
"display_name": "l api",
"owner": {
"id": "DnEopNmXQEGU2uvvzjgojw",
"type": "user"
},
"phone_number": "18108001001"
},
{
"display_name": "l api",
"owner": {
"id": "DnEopNmXQEGU2uvvzjgojw",
"type": "user"
},
"phone_number": "18108001001"
}
],
"session_id": "d39fc7e14ef9f2b6453f5f02524d79a2"
},
{
"last_access_time": "2022-03-25T02:11:27Z",
"participants": [
{
"display_name": "l api",
"owner": {
"id": "DnEopNmXQEGU2uvvzjgojw",
"type": "user"
},
"phone_number": "18108001001"
},
{
"display_name": "l api",
"owner": {
"id": "DnEopNmXQEGU2uvvzjgojw",
"type": "user"
},
"phone_number": "18108001001"
}
],
"session_id": "d39fc7e14ef9f2b6453f5f02524d79a2"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/sms/sessions?page_size=30&next_page_token=nav48KOj42vYPSG4f0cCdT575bZ980did22&from=2021-12-01&to=2021-12-31&phone_number=18108001001?page_size=30&next_page_token=nav48KOj42vYPSG4f0cCdT575bZ980did22&from=2021-12-01&to=2021-12-31&phone_number=18108001001' -H 'Accept: application/json'
ENDPOINTS