Sync user's call logs
GET {{baseUrl}}/phone/users/:userId/call_logs/sync?sync_type=BSync&count=<integer>&sync_token=<string>
Syncs 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:read
Granular Scopes:
phone:read:list_call_logs
,
phone:read:list_call_logs:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| sync_type | string | | Options for synchronizing call log:
FSync - Full sync
ISync - Increase sync
BSync - Backward sync |
| count | string | | The number of records returned within a single API call. |
| sync_token | string | | The time range for returned records. Used for locating where the next retrieval will begin. |
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":1,"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","direction":"\u003cstring\u003e","duration":"\u003cinteger\u003e","forwarded_by":{"extension_number":"\u003cstring\u003e","extension_type":"user","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"},{"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":"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":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":"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"}],"sync_token":"\u003cstring\u003e"}