Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Call Detail Records

Manage your call detail records.

List CDRs

get

Retrieve a collection of call detail records.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get/cdrs
GET /api/cdrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "caller": "101",
      "caller_domain": "example.com",
      "caller_display_name": "User 101",
      "callee": "102",
      "callee_domain": "example.com",
      "callee_display_name": "User 102",
      "started_at": "2020-01-01T00:00:00Z",
      "rang_at": "2020-01-01T00:00:00Z",
      "answered_at": "2020-01-01T00:00:00Z",
      "ended_at": "2020-01-01T00:00:00Z",
      "call_id": "",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 200,
      "destination": "",
      "outbound_caller_id": "123456",
      "did_cid": "",
      "trunk": "trunk",
      "duration": 60,
      "service_number": "",
      "user_data": ""
    }
  ]
}

Retrieve CDR detailed information.

get

Retrieve details of CDR.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
get/cdrs/{id}
GET /api/cdrs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "caller": "101",
      "caller_domain": "example.com",
      "caller_display_name": "User 101",
      "callee": "102",
      "callee_domain": "example.com",
      "callee_display_name": "User 102",
      "started_at": "2020-01-01T00:00:00Z",
      "rang_at": "2020-01-01T00:00:00Z",
      "answered_at": "2020-01-01T00:00:00Z",
      "ended_at": "2020-01-01T00:00:00Z",
      "call_id": "",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 200,
      "destination": "",
      "outbound_caller_id": "123456",
      "did_cid": "",
      "trunk": "trunk",
      "duration": 60,
      "cost": 1,
      "billed_account": "",
      "service_number": "",
      "user_data": ""
    }
  ]
}

List call logs

get

Retrieve a collection of call logs.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get/calllogs
GET /api/calllogs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "session_id": "xxxxxx",
      "caller": "101",
      "caller_domain": "example.com",
      "caller_display_name": "User 101",
      "callee": "102",
      "callee_domain": "example.com",
      "callee_display_name": "User 102",
      "started_at": "2020-01-01T00:00:00Z",
      "rang_at": "2020-01-01T00:00:00Z",
      "answered_at": "2020-01-01T00:00:00Z",
      "ended_at": "2020-01-01T00:00:00Z",
      "call_id": "xxxxxx",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 200,
      "destination": "",
      "outbound_caller_id": "123456",
      "did_cid": "xxxxxx",
      "trunk": "trunk",
      "duration": 60,
      "service_number": "",
      "user_data": ""
    }
  ]
}

Retrieve call log detailed information.

get

Retrieve details of call log.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
session_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
callerstring · max: 256Optional

The caller number of the call.

caller_domainstring · max: 1024Optional

The caller domain of the call.

caller_display_namestring · max: 1024Optional

The caller display name of the call.

calleestring · max: 256Optional

The callee number of the call.

callee_domainstring · max: 1024Optional

The callee domain of the call.

callee_display_namestring · max: 1024Optional

The callee display name of the call.

started_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
rang_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
answered_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
ended_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
call_idstringOptional

The call ID of CDR.

directionstring · enumOptional

The direction of CDR:

  • INBOUND_CALL:
  • OUTBOUND_CALL:
  • EXTENSION_CALL:
  • INBOUND_OUTBOUND_CALL:
Possible values:
end_reasonstring · enumOptional

The ended reason of CDR:
Can be either:

  • CALLER_DISCONNECTED:
  • CALLEE_DISCONNECTED:
  • BLIND_TRANSFER_COMPLETED:
  • CONSULT_TRANSFER_COMPLETED:
  • REPLACED:
  • REFERRED:
  • REDIRECTED:
  • CANCELLED:
Possible values:
reroute_reasonstring · enumOptional

The reroute reason of CDR:
Can be either:

  • TRANSFER:
  • OVERFLOW:
  • CAPACITY_BLOCKED:
  • QUEUE_EXIT:
  • QUEUE_ABANDONED:
  • REDIRECT:
  • FORWARDING_UNCONDITIONAL:
  • FORWARDING_BUSY:
  • FORWARDING_NO_ANSWER:
  • FORWARDING_NOT_REACHABLE:
  • FORWARDING_EXCEPTION:
  • FORWARDING_LUNCH:
  • FORWARDING_BUSINESS_TRIP:
  • FORWARDING_AWAY:
  • FORWARDING_NIGHT_MODE:
  • DISA:
