Queue Commands

Retrieve calls from a queue

Changed on

Retrieve the list of calls in an existing queue

get/queues/{queue_name}/calls

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/queues/{queue_name}/calls
  • Auth
    HTTP bearer

Path parameters

queue_namestring required

Uniquely identifies the queue by name

Query parameters

afterstring

Opaque identifier of next page

beforestring

Opaque identifier of previous page

limitinteger

Limit of records per single page

sizeinteger

The size of the page

numberinteger

The page number to load

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

Response

Successful response with a list of calls in a queue.

Example response

{
  "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",
      "is_alive": true
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • a72569d69430Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • warning

      deleted the query request parameter page[number]

    • warning

      deleted the query request parameter page[size]

    • info

      added the new optional query request parameter page

    • info

      the response property // became required for the status