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

查询单个会话消息

按会话 ID 查询该会话下的消息明细。接口不校验凌晨导出时间窗口,但仍会校验 appKey、checksum、IP 白名单与企业白名单。

请求参数

名称类型必填描述示例值
timeany是请求时间戳(秒);用于签名鉴权
checksumany是请求签名校验和
checksumAlgorithminteger否签名算法:0 - 默认(SHA1),1 - SHA256;不传默认为 0
appKeystring是应用 AppKey

请求体

名称类型必填描述示例值
sessionIdint64是会话 ID,必须是 64 位整数范围内的数字123456789
mTypesstring否消息类型筛选条件;不传表示不过滤。多个类型用英文逗号分隔。1,2,3

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messagestring成功提示success
dataobject[]消息列表[{"id":100001,"sessionId":200001,"from":1,"time":1720087200000,"mType":1,"msg":"您好"}]
└idint64消息 ID,全局唯一100001
└sessionIdint64会话 ID,全局唯一200001
└staffIdint64客服 ID;小于等于 0 时表示机器人10001
└staffNamestring客服名称张三
└userIdint64访客 ID556677
└userNamestring访客名称李四
└fromint32消息流向:1-来自访客、0-来自客服1
└timeint64消息创建时间,毫秒时间戳1720087200000
└mTypeint32消息类型:0-系统消息、1-文本、2-图片、3-语音、4-文件、5-视频、6-系统提示、100-自定义、110-机器人答案、111-机器人答案反馈、112-超时关闭前提醒、113-超时关闭提醒、114-工单流程、115-富文本、116-敏感词屏蔽、117-客服拒绝转接、118-客服提交工单、119-客服邀请评价、120-访客参评、121-主企业转子企业、122-客服邀请评价详情、123-emoji、124-客服转主企业1
└autoReplyint32消息回复类型:0-手动回复、1-自动回复0
└statusint32消息状态:1-正常、2-已撤回1
└msgstring消息体,可能为空您好,请问有什么可以帮助您?
└isRichMediaint32是否富媒体类型;mType 为 2、3、4、5、115 时为 1,其他为 00
└evaluationint32机器人答案评价:0-不显示、1-未评价、2-有用、3-没用2
└msgEvaluationContentstring差评内容,可能为空答案未解决我的问题
└matchTypeint32匹配类型:0-未匹配、1-精确匹配、2-相似匹配;仅机器人消息有业务含义1
└matchKnowledgeIdint64匹配知识 ID;大于 0 表示精确匹配命中,小于等于 0 或为空表示相似匹配或未匹配90001
└externalUserIdstring群聊消息发送者的第三方 ID;企业微信渠道返回访客企业微信 IDwmOgQwDgAAcwMTB7
└escrowAccountint32群聊消息发送者是否为托管账号:1-是1
└recommendKnowledgeIdsint64[]推荐知识 ID 列表;仅机器人消息返回,其他消息为空[90001,90002]
└clickKnowledgeIdsint64[]访客点击的推荐知识 ID 列表;仅机器人消息返回,其他消息为空[90001]
└llmDocIdsstring[]大模型知识引用文档 ID 列表;仅大模型回复返回,其他消息为空["doc-001","doc-002"]
└answerTypeint32机器人消息来源:0-客服回复、1-FAQ 精确匹配、2-FAQ/一触即达相似匹配、4-未知问题、5-内置寒暄、6-常见问题、7-一触即达、8-自定义寒暄、10-其他、12-沉默提醒、13-表格知识精确匹配、14-表格知识相似匹配、16-应急关键词、19-自定义分组常见问题、30-文档问答、33-第三方大模型、34-Agent、35-第三方 Agent30
└clickTypeint32点击触发来源:0 或空-无、1-常见问题、2-关联问题、3-相似问推荐2
└matchChannelRulestring匹配渠道规则答案的具体命中条件,JSON 字符串;为空表示未命中渠道答案{"channel":"web","ruleId":1001}
└dialogueGroupIdstring一触即达所属分类 IDgroup_001
└dialogueGroupNamestring一触即达所属分类名称,包含一级到当前层级并以 / 分隔售后服务/退款问题

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体为空、不是合法 JSON、sessionId 缺失、不是数字或超出 64 位整数范围
14008IP 或企业不在导出白名单内
14009频控限制:同一 appKey 对当前接口 60 秒内请求超过配置阈值
14500服务内部异常
postEndpoint
/openapi/export/session/one/message
POST
/openapi/export/session/one/message
curl -X POST "https://qiyukf.com/openapi/export/session/one/message?time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0&appKey=9f1d7c2b8a6e4d3c" \  -H "Content-Type: application/json" \  -d '{    "sessionId": 123456789  }'
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": 100001,
      "sessionId": 200001,
      "from": 1,
      "time": 1720087200000,
      "mType": 1,
      "msg": "您好"
    }
  ]
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体为空、不是合法 JSON、sessionId 缺失、不是数字或超出 64 位整数范围"
}
{
  "code": 14008,
  "message": "IP 或企业不在导出白名单内"
}
{
  "code": 14009,
  "message": "频控限制:同一 appKey 对当前接口 60 秒内请求超过配置阈值"
}
{
  "code": 14500,
  "message": "服务内部异常"
}

这篇文档有帮助吗?