SIsignalwire
Queues

Get queue

Retrieves one voice call queue from your SignalWire project. Use List queues to find queues or List queue members to inspect the calls currently waiting in one.

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.

get/api/relay/rest/queues/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/queues/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the queue.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

friendly_namestring required

The friendly name of the queue.

max_sizeinteger

The maximum number of callers allowed in the queue.

current_sizeinteger

The current number of callers in the queue.

average_wait_timeinteger

The average wait time in seconds.

uristring

The URL of this queue.

date_createdstring date-time

Timestamp when the queue was created.

date_updatedstring date-time

Timestamp when the queue was last updated.

Example response

{
  "friendly_name": "test",
  "max_size": 5,
  "uri": "/api/relay/rest/queues/aae131db-214c-46f5-88b6-92004f8467cf"
}

Changes

No operation changes found yet. Some revisions have not been checked.