Logo
Zoom Public API Documentation

List call logs

GET {{baseUrl}}/phone/metrics/call_logs?from=<date>&to=<date>&site_id=<string>&quality_type=<string>&page_size=30&next_page_token=<string>

Lists the monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.The call logs that provide a record of all incoming and outgoing calls over Zoom Phone in an account.

Prerequisites: * Business, or Education account * Zoom Phone license

Scopes: phone:read:admin

Granular Scopes: phone:read:list_call_logs:admin

Rate Limit Label: Heavy

 

Body PARAM

Key Datatype Required Description 
from
string The start date in **yyyy-mm-dd** 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 1 day.
to
string This setting is **required** only when the `from` parameter is specified. The end date is in **yyyy-mm-dd** format, which is the same format as the `from` parameter.
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.
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. * `all`: Retrieve all call logs without filtering by voice quality.
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 will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.


Curl
curl -X GET 'https://api.zoom.us/v2/phone/metrics/call_logs?from=<date>&to=<date>&site_id=<string>&quality_type=<string>&page_size=30&next_page_token=<string>?from=<date>&to=<date>&site_id=<string>&quality_type=<string>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'

ENDPOINTS