文档Engagement Platform API
Sign inGet started
Guides
API

Routing Queues

GET
/workspaces/{workspaceId}/inbox/routing-queues
Retrieve list of routing queues
查询参数
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.
响应载荷
results
array of object
必填
显示子属性
results.id
string
必填
results.workspaceId
string
必填
results.name
string
必填
results.description
string
必填
results.priority
integer
必填
results.teams
array of object
必填
显示子属性
results.teams.type
string
必填
Type of the team
Possible values: primary, secondary
results.teams.ids
array of string
必填
List of Team IDs
results.queuedItems
object
显示子属性
results.queuedItems.email
array of object
显示子属性
results.queuedItems.email.rootItemId
string
必填
results.queuedItems.email.capacityType
string
必填
results.queuedItems.email.QueuedAt
string
必填
results.queuedItems.messaging
array of object
显示子属性
results.queuedItems.messaging.rootItemId
string
必填
results.queuedItems.messaging.capacityType
string
必填
results.queuedItems.messaging.QueuedAt
string
必填
results.queuedItems.voice
array of object
显示子属性
results.queuedItems.voice.rootItemId
string
必填
results.queuedItems.voice.capacityType
string
必填
results.queuedItems.voice.QueuedAt
string
必填
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.
代码示例
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
请求载荷
name
string
必填
description
string
priority
integer
必填
teams
array of object
必填
显示子参数
teams.type
string
必填
Type of the team
Possible values: primary, secondary
teams.ids
array of string
必填
List of Team IDs
响应载荷
id
string
必填
workspaceId
string
必填
name
string
必填
description
string
必填
priority
integer
必填
teams
array of object
必填
显示子属性
teams.type
string
必填
Type of the team
Possible values: primary, secondary
teams.ids
array of string
必填
List of Team IDs
queuedItems
object
显示子属性
queuedItems.email
array of object
显示子属性
queuedItems.email.rootItemId
string
必填
queuedItems.email.capacityType
string
必填
queuedItems.email.QueuedAt
string
必填
queuedItems.messaging
array of object
显示子属性
queuedItems.messaging.rootItemId
string
必填
queuedItems.messaging.capacityType
string
必填
queuedItems.messaging.QueuedAt
string
必填
queuedItems.voice
array of object
显示子属性
queuedItems.voice.rootItemId
string
必填
queuedItems.voice.capacityType
string
必填
queuedItems.voice.QueuedAt
string
必填
createdAt
string
updatedAt
string
代码示例
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.
响应载荷
id
string
必填
workspaceId
string
必填
name
string
必填
description
string
必填
priority
integer
必填
teams
array of object
必填
显示子属性
teams.type
string
必填
Type of the team
Possible values: primary, secondary
teams.ids
array of string
必填
List of Team IDs
queuedItems
object
显示子属性
queuedItems.email
array of object
显示子属性
queuedItems.email.rootItemId
string
必填
queuedItems.email.capacityType
string
必填
queuedItems.email.QueuedAt
string
必填
queuedItems.messaging
array of object
显示子属性
queuedItems.messaging.rootItemId
string
必填
queuedItems.messaging.capacityType
string
必填
queuedItems.messaging.QueuedAt
string
必填
queuedItems.voice
array of object
显示子属性
queuedItems.voice.rootItemId
string
必填
queuedItems.voice.capacityType
string
必填
queuedItems.voice.QueuedAt
string
必填
createdAt
string
updatedAt
string
代码示例
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.
请求载荷
name
string
description
string
priority
integer
teams
array of object
显示子参数
teams.type
string
必填
Type of the team
Possible values: primary, secondary
teams.ids
array of string
必填
List of Team IDs
响应载荷
id
string
必填
workspaceId
string
必填
name
string
必填
description
string
必填
priority
integer
必填
teams
array of object
必填
显示子属性
teams.type
string
必填
Type of the team
Possible values: primary, secondary
teams.ids
array of string
必填
List of Team IDs
queuedItems
object
显示子属性
queuedItems.email
array of object
显示子属性
queuedItems.email.rootItemId
string
必填
queuedItems.email.capacityType
string
必填
queuedItems.email.QueuedAt
string
必填
queuedItems.messaging
array of object
显示子属性
queuedItems.messaging.rootItemId
string
必填
queuedItems.messaging.capacityType
string
必填
queuedItems.messaging.QueuedAt
string
必填
queuedItems.voice
array of object
显示子属性
queuedItems.voice.rootItemId
string
必填
queuedItems.voice.capacityType
string
必填
queuedItems.voice.QueuedAt
string
必填
createdAt
string
updatedAt
string
代码示例
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.
代码示例
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'