Get user's call logs
GET {{baseUrl}}/phone/users/:userId/call_logs?page_size=30&from=<date>&to=<date>&type=all&next_page_token=<string>&phone_number=<string>&time_type=startTime
Gets a user's Zoom phone call logs. For user-level apps, pass the me value instead of the userId parameter.
Prerequisites: * A Business or Enterprise account * A Zoom Phone license
Scopes: phone:read:admin,phone_call_log:read:admin,phone:read,phone_call_log:read
Granular Scopes: phone:read:list_call_logs,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 | ||
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. | |
phone_number | string | Filter API responses to include call logs of only the phone number defined in this field. | |
time_type | string | Enables you to sort call logs by start or end time. Choose the sort time value. Values include startTime or endTime. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"call_logs":[{"accepted_by":{"extension_number":"\u003cstring\u003e","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"answer_start_time":"\u003cstring\u003e","call_end_time":"\u003cstring\u003e","call_id":"\u003cstring\u003e","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":"internal","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":"external","caller_billing_reference_id":"\u003cstring\u003e","charge":"\u003cstring\u003e","client_code":"\u003cstring\u003e","date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","duration":"\u003cinteger\u003e","forwarded_by":{"extension_number":"\u003cstring\u003e","extension_type":"callQueue","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"forwarded_to":{"extension_number":"\u003cstring\u003e","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"has_recording":"\u003cboolean\u003e","has_voicemail":"\u003cboolean\u003e","id":"\u003cstring\u003e","outgoing_by":{"extension_number":"\u003cstring\u003e","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"path":"\u003cstring\u003e","rate":"\u003cstring\u003e","recording_type":"\u003cstring\u003e","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"},{"accepted_by":{"extension_number":"\u003cstring\u003e","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"answer_start_time":"\u003cstring\u003e","call_end_time":"\u003cstring\u003e","call_id":"\u003cstring\u003e","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":1,"callee_number_source":"internal","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":"internal","caller_billing_reference_id":"\u003cstring\u003e","charge":"\u003cstring\u003e","client_code":"\u003cstring\u003e","date_time":"\u003cstring\u003e","direction":"\u003cstring\u003e","duration":"\u003cinteger\u003e","forwarded_by":{"extension_number":"\u003cstring\u003e","extension_type":"sharedLineGroup","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"forwarded_to":{"extension_number":"\u003cstring\u003e","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"has_recording":"\u003cboolean\u003e","has_voicemail":"\u003cboolean\u003e","id":"\u003cstring\u003e","outgoing_by":{"extension_number":"\u003cstring\u003e","location":"\u003cstring\u003e","name":"\u003cstring\u003e","number_type":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e"},"path":"\u003cstring\u003e","rate":"\u003cstring\u003e","recording_type":"\u003cstring\u003e","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"}