Possible values:
status_codeintegerOptional

The status code of CDR.

destinationstringOptional

The destination number of CDR.

outbound_caller_idstring · min: 1 · max: 64Optional

Outbound caller id.

did_cidstringOptional

The DID CID of CDR.

trunkstringOptional

The trunk name of CDR.

durationinteger · int32Optional

The total talk time for a session (in seconds).

costnumber · doubleOptional

The cost for this call.

billed_accountstringOptional

The account name for billing.

service_numberstringOptional

The service number of the call.

user_datastringOptional

The additional custom user data of CDR.

get/calllogs/{id}
GET /api/calllogs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxxxxxxxxxxx",
  "session_id": "xxxxxx",
  "caller": "101",
  "caller_domain": "example.com",
  "caller_display_name": "User 101",
  "callee": "101",
  "callee_domain": "example.com",
  "callee_display_name": "User 102",
  "started_at": "2000-01-01T00:00:00Z",
  "rang_at": "2000-01-01T00:00:00Z",
  "answered_at": "2000-01-01T00:00:00Z",
  "ended_at": "2000-01-01T00:00:00Z",
  "call_id": "a5G37QtkQC6BrNkGMFGyPA",
  "direction": "INBOUND_CALL",
  "end_reason": "CALLER_DISCONNECTED",
  "reroute_reason": "TRANSFER",
  "status_code": 200,
  "destination": "",
  "outbound_caller_id": "123456",
  "did_cid": "123456",
  "trunk": "trunk",
  "duration": 3,
  "cost": 1,
  "billed_account": "",
  "service_number": "000000",
  "user_data": ""
}

List call reports

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100
Responses
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get/call_reports
GET /api/call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "type": "NORMAL",
      "cron_expr": "",
      "status": "SCHEDULED"
    }
  ]
}

Create new call report

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired

The name of call report.

typestring · enumRequired

The report types can be either:

  • NORMAL:
  • EXTENSION_GROUP_CALL_COST:
  • QUEUE_PERFORMANCE:
  • QUEUE_DETAILED_STATISTICS:
  • QUEUE_ABANDONED_CALLS:
  • QUEUE_SLA_STATISTICS:
  • QUEUE_BREACHES_SLA_STATISTICS:
  • QUEUE_CALLBACKS:
  • QUEUE_FAILED_CALLBACKS:
  • TEAM_QUEUE_GENERAL_STATISTICS:
  • RING_GROUP_STATISTICS:
Possible values:
emailstring · max: 128Required

The email address.

Example: example@example.com
formatstring · enumRequired

The report output files format can be either:

  • CSV:
  • HTML:
Possible values:
rangestring · enumRequired

The report range can be either:

  • TODAY: the day the report was generated.
  • YESTERDAY: yesterday of the day the report was generated.
  • LAST_WEEK: the last week of the day the report was generated.
  • LAST_SEVEN_DAYS: seven days before the day the report was generated.
  • LAST_MONTH: the last month of the day the report was generated.
  • LAST_THIRTY_DAYS: thirty days before the day the report was generated.
  • CUSTOM: custom date range.
Possible values:
started_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
ended_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofRequired
or
or
or
or
or
or
or
or
or
or
or
Responses
201

Created

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
post/call_reports
POST /api/call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "name": "example",
  "type": "NORMAL",
  "email": "example@example.com",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2000-01-01T00:00:00Z",
  "ended_at": "2000-01-01T00:00:00Z",
  "cron_expr": "",
  "filter": {
    "from": "ANY",
    "to": "ANY",
    "answer_state": "ANY",
    "duration": "ANY"
  }
}
{
  "id": "xxxxxxxx"
}

Get call report details

get

Get details of call report by it's unique ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
namestringOptional

The name of call report.

typestring · enumOptional

The report types can be either:

  • NORMAL:
  • EXTENSION_GROUP_CALL_COST:
  • QUEUE_PERFORMANCE:
  • QUEUE_DETAILED_STATISTICS:
  • QUEUE_ABANDONED_CALLS:
  • QUEUE_SLA_STATISTICS:
  • QUEUE_BREACHES_SLA_STATISTICS:
  • QUEUE_CALLBACKS:
  • QUEUE_FAILED_CALLBACKS:
  • TEAM_QUEUE_GENERAL_STATISTICS:
  • RING_GROUP_STATISTICS:
