Debugging API

Call Control debugging

List call events

Filters call events by given filter parameters. Events are ordered by event_timestamp. If filter for call_leg_id or call_session_id is not present, it only filters events from the last 24 hours.

Note: Only one filter[event_timestamp] can be passed.

SecuritybearerAuth
Request
query Parameters
filter[call_leg_id]
string <uuid>

The unique identifier of an individual call leg.

filter[call_session_id]
string <uuid>

The unique identifier of the call control session. A session may include multiple call leg events.

filter[status]
string

Event status

Enum: "delivered" "failed"
Example: filter[status]=delivered
filter[type]
string

Event type

Enum: "command" "webhook"
Example: filter[type]=webhook
filter[event_timestamp][gt]
string

Event timestamp: greater than

Example: filter[event_timestamp][gt]=2019-03-29T11:10:00Z
filter[event_timestamp][gte]
string

Event timestamp: greater than or equal

Example: filter[event_timestamp][gte]=2019-03-29T11:10:00Z
filter[event_timestamp][lt]
string

Event timestamp: lower than

Example: filter[event_timestamp][lt]=2019-03-29T11:10:00Z
filter[event_timestamp][lte]
string

Event timestamp: lower than or equal

Example: filter[event_timestamp][lte]=2019-03-29T11:10:00Z
filter[event_timestamp][eq]
string

Event timestamp: equal

Example: filter[event_timestamp][eq]=2019-03-29T11:10:00Z
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

Successful response with a list of call events.

Response Schema: application/json
Array of objects (Call Event)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/call_events
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "call_leg_id": "308fe500-5213-11e9-ace7-02420a0f0668",
      • "call_session_id": "308fec30-5213-11e9-9d3f-02420a0f0668",
      • "event_timestamp": "2019-03-29T11:10:19.127783Z",
      • "metadata": { },
      • "name": "call.hangup",
      • "record_type": "call_event",
      • "type": "webhook"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}