Contact-center call detail records (keyset paged, incremental)

GET

/v1/reports/contact-center/cdrs

curl --request GET \
  --url 'https://api.vocapable.com/v1/reports/contact-center/cdrs?limit=1000&kind=call' \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Parameters

Query Parameters

changed_after

Any of:

string

string format: date-time

null

null

offered_from

Any of:

string

string format: date-time

null

null

offered_until

Any of:

string

string format: date-time

null

null

cursor

Any of:

string

string

<= 256 characters

null

null

limit

Limit

integer

default: 1000 >= 1 <= 1000

kind

Kind

string

default: call

Allowed values: call conversation

updated_after

Any of:

string

string format: date-time

null

null

The PRD’s name for changed_after (records’ updated_at).

Responses

200

Successful Response

Media typeapplication/json

Any of:

CcCallDetailRecords

CcCallDetailRecords

object

data

required

Data

Array<object>

CcCallDetailRecord

object

kind

Kind

string

default: call

Allowed value: call

id

required

Id

string

queue_key

required

Queue Key

string

queue_id

required

Any of:

string

string

null

null

line_id

required

Line Id

string

offered_at

required

Offered At

string format: date-time

answered_at

required

Any of:

string

string format: date-time

null

null

ended_at

required

Any of:

string

string format: date-time

null

null

outcome

required

Outcome

string

Allowed values: waiting answered abandoned flowout callback

exit_reason

required

Any of:

string

string

null

null

wait_seconds

required

Any of:

number

number

null

null

handler_type

required

Any of:

string

string

Allowed values: human ai

null

null

agent_user_id

required

Any of:

string

string

null

null

call_id

required

Any of:

string

string

null

null

disposition

required

Any of:

string

string

null

null

talk_seconds

required

Talk Seconds

number

hold_seconds

required

Hold Seconds

number

acw_seconds

required

Acw Seconds

number

transferred

required

Transferred

boolean

short_abandon

required

Short Abandon

boolean

within_service_level

required

Any of:

boolean

boolean

null

null

updated_at

required

Updated At

string format: date-time

next_cursor

required

Any of:

string

string

null

null

has_more

required

Has More

boolean

CcConversationDetailRecords

CcConversationDetailRecords

object

data

required

Data

Array<object>

CcConversationDetailRecord

One routed text conversation (CC8-R1 work item) for the reporting API (kind=conversation). Counts and instants only - never a message body.

object

kind

Kind

string

default: conversation

Allowed value: conversation

id

required

Id

string

queue_id

required

Queue Id

string

team_id

required

Any of:

string

string

null

null

line_id

required

Any of:

string

string

null

null

contact_id

required

Any of:

string

string

null

null

channel

Channel

string

default: sms

Allowed value: sms

state

required

State

string

Allowed values: waiting offered assigned closed

outcome

required

Outcome

string

Allowed values: waiting answered abandoned

offered_at

required

Offered At

string format: date-time

first_offered_at

required

Any of:

string

string format: date-time

null

null

accepted_at

required

Any of:

string

string format: date-time

null

null

first_response_at

required

Any of:

string

string format: date-time

null

null

closed_at

required

Any of:

string

string format: date-time

null

null

first_response_seconds

required

Any of:

number

number

null

null

handler_type

required

Any of:

string

string

Allowed values: human ai

null

null

agent_user_id

required

Any of:

string

string

null

null

assignee_user_id

required

Any of:

string

string

null

null

closed_by_user_id

required

Any of:

string

string

null

null

close_reason

required

Any of:

string

string

null

null

disposition

required

Any of:

string

string

null

null

transfer_count

required

Transfer Count

integer

inbound_messages

required

Inbound Messages

integer

outbound_messages

required

Outbound Messages

integer

handle_seconds

required

Handle Seconds

number

sla_seconds

required

Sla Seconds

integer

within_service_level

required

Any of:

boolean

boolean

null

null

updated_at

required

Updated At

string format: date-time

next_cursor

required

Any of:

string

string

null

null

has_more

required

Has More

boolean

Example

{
  "data": [
    {
      "kind": "call",
      "outcome": "waiting",
      "handler_type": "human"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}