Use the CDR (Call Detail Record) API to query Voiso interaction detail records from your account using various query parameters as filters. This is identical to the Call Detail Records page in the Voiso application.
Important: You may only query CDRs for which access has been granted to you by your account privileges. Refer to Security Access Groups.
To build a CDR request, use the following APIs to get IDs and other details for these contact center objects:
The CDR API enables you to query your contact center interaction details and export them to any Business Intelligence (BI), CRM, or other services. Use the CDR GET request to create an application that regularly queries your data.
The following is an example of a request:
GET https://cluster1.voiso.com/api/v2/cdr ?key=a387aaf1f101fc...fe284aaf61 &page=1 &per_page=1000 &type=outbound &start_date=2022-12-01
The CDR API returns up to 10,000 results per request. You must make multiple requests to obtain more than 10,000 results, adding the search_token
parameter to subsequent requests.
If your first request returns 10,000 records, but additional records match the search criteria, the response includes the search_token
parameter and value. For example:
{
"records": [ …array of records… ],
"total":176,
"page":1,
"search_token": "WzE2NjkwMTcyNDkwMTUsImNkcl9pdGVtI2MzNTY2ZTFiL"
}
To continue searching the records from where you left off, enter your request again, adding the search_token
parameter. For example:
https://cluster1.voiso.com/api/v2/cdr ?key=a387aaf1f101fc...fe284aaf61 &page=1 &per_page=1000 &type=outbound &start_date=2022-12-01 &search_token=WzE2NjkwMTcyNDkwMTUsImNkcl9pdGVtI2MzNTY2ZTFiL
Repeat the search process, replacing the search_token
value with the new value in the response until the response is "search_token": null
. For example:
{
"records":[],
"total":310,
"search_token":null
}
The following parameters are supported by the CDR API.
Parameter Name | Description | Required | Type | Example |
---|---|---|---|---|
key | The API key of a specific user. | Required | string | user_api_key |
search_token | Parameter should be used to query more than 10000 records. | Required | string | dkeouof13kjhk4HHH59 |
page | Indicates the current page number | Optional | integer (int32) | 1 |
per_page | Number of records per page | Optional | integer (int32) | 20 |
start_date | Include only record on or after this date. Must be in the 'YYYY-MM-DD' format (ISO 8601). | Optional | string | 2020-04-01 |
end_date | Include only record on or before this date. Must be in the 'YYYY-MM-DD' format (ISO 8601). | Optional | string | 2020-05-01 |
cli | The call line identity (CLI) calling number. A 'starting with' search of the ANI/From field. | Optional | string | 197 |
number | The called number. A 'starting with' search of the DNIS/To field. | Optional | string | 187 |
wildcard_cli | The call line identity (CLI) calling number. An 'includes' search of the ANI/From field. | Optional | string | 971231 |
wildcard_number | The called number. An 'includes' search of the DNIS/To field. | Optional | string | 7751 |
type | Direction and type of the interaction | Optional | type (custom schema) | - |
disposition | Retrieved call outcome | Optional | disposition_code (custom schema) | - |
queue_ids | Single or multiple queue IDs, separated by commas. These can be obtained with the /api/v2/cdr/queues method | Optional | string | 199, 201 |
agent_ids | Single or multiple agent IDs, separated by commas. These can be obtained with the /api/v2/cdr/agents method | Optional | string | 1,2,3 |
team_ids | Single or multiple agent team IDs, separated by commas. These can be obtained with the /api/v2/cdr/teams method | Optional | string | 3,4 |
wrapup_codes | Single or multiple wrap-up code IDs, separated by commas. These can be obtained with the /api/v2/cdr/wrapup_codes method | Optional | string | 0001, 1002 |
event | Standard call events | Optional | events (custom schema) | - |
end_reason | Standard call end reasons | Optional | end_reason (custom schema) | - |
campaign_ids | Single or multiple campaign IDs, separated by commas. These can be obtained with the /api/v2/cdr/campaigns method | Optional | string | 15, 13, 22 |
duration_from | Calls which have a duration longer than the specified value (in seconds) | Optional | integer (int32) | 1 |
duration_to | Calls which have a duration shorter than the specified value (in seconds) | Optional | integer (int32) | 10 |
dialing_time_from | Calls which have a dialing time longer than the specified value (in seconds) | Optional | integer (int32) | 1 |
dialing_time_to | Calls which have a dialing time shorter than the specified value (in seconds) | Optional | integer (int32) | 10 |
talk_time_from | Calls which have a talk time longer than the specified value (in seconds) | Optional | integer (int32) | 1 |
talk_time_to | Calls which have a talk time shorter than the specified value (in seconds) | Optional | integer (int32) | 10 |
hold_time_from | Calls which have a hold time longer than the specified value (in seconds) | Optional | integer (int32) | 1 |
hold_time_to | Calls which have a hold time shorter than the specified value (in seconds) | Optional | integer (int32) | 10 |
ivr_time_from | Calls which have a pre-queue (IVR) time longer than the specified value (in seconds) | Optional | integer (int32) | 1 |
ivr_time_to | Calls which have a pre-queue (IVR) time shorter than the specified value (in seconds) | Optional | integer (int32) | 10 |
queue_time_from | Calls which have a queue time longer than the specified value (in seconds) | Optional | integer (int32) | 1 |
queue_time_to | Calls which have a queue time shorter than the specified value (in seconds) | Optional | integer (int32) | 10 |
deleted_agent_ids | Single or multiple deleted (archived) agent IDs, separated by commas. These can be obtained with the /api/v2/cdr/deleted_agents method | Optional | string | 15, 16, 17 |
first_seen | Set to Required to get only new numbers that have never been dialed before | Optional | first_seen (custom schema) | - |
lead_source | Calls with a specified lead source type (available only for dialer campaigns with a specified lead source) | Optional | string | Google ADS |
start_datetime | Must be in this format: 'YYYY-MM-DD'T'HH:MM:SS'. | Optional | string | 2022-08-19T02:56:02 |
end_datetime | Must be in this format: 'YYYY-MM-DD'T'HH:MM:SS'. | Optional | string | 2022-08-19T02:56:02 |
uuid | UUID of the call. | Optional | string | a6c74840-574b-4e6e-baad-6b69bc38ccfc |
related_call_uuid | UUID of the parent call if the callback was requested from the queue. | Optional | string | 8d1371d2-e166-4677-b158-b1782ddd412d |
destination_name | The name of destination country. Valid for outbound calls only. | Optional | string | Germany - Other |