Telnyx

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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]

Show child attributes

filter[application_name]

object

Application name filters

Show child attributes

filter[application_name][contains]

string

default:null

If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[outbound.outbound_voice_profile_id]

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

filter[leg_id]

string<uuid>

The unique identifier of an individual call leg.

filter[application_session_id]

string<uuid>

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

filter[connection_id]

string

The unique identifier of the conection.

filter[product]

enum<string>

Filter by product.

Available options:

call_control,

fax,

texml

Example:

"texml"

filter[failed]

boolean

Delivery failed or not.

Example:

false

filter[from]

string

Filter by From number.

Example:

"+12025550142"

filter[to]

string

Filter by To number.

Example:

"+12025550142"

filter[name]

string

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

filter[type]

enum<string>

Event type

Available options:

command,

webhook

Example:

"webhook"

filter[occurred_at]

object

Event occurred_at filters

Show child attributes

filter[occurred_at][eq]

string

Event occurred_at: equal

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][gt]

string

Event occurred_at: greater than

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][gte]

string

Event occurred_at: greater than or equal

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][lt]

string

Event occurred_at: lower than

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][lte]

string

Event occurred_at: lower than or equal

Example:

"2019-03-29T11:10:00Z"

filter[status]

enum<string>

If present, conferences will be filtered by status.

Available options:

init,

in_progress,

completed

page

object

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

Show child attributes

page[after]

string

default:null

Opaque identifier of next page

page[before]

string

default:null

Opaque identifier of previous page

page[limit]

integer

default:20

Limit of records per single page

Required range: 1 <= x <= 250

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

Response

Successful response with a list of call events.

data

Call Event · object[]

Show child attributes

data.record_type

enum<string>

required

Available options:

call_event

Example:

"call_event"

data.call_leg_id

string

required

Uniquely identifies an individual call leg.

Example:

"308fe500-5213-11e9-ace7-02420a0f0668"

data.call_session_id

string

required

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

Example:

"308fec30-5213-11e9-9d3f-02420a0f0668"

data.event_timestamp

string

required

Event timestamp

Example:

"2019-03-29T11:10:19.127783Z"

data.name

string

required

Event name

Example:

"call.hangup"

data.type

enum<string>

required

Event type

Available options:

command,

webhook

Example:

"webhook"

data.metadata

object

required

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

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List call events

Authorizations

Query Parameters

Response