Zoom Public API Documentation
Sync user's call logs
GET {{baseUrl}}/phone/users/:userId/call_logs/sync?sync_type=FSync&count=50&sync_token=SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=
Use this API to sync a user's Zoom phone call logs. For user-level apps, pass the Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Rate Limit Label: me value instead of the userId parameter.phone:read, phone:read:admin, phone_call_log:read, phone_call_log:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
sync_type
|
string | Options for synchronizing call log:<br> FSync - Full sync<br> ISync - Increase sync<br> BSync - Backward sync | |
count
|
number | 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": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"answer_start_time": "2021-10-08T16:10:04Z",
"call_end_time": "2021-10-08T16:12:04Z",
"call_id": "7006926284340112376",
"callee_country_code": "1",
"callee_country_iso_code": "US",
"callee_did_number": "+12135551234",
"callee_name": "Jan Dev",
"callee_number": "101",
"callee_number_type": 1,
"callee_number_source": "internal",
"caller_country_code": "1",
"caller_country_iso_code": "US",
"caller_did_number": "+18108001001",
"caller_name": "Zoom",
"caller_number": "+12095552345",
"caller_number_type": 1,
"caller_number_source": "internal",
"caller_billing_reference_id": "ZoomTelecom123456",
"charge": "$0.0255",
"client_code": "123",
"date_time": "2022-01-24T23:58:10Z",
"direction": "inbound",
"duration": 7,
"forwarded_by": {
"extension_number": "1009",
"extension_type": "callQueue",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"forwarded_to": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"has_recording": false,
"has_voicemail": false,
"id": "11f2bacb-37d8-4ae4-8d88-be657421266f",
"outgoing_by": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"path": "callQueue",
"rate": "$0.0255",
"recording_type": "1",
"result": "call_connected",
"site": {
"id": "GNO-CItXQaLhqH3qfPD1kg",
"name": "Main Site"
},
"user_id": "IqoQmDRqS-aIoXqV_FZ88w",
"hold_time": 5,
"waiting_time": 47
},
{
"accepted_by": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"answer_start_time": "2021-10-08T16:10:04Z",
"call_end_time": "2021-10-08T16:12:04Z",
"call_id": "7006926284340112376",
"callee_country_code": "1",
"callee_country_iso_code": "US",
"callee_did_number": "+12135551234",
"callee_name": "Jan Dev",
"callee_number": "101",
"callee_number_type": 1,
"callee_number_source": "internal",
"caller_country_code": "1",
"caller_country_iso_code": "US",
"caller_did_number": "+18108001001",
"caller_name": "Zoom",
"caller_number": "+12095552345",
"caller_number_type": 1,
"caller_number_source": "internal",
"caller_billing_reference_id": "ZoomTelecom123456",
"charge": "$0.0255",
"client_code": "123",
"date_time": "2022-01-24T23:58:10Z",
"direction": "inbound",
"duration": 7,
"forwarded_by": {
"extension_number": "1009",
"extension_type": "callQueue",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"forwarded_to": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"has_recording": false,
"has_voicemail": false,
"id": "11f2bacb-37d8-4ae4-8d88-be657421266f",
"outgoing_by": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"path": "callQueue",
"rate": "$0.0255",
"recording_type": "1",
"result": "call_connected",
"site": {
"id": "GNO-CItXQaLhqH3qfPD1kg",
"name": "Main Site"
},
"user_id": "IqoQmDRqS-aIoXqV_FZ88w",
"hold_time": 5,
"waiting_time": 47
}
],
"sync_token": "SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI="
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/call_logs/sync?sync_type=FSync&count=50&sync_token=SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=?sync_type=FSync&count=50&sync_token=SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=' -H 'Accept: application/json'
ENDPOINTS