Queues

Create a Queue

Changed on

Creates a voice queue in the account to hold callers until an application dequeues them. Queue names must be unique among the account's active queues; a deleted queue's name can be reused. Use SignalWire REST Create queue for JSON requests; a queue created through either route is available through both APIs.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

post/Accounts/{AccountSid}/Queues

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Queues
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

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

Request body application/x-www-form-urlencoded

FriendlyNamestring required

A unique name for the queue. Must contain only alphanumeric characters and underscores.

MaxSizeinteger

The maximum number of calls that are allowed to wait in a queue. Must be a positive integer.

Example request

{
  "FriendlyName": "Queue1",
  "MaxSize": 100
}

Response

Response returned when a queue is successfully created.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

friendly_namestring required

A description that distinguishes a queue.

max_sizeinteger nullable required

The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.

current_sizeinteger required

The number of calls currently waiting in the queue.

average_wait_timeinteger required

The average wait time, in seconds, of callers in a queue.

date_createdstring required

The date and time, in RFC 2822 format, the Queue was created.

date_updatedstring required

The date and time, in RFC 2822 format, the Queue was updated.

api_versionstring required

The version of the SignalWire API.

uristring required

The URI of this resource, relative to the API base URL.

Example response

{
  "friendly_name": "Queue1",
  "max_size": 100,
  "date_created": "Wed, 26 Sep 2018 18:00:00 +0000",
  "date_updated": "Thu, 27 Sep 2018 19:00:00 +0000",
  "api_version": "2010-04-01",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json"
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • breaking

      added 'unevaluatedProperties' constraint to the request body

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status