Skip to main content

Retrieve calls from a queue

GET 
/queues/:queue_name/calls

Retrieve the list of calls in an existing queue

Request ​

Path Parameters

    queue_name stringrequired

    Uniquely identifies the queue by name

Query Parameters

    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 calls in a queue.

Schema

    data

    object[]

  • Array [

    • record_type stringrequired

    Possible values: [queue_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.

    connection_id stringrequired

    Call Control App ID (formerly Telnyx connection ID) used in the call.

    from stringrequired

    Number or SIP URI placing the call.

    to stringrequired

    Destination number or SIP URI of the call.

    enqueued_at stringrequired

    ISO 8601 formatted date of when the call was put in the queue

    wait_time_secs integerrequired

    The time the call has been waiting in the queue, given in seconds

    queue_position integerrequired

    Current position of the call in the queue

    queue_id stringrequired

    Unique identifier of the queue the call is in.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

404: Conference does not exist

Request samples

curl -L 'https://api.telnyx.com/v2/queues/:queue_name/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",
      "record_type": "queue_call",
      "connection_id": "7267xxxxxxxxxxxxxx",
      "from": "+18005550101",
      "to": "+18005550102",
      "enqueued_at": "2019-01-23T18:10:02.574Z",
      "wait_time_secs": 145,
      "queue_position": 3,
      "queue_id": "ae1626cc-6f42-11ea-becd-02420a0f8b69"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}