Retrieve a call queue

GET 
/queues/:queue_name

Retrieve an existing call queue

Request

Path Parameters

queue_name stringrequired

Uniquely identifies the queue by name

Responses

200: Successful response with details about a queue.

application/json

Schema

Schema

data

object

record_type stringrequired

Possible values: [queue]

id stringrequired

Uniquely identifies the queue

name stringrequired

Name of the queue

created_at stringrequired

ISO 8601 formatted date of when the queue was created

updated_at stringrequired

ISO 8601 formatted date of when the queue was last updated

current_size integerrequired

The number of calls currently in the queue

max_size integerrequired

The maximum number of calls allowed in the queue

average_wait_time_secs integerrequired

The average time that the calls currently in the queue have spent waiting, given in seconds.

Example (from schema)

{
  "data": {
    "record_type": "queue",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "support",
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "current_size": 20,
    "max_size": 50,
    "average_wait_time_secs": 175
  }
}

404: Conference does not exist

Loading...