DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Routing Queues

GET
/workspaces/{workspaceId}/inbox/routing-queues
Retrieve list of routing queues
Parameter query
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.
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.workspaceId
string
wajib
results.name
string
wajib
results.description
string
wajib
results.priority
integer
wajib
results.teams
array of object
wajib
Tampilkan atribut turunan
results.teams.type
string
wajib
Type of the team
Possible values: primary, secondary
results.teams.ids
array of string
wajib
List of Team IDs
results.queuedItems
object
Tampilkan atribut turunan
results.queuedItems.email
array of object
Tampilkan atribut turunan
results.queuedItems.email.rootItemId
string
wajib
results.queuedItems.email.capacityType
string
wajib
results.queuedItems.email.QueuedAt
string
wajib
results.queuedItems.messaging
array of object
Tampilkan atribut turunan
results.queuedItems.messaging.rootItemId
string
wajib
results.queuedItems.messaging.capacityType
string
wajib
results.queuedItems.messaging.QueuedAt
string
wajib
results.queuedItems.voice
array of object
Tampilkan atribut turunan
results.queuedItems.voice.rootItemId
string
wajib
results.queuedItems.voice.capacityType
string
wajib
results.queuedItems.voice.QueuedAt
string
wajib
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.
Contoh kode
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
Payload permintaan
name
string
wajib
description
string
priority
integer
wajib
teams
array of object
wajib
Tampilkan parameter turunan
teams.type
string
wajib
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wajib
List of Team IDs
Payload respons
id
string
wajib
workspaceId
string
wajib
name
string
wajib
description
string
wajib
priority
integer
wajib
teams
array of object
wajib
Tampilkan atribut turunan
teams.type
string
wajib
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wajib
List of Team IDs
queuedItems
object
Tampilkan atribut turunan
queuedItems.email
array of object
Tampilkan atribut turunan
queuedItems.email.rootItemId
string
wajib
queuedItems.email.capacityType
string
wajib
queuedItems.email.QueuedAt
string
wajib
queuedItems.messaging
array of object
Tampilkan atribut turunan
queuedItems.messaging.rootItemId
string
wajib
queuedItems.messaging.capacityType
string
wajib
queuedItems.messaging.QueuedAt
string
wajib
queuedItems.voice
array of object
Tampilkan atribut turunan
queuedItems.voice.rootItemId
string
wajib
queuedItems.voice.capacityType
string
wajib
queuedItems.voice.QueuedAt
string
wajib
createdAt
string
updatedAt
string
Contoh kode
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.
Payload respons
id
string
wajib
workspaceId
string
wajib
name
string
wajib
description
string
wajib
priority
integer
wajib
teams
array of object
wajib
Tampilkan atribut turunan
teams.type
string
wajib
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wajib
List of Team IDs
queuedItems
object
Tampilkan atribut turunan
queuedItems.email
array of object
Tampilkan atribut turunan
queuedItems.email.rootItemId
string
wajib
queuedItems.email.capacityType
string
wajib
queuedItems.email.QueuedAt
string
wajib
queuedItems.messaging
array of object
Tampilkan atribut turunan
queuedItems.messaging.rootItemId
string
wajib
queuedItems.messaging.capacityType
string
wajib
queuedItems.messaging.QueuedAt
string
wajib
queuedItems.voice
array of object
Tampilkan atribut turunan
queuedItems.voice.rootItemId
string
wajib
queuedItems.voice.capacityType
string
wajib
queuedItems.voice.QueuedAt
string
wajib
createdAt
string
updatedAt
string
Contoh kode
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.
Payload permintaan
name
string
description
string
priority
integer
teams
array of object
Tampilkan parameter turunan
teams.type
string
wajib
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wajib
List of Team IDs
Payload respons
id
string
wajib
workspaceId
string
wajib
name
string
wajib
description
string
wajib
priority
integer
wajib
teams
array of object
wajib
Tampilkan atribut turunan
teams.type
string
wajib
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wajib
List of Team IDs
queuedItems
object
Tampilkan atribut turunan
queuedItems.email
array of object
Tampilkan atribut turunan
queuedItems.email.rootItemId
string
wajib
queuedItems.email.capacityType
string
wajib
queuedItems.email.QueuedAt
string
wajib
queuedItems.messaging
array of object
Tampilkan atribut turunan
queuedItems.messaging.rootItemId
string
wajib
queuedItems.messaging.capacityType
string
wajib
queuedItems.messaging.QueuedAt
string
wajib
queuedItems.voice
array of object
Tampilkan atribut turunan
queuedItems.voice.rootItemId
string
wajib
queuedItems.voice.capacityType
string
wajib
queuedItems.voice.QueuedAt
string
wajib
createdAt
string
updatedAt
string
Contoh kode
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.
Contoh kode
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'