通用回调
注意
回调服务不能保证完全可靠,请慎重考虑使用回调方案构建核心业务流程的风险。
描述
凭借本回调,您可以监听用户与智能体对话过程中所发生的事件,包含 ASR 结果、LLM 结果、异常事件。
说明
如需获取 ASR 结果和 LLM 结果,您需要在 创建智能体实例 时,将 CallbackConfig.ASRResult 和 CallbackConfig.LLMResult 设置为 1
。
回调说明
- 请求方法:POST。
说明回调数据格式为 JSON。您需要对其进行 UrlDecode 解码.
- 请求地址:请联系 ZEGO 技术支持配置。
- 传输协议:HTTPS/HTTP,建议使用 HTTPS。
回调参数
说明
回调的相关参数,ZEGO 会在之后的迭代计划中,持续优化更新(例如:新增字段、或新增某些字段的参数取值)。开发者在接入时,请避免将代码写死,造成后期更新后,无法兼容新版本。
参数 | 类型 | 描述 |
---|---|---|
AppId | Number | ZEGO 给开发者 APP 的唯一标识。 |
Event | String | 事件通知类型。
|
Nonce | String | 随机数,用于检验串计算。 |
Timestamp | Number | 回调发送时的 Unix 时间戳(毫秒),用于检验串计算。 |
Signature | String | 检验串,验证回调发送方身份。 |
AgentInstanceId | String | 智能体实例的唯一标识。 |
Data | Object | 事件详细信息。本参数结构,请参考 Data。 |
Data
根据 Event
取值不同,Data 包含的参数不同。
ASRResult
LLMResult
Exception
回调示例
Event 为 ASRResult
Event 为 LLMResult
Event 为 Exception
返回响应
当您收到回调后,请返回 HTTP status code 为 2XX (例如 200),表示接收成功。返回其他,都表示接收失败。
回调重试策略
如果 ZEGO 服务器没有收到响应,或收到的 HTTP status code 不为 2XX(例如 200),都会尝试重试,最多进行 5 次重试。每次重试请求与上一次请求的间隔时间分别为 2s、4s、8s、16s、32s。若第 5 次重试后仍然失败,将不再重试,该回调丢失。