CDR

API Docs by APIMATIC

CDR
#

  • REST
  • Java

CDR
#

The Voiso CDR API enables you to query call detail records from your account using various query parameters.

GET /api/v2/cdr

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Query
Required
String
Query

Parameter should be used to query more then 10000 records.

Number
Query

Indicates the current page number

Default: 1

Number
Query

Number of records per page

Default: 1000
Constraints: >= 1, <= 10000

String
Query

Include only record on or after this date. Must be in the 'YYYY-MM-DD' format (ISO 8601).

String
Query

Include only record on or before this date. Must be in the 'YYYY-MM-DD' format (ISO 8601).

String
Query

The call line identity (CLI) calling number. A 'starting with' search of the ANI/From field.

String
Query

The called number. A 'starting with' search of the DNIS/To field.

String
Query

The call line identity (CLI) calling number. An 'includes' search of the ANI/From field.

String
Query

The called number. An 'includes' search of the DNIS/To field.

Query

Direction and type of the interaction

Retrieved call outcome

String
Query

Single or multiple queue IDs, separated by commas. These can be obtained with the /api/v2/cdr/queues method

String
Query

Single or multiple agent IDs, separated by commas. These can be obtained with the /api/v2/cdr/agents method

String
Query

Single or multiple agent team IDs, separated by commas. These can be obtained with the /api/v2/cdr/teams method

String
Query

Single or multiple wrap-up code IDs, separated by commas. These can be obtained with the /api/v2/cdr/wrapup_codes method

Query

Standard call events

Standard call end reasons

String
Query

Single or multiple campaign IDs, separated by commas. These can be obtained with the /api/v2/cdr/campaigns method

Number
Query

Calls which have a duration longer than the specified value (in seconds)

Number
Query

Calls which have a duration shorter than the specified value (in seconds)

Number
Query

Calls which have a dialing time longer than the specified value (in seconds)

Number
Query

Calls which have a dialing time shorter than the specified value (in seconds)

Number
Query

Calls which have a talk time longer than the specified value (in seconds)

Number
Query

Calls which have a talk time shorter than the specified value (in seconds)

Number
Query

Calls which have a hold time longer than the specified value (in seconds)

Number
Query

Calls which have a hold time shorter than the specified value (in seconds)

Number
Query

Calls which have a pre-queue (IVR) time longer than the specified value (in seconds)

Number
Query

Calls which have a pre-queue (IVR) shorter than the specified value (in seconds)

Number
Query

Calls which have a queue time longer than the specified value (in seconds)

Number
Query

Calls which have a queue time shorter than the specified value (in seconds)

String
Query

Single or multiple deleted (archived) agent IDs, separated by commas. These can be obtained with the /api/v2/cdr/deleted_agents method

Set to true to get only new numbers that have never been dialed before

String
Query

Calls with a specified lead source type (available only for dialer campaigns with a specified lead source)

String
Query

Must be in this format: 'YYYY-MM-DD'T'HH:MM:SS'.

String
Query

Must be in this format: 'YYYY-MM-DD'T'HH:MM:SS'.

String
Query

UUID of the parent call if the callback was requested from the queue.

String
Query

The name of destination country. Valid for outbound calls only.


Responses

  • 200
  • 400

Success

application/json

Type

Object

  • Calls 1
  • Calls 2
  • SMS
  • Telegram

Call records array requested with page based pagination.

{
  "page": 1,
  "total": 5032,
  "records": [
    {
      "agent": "Agent 1",
      "from": "12345678912",
      "disposition": "rejected",
      "duration": "00:00:00",
      "queue_name": "string",
      "to": "5001",
      "timestamp": "2020-04-20T09:38:33.000Z",
      "uuid": "a619cccc-b832-4896-9be4-3ff12c3a6770",
      "wrapup_code": "123",
      "type": "outbound",
      "agent_id": 1,
      "cpc": 0.0053
    }
  ]
}
  • Request
  • Response
curl -X GET -G \
  --url 'https://{cluster_id}.voiso.com/api/v2/cdr'  \
  -d 'key=user_api_key' \
  -d 'search_token=dkeouof13kjhk4HHH59' \
  -d 'page=1' \
  -d 'per_page=20' \
  -d 'start_date=2020-04-01' \
  -d 'end_date=2020-05-01' \
  -d 'cli=197' \
  -d 'number=187' \
  -d 'wildcard_cli=971231' \
  -d 'wildcard_number=7751' \
  -d 'queue_ids=199%2C%20201' \
  -d 'agent_ids=1%2C2%2C3' \
  -d 'team_ids=3%2C4' \
  -d 'wrapup_codes=0001%2C%201002' \
  -d 'campaign_ids=15%2C%2013%2C%2022' \
  -d 'duration_from=1' \
  -d 'duration_to=10' \
  -d 'dialing_time_from=1' \
  -d 'dialing_time_to=10' \
  -d 'talk_time_from=1' \
  -d 'talk_time_to=10' \
  -d 'hold_time_from=1' \
  -d 'hold_time_to=10' \
  -d 'ivr_time_from=1' \
  -d 'ivr_time_to=10' \
  -d 'queue_time_from=1' \
  -d 'queue_time_to=10' \
  -d 'deleted_agent_ids=15%2C%2016%2C%2017' \
  -d 'lead_source=Google%20ADS' \
  -d 'start_datetime=2022-08-19T02%3A56%3A02' \
  -d 'end_datetime=2022-08-19T02%3A56%3A02' \
  -d 'related_call_uuid=8d1371d2-e166-4677-b158-b1782ddd412d' \
  -d 'destination_name=Germany%20-%20Other'