Zoom Public API Documentation
Get telephone reports
GET {{baseUrl}}/report/telephone?type=1&query_date_type=start_time&from=<date>&to=<date>&page_size=30&page_number=1&next_page_token=<string>
The telephone report allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time. Prerequisites: Scopes: Rate Limit Label:
report:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
type
|
number | Audio types: `1` - Toll-free Call-in & Call-out. `2` - Toll `3` - SIP Connected Audio | |
query_date_type
|
string | The type of date to query. * `start_time` — Query by call start time. * `end_time` — Query by call end time. * `meeting_start_time` — Query by meeting start time. * `meeting_end_time` — Query by meeting end time. This value defaults to `start_time`. | |
from
|
string | (Required) Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once. | |
to
|
string | (Required) End date. | |
page_size
|
number | The number of records returned within a single API call. | |
page_number
|
number | The page number of the current page in the returned records. This field is **not** available if the `query_date_type` parameter is the `meeting_start_time` or `meeting_end_time` value. This field is deprecated. Use the `next_page_token` query parameter for pagination. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<date>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": "<integer>",
"to": "<date>",
"total_records": "<integer>",
"telephony_usage": [
{
"call_in_number": "<string>",
"country_name": "<string>",
"dept": "<string>",
"duration": "<integer>",
"end_time": "<dateTime>",
"host_email": "<string>",
"host_id": "<string>",
"host_name": "<string>",
"meeting_id": "<long>",
"meeting_type": "<string>",
"phone_number": "<string>",
"rate": "<number>",
"signaled_number": "<string>",
"start_time": "<dateTime>",
"total": "<number>",
"type": "call-in",
"uuid": "<string>"
},
{
"call_in_number": "<string>",
"country_name": "<string>",
"dept": "<string>",
"duration": "<integer>",
"end_time": "<dateTime>",
"host_email": "<string>",
"host_id": "<string>",
"host_name": "<string>",
"meeting_id": "<long>",
"meeting_type": "<string>",
"phone_number": "<string>",
"rate": "<number>",
"signaled_number": "<string>",
"start_time": "<dateTime>",
"total": "<number>",
"type": "premium call-in",
"uuid": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/report/telephone?type=1&query_date_type=start_time&from=<date>&to=<date>&page_size=30&page_number=1&next_page_token=<string>?type=1&query_date_type=start_time&from=<date>&to=<date>&page_size=30&page_number=1&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS