Skip to main content

List all active calls for given connection

GET 

/connections/:connection_id/active_calls

Lists all active calls for given connection. Acceptable connections are either SIP connections with webhook_url or xml_request_url, call control or texml. Returned results are cursor paginated.

Request

Path Parameters

    connection_id stringrequired

    Telnyx connection id

Query Parameters

    page[limit] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    Limit of records per single page

    page[after] string

    Default value: null

    Opaque identifier of next page

    page[before] string

    Default value: null

    Opaque identifier of previous page

Responses

200: Successful response with list of details about active calls.

Schema

    data

    object[]

  • Array [

  • record_type stringrequired

    Possible values: [call]

    call_session_id stringrequired

    ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call

    call_leg_id stringrequired

    ID that is unique to the call and can be used to correlate webhook events

    call_control_id stringrequired

    Unique identifier and token for controlling the call.

    client_state stringrequired

    State received from a command.

    call_duration integerrequired

    Indicates the duration of the call in seconds

  • ]

  • meta

    object

    cursors

    object

    after string

    Opaque identifier of next page.

    before string

    Opaque identifier of previous page.

    total_items integer
    next string

    Path to next page.

    previous string

    Path to previous page.

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