Queues

List All Queues

The ability to read all of the queues that are associated with your account. This will be returned as a list of queues.

Permissions

The API token must include the following scopes: Voice.

get/Accounts/{AccountSid}/Queues

Path parameters

AccountSidstring uuid required

The unique identifier for the account this Queue is associated with.

Query parameters

FriendlyNamestring

A description that distinguishes a queue.

MaxSizestring

The maximum number of calls that are allowed to wait in a queue.

Response

The request has succeeded.

uristring

The URI of the current page.

first_page_uristring

The URI of the first page.

next_page_uristring

The URI of the next page.

previous_page_uristring nullable

The URI of the previous page.

pageinteger

The current page number.

page_sizeinteger

The number of items per page.

account_sidstring

The unique identifier for this account.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
  "first_page_uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
  "next_page_uri": "/api/laml/2010-04-01/Accounts?Page=1&PageSize=50",
  "page_size": 50,
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "queues": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
      "average_wait_time": "0",
      "current_size": "0",
      "date_created": "Wed, 26 Sept 2018 18:00:00 +0000",
      "date_updated": "Thur, 27 Sept 2018 19:00:00 +0000",
      "friendly_name": "Queue1",
      "max_size": "123",
      "sid": "b3877c40-da60-4998-90ad-b792e98472qu",
      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json"
    }
  ]
}

Changes