Zoom Public API Documentation
Get telephone report
GET {{baseUrl}}/videosdk/report/telephone?from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&type=&query_date_type=
The telephone report allows you to view who dialed into sessions via phone (Audio Conferencing or SIP Connected Audio), which number they dialed into, and other details. Use this API to get the telephone report for a specified period of time. Rate Limit Label:
Prerequisites
* A Video SDK account.Heavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (Required) The start date to query, in `yyyy-mm-dd` format. The ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data. | |
to
|
string | (Required) The end date to query, in `yyyy-mm-dd` format. The ranges defined in the `from` and `to` parameters should **only** be a one month range. This is because the report only includes one month's worth of data. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
type
|
null | Audio types:<br>`1` - Toll-free Call-in & Call-out.<br>`2` - Toll <br> `3` - SIP Connected Audio (This can only be one of 1,2,3) | |
query_date_type
|
null | The type of date to query: * `start_time` — Query by call start time. * `end_time` — Query by call end time. * `session_start_time` — Query by session start time. * `session_end_time` — Query by session end time. This value defaults to `start_time`. (This can only be one of start_time,end_time,session_start_time,session_end_time) |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"page_size": 50,
"next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2",
"from": "2019-07-15",
"to": "2019-07-20",
"telephony_usage": [
{
"session_id": "sfk/aOFJSJSYhGwk1hnxgw==",
"phone_number": "000002001",
"signaled_number": "000002001",
"start_time": "2019-07-15T23:24:52Z",
"end_time": "2019-07-15T23:30:19Z",
"duration": 52779115,
"total": 90324461.0447123,
"country_name": "Macau SAR",
"call_in_number": "+85123456789",
"type": "toll-free",
"rate": 26614345.8026177
},
{
"session_id": "sfk/aOFJSJSYhGwk1hnxgw==",
"phone_number": "000002001",
"signaled_number": "000002001",
"start_time": "2019-07-15T23:24:52Z",
"end_time": "2019-07-15T23:30:19Z",
"duration": 40716844,
"total": -43407581.102647,
"country_name": "Macau SAR",
"call_in_number": "+85123456789",
"type": "toll-free",
"rate": 51499133.88117099
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/videosdk/report/telephone?from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&type=&query_date_type=?from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&type=&query_date_type=' -H 'Accept: application/json'
ENDPOINTS