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: phone:read:admin,phone_call_log:read:admin
Granular Scopes: phone:read:list_call_logs:admin
Rate Limit Label: HEAVY
Request Params
| 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 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. 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":"\u003cdateTime\u003e","call_end_time":"\u003cstring\u003e","call_id":"\u003cstring\u003e","call_type":"contactCenter","callee_country_code":"\u003cstring\u003e","callee_country_iso_code":"\u003cstring\u003e","callee_did_number":"\u003cstring\u003e","callee_name":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_number_type":2,"callee_number_source":"external","caller_country_code":"\u003cstring\u003e","caller_country_iso_code":"\u003cstring\u003e","caller_did_number":"\u003cstring\u003e","caller_name":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_number_type":1,"caller_number_source":"external","caller_billing_reference_id":"\u003cstring\u003e","charge":"\u003cstring\u003e","client_code":"\u003cstring\u003e","date_time":"\u003cstring\u003e","device_private_ip":"\u003cstring\u003e","device_public_ip":"\u003cstring\u003e","direction":"\u003cstring\u003e","duration":"\u003cinteger\u003e","id":"\u003cstring\u003e","owner":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"user"},"path":"\u003cstring\u003e","rate":"\u003cstring\u003e","recording_id":"\u003cstring\u003e","recording_type":"Automatic","result":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"user_id":"\u003cstring\u003e","hold_time":"\u003cinteger\u003e","waiting_time":"\u003cinteger\u003e","department":"\u003cstring\u003e","cost_center":"\u003cstring\u003e"},{"answer_start_time":"\u003cdateTime\u003e","call_end_time":"\u003cstring\u003e","call_id":"\u003cstring\u003e","call_type":"international","callee_country_code":"\u003cstring\u003e","callee_country_iso_code":"\u003cstring\u003e","callee_did_number":"\u003cstring\u003e","callee_name":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_number_type":2,"callee_number_source":"byop","caller_country_code":"\u003cstring\u003e","caller_country_iso_code":"\u003cstring\u003e","caller_did_number":"\u003cstring\u003e","caller_name":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_number_type":2,"caller_number_source":"byop","caller_billing_reference_id":"\u003cstring\u003e","charge":"\u003cstring\u003e","client_code":"\u003cstring\u003e","date_time":"\u003cstring\u003e","device_private_ip":"\u003cstring\u003e","device_public_ip":"\u003cstring\u003e","direction":"\u003cstring\u003e","duration":"\u003cinteger\u003e","id":"\u003cstring\u003e","owner":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"user"},"path":"\u003cstring\u003e","rate":"\u003cstring\u003e","recording_id":"\u003cstring\u003e","recording_type":"OnDemand","result":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"user_id":"\u003cstring\u003e","hold_time":"\u003cinteger\u003e","waiting_time":"\u003cinteger\u003e","department":"\u003cstring\u003e","cost_center":"\u003cstring\u003e"}],"from":"\u003cstring\u003e","next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":"\u003cinteger\u003e","to":"\u003cstring\u003e","total_records":"\u003cinteger\u003e"}