Retrieve a Queue
Retrieves one voice queue by SID so you can inspect its configuration and current occupancy. Use List All Queues to discover SIDs, or SignalWire REST Get queue for a resource ID.
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.
Path parameters
Universal Unique Identifier.
The unique identifier for the account this Queue is associated with.
Universal Unique Identifier.
The unique identifier for the queue.
Response
The request has succeeded.
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
Changed in 5 of the 40 revisions of this API.1019
- ▲
the
account_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ▲
the
sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ○
added
uuidto theaccount_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
uuidto thesidresponse propertyallOflist for the response status200response-property-all-of-added
- ▲
- ○
added 'unevaluatedProperties' constraint to the response body for the status
200response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
400response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
401response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
404response-body-unevaluated-properties-added
- ○
- ▲
response property
max_sizelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
- ▲
the response property
max_sizebecame nullable for the status200response-property-became-nullable
- ▲
the
average_wait_timeresponse's property type/format changed fromstring/tointeger/int32for status200response-property-type-changed
- ▲
the
current_sizeresponse's property type/format changed fromstring/tointeger/int32for status200response-property-type-changed
- ▲
the
max_sizeresponse's property type/format changed fromstring/tointeger/int32for status200response-property-type-changed
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
the response property
account_sidbecame required for the status200response-property-became-required
- ○
the response property
average_wait_timebecame required for the status200response-property-became-required
- ○
the response property
current_sizebecame required for the status200response-property-became-required
- ○
the response property
date_createdbecame required for the status200response-property-became-required
- ○
the response property
date_updatedbecame required for the status200response-property-became-required
- ○
the response property
friendly_namebecame required for the status200response-property-became-required
- ○
the response property
max_sizebecame required for the status200response-property-became-required
- ○
the response property
sidbecame required for the status200response-property-became-required
- ○
the response property
uribecame required for the status200response-property-became-required
- ○
added the required property
api_versionto the response with the200statusresponse-required-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
added the new path request parameter
AccountSidnew-request-path-parameter
- ▲
added the new path request parameter
Sidnew-request-path-parameter
- ▲
the
average_wait_timeresponse's property type/format changed fromstring/uuidtostring/for status200response-property-type-changed
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the non-success response with the status
404response-non-success-status-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