Possible values:
emailstring · max: 128Optional

The email address.

Example: example@example.com
formatstring · enumOptional

The report output files format can be either:

  • CSV:
  • HTML:
Possible values:
rangestring · enumOptional

The report range can be either:

  • TODAY: the day the report was generated.
  • YESTERDAY: yesterday of the day the report was generated.
  • LAST_WEEK: the last week of the day the report was generated.
  • LAST_SEVEN_DAYS: seven days before the day the report was generated.
  • LAST_MONTH: the last month of the day the report was generated.
  • LAST_THIRTY_DAYS: thirty days before the day the report was generated.
  • CUSTOM: custom date range.
Possible values:
started_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
ended_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofOptional
or
or
or
or
or
or
or
or
or
or
or
statusstring · enumOptional

The report status can be either:

  • RUNNING:
  • SCHEDULED:
  • ABORTED:
Possible values:
get/call_reports/{id}
GET /api/call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "name": "example",
  "type": "NORMAL",
  "email": "example@example.com",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2000-01-01T00:00:00Z",
  "ended_at": "2000-01-01T00:00:00Z",
  "cron_expr": "",
  "filter": {
    "from": "ANY",
    "to": "ANY",
    "answer_state": "ANY",
    "duration": "ANY"
  },
  "status": "RUNNING"
}

Update call report

post

Update call report properties.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Body
namestringOptional

The name of call report.

emailstring · max: 128Optional

The email address.

Example: example@example.com
formatstring · enumOptional

The report output files format can be either:

  • CSV:
  • HTML:
Possible values:
rangestring · enumOptional

The report range can be either:

  • TODAY: the day the report was generated.
  • YESTERDAY: yesterday of the day the report was generated.
  • LAST_WEEK: the last week of the day the report was generated.
  • LAST_SEVEN_DAYS: seven days before the day the report was generated.
  • LAST_MONTH: the last month of the day the report was generated.
  • LAST_THIRTY_DAYS: thirty days before the day the report was generated.
  • CUSTOM: custom date range.
Possible values:
started_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
ended_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofOptional
or
or
or
or
or
or
or
or
or
or
or
Responses
200

OK

No content
post/call_reports/{id}
POST /api/call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "name": "example",
  "email": "example@example.com",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2000-01-01T00:00:00Z",
  "ended_at": "2000-01-01T00:00:00Z",
  "cron_expr": "",
  "filter": {
    "from": "ANY",
    "to": "ANY",
    "answer_state": "ANY",
    "duration": "ANY"
  }
}
No content

Destroy call report

post

Destroy call report by it's unique ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post/call_reports/{id}/destroy
POST /api/call_reports/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List completed call reports

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100
Responses
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get/completed_call_reports
GET /api/completed_call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "type": "NORMAL",
      "format": "CSV",
      "completed_at": "",
      "file_name": "example",
      "file_size": 100,
      "file_url": ""
    }
  ]
}

Get completed call report details

get

Get details of completed call report by it's unique ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
namestringOptional

The name of call report.

typestring · enumOptional

The report types can be either:

  • NORMAL:
  • EXTENSION_GROUP_CALL_COST:
  • QUEUE_PERFORMANCE:
  • QUEUE_DETAILED_STATISTICS:
  • QUEUE_ABANDONED_CALLS:
  • QUEUE_SLA_STATISTICS:
  • QUEUE_BREACHES_SLA_STATISTICS:
  • QUEUE_CALLBACKS:
  • QUEUE_FAILED_CALLBACKS:
  • TEAM_QUEUE_GENERAL_STATISTICS:
  • RING_GROUP_STATISTICS:
Possible values:
formatstring · enumOptional

The report output files format can be either:

  • CSV:
  • HTML:
Possible values:
completed_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
file_namestringOptional

The name of the file.

file_sizeinteger · int64Optional

The file size in bytes.

Example: 0
file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK
get/completed_call_reports/{id}
GET /api/completed_call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "name": "example",
  "type": "NORMAL",
  "format": "CSV",
  "completed_at": "",
  "file_name": "example",
  "file_size": 100,
  "file_url": ""
}

Destroy completed call report

post

Destroy completed call report by it's unique ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post/completed_call_reports/{id}/destroy
POST /api/completed_call_reports/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousCall Sessions
NextConference

Last updated

Was this helpful?