Get account's call logs

GET {{baseUrl}}/phone/call_logs?page_size=30&from=2020-10-31&to=2021-12-31&type=all&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&path=extension&time_type=startTime&site_id=8f71O6rWT8KFUGQmJIFAdQ&charged_call_logs=false

Use this API to return 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

Rate Limit Label: Heavy

Request Params

KeyDatatypeRequiredDescription
page_sizenumberThe number of records returned within a single API call.
fromstringStart 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.
tostringRequired 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.
typestringThe type of the call logs. The value can be either "all" or "missed".
next_page_tokenstringThe 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.
pathstringFilter 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_typestringEnables you to search call logs by start or end time. Choose startTime or endTime.
site_idstringUnique 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_logsbooleanWhether to filter API responses to include call logs that only have a non-zero charge.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"call_logs":[{"answer_start_time":"2021-10-12T16:00:08Z","call_end_time":"2021-10-08T16:12:04Z","call_id":"7018210229361148737","call_type":"voip","callee_country_code":"1","callee_country_iso_code":"US","callee_did_number":"+12055432724","callee_name":"Callee name","callee_number":"1001","callee_number_type":1,"callee_number_source":"internal","caller_country_code":"1","caller_country_iso_code":"US","caller_did_number":"+12055432724","caller_name":"Caller name","caller_number":"+12059300920","caller_number_type":1,"caller_number_source":"internal","caller_billing_reference_id":"ZoomTelecom123456","charge":"$0.0255","client_code":"123","date_time":"2021-10-08T16:23:34Z","device_private_ip":"12","device_public_ip":"23","direction":"inbound","duration":25,"id":"48c1dfd4-91ce-4df5-8495-7c9e33d10869","owner":{"extension_number":-19995163,"id":"N3hAhug-QVyFPYZJrHpRaQ","name":"123@test.com","type":"user"},"path":"pstn","rate":"0.0255","recording_id":"c71b360f6e774e3aa101453117b7e1a7","recording_type":"2","result":"call_connected","site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"user_id":"IqoQmDRqS-aIoXqV_FZ88w","hold_time":5,"waiting_time":5},{"answer_start_time":"2021-10-12T16:00:08Z","call_end_time":"2021-10-08T16:12:04Z","call_id":"7018210229361148737","call_type":"voip","callee_country_code":"1","callee_country_iso_code":"US","callee_did_number":"+12055432724","callee_name":"Callee name","callee_number":"1001","callee_number_type":1,"callee_number_source":"internal","caller_country_code":"1","caller_country_iso_code":"US","caller_did_number":"+12055432724","caller_name":"Caller name","caller_number":"+12059300920","caller_number_type":1,"caller_number_source":"internal","caller_billing_reference_id":"ZoomTelecom123456","charge":"$0.0255","client_code":"123","date_time":"2021-10-08T16:23:34Z","device_private_ip":"12","device_public_ip":"23","direction":"inbound","duration":25,"id":"48c1dfd4-91ce-4df5-8495-7c9e33d10869","owner":{"extension_number":12452707,"id":"N3hAhug-QVyFPYZJrHpRaQ","name":"123@test.com","type":"user"},"path":"pstn","rate":"0.0255","recording_id":"c71b360f6e774e3aa101453117b7e1a7","recording_type":"1","result":"call_connected","site":{"id":"8f71O6rWT8KFUGQmJIFAdQ","name":"Main Site"},"user_id":"IqoQmDRqS-aIoXqV_FZ88w","hold_time":5,"waiting_time":5}],"from":"2021-10-01","next_page_token":"AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2","page_count":2,"page_size":30,"to":"2021-10-12","total_records":54}