Zoom Public API Documentation
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 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_call_log:read:admin,phone:read,phone_call_log:readphone:read:list_call_logs,phone:read:list_call_logs:adminHeavy
Body
PARAM
| 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": "<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": "internal",
"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": "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": "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>",
"department": "<string>",
"cost_center": "<string>"
},
{
"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": "internal",
"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": "sharedLineGroup",
"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>",
"department": "<string>",
"cost_center": "<string>"
}
],
"from": "<string>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": "<integer>",
"to": "<string>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/call_logs?page_size=30&from=<date>&to=<date>&type=all&next_page_token=<string>&phone_number=<string>&time_type=startTime?page_size=30&from=<date>&to=<date>&type=all&next_page_token=<string>&phone_number=<string>&time_type=startTime' -H 'Accept: application/json'
ENDPOINTS