文档Engagement Platform API
Sign inGet started
Guides
API

Automation Rules

GET
/workspaces/{workspaceId}/inbox/automation/rules
List inbox automation rules
查询参数
trigger
string
Rule trigger
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
enabled
boolean
Rule enabled state
响应载荷
results
array of object
必填
显示子属性
results.id
string
必填
results.name
string
必填
results.description
string
results.categoryId
string
必填
results.trigger
string
必填
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
results.triggerArguments
object
results.orderPosition
number
results.enabled
boolean
必填
results.conditions
object
必填
显示子属性
results.conditions.all
array of object
显示子属性
results.conditions.all.name
string
必填
results.conditions.all.value
object
results.conditions.any
array of object
显示子属性
results.conditions.any.name
string
必填
results.conditions.any.value
object
results.actions
array of object
显示子属性
results.actions.name
string
必填
results.actions.value
object
results.createdAt
string
必填
results.updatedAt
string
必填
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/rules/reorder
Reorder automation rule
请求载荷
trigger
string
必填
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
rules
array of object
必填
显示子参数
rules.ruleId
string
必填
rules.newCategoryId
string
rules.newOrderPosition
number
必填
代码示例
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/reorder' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}
Get automation rule
响应载荷
id
string
必填
name
string
必填
description
string
categoryId
string
必填
trigger
string
必填
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
必填
conditions
object
必填
显示子属性
conditions.all
array of object
显示子属性
conditions.all.name
string
必填
conditions.all.value
object
conditions.any
array of object
显示子属性
conditions.any.name
string
必填
conditions.any.value
object
actions
array of object
显示子属性
actions.name
string
必填
actions.value
object
createdAt
string
必填
updatedAt
string
必填
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}
Update automation rule
请求载荷
name
string
description
string
enabled
boolean
trigger
string
triggerArguments
object
categoryId
string
conditions
object
显示子参数
conditions.all
array of object
显示子参数
conditions.all.name
string
必填
conditions.all.value
object
conditions.any
array of object
显示子参数
conditions.any.name
string
必填
conditions.any.value
object
actions
array of object
显示子参数
actions.name
string
必填
actions.value
object
响应载荷
id
string
必填
name
string
必填
description
string
categoryId
string
必填
trigger
string
必填
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
必填
conditions
object
必填
显示子属性
conditions.all
array of object
显示子属性
conditions.all.name
string
必填
conditions.all.value
object
conditions.any
array of object
显示子属性
conditions.any.name
string
必填
conditions.any.value
object
actions
array of object
显示子属性
actions.name
string
必填
actions.value
object
createdAt
string
必填
updatedAt
string
必填
代码示例
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}
Delete automation rule
代码示例
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/automation/categories
List inbox automation categories
响应载荷
results
array of object
必填
显示子属性
results.id
string
必填
results.name
string
必填
results.orderPosition
number
results.createdAt
string
必填
results.updatedAt
string
必填
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/inbox/automation/categories
Create automation category
请求载荷
name
string
必填
响应载荷
id
string
必填
name
string
必填
orderPosition
number
createdAt
string
必填
updatedAt
string
必填
代码示例
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/categories/reorder
Reorder automation categories
请求载荷
categories
array of object
必填
显示子参数
categories.categoryId
string
必填
categories.newOrderPosition
number
必填
代码示例
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories/reorder' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}
Update automation category
请求载荷
name
string
必填
响应载荷
id
string
必填
name
string
必填
orderPosition
number
createdAt
string
必填
updatedAt
string
必填
代码示例
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}
Delete automation category
代码示例
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/automation/new-item-reply
Get current new-item reply configuration.
响应载荷
projectId
string
必填
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PUT
/workspaces/{workspaceId}/inbox/automation/new-item-reply
Update or create new-item reply configuration.
请求载荷
projectId
string
必填
代码示例
curl -X PUT 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'