借助网络钩子，Apps API 会在聊天会话期间每次发生相关事件时（例如创建聊天、收到消息或聊天被转接或升级时）向您的应用发送实时通知。使用网络钩子来实时响应聊天活动，而不是轮询 API。
Webhook 的范围限定为 Apps API 上的聊天会话。Contact Center AI 平台会将所有受支持的应用 API 聊天网络钩子事件作为 HTTP POST 请求传递到您配置的单个网络钩子网址。没有按活动订阅。
准备工作
- 您必须是管理员（或拥有可修改开发者设置的权限的角色）才能配置 Webhook。
- 准备一个可以接收 HTTP
POST请求的端点。网络钩子网址必须使用 HTTPS。
启用网络钩子
启用 Webhook 后，Contact Center AI 平台会将 Webhook 事件传递到您配置的网址，并且系统会显示网址和密钥字段。关闭 Webhook 后，系统不会发送任何事件。
如需启用网络钩子，请按以下步骤操作：
- 在 CCAI 平台门户中，依次点击设置 > 开发者设置。 如果您没有看到设置菜单，请点击 菜单。
- 前往 Webhooks 窗格，然后点击 Webhooks 切换开关，将其切换到开启位置。
配置网络钩子网址
- 在 URL 中，输入您的网络钩子端点。
- 确认端点使用 HTTPS 并且可以接收
POST请求。 Contact Center AI 平台会将所有受支持的事件发送到此单个网址。
生成签名密文
Contact Center AI 平台会对每个 Webhook 请求进行签名，以便您的应用确认请求来自 Contact Center AI 平台。它在 X-Signature 请求标头中发送签名，并在 X-Signature-Timestamp 中发送签名时间戳。您可以配置最多两个签名密钥：
- 主密钥：用于签署网络钩子请求的主要令牌。
- 辅助密钥：可选的第二个令牌。设置辅助 Secret 后，Contact Center AI 平台会使用这两个 Secret 对每个请求进行签名，这样您就可以轮换 Secret，而不会错过任何事件。
分别生成每个 Secret。如需生成 Secret，请按以下步骤操作：
- 在 CCAI 平台门户中，依次点击设置 > 开发者设置。 如果您没有看到设置菜单，请点击 菜单。
- 前往 Webhook 窗格。
- 在主 Secret 部分中，点击生成。点击复制以复制密钥并妥善存储。完整密钥仅在您生成密钥后立即显示。之后，系统会遮盖该密钥。
- 可选：在辅助密钥部分中，点击生成。点击复制以复制密钥并妥善存储。
- 在警告对话框中确认。新密钥会立即生效，因此任何仍在使用被替换密钥的内容都会失败。
轮替签名密钥
当存在主密钥时，轮替密钥操作会变为可用状态。 定期轮替密文是安全性方面的最佳实践。由于 Contact Center AI 平台会使用主密钥和辅助密钥对每个请求进行签名，因此您可以在不中断交付的情况下进行轮换：
- 在 CCAI 平台门户中，依次点击设置 > 开发者设置。 如果您没有看到设置菜单，请点击 菜单。
- 确保已设置主要 Secret 和次要 Secret。
- 点击 Rotate Secrets（轮替 Secret），以交换主 Secret 和次要 Secret。
- 更新您的应用，以根据新的有效密文验证签名。 在重叠期间，Contact Center AI 平台会使用两个已配置的密钥对每个请求进行签名，因此接受其中任何一个密钥都不会中断交付。
保存配置
选择保存以应用 webhook 的启用状态和网址。生成或轮换密钥的操作会立即生效，无需保存。在启用网络钩子并设置网络钩子网址和主密钥后，Contact Center AI 平台便会开始传送事件。
应用接收到的内容
启用网络钩子后，Contact Center AI 平台会针对每个受支持的聊天事件（例如生命周期更改、参与者活动、消息、转接、升级、网络表单和关闭警告）发送 HTTP POST 请求。每个请求正文都是一个 JSON 信封，其中包含 event_type、timestamp、chat_id 和特定于事件的 body。