GET /phone/metrics/call_logs

Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.

Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.

Prerequisites:

Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Heavy

Servers

Query parameters

Name Type Required Description
to String No

End date for the report in yyyy-mm-dd format.

site_id String No

Unique identifier of the site. 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 No

Filter 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 Integer No

The number of records returned within a single call.

Default value: 30

next_page_token String No

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.

from String No

Start date for the report in yyyy-mm-dd format. Specify a 30 day range using the from and to parameters as the response provides a maximum of a month worth of data per API request.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.