DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Routing Queues

GET
/workspaces/{workspaceId}/inbox/routing-queues
Retrieve list of routing queues
Queryparameters
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
Antwoord-payload
results
array of object
verplicht
Onderliggende attributen tonen
results.id
string
verplicht
results.workspaceId
string
verplicht
results.name
string
verplicht
results.description
string
verplicht
results.priority
integer
verplicht
results.teams
array of object
verplicht
Onderliggende attributen tonen
results.teams.type
string
verplicht
Type of the team
Possible values: primary, secondary
results.teams.ids
array of string
verplicht
List of Team IDs
results.queuedItems
object
Onderliggende attributen tonen
results.queuedItems.email
array of object
Onderliggende attributen tonen
results.queuedItems.email.rootItemId
string
verplicht
results.queuedItems.email.capacityType
string
verplicht
results.queuedItems.email.QueuedAt
string
verplicht
results.queuedItems.messaging
array of object
Onderliggende attributen tonen
results.queuedItems.messaging.rootItemId
string
verplicht
results.queuedItems.messaging.capacityType
string
verplicht
results.queuedItems.messaging.QueuedAt
string
verplicht
results.queuedItems.voice
array of object
Onderliggende attributen tonen
results.queuedItems.voice.rootItemId
string
verplicht
results.queuedItems.voice.capacityType
string
verplicht
results.queuedItems.voice.QueuedAt
string
verplicht
results.createdAt
string
results.updatedAt
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
total
integer
The total number of results across all pages.
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/inbox/routing-queues
Create a new routing queue
Verzoek-payload
name
string
verplicht
description
string
priority
integer
verplicht
teams
array of object
verplicht
Onderliggende parameters tonen
teams.type
string
verplicht
Type of the team
Possible values: primary, secondary
teams.ids
array of string
verplicht
List of Team IDs
Antwoord-payload
id
string
verplicht
workspaceId
string
verplicht
name
string
verplicht
description
string
verplicht
priority
integer
verplicht
teams
array of object
verplicht
Onderliggende attributen tonen
teams.type
string
verplicht
Type of the team
Possible values: primary, secondary
teams.ids
array of string
verplicht
List of Team IDs
queuedItems
object
Onderliggende attributen tonen
queuedItems.email
array of object
Onderliggende attributen tonen
queuedItems.email.rootItemId
string
verplicht
queuedItems.email.capacityType
string
verplicht
queuedItems.email.QueuedAt
string
verplicht
queuedItems.messaging
array of object
Onderliggende attributen tonen
queuedItems.messaging.rootItemId
string
verplicht
queuedItems.messaging.capacityType
string
verplicht
queuedItems.messaging.QueuedAt
string
verplicht
queuedItems.voice
array of object
Onderliggende attributen tonen
queuedItems.voice.rootItemId
string
verplicht
queuedItems.voice.capacityType
string
verplicht
queuedItems.voice.QueuedAt
string
verplicht
createdAt
string
updatedAt
string
Codevoorbeeld
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}
Retrieves Routing queue.
Antwoord-payload
id
string
verplicht
workspaceId
string
verplicht
name
string
verplicht
description
string
verplicht
priority
integer
verplicht
teams
array of object
verplicht
Onderliggende attributen tonen
teams.type
string
verplicht
Type of the team
Possible values: primary, secondary
teams.ids
array of string
verplicht
List of Team IDs
queuedItems
object
Onderliggende attributen tonen
queuedItems.email
array of object
Onderliggende attributen tonen
queuedItems.email.rootItemId
string
verplicht
queuedItems.email.capacityType
string
verplicht
queuedItems.email.QueuedAt
string
verplicht
queuedItems.messaging
array of object
Onderliggende attributen tonen
queuedItems.messaging.rootItemId
string
verplicht
queuedItems.messaging.capacityType
string
verplicht
queuedItems.messaging.QueuedAt
string
verplicht
queuedItems.voice
array of object
Onderliggende attributen tonen
queuedItems.voice.rootItemId
string
verplicht
queuedItems.voice.capacityType
string
verplicht
queuedItems.voice.QueuedAt
string
verplicht
createdAt
string
updatedAt
string
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}
Modify the details of a specific routing queue.
Verzoek-payload
name
string
description
string
priority
integer
teams
array of object
Onderliggende parameters tonen
teams.type
string
verplicht
Type of the team
Possible values: primary, secondary
teams.ids
array of string
verplicht
List of Team IDs
Antwoord-payload
id
string
verplicht
workspaceId
string
verplicht
name
string
verplicht
description
string
verplicht
priority
integer
verplicht
teams
array of object
verplicht
Onderliggende attributen tonen
teams.type
string
verplicht
Type of the team
Possible values: primary, secondary
teams.ids
array of string
verplicht
List of Team IDs
queuedItems
object
Onderliggende attributen tonen
queuedItems.email
array of object
Onderliggende attributen tonen
queuedItems.email.rootItemId
string
verplicht
queuedItems.email.capacityType
string
verplicht
queuedItems.email.QueuedAt
string
verplicht
queuedItems.messaging
array of object
Onderliggende attributen tonen
queuedItems.messaging.rootItemId
string
verplicht
queuedItems.messaging.capacityType
string
verplicht
queuedItems.messaging.QueuedAt
string
verplicht
queuedItems.voice
array of object
Onderliggende attributen tonen
queuedItems.voice.rootItemId
string
verplicht
queuedItems.voice.capacityType
string
verplicht
queuedItems.voice.QueuedAt
string
verplicht
createdAt
string
updatedAt
string
Codevoorbeeld
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}
Delete a Routing queue. Items on the queue will be un-queued, then queue will be deleted.
Codevoorbeeld
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'