七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线系统

消息类型说明

在线系统消息推送与消息接口中 msgType 对应的消息体结构。

文本消息

消息类型:msgType=1(TEXT)

msg消息体 :字符串

这就是内容

图片

消息类型:msgType=2(PICTURE)

msg消息体 json

{
    "ext": "jpg",//扩展名
    "name": "9d7017eea90349b4970fe3b6058ecf53.jpg",//文件名
    "url": "https://ysf.nosdn.127.net/9d7017eea90349b4970fe3b6058ecf53.jpg"//文件url
}

音频

消息类型:**msgType=3(**AUDIO)

msg消息体 json

{
    "ext": "pdf", //扩展名
    "dur": 4000,//时长  毫秒
    "size": 105114,//大小 字节
    "name": "ysf_open_1739354243821",//展示的名字
    "url": "https://ysf.nosdn.127.net/97bbb90843effb9ab9e69e193d264337?Signature=djsNxVxKIQ3PIzIpXYQwXlPh9CrBXj3by6s7Q3lwMio%3D&Expires=2649030991&NOSAccessKeyId=b7e7f6715c6a4cffab9d28b5404f6f52" //文件url
}

文件

消息类型:**msgType=4(**FILE)

msg消息体 json

{
    "ext": "pdf", //扩展名
    "size": 105114,//大小 字节
    "name": "182E282736F88E4F85410F57A02884D1.pdf",//文件名
    "url": "https://urchin.nosdn.127.net/f97750f95b0b44e78c92012b1ccb5729.pdf",
    "md5": "n"  //文件url
}

视频

消息类型:**msgType=5(**VIDEO)

msg消息体 json

{
    "dur": 24000,//时长  毫秒
    "ext": "mp4", //扩展名
    "size": 13365376,//大小 字节
    "name": "b331ba0000a0434e9857130a6eef2cdf.mp4",//文件名
    "url": "https://urchin.nosdn.127.net/b331ba0000a0434e9857130a6eef2cdf.mp4",//文件url
}

提示词

提示词,比如消息发送失败的原因

消息类型:**msgType=6(**TIP)

msg消息体 纯文本

消息接口服务不可用,请联系管理员解决

企微客服支持合并转发的消息

消息类型:**msgType=8(**MERGE)

msg消息体 json

{
    "title": "企微的聊天记录",
    "list": [
        {
            "content": "话说这种 高股息的 分红 是不是要扣税呀", //内容
            "createTime": 1744789902000,//时间  毫秒
            "msgType": 1 消息类型
        },
        {
            "content": "它自动扣了",
            "createTime": 1744790716000,
            "msgType": 1
        }
    ]
}

企微语音通话消息

消息类型:**msgType=9(**MEETINGVOICECALL)

msg消息体 json

{
    "ext": "wav",//扩展名
    "dur": 13000,//时长  毫秒
    "sessionid": 11823423079,//会话id
    "url": "https://ysf.nosdn.127.net/b3f02588c53245d2af3631482194eee6.wav?audioTrans&type=mp3"  //文件url
}

自定义消息

消息类型:**msgType=100(**CUSTOM)

msg消息体 json 字段不固定,随意性很大,一般用不到,可忽略

{
    "ext": "n",
    "note": "2024009备注note备注note备注note备注note备注note",
    "actionText": "actionText_refactor_async_2024009",
    "auto": "0",
    "goodsCId": "商品类目ID-11111",
    "goodsId": "商品ID-22222",
    "cardType": "0",
    "show": "1",
    "actionTextColor": "#0000FF",
    "sessionid": 100000867646,
    "pageId": "1725268739273re3FzWX2Em",
    "title": "2024009商品标题title",
    "intent": "",
    "picture": "https://res.qiyukf.net/operation/a36b57015f609344d1ceebef413664c2",
    "url": "https://qiyukf.com/docs/guide/web/5-%E4%BC%9A%E8%AF%9D%E6%B6%88%E6%81%AF.html#%E5%95%86%E5%93%81%E5%8D%A1%E7%89%87",
    "tags": "[{\"label\":\"iframe测试1\",\"url\":\"https://qi.163.com\",\"focusIframe\":\"iframe测试1\",\"data\":{\"name\":\"ss\",\"sex\":\"男\"}},{\"label\":\"Iframe\",\"focusIframe\":\"Iframe\",\"data\":{\"name\":\"ss\",\"sex\":\"男\"}},{\"label\":\"用户信息\",\"url\":\"https://qi.163.com\",\"focusIframe\":\"用户信息\",\"data\":{\"name\":\"ss\",\"sex\":\"男\"}},{\"label\":\"客户资料\",\"url\":\"https://qi.163.com\",\"focusIframe\":\"客户资料\",\"data\":{\"name\":\"ss\",\"sex\":\"男\"}},{\"label\":\"新建工单\",\"url\":\"https://qi.163.com\",\"focusIframe\":\"新建工单\",\"data\":{\"name\":\"ss\",\"sex\":\"男\"}},{\"label\":\"postmessage\",\"url\":\"https://dev-i08ccdedebc77-ide.igame.163.com\",\"focusIframe\":\"postmessage\",\"data\":{\"name\":\"sssssssss\",\"sex\":\"男\"}},{\"label\":\"未匹配-七鱼官网\",\"url\":\"https://qi.163.com\",\"focusIframe\":\"iframe名称\",\"data\":{\"name\":\"ss\",\"sex\":\"男\"}},{\"label\":\"无字段-有URL\",\"url\":\"https://www.baidu.com\",\"data\":{\"orderId\":\"10702\",\"userName\":\"xxx\"}},{\"label\":\"无字段-无URL\",\"data\":{\"orderId\":\"10702\",\"userName\":\"xxx\"}},{\"label\":\"仅有label\"}]",
    "sendProToRobot": "0",
    "sendByUser": "1",
    "name": "ysf_WEB_1725268759282",
    "cmd": 121,
    "desc": "2024009商品描述desc商品描述desc商品描述desc商品描述desc商品描述desc商品描述desc商品描述desc商品描述desc商品描述desc商品描述desc",
    "md5": "n"
}

卡片消息

消息类型:msgType=102(CARD_MSG)

msg消息体 json 根据不同的cmd有不同的cards,cards数量不固定,解析非常复杂,建议忽略

{
    "cards": [
        {
            "type": "title",
            "content": "Card标题模板"
        }
    ],
    "cmd": 124,
    "sessionid": 100000868200
}

自定义消息

消息类型:msgType=103(CUSTOM_MESSAGE)

msg消息体 json 根据不同的cmd有不同的cards,data属性不固定,解析非常复杂,建议忽略

{
    "auto": 0,
    "data": {
        "img": "https://res.qiyukf.net/storage/d31ee172-3734-4991-a97a-feed3c2a35ff.png",
        "staffName": "客服小七",
        "staffImage": "https://res.qiyukf.net/storage/d31ee172-3734-4991-a97a-feed3c2a35ff.png",
        "title": "网易七鱼客服",
        "content": "WebSDK自定义消息"
    },
    "description": "卡片消息2.0",
    "cmd": 125,
    "sessionid": 144001313364,
    "type": "customMessage",
    "msgtype": "customMessage"
}

机器人答案

消息类型:msgType=110(ROBOT)

msg消息体 json 根据cmd不同有不同的结果,一般值关注cmd=60的消息,格式如下

{
    "answer_cnt": 1,// faq匹配问题数
    "answer_flag": 1,//答案标识  0:文本 1:富文本
    "answer_label": "常见问题引导语",// answer_type=1且有关联问题时,该字段表示命中问题的答案 answer_type=2时该字段表示相似问题引导语
    "answer_list": "[{\"groupId\":21339029,\"id\":71307032,\"question\":\"我想买把雨伞!\",\"templateId\":10539531,\"type\":1}]",//匹配的问题列表
    "answer_type": 6,// 1:精准匹配 2:相似匹配到若干个相似度高的问题 4:拒识,未能匹配到知识 5:内置寒暄 6:常见问题  8:企业自定义寒暄库 13:精准匹配到表格知识 14:相似匹配到表格知识  16:关键词回复 17:文档中心 18:常用语  19:自定义分组 常见问题 30:文档应答 31:SOP流程辅助 32:知识中台匹配 33:大模型匹配 34:七鱼自有agent匹配  35:三方agent匹配
    "cmd": 60,
    "evaluation": 0,//评价标记  0:默认不显示评价  1:没有评价 2:答案有用 3:答案没用
    "evaluation_reason": 0,//是否可填写评价原因  0:不可以   1:可以
    "handlerType": 1,//处理类型  0:静默 1:自定义回复 2:转人工
    "has_connected_questions": 0,//answerList是否为关联问题  0:不是 1:是
    "operator_hint": 0,//是否展示转人工提示引导语 0:不展示  1:展示
    "style": 0//常见问题样式,默认0:气泡;1:卡片
}

会话关闭提醒语

消息类型:**msgType=112(**CLOSENOTIFY)

msg消息体 字符串

您长时间未回复,请尽快回复!

提示语

消息类型:**msgType=113(**AUTOINVALID)

msg消息体 字符串

当前会话回合数<2,识别为无效会话

一触即达消息

消息类型:msgType=114(WORKFLOW)

msg消息体 json 根据不同的cmd有不同字段,cmd参考(<u>服务直达 七鱼内部协议文档</u>),解析非常复杂

{
    "cmd": 203,
    "delayReplyTime": 3000,
    "evaluation": 0,
    "evaluation_reason": 0,
    "extendInfo": {
        "dialogId": "96E413229F552D20-602A410526A842E4",
        "flowId": "96E413229F552D20-FA9BB3A85B54B3F6",
        "message": "",
        "needStatistics": true,
        "nodeId": "96E413229F552D20-ab405e01324cf4be",
        "nodeType": "1",
        "preRequestId": "127b30fb-c843-4ba4-8aae-8404b6c8252e",
        "requestId": "b8a27254-9624-44ce-8df1-1a5d35915c5c",
        "sendType": 0,
        "showUseful": true,
        "subType": "04"
    },
    "template": {
        "id": "refund_detail",
        "label": "您的订单详情如下",
        "state": {
            "name": "退款完成",
            "type": "success"
        },
        "list": [
            "退款时间:2020-02-02",
            "退款金额:999.99"
        ],
        "version": "0.1"
    },
    "transferRgType": 38,
    "type": "11"
}

富文本

消息类型:msgType=115(RICHTEXT)

msg消息体 json

{
    "content": "<p>您好,请问有什么可以帮助您66666666?<span style=\"background-color: rgb(51, 126, 255); color: rgb(255, 255, 255);\"><span style=\"font-size: 14px;\"><img height=\"129\" width=\"300\" data-group=\"ysf\" data-size=\"6857\" data-url=\"https://jnncs06zd.qiyukf.net/bd57c6478a16ccd3c097238815d1bb23.jpg\" title=\"ys.jpg\" src=\"https://jnncs06zd.qiyukf.net/bd57c6478a16ccd3c097238815d1bb23.jpg?imageView\"></span></span></p>" //富文本内容
}

敏感词屏蔽后的消息类型

消息类型:msgType=116(GFW)

msg消息体 富文本

{
    "cmd": 203,
    "type": 1, 消息类型,就是msgtype的值
    "auditResult": ["拦截词"],//拦截词
    "auditResult":1 //1:易盾反垃圾拦截 2:拦截词拦截
    "content": "<p>您好,请问有什么可以帮助您66666666?<span style=\"background-color: rgb(51, 126, 255); color: rgb(255, 255, 255);\"><span style=\"font-size: 14px;\"><img height=\"129\" width=\"300\" data-group=\"ysf\" data-size=\"6857\" data-url=\"https://jnncs06zd.qiyukf.net/bd57c6478a16ccd3c097238815d1bb23.jpg\" title=\"ys.jpg\" src=\"https://jnncs06zd.qiyukf.net/bd57c6478a16ccd3c097238815d1bb23.jpg?imageView\"></span></span></p>" //富文本内容
}

客服拒绝转接

消息类型:msgType=117(STAFF_REJECT_TRANSFER)

msg消息体 字符串

转接失败,超级管理员超时未确认

访客工单卡片

消息类型:**msgType=118(**RG_WORKSHEET)

msg消息体 json

{
    "worksheetId": 31314631283320,//工单id
    "content": "访客提交了一个新工单"//内容
}

客服邀评

消息类型:msgType=119(STAFF_INVITED_EVALUATE)

msg消息体 json

{
    "time": 1749811825449,//邀评时间
    "staffId": 9032319//客服id
}

访客评价

消息类型:**msgType=120(**USER_JOIN_EVALUATE)

msg消息体 json

{
    "tagList": "[\"服务响应及时\",\"服务态度好\",\"问题解答很专业\"]",//评价标签
    "evaluation": 100,//二级评价:100满意,1不满意  三级评价:100满意 50一般 1不满意 四级评价:100非常满意 75满意 25不满意 1非常不满意  五级评价:100非常满意 75满意 50一般 25不满意 1非常不满意
    "evaluation_resolved": 1,//是否解决  2未解决,1已解决
    "satisfactionName": "非常满意",//评价描述
    "messageId": 80498724803,//消息id
    "time": 1749804280086,//时间
    "message": "<p>您对我们的服务评价为: 非常满意。非常感谢!<img src=\"https://yyncs.qiyukf.net/cbdc108183c32b2fdb88be6bdfbd1e69.jpg?imageView\" title=\"yyncs.jpg\" data-url=\"https://yyncs.qiyukf.net/cbdc108183c32b2fdb88be6bdfbd1e69.jpg\" data-size=\"17136\" data-group=\"ysf\" width=\"148\" height=\"145\"><img src=\"https://yyncs.qiyukf.net/1220d616716317f8d835f24636cb77bc.jpg?imageView\" title=\"qwcsa.jpg\" data-url=\"https://yyncs.qiyukf.net/1220d616716317f8d835f24636cb77bc.jpg\" data-size=\"17087\" width=\"163\" height=\"155\" data-group=\"ysf\"></p><p><img src=\"https://yyncs.qiyukf.net/11fbe28ba9596e2078a80f18bc59f01f.jpg?imageView\" title=\"ys.jpg\" data-url=\"https://yyncs.qiyukf.net/11fbe28ba9596e2078a80f18bc59f01f.jpg\" data-size=\"6857\" width=\"300\" height=\"129\" data-group=\"ysf\"></p>", //消息内容
    "userId": 420897967505,//用户id
    "remarks": "gotest的评价"//用户备注
}

子企业转接

消息类型:msgType=121(STAFF_TRANSFER_SUB_CORP_SESSION_END)

msg消息体 json cmd=11063和cmd=11064两种类型,格式分别如下

{
    "parentCorpId": 13652097,//主企业id
    "currentSessionId": 144001307155,//当前会话id
    "subCorpId": 13654088,//子企业id
    "bizCode": "test1",//店铺编号
    "parentSessionId": 144001307155,//被转接会话id
    "cmd": 11063,//返回访客联系商家相关信息
    "time": 1731656605350,//时间
    "subCorpName": "test1"//子企业名字
}

{
    "transferStatus": 1,//转接状态  1转接成功 -1无客服在线 -2会话结束 -3其他
    "cmd": 11064,//通知主企业客服转接状态
    "sessionId": 144001307159,//会话id
    "time": 1731656888853,//时间
    "subCorpName": "test1"//子企业名字
}

客服邀评详情

消息类型:**msgType=122(**STAFF_INVITE_DETAIL)

msg消息体 json

{
    "evaluation_auto_popup": 0,//评价模式  0浮层弹窗 1消息气泡 2自定义评价界面
    "defaultSatisfied": 1,// 0默认不满意 1默认满意
    "messageId": 80498737062,//消息id
    "cmd": 50,//邀请用户评价
    "sessionid": 144003774180,//会话id
    "message": "我是您的专属顾问goapi10,请对我本次服务进行评价",
    "evaluationTimes": 0//已经评价次数
}

这篇文档有帮助吗?

目录