在线系统获取会话数据
查询单个会话消息
按会话 ID 查询该会话下的消息明细。接口不校验凌晨导出时间窗口,但仍会校验 appKey、checksum、IP 白名单与企业白名单。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| time | any | 是 | 请求时间戳(秒);用于签名鉴权 | |
| checksum | any | 是 | 请求签名校验和 | |
| checksumAlgorithm | integer | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256;不传默认为 0 | |
| appKey | string | 是 | 应用 AppKey |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| sessionId | int64 | 是 | 会话 ID,必须是 64 位整数范围内的数字 | 123456789 |
| mTypes | string | 否 | 消息类型筛选条件;不传表示不过滤。多个类型用英文逗号分隔。 | 1,2,3 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 成功提示 | success |
| data | object[] | 消息列表 | [{"id":100001,"sessionId":200001,"from":1,"time":1720087200000,"mType":1,"msg":"您好"}] |
| └id | int64 | 消息 ID,全局唯一 | 100001 |
| └sessionId | int64 | 会话 ID,全局唯一 | 200001 |
| └staffId | int64 | 客服 ID;小于等于 0 时表示机器人 | 10001 |
| └staffName | string | 客服名称 | 张三 |
| └userId | int64 | 访客 ID | 556677 |
| └userName | string | 访客名称 | 李四 |
| └from | int32 | 消息流向:1-来自访客、0-来自客服 | 1 |
| └time | int64 | 消息创建时间,毫秒时间戳 | 1720087200000 |
| └mType | int32 | 消息类型: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 |
| └autoReply | int32 | 消息回复类型:0-手动回复、1-自动回复 | 0 |
| └status | int32 | 消息状态:1-正常、2-已撤回 | 1 |
| └msg | string | 消息体,可能为空 | 您好,请问有什么可以帮助您? |
| └isRichMedia | int32 | 是否富媒体类型;mType 为 2、3、4、5、115 时为 1,其他为 0 | 0 |
| └evaluation | int32 | 机器人答案评价:0-不显示、1-未评价、2-有用、3-没用 | 2 |
| └msgEvaluationContent | string | 差评内容,可能为空 | 答案未解决我的问题 |
| └matchType | int32 | 匹配类型:0-未匹配、1-精确匹配、2-相似匹配;仅机器人消息有业务含义 | 1 |
| └matchKnowledgeId | int64 | 匹配知识 ID;大于 0 表示精确匹配命中,小于等于 0 或为空表示相似匹配或未匹配 | 90001 |
| └externalUserId | string | 群聊消息发送者的第三方 ID;企业微信渠道返回访客企业微信 ID | wmOgQwDgAAcwMTB7 |
| └escrowAccount | int32 | 群聊消息发送者是否为托管账号:1-是 | 1 |
| └recommendKnowledgeIds | int64[] | 推荐知识 ID 列表;仅机器人消息返回,其他消息为空 | [90001,90002] |
| └clickKnowledgeIds | int64[] | 访客点击的推荐知识 ID 列表;仅机器人消息返回,其他消息为空 | [90001] |
| └llmDocIds | string[] | 大模型知识引用文档 ID 列表;仅大模型回复返回,其他消息为空 | ["doc-001","doc-002"] |
| └answerType | int32 | 机器人消息来源:0-客服回复、1-FAQ 精确匹配、2-FAQ/一触即达相似匹配、4-未知问题、5-内置寒暄、6-常见问题、7-一触即达、8-自定义寒暄、10-其他、12-沉默提醒、13-表格知识精确匹配、14-表格知识相似匹配、16-应急关键词、19-自定义分组常见问题、30-文档问答、33-第三方大模型、34-Agent、35-第三方 Agent | 30 |
| └clickType | int32 | 点击触发来源:0 或空-无、1-常见问题、2-关联问题、3-相似问推荐 | 2 |
| └matchChannelRule | string | 匹配渠道规则答案的具体命中条件,JSON 字符串;为空表示未命中渠道答案 | {"channel":"web","ruleId":1001} |
| └dialogueGroupId | string | 一触即达所属分类 ID | group_001 |
| └dialogueGroupName | string | 一触即达所属分类名称,包含一级到当前层级并以 / 分隔 | 售后服务/退款问题 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体为空、不是合法 JSON、sessionId 缺失、不是数字或超出 64 位整数范围 |
| 14008 | IP 或企业不在导出白名单内 |
| 14009 | 频控限制:同一 appKey 对当前接口 60 秒内请求超过配置阈值 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/export/session/one/messagecurl -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": "服务内部异常"
}这篇文档有帮助吗?
查询会话导出文件
使用 `/openapi/export/session` 或 `/openapi/export/session/v1` 返回的 key 查询会话导出文件地址。 - 请求体格式为 `{"key":"创建任务接口返回的值"}`;key 可为 8 位 token 或数字下载任务 ID。 - 本接口不受凌晨导出时间窗口限制,但仍校验签名、IP 白名单和企业白名单。 - 文件未生成时返回 14520,message 为 `Wait...`,请稍后重试;生成完成后返回 200,message 为文件下载 URL。 - 8 位 token 对应的旧下载链路返回加密 ZIP,下载链接有效期为 6 小时,解压密码为当前企业 appKey 的前 12 个字符,压缩包内包含 session.txt 和 message.txt。若 key 为数字下载任务 ID,文件格式及密码规则以企业当前下载任务配置和实际返回文件为准。
查询单个会话详情
按会话 ID 查询会话基础信息。接口不校验凌晨导出时间窗口,但仍会校验 appKey、checksum、IP 白名单与企业白名单。