QA消息回调接口规范
QA问答接口回调(高级能力)
由您的技术团队按本接口文档开发一个接口并将接口地址设置绑定到对应机器人id,可以使@机器人回复时使用个性化接口来定制回答。
也就是说由第三方自己接收所有单聊和群聊消息,并进行回答处理。接口开发后调用 “机器人配置-机器人第三方QA配置” 将接口地址设置给机器人。
注意:
- 入参和出参需要和本文档完全一致。设置成功后在APP里要打开接收新消息开关。
- 第三方QA接口必须在3秒内处理响应,否则平台将放弃本次请求结果。如果接口确实处理耗时较长,可立即返回text值为空字符串后异步调用发送消息指令。
- 本接口也支持群内非@回调,即所有消息都回调,请查看“机器人配置-开启机器人群非@me回复”。
- 如果@机器人没有回复(或atMe总是false),应检查回复策略或者查看账号对外显示名与账号昵称是否一致(应修改一致)。
- QA记录可查询“历史记录-机器人QA日志列表查询”,包含请求耗时等信息。
- 如果不想回复处理本次消息可在响应体 text 的值设为空字符串。
- 图片消息仅可识别消息类型,如需回调图片内容请联系管理员。
Path: 您开发并测试验证过的接口地址(url支持带param参数以区分多个机器人)
Method: POST application/json或form-data均支持(优先使用json)
接口描述:
请求参数
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
spoken | 是 | 你好啊 | 问题文本 |
rawSpoken | 是 | @me 你好啊 | 原始问题文本 |
receivedName | 是 | 仑哥 | 提问者名称 |
groupName | 是 | 测试群1 | QA所在群名(群聊) |
groupRemark | 是 | 测试群1备注名 | QA所在群备注名(群聊) |
roomType | 是 | 1 | QA所在房间类型 1=外部群 2=外部联系人 3=内部群 4=内部联系人 |
atMe | 是 | true | 是否@机器人(群聊) |
textType | 是 | 1 | 消息类型 0=未知 1=文本 2=图片 5=视频 7=小程序 8=链接 9=文件 |
返回数据
名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
code | 是 | 0 | 0 调用成功 -1或其他值 调用失败并回复message |
message | 是 | success | 对本次接口调用的信息描述 |
data | 是 | 返回数据 | |
├─ type | 是 | 5000 | 5000 回答类型为文本 |
├─ info | 是 | 回答结果集合 | |
├─ text | 是 | 你也好啊 | 回答文本(您期望的回复内容) \n可换行 空字符串则不回复 |
请求示例(您开发的接口需要与示例的入参出参一致)
Path: https://mock.apifox.cn/m1/1035094-0-default/thirdQa
Method: POST application/json
Body:
{
"spoken": "你好",
"rawSpoken": "@管家 你好",
"receivedName": "仑哥",
"groupName": "测试群1",
"groupRemark": "测试群1备注名",
"roomType": "1",
"atMe": true
}
返回数据
{
"code": 0,
"message": "success",
"data": {
"type": 5000,
"info": {
"text": "你也好啊"
}
}
}
您也可以参考这里:https://www.apifox.cn/apidoc/project-1035094/api-29998765