回调接口说明
回调类型对照
| mode类型 | 场景描述 |
|---|---|
| init | 初始化回调地址配置回调 |
| logs | 收到聊天记录回调(可根据业务需要自行判断是否为用户新消息) |
| receipt | 指令已接收回调（版本 >= v2.5.5） |
| callBack | 指令执行回调 |
| online | 机器人上线回调 |
| offline | 机器人离线回调 |
初始化回调地址配置回调
{
"robotId":{robotId},
"mode":"init",
"data":[]
}收到聊天记录消息回调
1、FlowBot免费提供客户端本地会话新消息上报功能，简单易用，可满足日常大部分业务场景。 2、业务方如对聊天记录要求比较高，可选择开通 企微官方会话存档功能 实现企微官方聊天记录读取，即：收消息通过会话 存档能力，发消息使用FlowBot即可。
| role | 说明 |
|---|---|
| admin | 机器人发出的消息 |
| user | 好友发来的消息 |
| system | 官方系统发来的消息 |
| 消息类型 | 类型描述 |
|---|---|
| text | 文本 |
| image | 图片 |
| card | 名片 |
| money | 红包 |
| map | 地图 |
| file | 文件 |
| video | 视频 |
| voice | 语音 |
| url | 链接 |
| miniapp | 小程序 |
| transfer | 转账 |
{
"robotId": {robotId},
"mode": "logs",
"searchText": {消息所属好友名称/群聊名称},
"data": [
{
"role":"system",
"type":"system",
"data":{
"message":"你已添加了小碗泡泡糖，现在可以开始聊天了。"
}
},
{
"role": "user",
"type": "text",
"data": {
"message": "文本内容",
"groupNickname":"用户昵称/备注",//限群聊
"corpsName":"@微信/主体名称"//限群聊
}
},
{
"role": "admin",
"type": "image",
"data": {
"message": "图片"
}
},
{
"role": "user",
"type": "money",
"data": {
"message": "红包备注内容"
}
},{
"role": "user",
"type": "card",
"data": {
"message": "个人名片昵称"
}
},{
"role": "user",
"type": "map",
"data": {
"message": "地图标题",
"extra": "地图详细描述"
}
},{
"role": "user",
"type": "file",
"data": {
"message": "文件名称",
"extra": "文件大小"
}
},{
"role": "user",
"type": "video",
"data": {
"message": "视频时长"
}
},{
"role": "user",
"type": "voice",
"data": {
"message": "语音识别内容(若有)",
"extra": "语音时长"
}
},{
"role": "user",
"type": "miniapp",
"data": {
"message": "小程序名称",
"extra": "小程序分享标题"
}
},{
"role": "user",
"type": "url",
"data": {
"message": "链接标题"
}
},{
"role": "user",
"type": "transfer",
"data": {
"message": "转账备注描述",
"extra": "转账金额及内容"
}
}
]
}指令已接收回调
注意： 1、若业务端仅实现消息收发功能，不需要监听指令执行结果，暂时可以忽略指令回调，仅调用发送消息相关接口并监听收到新消息回调即可实现业务闭环 2、该回调用于判断FlowBot客户端是否成功接收到服务端下发指令的回调。
指令执行回调
注意：
1、若业务端仅实现消息收发功能，暂时可以忽略指令回调，仅调用发送消息相关接口并监听收到新消息回调即可实现业务闭环2、该回调用于判断FlowBot客户端是否执行成功了服务端下发指令的回调。
机器人上线回调
{
"robotId":{robotId},
"mode":"online"
}机器人离线回调
{
"robotId":{robotId},
"mode":"offline"
}