Zoom Public API Documentation
List past call metrics
GET {{baseUrl}}/phone/metrics/past_calls?from=<date>&to=<date>&phone_number=<string>&extension_number=<string>&quality_type=good&department=<string>&cost_center=<string>&directions=internal&directions=inbound&durations=0&durations=1&site_id=<string>&page_size=30&next_page_token=<string>
Returns all the call logs metrics of the account from the selected time period. The call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. You can use query parameters to filter the response by metrics of the call (such as date, phone number, extension number and quality type). Prerequisites:
* Business, or Education account
* Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_call_logs:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
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. | |
phone_number
|
string | This setting filters call logs of a specified phone number. | |
extension_number
|
string | This setting filters call logs of a specified extension number | |
quality_type
|
string | This setting filters call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. The value of this field can be one of the following: * `good`: Retrieve call logs of the call(s) with good quality of voice. * `bad`: Retrieve call logs of the call(s) with good quality of voice. | |
department
|
string | The department the extension belongs to. | |
cost_center
|
string | The cost center the extension belongs to. | |
directions
|
string | The directions of the call. | |
directions
|
string | The directions of the call. | |
durations
|
number | The duration of the call. * `0`: The call that lasts 1 to 5 minutes. * `1`: The call that lasts 5 to 10 minutes. * `2`: The call that lasts more than 10 minutes. * `3`: The call that lasts less than 1 minute. | |
durations
|
number | The duration of the call. * `0`: The call that lasts 1 to 5 minutes. * `1`: The call that lasts 5 to 10 minutes. * `2`: The call that lasts more than 10 minutes. * `3`: The call that lasts less than 1 minute. | |
site_id
|
string | The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site. | |
page_size
|
number | The number of records returned within a single call. | |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token is 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
| {
"call_logs": [
{
"call_id": "<string>",
"callee": {
"codec": "<string>",
"device_private_ip": "<string>",
"device_public_ip": "<string>",
"device_type": "<string>",
"extension_number": "<string>",
"headset": "<string>",
"isp": "<string>",
"microphone": "<string>",
"phone_number": "<string>",
"site_id": "<string>"
},
"caller": {
"codec": "<string>",
"device_private_ip": "<string>",
"device_public_ip": "<string>",
"device_type": "<string>",
"extension_number": "<string>",
"headset": "<string>",
"isp": "<string>",
"microphone": "<string>",
"phone_number": "<string>",
"site_id": "<string>"
},
"date_time": "<string>",
"direction": "inbound",
"duration": "<integer>",
"mos": "<string>"
},
{
"call_id": "<string>",
"callee": {
"codec": "<string>",
"device_private_ip": "<string>",
"device_public_ip": "<string>",
"device_type": "<string>",
"extension_number": "<string>",
"headset": "<string>",
"isp": "<string>",
"microphone": "<string>",
"phone_number": "<string>",
"site_id": "<string>"
},
"caller": {
"codec": "<string>",
"device_private_ip": "<string>",
"device_public_ip": "<string>",
"device_type": "<string>",
"extension_number": "<string>",
"headset": "<string>",
"isp": "<string>",
"microphone": "<string>",
"phone_number": "<string>",
"site_id": "<string>"
},
"date_time": "<string>",
"direction": "outbound",
"duration": "<integer>",
"mos": "<string>"
}
],
"from": "<string>",
"to": "<string>",
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/metrics/past_calls?from=<date>&to=<date>&phone_number=<string>&extension_number=<string>&quality_type=good&department=<string>&cost_center=<string>&directions=internal&directions=inbound&durations=0&durations=1&site_id=<string>&page_size=30&next_page_token=<string>?from=<date>&to=<date>&phone_number=<string>&extension_number=<string>&quality_type=good&department=<string>&cost_center=<string>&directions=internal&directions=inbound&durations=0&durations=1&site_id=<string>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS