Zoom Public API Documentation
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 Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: me value instead of the userId parameter.phone:read:admin,phone:readphone:read:list_call_logs,phone:read:list_call_logs:adminMedium
Body
PARAM
| 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": "<string>",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"answer_start_time": "<string>",
"call_end_time": "<string>",
"call_id": "<string>",
"callee_country_code": "<string>",
"callee_country_iso_code": "<string>",
"callee_did_number": "<string>",
"callee_name": "<string>",
"callee_number": "<string>",
"callee_number_type": 1,
"callee_number_source": "external",
"caller_country_code": "<string>",
"caller_country_iso_code": "<string>",
"caller_did_number": "<string>",
"caller_name": "<string>",
"caller_number": "<string>",
"caller_number_type": 1,
"caller_number_source": "external",
"caller_billing_reference_id": "<string>",
"charge": "<string>",
"client_code": "<string>",
"date_time": "<string>",
"direction": "<string>",
"duration": "<integer>",
"forwarded_by": {
"extension_number": "<string>",
"extension_type": "user",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"forwarded_to": {
"extension_number": "<string>",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"has_recording": "<boolean>",
"has_voicemail": "<boolean>",
"id": "<string>",
"outgoing_by": {
"extension_number": "<string>",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"path": "<string>",
"rate": "<string>",
"recording_type": "<string>",
"result": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"user_id": "<string>",
"hold_time": "<integer>",
"waiting_time": "<integer>"
},
{
"accepted_by": {
"extension_number": "<string>",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"answer_start_time": "<string>",
"call_end_time": "<string>",
"call_id": "<string>",
"callee_country_code": "<string>",
"callee_country_iso_code": "<string>",
"callee_did_number": "<string>",
"callee_name": "<string>",
"callee_number": "<string>",
"callee_number_type": 2,
"callee_number_source": "external",
"caller_country_code": "<string>",
"caller_country_iso_code": "<string>",
"caller_did_number": "<string>",
"caller_name": "<string>",
"caller_number": "<string>",
"caller_number_type": 2,
"caller_number_source": "internal",
"caller_billing_reference_id": "<string>",
"charge": "<string>",
"client_code": "<string>",
"date_time": "<string>",
"direction": "<string>",
"duration": "<integer>",
"forwarded_by": {
"extension_number": "<string>",
"extension_type": "callQueue",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"forwarded_to": {
"extension_number": "<string>",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"has_recording": "<boolean>",
"has_voicemail": "<boolean>",
"id": "<string>",
"outgoing_by": {
"extension_number": "<string>",
"location": "<string>",
"name": "<string>",
"number_type": "<integer>",
"phone_number": "<string>"
},
"path": "<string>",
"rate": "<string>",
"recording_type": "<string>",
"result": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"user_id": "<string>",
"hold_time": "<integer>",
"waiting_time": "<integer>"
}
],
"sync_token": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/call_logs/sync?sync_type=BSync&count=<integer>&sync_token=<string>?sync_type=BSync&count=<integer>&sync_token=<string>' -H 'Accept: application/json'
ENDPOINTS