Skip to main content

List call events

GET 
/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.

Request ​

Query Parameters

    filter object

    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]

    page object

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

Responses ​

200: Successful response with a list of call events.

Schema

    data

    object[]

  • Array [

    • record_type stringrequired

    Possible values: [call_event]

    call_leg_id stringrequired

    Uniquely identifies an individual call leg.

    call_session_id stringrequired

    Uniquely identifies the call control session. A session may include multiple call leg events.

    event_timestamp stringrequired

    Event timestamp

    name stringrequired

    Event name

    type stringrequired

    Possible values: [command, webhook]

    Event type

    metadata objectrequired

    Event metadata, which includes raw event, and extra information based on event type

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/call_events' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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
  }
}