Zoom Public API Documentation
Get account's call history
GET {{baseUrl}}/phone/call_history?page_size=30&from=<date>&to=<date>&next_page_token=<string>&keyword=<string>&directions=outbound&directions=outbound&connect_types=internal&connect_types=internal&number_types=3rd_party_contact_center&number_types=byoc&call_types=emergency&call_types=emergency&extension_types=group_call_pickup&extension_types=user&call_results=answered&call_results=connected&group_ids=<string>&group_ids=<string>&site_ids=<string>&site_ids=<string>&department=<string>&cost_center=<string>&time_type=start_time&recording_status=
Returns an account's new edition 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. | |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
keyword
|
string | The keyword of the name, extension, number, email address, and call ID. It provides the ability to search by keyword and it shows a list of all the related calls. Any calls go through this keyword. | |
directions
|
string | The direction filter of the call logs. | |
directions
|
string | The direction filter of the call logs. | |
connect_types
|
string | The connect type filter of the call logs. * `internal` * `external` | |
connect_types
|
string | The connect type filter of the call logs. * `internal` * `external` | |
number_types
|
string | The number type filter of the caller or callee. | |
number_types
|
string | The number type filter of the caller or callee. | |
call_types
|
string | The call type filter of the call logs. * `general` * `emergency` | |
call_types
|
string | The call type filter of the call logs. * `general` * `emergency` | |
extension_types
|
string | The extension type filter of the call logs. | |
extension_types
|
string | The extension type filter of the call logs. | |
call_results
|
string | The call result filter of the call logs. | |
call_results
|
string | The call result filter of the call logs. | |
group_ids
|
string | The primary group filter of call logs. | |
group_ids
|
string | The primary group filter of call logs. | |
site_ids
|
string | The site filter of call logs. | |
site_ids
|
string | The site filter of call logs. | |
department
|
string | The department of which the call log belongs. | |
cost_center
|
string | The cost center of which the call log belongs. | |
time_type
|
string | This field enables you to search call logs by start or end time. By default, using start_time | |
recording_status
|
null | The recording filter indicates whether the whole call has recording or not. recorded means the call has at least one recording, non_recorded means the call does not have any recordings. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"call_logs": [
{
"id": "<string>",
"call_id": "<string>",
"direction": "inbound",
"start_time": "<string>",
"answer_time": "<string>",
"end_time": "<string>",
"duration": "<integer>",
"connect_type": "internal",
"sbc_id": "<string>",
"sbc_name": "<string>",
"sip_group_id": "<string>",
"sip_group_name": "<string>",
"call_type": "general",
"call_result": "abandoned",
"caller_ext_id": "<string>",
"caller_did_number": "<string>",
"caller_ext_number": "<string>",
"caller_name": "<string>",
"caller_email": "<string>",
"caller_ext_type": "shared_line_group",
"caller_number_type": "anonymous_number",
"callee_ext_id": "<string>",
"callee_did_number": "<string>",
"callee_ext_number": "<string>",
"callee_name": "<string>",
"callee_email": "<string>",
"callee_ext_type": "common_area",
"callee_number_type": "byop",
"department": "<string>",
"cost_center": "<string>",
"site_id": "<string>",
"group_id": "<string>",
"site_name": "<string>",
"spam": "<string>",
"recording_status": "recorded"
},
{
"id": "<string>",
"call_id": "<string>",
"direction": "outbound",
"start_time": "<string>",
"answer_time": "<string>",
"end_time": "<string>",
"duration": "<integer>",
"connect_type": "external",
"sbc_id": "<string>",
"sbc_name": "<string>",
"sip_group_id": "<string>",
"sip_group_name": "<string>",
"call_type": "general",
"call_result": "hang_up",
"caller_ext_id": "<string>",
"caller_did_number": "<string>",
"caller_ext_number": "<string>",
"caller_name": "<string>",
"caller_email": "<string>",
"caller_ext_type": "call_queue",
"caller_number_type": "zoom_toll_free_number",
"callee_ext_id": "<string>",
"callee_did_number": "<string>",
"callee_ext_number": "<string>",
"callee_name": "<string>",
"callee_email": "<string>",
"callee_ext_type": "external_contact",
"callee_number_type": "anonymous_number",
"department": "<string>",
"cost_center": "<string>",
"site_id": "<string>",
"group_id": "<string>",
"site_name": "<string>",
"spam": "<string>",
"recording_status": "recorded"
}
],
"from": "<string>",
"to": "<string>",
"page_count": "<integer>",
"page_size": "<integer>",
"total_records": "<integer>",
"next_page_token": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/call_history?page_size=30&from=<date>&to=<date>&next_page_token=<string>&keyword=<string>&directions=outbound&directions=outbound&connect_types=internal&connect_types=internal&number_types=3rd_party_contact_center&number_types=byoc&call_types=emergency&call_types=emergency&extension_types=group_call_pickup&extension_types=user&call_results=answered&call_results=connected&group_ids=<string>&group_ids=<string>&site_ids=<string>&site_ids=<string>&department=<string>&cost_center=<string>&time_type=start_time&recording_status=?page_size=30&from=<date>&to=<date>&next_page_token=<string>&keyword=<string>&directions=outbound&directions=outbound&connect_types=internal&connect_types=internal&number_types=3rd_party_contact_center&number_types=byoc&call_types=emergency&call_types=emergency&extension_types=group_call_pickup&extension_types=user&call_results=answered&call_results=connected&group_ids=<string>&group_ids=<string>&site_ids=<string>&site_ids=<string>&department=<string>&cost_center=<string>&time_type=start_time&recording_status=' -H 'Accept: application/json'
ENDPOINTS