Zoom Public API Documentation
Get user's call logs
GET {{baseUrl}}/phone/users/:userId/call_logs?page_size=30&from=2020-10-31&to=2021-12-31&type=all&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&phone_number=+12055432724&time_type=startTime
Use this API to get 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:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
from
|
string | 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 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. | |
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": "1009",
"location": "Pontotoc MS",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"answer_start_time": "2021-10-09T16:52:05Z",
"call_end_time": "2021-10-09T17:20:53Z",
"call_id": "7017184835983901126",
"callee_country_code": "1",
"callee_country_iso_code": "US",
"callee_did_number": "+12055432724",
"callee_name": "Callee name",
"callee_number": "1018",
"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": "2022-01-24T23:58:10Z",
"direction": "inbound",
"duration": 20,
"forwarded_by": {
"extension_number": "1009",
"extension_type": "user",
"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": "48c1dfd4-91ce-4df5-8495-7c9e33d10869",
"outgoing_by": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"path": "pstn",
"rate": "$0.0255",
"recording_type": "1",
"result": "call_connected",
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "Main Site"
},
"user_id": "DnEopNmXQEGU2uvvzjgojw",
"hold_time": 5,
"waiting_time": 10
},
{
"accepted_by": {
"extension_number": "1009",
"location": "Pontotoc MS",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"answer_start_time": "2021-10-09T16:52:05Z",
"call_end_time": "2021-10-09T17:20:53Z",
"call_id": "7017184835983901126",
"callee_country_code": "1",
"callee_country_iso_code": "US",
"callee_did_number": "+12055432724",
"callee_name": "Callee name",
"callee_number": "1018",
"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": "2022-01-24T23:58:10Z",
"direction": "inbound",
"duration": 20,
"forwarded_by": {
"extension_number": "1009",
"extension_type": "user",
"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": "48c1dfd4-91ce-4df5-8495-7c9e33d10869",
"outgoing_by": {
"extension_number": "1009",
"location": "Glendale CA",
"name": "Display name",
"number_type": 1,
"phone_number": "+12055432724"
},
"path": "pstn",
"rate": "$0.0255",
"recording_type": "1",
"result": "call_connected",
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "Main Site"
},
"user_id": "DnEopNmXQEGU2uvvzjgojw",
"hold_time": 5,
"waiting_time": 10
}
],
"from": "2021-10-01",
"next_page_token": "AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2",
"page_count": 2,
"page_size": 30,
"to": "2021-10-12",
"total_records": 54
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/call_logs?page_size=30&from=2020-10-31&to=2021-12-31&type=all&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&phone_number=+12055432724&time_type=startTime?page_size=30&from=2020-10-31&to=2021-12-31&type=all&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&phone_number=+12055432724&time_type=startTime' -H 'Accept: application/json'
ENDPOINTS