Skip to navigation
CallingQueues

Create queue

View as MarkdownOpen in Claude

Creates a voice call queue in the project for calls that need to wait for later handling. Queue names must be unique among active queues; a deleted queue’s name can be reused. The call workflow is responsible for placing callers into the queue. Use Compatibility Create queue for form-encoded requests.

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Request

This endpoint expects an object.
namestringRequired
The name of the queue. Must be unique among the project's active queues.
max_sizeinteger or nullOptional>=1

The maximum number of callers allowed in the queue. Must be an integer greater than 0. Omit it or send null for no maximum.

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
The unique identifier of the queue.
project_idstringformat: "uuid"
The project ID associated with this queue.
friendly_namestring
The friendly name of the queue.
max_sizeinteger or null

The maximum number of callers allowed in the queue, or null when no maximum is set.

current_sizeintegerOptional
The current number of callers in the queue.
average_wait_timeintegerOptional
The average wait time in seconds.
uristringOptional
The URL of this queue.
date_createddatetimeOptional
Timestamp when the queue was created.
date_updateddatetimeOptional
Timestamp when the queue was last updated.

Errors

422
Unprocessable Entity Error
500
Internal Server Error