Skip to main content

List call events

GET 

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

Request

Query Parameters

    filter[call_leg_id] uuid

    The unique identifier of an individual call leg.

    filter[call_session_id] uuid

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

    filter[status] string

    Possible values: [delivered, failed]

    Event status

    filter[type] string

    Possible values: [command, webhook]

    Event type

    filter[event_timestamp][gt] string

    Event timestamp: greater than

    filter[event_timestamp][gte] string

    Event timestamp: greater than or equal

    filter[event_timestamp][lt] string

    Event timestamp: lower than

    filter[event_timestamp][lte] string

    Event timestamp: lower than or equal

    filter[event_timestamp][eq] string

    Event timestamp: equal

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

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
  • ]

Loading...