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-18T03:32:00.286Z"
          }
        ],
        "messaging": [
          {
            "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
            "capacityType": "text",
            "QueuedAt": "2024-10-18T03:32:00.286Z"
          }
        ],
        "voice": [
          {
            "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
            "capacityType": "text",
            "QueuedAt": "2024-10-18T03:32:00.286Z"
          }
        ]
      },
      "createdAt": "2024-10-18T03:32:00.286Z",
      "updatedAt": "2024-10-18T03:32:00.286Z"
    }
  ],
  "nextPageToken": "text"
}

Create a routing queue

Create a new routing queue

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

descriptionstring

priority*integer

teams*array of RoutingQueueTeam (object)

Response

201404422

created

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

name*string

description*string

priority*integer

teams*array of RoutingQueueTeam (object)

queuedItemsobject

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/routing-queues', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "teams": [
        {
          "type": "primary",
          "ids": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

201404422

{
  "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-18T03:32:00.286Z"
      }
    ],
    "messaging": [
      {
        "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
        "capacityType": "text",
        "QueuedAt": "2024-10-18T03:32:00.286Z"
      }
    ],
    "voice": [
      {
        "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
        "capacityType": "text",
        "QueuedAt": "2024-10-18T03:32:00.286Z"
      }
    ]
  },
  "createdAt": "2024-10-18T03:32:00.286Z",
  "updatedAt": "2024-10-18T03:32:00.286Z"
}

Get routing queue

Retrieves Routing queue.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

routingQueueId*string

Response

200404

ok

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

name*string

description*string

priority*integer

teams*array of RoutingQueueTeam (object)

queuedItemsobject

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "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-18T03:32:00.286Z"
      }
    ],
    "messaging": [
      {
        "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
        "capacityType": "text",
        "QueuedAt": "2024-10-18T03:32:00.286Z"
      }
    ],
    "voice": [
      {
        "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
        "capacityType": "text",
        "QueuedAt": "2024-10-18T03:32:00.286Z"
      }
    ]
  },
  "createdAt": "2024-10-18T03:32:00.286Z",
  "updatedAt": "2024-10-18T03:32:00.286Z"
}

Update a Routing queue

Modify the details of a specific routing queue.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

routingQueueId*string

Body

application/json

namestring

descriptionstring

priorityinteger

teamsarray of RoutingQueueTeam (object)

Response

200404422

Updated

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

name*string

description*string

priority*integer

teams*array of RoutingQueueTeam (object)

queuedItemsobject

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "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-18T03:32:00.286Z"
      }
    ],
    "messaging": [
      {
        "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
        "capacityType": "text",
        "QueuedAt": "2024-10-18T03:32:00.286Z"
      }
    ],
    "voice": [
      {
        "rootItemId": "123e4567-e89b-12d3-a456-426614174000",
        "capacityType": "text",
        "QueuedAt": "2024-10-18T03:32:00.286Z"
      }
    ]
  },
  "createdAt": "2024-10-18T03:32:00.286Z",
  "updatedAt": "2024-10-18T03:32:00.286Z"
}

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"
}