v55

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-051,2852,0364.4 MB

Debugging

List call events

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

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

get/call_events

Query parameters

outbound.outbound_voice_profile_idstring

Identifies the associated outbound voice profile.

leg_idstring uuid

The unique identifier of an individual call leg.

application_session_idstring uuid

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

connection_idstring

The unique identifier of the conection.

product'call_control' | 'fax' | 'texml'

Filter by product.

failedboolean

Delivery failed or not.

fromstring

Filter by From number.

tostring

Filter by To number.

namestring

If present, conferences will be filtered to those with a matching name attribute. Matching is case-sensitive

type'command' | 'webhook'

Event type

status'init' | 'in_progress' | 'completed'

If present, conferences will be filtered by status.

Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]

{
  "outbound.outbound_voice_profile_id": "1293384261075731499",
  "product": "texml",
  "from": "+12025550142",
  "to": "+12025550142",
  "type": "webhook",
  "occurred_at": {
    "eq": "2019-03-29T11:10:00Z",
    "gt": "2019-03-29T11:10:00Z",
    "gte": "2019-03-29T11:10:00Z",
    "lt": "2019-03-29T11:10:00Z",
    "lte": "2019-03-29T11:10:00Z"
  }
}

afterstring

Opaque identifier of next page

beforestring

Opaque identifier of previous page

limitinteger

Limit of records per single page

sizeinteger

The size of the page

numberinteger

The page number to load

Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]

Response

Successful response with a list of call events.

Example response

{
  "data": [
    {
      "record_type": "call_event",
      "call_leg_id": "308fe500-5213-11e9-ace7-02420a0f0668",
      "call_session_id": "308fec30-5213-11e9-9d3f-02420a0f0668",
      "event_timestamp": "2019-03-29T11:10:19.127783Z",
      "name": "call.hangup",
      "type": "webhook",
      "metadata": {}
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}