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

  • ]

Request samples

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

Response samples

{
  "data": [
    {
      "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
      "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
      "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
      "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
      "call_duration": 50,
      "record_type": "call"
    }
  ],
  "meta": {
    "cursors": {
      "after": "v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI=",
      "before": "v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI="
    },
    "total_items": 50,
    "next": "/v2/connections/1234567890/active_calls?page[after]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI=",
    "previous": "/v2/connections/1234567890/active_calls?page[before]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI="
  }
}