The GET /queues
endpoint gets a list of all queues (also known as ACDs) within the VCC account.
...
Type | Required | Example |
---|---|---|
integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
---|---|---|
integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Requests
Request all queues
...
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/queues?page=2" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain a list of all queues (also known as ACDs) within the VCC account.
Successful response
Successful requests return a 200 Success
code and a collection of queues.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "meta": { "page": 1, "count": 2, "pageCount": 1, "totalCount": 2 }, "queues": [ { "queueId": "7223842d-0e01-4ac3-8e95-e4d5774c3391", "queueName": "Queue 1", "interactionPlanId": "58c06122-45c0-420e-bb61-829abd7cd063" }, { "queueId": "2a53ddae-d9c1-46e3-9bb8-c112341ea480", "queueName": "Queue 2", "interactionPlanId": "70654437-31ed-446d-b7ff-1d064b398f25" } ] } |
where:
queues
. A collection of queues.queueId
. The unique ID of the queue.queueName
. The user-friendly name of the queue.Note Queue names are unique within an interaction plan.
interactionPlanId
. The ID of the interaction plan where the queue is configured.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true