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: contact_center_voice_call:read:admin
Rate Limit Label: HEAVY
Request Params
| 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. | |
country_iso_codes | string | Two-letter country code. | |
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":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e","voice_calls":[{"engagement_id":"\u003cstring\u003e","direction":"outbound","call_legs":["inbound","outbound"],"distributions":["acd","acd"],"types":["internal_call","internal_conference_call"],"caller_number":"\u003cstring\u003e","caller_number_type":"virtual_service_number","callee_number":"\u003cstring\u003e","callee_number_type":"byoc_number","start_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","total_duration":"\u003clong\u003e","consumer_number":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","queues":[{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"},{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"}],"agents":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"}],"flows":[{"flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e"},{"flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e"}],"country_name":"\u003cstring\u003e","recorded":"\u003cboolean\u003e","monitored":"\u003cboolean\u003e","inbox":"\u003cboolean\u003e","result":"short_abandoned","caller_id":"\u003cstring\u003e","calling_party":"agent","charge":"\u003cstring\u003e","rates":["\u003cstring\u003e","\u003cstring\u003e"],"charge_type":"per_minute"},{"engagement_id":"\u003cstring\u003e","direction":"inbound","call_legs":["outbound","outbound"],"distributions":["acd","non_acd"],"types":["internal_callback_call","internal_conference_call"],"caller_number":"\u003cstring\u003e","caller_number_type":"virtual_service_number","callee_number":"\u003cstring\u003e","callee_number_type":"byoc_number","start_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","total_duration":"\u003clong\u003e","consumer_number":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","queues":[{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"},{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e"}],"agents":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e"}],"flows":[{"flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e"},{"flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e"}],"country_name":"\u003cstring\u003e","recorded":"\u003cboolean\u003e","monitored":"\u003cboolean\u003e","inbox":"\u003cboolean\u003e","result":"hang_up_calls","caller_id":"\u003cstring\u003e","calling_party":"consumer","charge":"\u003cstring\u003e","rates":["\u003cstring\u003e","\u003cstring\u003e"],"charge_type":"per_minute"}]}