订阅此 webhook 后,您将收到 WOZTELL 为所有支持的平台预处理的标准化事件。
文本消息:
视频消息:
除了消息事件之外,通过订阅入站消息,您还可以收到消息状态更新,例如 WhatsApp 的 已发送
、 已送达
和 已读
事件。
当消息状态变为 已读
时:
body
属性 | 类型 | 描述 |
---|---|---|
type | 字符串 | 可以是 BOT 或 MANUAL ,表示出站消息是来自聊天机器人还是 API/Broadcast |
member | 字符串 | 成员的 ID |
channel | 字符串 | 频道的 ID |
app | 字符串 | 应用的 ID |
meta | 对象 | apiSource ,包含源集成的信息 |
memberExtraData | 对象 | 额外的成员数据和有效的成员路径 |
customHeadersData | 对象 | 自定义请求头键和值 |
messageEvent | 对象 | 包含标准化消息的 messageEvent 对象 |
messageEvent
属性 | 类型 | 描述 |
---|---|---|
from | 字符串 | 发送者的 ID |
to | 字符串 | 接收者的 ID |
timestamp | 数字 | Unix 时间戳 |
type | 字符串 | 消息类型 |
data | 对象 | 对应消息类型的消息数据 |
messageId | 字符串 | 外部平台的消息 ID (此属性可能不存在) |
meta
属性 | 类型 | 描述 |
---|---|---|
agentUserId | 字符串 | 发送消息的用户 ID。 |
source | 对象 | 源集成信息;与 apiSource 相同 |
apiSource | 对象 | 源集成信息;即将废弃 |
_source_
属性 | 类型 | 描述 |
---|---|---|
integrationId | 字符串 | 源集成类型 |
build | 数字 | 集成版本 |
appIntegration | 字符串 | 集成 ID |
出站消息中的 agentUserId
可用于通过 开放 API 查询团队成员信息:
机器人响应消息将发送到您指定的 webhook。
通过SendResponse API发送的消息将发送到您指定的 webhook。
通过Broadcast发送的消息将发送到您指定的 webhook。
通过订阅这些事件,您将收到该频道成员状态变化时的事件通知。
成员更新事件包括:成员创建
、成员订阅状态更新
、成员在线状态更新
、成员元数据更新
、成员临时数据更新
和 成员标签更新
。
body
属性 | 类型 | 描述 |
---|---|---|
eventType | 字符串 | MEMBER_UPDATE |
functionName | 字符串 | NORMAL_UPDATE_MEMBER :在成员页面手动更新成员;BOT_UPDATE_MEMBER :通过机器人更新成员 |
member | 字符串 | 成员 ID |
channel | 字符串 | 频道 ID |
app | 字符串 | 应用 ID |
before | 对象 | 变更前成员状态 |
after | 对象 | 变更后成员状态 |
当多个成员同时批量更新时,您将收到事件类型为 BATCH_MEMBER_UPDATE
的事件。
body
属性 | 类型 | 描述 |
---|---|---|
eventType | 字符串 | BATCH_MEMBER_UPDATE |
functionName | 字符串 | 批量更新函数,包括 OPEN_API_BATCH_CREATE_CHAT 、 OPEN_API_UPDATE_MEMBERS 、 OPEN_API_BATCH_UPDATE_MEMBERS 、 NORMAL_UPDATE_MEMBERS 、 BATCH_ADD_TAGS 、 BATCH_DELETE_TAGS 、 BATCH_REPLACE_TAGS |
members | 数组 | 成员 ID 数组 |
channel | 字符串 | 频道 ID |
app | 字符串 | 应用 ID |
update | 对象 | 成员更新详情 |
订阅此事件后,您将在频道中节点被触发时收到通知。
body
属性 | 类型 | 描述 |
---|---|---|
eventType | 字符串 | NODE_TRIGGER |
app | 字符串 | 应用 ID |
字符串 | 频道 ID | 频道 ID |
字符串 | 成员 ID | 成员 ID |
字符串 | 节点触发时间 | 节点触发时间 |
字符串 | 节点 ID | 节点 ID |
字符串 | 节点唯一 ID | 节点唯一 ID |
字符串 | 树的 ID | 树的 ID |
对象 | 包含标准化消息的 messageEvent 对象 | 包含标准化消息的 messageEvent 对象 |
新的频道 webhook 系统可以更好地控制您 webhook 接收的事件。在频道的“环境”页面,您可以管理订阅该频道各个环境的 webhook。
要删除 webhook,请点击“更多”并选择“删除”。