GET /phone/call_logs
Retrieve call logs for an account.
Scopes: phone:read:admin
Rate Limit Label: Heavy
Prerequisite:
- Business or Enterprise account
- A Zoom Phone license
- Account Owner and a role with Zoom Phone Management
Servers
- https://api.zoom.us/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
to |
String | No |
The end date upto which you would like to get the call logs for. The end date should be within past six months. |
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. |
page_size |
Integer | No |
The number of records returned within a single API call. Default value: 30 |
type |
String | No |
The type of the call logs. The value can be either "all" or "missed". |
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. |
path |
String | No |
Filter the API response by path of the call. The value of this field can be one of the following: |
time_type |
String | No |
Enables you to sort call logs by start or end time. Choose the sort time value. Values include Valid values:
Default value: "startTime" |
from |
String | No |
Start date from which you would like to get the call logs. The start date should be within past six months. The API only returns data pertaining to a month. Thus, the date range(defined using "from" and "to" fields) for which the call logs are to be returned must not exceed a month. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.