Zoom Public API Documentation
List voice call logs
GET {{baseUrl}}/contact_center/voice_calls?next_page_token=<string>&page_size=10&from=<date>&to=<date>&types=external_conference_call&types=external_call&distribution=non_acd&consumer_number=<string>&direction=outbound&user_ids=<string>&user_ids=<string>&engagement_id=<string>&queue_ids=<string>&queue_ids=<string>&country_iso_codes=<string>&country_iso_codes=<string>&number_types=byoc_number&number_types=byoc_number
Returns a list of voice call logs. Scopes: Rate Limit Label: contact_center_voice_call:read:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
from
|
string | The start time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'). The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours. | |
to
|
string | **Required** only when the `from` parameter is specified. The end time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss'TZD'. | |
types
|
string | The call's type. | |
types
|
string | The call's type. | |
distribution
|
string | The engagement's distribution. | |
consumer_number
|
string | The consumer's phone number. | |
direction
|
string | The engagement's direction. | |
user_ids
|
string | A comma-separated list of agents' user IDs to query, up to 20 agent IDs. | |
user_ids
|
string | A comma-separated list of agents' user IDs to query, up to 20 agent IDs. | |
engagement_id
|
string | The engagement's ID. | |
queue_ids
|
string | A comma-separated list of queue IDs to query, up to 20 queue IDs. If user provide `none`, filter by “No queue used” in the web UI. | |
queue_ids
|
string | A comma-separated list of queue IDs to query, up to 20 queue IDs. If user provide `none`, filter by “No queue used” in the web UI. | |
country_iso_codes
|
string | Two-letter country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). | |
country_iso_codes
|
string | Two-letter country [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). | |
number_types
|
string | The number's type. | |
number_types
|
string | The number's type. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 10,
"total_records": "<integer>",
"from": "<dateTime>",
"to": "<dateTime>",
"voice_calls": [
{
"engagement_id": "<string>",
"direction": "outbound",
"call_legs": [
"inbound",
"outbound"
],
"distributions": [
"acd",
"acd"
],
"types": [
"internal_call",
"internal_conference_call"
],
"caller_number": "<string>",
"caller_number_type": "virtual_service_number",
"callee_number": "<string>",
"callee_number_type": "byoc_number",
"start_time": "<string>",
"end_time": "<string>",
"total_duration": "<long>",
"consumer_number": "<string>",
"consumer_display_name": "<string>",
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"flows": [
{
"flow_id": "<string>",
"flow_name": "<string>"
},
{
"flow_id": "<string>",
"flow_name": "<string>"
}
],
"country_name": "<string>",
"recorded": "<boolean>",
"monitored": "<boolean>",
"inbox": "<boolean>",
"result": "short_abandoned",
"caller_id": "<string>",
"calling_party": "agent",
"charge": "<string>",
"rates": [
"<string>",
"<string>"
],
"charge_type": "per_minute"
},
{
"engagement_id": "<string>",
"direction": "inbound",
"call_legs": [
"outbound",
"outbound"
],
"distributions": [
"acd",
"non_acd"
],
"types": [
"internal_callback_call",
"internal_conference_call"
],
"caller_number": "<string>",
"caller_number_type": "virtual_service_number",
"callee_number": "<string>",
"callee_number_type": "byoc_number",
"start_time": "<string>",
"end_time": "<string>",
"total_duration": "<long>",
"consumer_number": "<string>",
"consumer_display_name": "<string>",
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"flows": [
{
"flow_id": "<string>",
"flow_name": "<string>"
},
{
"flow_id": "<string>",
"flow_name": "<string>"
}
],
"country_name": "<string>",
"recorded": "<boolean>",
"monitored": "<boolean>",
"inbox": "<boolean>",
"result": "hang_up_calls",
"caller_id": "<string>",
"calling_party": "consumer",
"charge": "<string>",
"rates": [
"<string>",
"<string>"
],
"charge_type": "per_minute"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/voice_calls?next_page_token=<string>&page_size=10&from=<date>&to=<date>&types=external_conference_call&types=external_call&distribution=non_acd&consumer_number=<string>&direction=outbound&user_ids=<string>&user_ids=<string>&engagement_id=<string>&queue_ids=<string>&queue_ids=<string>&country_iso_codes=<string>&country_iso_codes=<string>&number_types=byoc_number&number_types=byoc_number?next_page_token=<string>&page_size=10&from=<date>&to=<date>&types=external_conference_call&types=external_call&distribution=non_acd&consumer_number=<string>&direction=outbound&user_ids=<string>&user_ids=<string>&engagement_id=<string>&queue_ids=<string>&queue_ids=<string>&country_iso_codes=<string>&country_iso_codes=<string>&number_types=byoc_number&number_types=byoc_number' -H 'Accept: application/json'
ENDPOINTS