DokumentacjaEngagement Platform API
Sign inGet started
Guides
API

Routing Queues

GET
/workspaces/{workspaceId}/inbox/routing-queues
Retrieve list of routing queues
Parametry zapytania
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.
Treść odpowiedzi
results
array of object
wymagane
Pokaż atrybuty podrzędne
results.id
string
wymagane
results.workspaceId
string
wymagane
results.name
string
wymagane
results.description
string
wymagane
results.priority
integer
wymagane
results.teams
array of object
wymagane
Pokaż atrybuty podrzędne
results.teams.type
string
wymagane
Type of the team
Possible values: primary, secondary
results.teams.ids
array of string
wymagane
List of Team IDs
results.queuedItems
object
Pokaż atrybuty podrzędne
results.queuedItems.email
array of object
Pokaż atrybuty podrzędne
results.queuedItems.email.rootItemId
string
wymagane
results.queuedItems.email.capacityType
string
wymagane
results.queuedItems.email.QueuedAt
string
wymagane
results.queuedItems.messaging
array of object
Pokaż atrybuty podrzędne
results.queuedItems.messaging.rootItemId
string
wymagane
results.queuedItems.messaging.capacityType
string
wymagane
results.queuedItems.messaging.QueuedAt
string
wymagane
results.queuedItems.voice
array of object
Pokaż atrybuty podrzędne
results.queuedItems.voice.rootItemId
string
wymagane
results.queuedItems.voice.capacityType
string
wymagane
results.queuedItems.voice.QueuedAt
string
wymagane
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.
Przykład kodu
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
Treść żądania
name
string
wymagane
description
string
priority
integer
wymagane
teams
array of object
wymagane
Pokaż parametry podrzędne
teams.type
string
wymagane
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wymagane
List of Team IDs
Treść odpowiedzi
id
string
wymagane
workspaceId
string
wymagane
name
string
wymagane
description
string
wymagane
priority
integer
wymagane
teams
array of object
wymagane
Pokaż atrybuty podrzędne
teams.type
string
wymagane
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wymagane
List of Team IDs
queuedItems
object
Pokaż atrybuty podrzędne
queuedItems.email
array of object
Pokaż atrybuty podrzędne
queuedItems.email.rootItemId
string
wymagane
queuedItems.email.capacityType
string
wymagane
queuedItems.email.QueuedAt
string
wymagane
queuedItems.messaging
array of object
Pokaż atrybuty podrzędne
queuedItems.messaging.rootItemId
string
wymagane
queuedItems.messaging.capacityType
string
wymagane
queuedItems.messaging.QueuedAt
string
wymagane
queuedItems.voice
array of object
Pokaż atrybuty podrzędne
queuedItems.voice.rootItemId
string
wymagane
queuedItems.voice.capacityType
string
wymagane
queuedItems.voice.QueuedAt
string
wymagane
createdAt
string
updatedAt
string
Przykład kodu
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.
Treść odpowiedzi
id
string
wymagane
workspaceId
string
wymagane
name
string
wymagane
description
string
wymagane
priority
integer
wymagane
teams
array of object
wymagane
Pokaż atrybuty podrzędne
teams.type
string
wymagane
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wymagane
List of Team IDs
queuedItems
object
Pokaż atrybuty podrzędne
queuedItems.email
array of object
Pokaż atrybuty podrzędne
queuedItems.email.rootItemId
string
wymagane
queuedItems.email.capacityType
string
wymagane
queuedItems.email.QueuedAt
string
wymagane
queuedItems.messaging
array of object
Pokaż atrybuty podrzędne
queuedItems.messaging.rootItemId
string
wymagane
queuedItems.messaging.capacityType
string
wymagane
queuedItems.messaging.QueuedAt
string
wymagane
queuedItems.voice
array of object
Pokaż atrybuty podrzędne
queuedItems.voice.rootItemId
string
wymagane
queuedItems.voice.capacityType
string
wymagane
queuedItems.voice.QueuedAt
string
wymagane
createdAt
string
updatedAt
string
Przykład kodu
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.
Treść żądania
name
string
description
string
priority
integer
teams
array of object
Pokaż parametry podrzędne
teams.type
string
wymagane
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wymagane
List of Team IDs
Treść odpowiedzi
id
string
wymagane
workspaceId
string
wymagane
name
string
wymagane
description
string
wymagane
priority
integer
wymagane
teams
array of object
wymagane
Pokaż atrybuty podrzędne
teams.type
string
wymagane
Type of the team
Possible values: primary, secondary
teams.ids
array of string
wymagane
List of Team IDs
queuedItems
object
Pokaż atrybuty podrzędne
queuedItems.email
array of object
Pokaż atrybuty podrzędne
queuedItems.email.rootItemId
string
wymagane
queuedItems.email.capacityType
string
wymagane
queuedItems.email.QueuedAt
string
wymagane
queuedItems.messaging
array of object
Pokaż atrybuty podrzędne
queuedItems.messaging.rootItemId
string
wymagane
queuedItems.messaging.capacityType
string
wymagane
queuedItems.messaging.QueuedAt
string
wymagane
queuedItems.voice
array of object
Pokaż atrybuty podrzędne
queuedItems.voice.rootItemId
string
wymagane
queuedItems.voice.capacityType
string
wymagane
queuedItems.voice.QueuedAt
string
wymagane
createdAt
string
updatedAt
string
Przykład kodu
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.
Przykład kodu
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'