回调类型对照
mode类型 |
场景描述 |
logs |
收到聊天记录回调(可根据业务需要自行判断是否为用户新消息) |
callBack |
指令执行回调 |
online |
机器人上线回调 |
offline |
机器人离线回调 |
收到聊天记录消息回调
role |
说明 |
admin |
机器人发出的消息 |
user |
好友发来的消息 |
消息类型 |
类型描述 |
text |
文本 |
image |
图片 |
card |
名片 |
money |
红包 |
map |
地图 |
file |
文件 |
video |
视频 |
voice |
语音 |
url |
链接 |
miniapp |
小程序 |
transfer |
转账 |
{
"robotId": {robotId},
"mode": "logs",
"searchText": {消息所属好友名称/群聊名称},
"data": [
{
"role": "admin",
"type": "text",
"data": {
"message": "文本内容"
}
},{
"role": "user",
"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": "转账金额及内容"
}
}
]
}
指令执行回调
注:若业务端仅实现消息收发功能,暂时可以忽略指令回调,仅调用发送消息相关接口并监听收到新消息回调即可实现业务闭环
{
"robotId": {robotId},
"mode": "callBack",
"taskId": {taskId},//任务id,递交任务时会返回
"type":'10001',
"status": 'success',//失败返回fail
"message":'执行成功'//'失败返回具体原因'
}
机器人上线回调
{
"robotId":"efb3a4abc63d01fe57aa7ff20f46a8c7",
"mode":"online"
}
机器人离线回调
{
"robotId":"efb3a4abc63d01fe57aa7ff20f46a8c7",
"mode":"offline"
}