Zoom Public API Documentation
Get account's call logs
GET {{baseUrl}}/phone/call_logs?page_size=30&from=<date>&to=<date>&type=<string>&next_page_token=<string>&path=<string>&time_type=startTime&site_id=<string>&charged_call_logs=<boolean>
Returns an account's call logs. Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license
* Account owner or a role with Zoom Phone management Scopes: Granular Scopes: Rate Limit Label: phone:read:admin,phone_call_log:read:adminphone:read:list_call_logs:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
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. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours. | |
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. | |
type
|
string | The type of the call logs. The value can be either "all" or "missed". | |
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. | |
path
|
string | Filter the API response by [path](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs#h_646b46c6-0623-4ab1-8b8b-ea5b8bcef679) of the call. The value of this field can be one of the following: `voiceMail`, `message`, `forward`, `extension`, `callQueue`, `ivrMenu`, `companyDirectory`, `autoReceptionist`, `contactCenter`, `disconnected`, `commonAreaPhone`, `pstn`, `transfer`, `sharedLines`, `sharedLineGroup`, `tollFreeBilling`, `meetingService`, `parkPickup`, `parkTimeout`, `monitor`, `takeover`, `sipGroup` | |
time_type
|
string | Enables you to search call logs by start or end time. Choose `startTime` or `endTime`. | |
site_id
|
string | 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. | |
charged_call_logs
|
string | Whether to filter API responses to include call logs that only have a non-zero charge. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"call_logs": [
{
"answer_start_time": "<dateTime>",
"call_end_time": "<string>",
"call_id": "<string>",
"call_type": "contactCenter",
"callee_country_code": "<string>",
"callee_country_iso_code": "<string>",
"callee_did_number": "<string>",
"callee_name": "<string>",
"callee_number": "<string>",
"callee_number_type": 2,
"callee_number_source": "external",
"caller_country_code": "<string>",
"caller_country_iso_code": "<string>",
"caller_did_number": "<string>",
"caller_name": "<string>",
"caller_number": "<string>",
"caller_number_type": 1,
"caller_number_source": "external",
"caller_billing_reference_id": "<string>",
"charge": "<string>",
"client_code": "<string>",
"date_time": "<string>",
"device_private_ip": "<string>",
"device_public_ip": "<string>",
"direction": "<string>",
"duration": "<integer>",
"id": "<string>",
"owner": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"type": "user"
},
"path": "<string>",
"rate": "<string>",
"recording_id": "<string>",
"recording_type": "Automatic",
"result": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"user_id": "<string>",
"hold_time": "<integer>",
"waiting_time": "<integer>",
"department": "<string>",
"cost_center": "<string>"
},
{
"answer_start_time": "<dateTime>",
"call_end_time": "<string>",
"call_id": "<string>",
"call_type": "international",
"callee_country_code": "<string>",
"callee_country_iso_code": "<string>",
"callee_did_number": "<string>",
"callee_name": "<string>",
"callee_number": "<string>",
"callee_number_type": 2,
"callee_number_source": "byop",
"caller_country_code": "<string>",
"caller_country_iso_code": "<string>",
"caller_did_number": "<string>",
"caller_name": "<string>",
"caller_number": "<string>",
"caller_number_type": 2,
"caller_number_source": "byop",
"caller_billing_reference_id": "<string>",
"charge": "<string>",
"client_code": "<string>",
"date_time": "<string>",
"device_private_ip": "<string>",
"device_public_ip": "<string>",
"direction": "<string>",
"duration": "<integer>",
"id": "<string>",
"owner": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"type": "user"
},
"path": "<string>",
"rate": "<string>",
"recording_id": "<string>",
"recording_type": "OnDemand",
"result": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"user_id": "<string>",
"hold_time": "<integer>",
"waiting_time": "<integer>",
"department": "<string>",
"cost_center": "<string>"
}
],
"from": "<string>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": "<integer>",
"to": "<string>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/call_logs?page_size=30&from=<date>&to=<date>&type=<string>&next_page_token=<string>&path=<string>&time_type=startTime&site_id=<string>&charged_call_logs=<boolean>?page_size=30&from=<date>&to=<date>&type=<string>&next_page_token=<string>&path=<string>&time_type=startTime&site_id=<string>&charged_call_logs=<boolean>' -H 'Accept: application/json'
ENDPOINTS