Routing Queues

List routing queues

Retrieve list of routing queues

GET/workspaces/{workspaceId}/inbox/routing-queues

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200

OK

Body

application/json

results*array of RoutingQueue (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalinteger

The total number of results across all pages.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/routing-queues', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "teams": [
        {
          "type": "primary",
          "ids": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "queuedItems": {
        "email": [
          {
            "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
            "capacityType": "text",
            "QueuedAt": "2024-10-13T23:28:40.899Z"
          }
        ],
        "messaging": [
          {
            "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
            "capacityType": "text",
            "QueuedAt": "2024-10-13T23:28:40.899Z"
          }
        ],
        "voice": [
          {
            "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
            "capacityType": "text",
            "QueuedAt": "2024-10-13T23:28:40.899Z"
          }
        ]
      },
      "createdAt": "2024-10-13T23:28:40.899Z",
      "updatedAt": "2024-10-13T23:28:40.899Z"
    }
  ],
  "nextPageToken": "text"
}

Delete a Routing queue

Delete a Routing queue. Items on the queue will be un-queued, then queue will be deleted.

DELETE/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

Authorization

useraccessKey

Path parameters

workspaceId*string

routingQueueId*string

Response

204404

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}