在线系统获取会话数据
查询单个会话详情
按会话 ID 查询会话基础信息。接口不校验凌晨导出时间窗口,但仍会校验 appKey、checksum、IP 白名单与企业白名单。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| time | any | 是 | 请求时间戳(秒);用于签名鉴权 | |
| checksum | any | 是 | 请求签名校验和 | |
| checksumAlgorithm | integer | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256;不传默认为 0 | |
| appKey | string | 是 | 应用 AppKey |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| sessionId | int64 | 是 | 会话 ID,必须是 64 位整数范围内的数字 | 123456789 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 成功提示 | success |
| data | object | 在线会话详情 | {"id":200001,"startTime":1720085400000,"endTime":1720089000000,"sType":0,"staffId":10001,"userId":556677} |
| └id | int64 | 会话 ID,全局唯一 | 200001 |
| └startTime | int64 | 会话开始时间,毫秒时间戳 | 1720085400000 |
| └endTime | int64 | 会话结束时间,毫秒时间戳 | 1720089000000 |
| └treatedTime | int64 | 留言处理时间;仅留言会话有业务含义,单位毫秒 | 1720090800000 |
| └category | string | 会话末级咨询分类名称 | 退款问题 |
| └categoryDetail | string | 会话咨询分类明细,格式为一级/二级/三级/四级/五级分类名 | 售后服务/订单问题/退款问题 |
| └evaluation | int32 | 满意度值;2 级模型支持 100/1,3 级支持 100/50/1,5 级支持 100/75/50/25/1,其他值表示未评价 | 100 |
| └evaluationType | int32 | 满意度类型,支持 2、3、5,分别表示 2/3/5 级满意度 | 5 |
| └evaluationRemark | string | 满意度评价内容 | 处理及时,问题已解决 |
| └relatedType | int32 | 关联会话类型:0-无关联、1-从机器人转入、2-机器人转人工、3-历史会话发起、4-客服间转接、5-被接管、6-排队会话提前进线、7-留言分配、8-多机器人切换、9-主企业转子企业、10-从主企业转入、11-子企业转主企业、12-从子企业转入 | 2 |
| └relatedId | int64 | 被关联的会话 ID;无关联时该字段未定义 | 200000 |
| └interaction | int32 | 会话交互类型:0-客服正常会话、1-机器人会话、2-呼叫中心会话、3-推送消息 | 0 |
| └closeReason | int32 | 会话结束原因,取值参照会话结束通知的 closeReason | 1 |
| └fromGroupId | int64 | 分流客服组 ID,可能为空 | 20001 |
| └fromGroup | string | 分流客服组名称,可能为空 | 售后组 |
| └fromStaff | string | 会话来源客服,可能为空 | 张三 |
| └inQueueTime | int64 | 开始排队时间,毫秒时间戳;小于等于 0 时忽略 | 1720085350000 |
| └visitRange | int64 | 与上一次来访的时间差,单位毫秒;默认按 360 天 | 86400000 |
| └vipLevel | int32 | VIP 级别,0 表示非 VIP 用户 | 3 |
| └staffId | int64 | 接待客服 ID;小于等于 0 时表示机器人 | 10001 |
| └staffName | string | 接待客服名称;机器人会话可能返回“机器人” | 张三 |
| └userId | int64 | 访客 ID | 556677 |
| └foreignId | string | 企业提供的访客外部 ID | external-user-001 |
| └userName | string | 访客名称 | 李四 |
| └userPhone | string | 访客电话 | 13800138000 |
| └userEmail | string | 访客邮箱 | lisi@example.com |
| └userAddress | string | 访客地址 | 杭州市滨江区 |
| └userCrmInfo | string | 访客 CRM 信息 JSON 字符串 | {"crmId":"crm_78901"} |
| └userTags | object[] | 访客标签列表 | [{"id":1,"name":"VIP"}] |
| └name | string | 标签名称 | 重点客户 |
| └tagId | int64 | 标签 ID | 10001 |
| └fromIp | string | 访客来源 IP,可能为空 | 203.0.113.10 |
| └fromPage | string | 来源页面 URL,可能为空 | https://example.com/order/10001 |
| └fromTitle | string | 来源页面标题,可能为空 | 订单详情 |
| └fromType | string | 来源类型:Ios、Android、Web(含 H5)、Wx、wx_ma、Wb、Open | Web |
| └fromSubType | string | 终端明细,与管理端导出会话的终端明细一致 | Chrome |
| └intelligentEvaluationResults | string | 智能满意度评价;企业开启 AI 智能满意度评价后返回 | 满意 |
| └intelligentEvaluationBasis | string | 智能满意度依据;企业开启 AI 智能满意度评价后返回 | 客服响应及时且解决了用户问题 |
| └llmConsumptionCount | int32 | 大模型资源点消耗数量 | 12 |
| └emotionTransSentiment | string | 情绪转人工命中的情绪类型,例如消极、生气、焦急 | 焦急 |
| └customFiled | object[] | 所有会话自定义字段;级联字段值包含 path、idpath 和 id | [{"fieldId":81001,"name":"订单号","value":"SO202608090001"}] |
| └id | int64 | 字段值记录 ID | 91001 |
| └name | string | 字段名称 | 订单号 |
| └type | int32 | 字段类型:0-文本、1-下拉菜单、2-多选、3-日期 | 0 |
| └description | string | 字段说明 | 客户订单编号 |
| └value | string | 字段值 | SO202608090001 |
| └valueEditable | int32 | 字段值是否可编辑:0-否、1-是 | 1 |
| └assignType | int32 | 字段归属类型 | 1 |
| └status | int32 | 字段状态:0-可用、1-不可用 | 0 |
| └required | int32 | 是否必填:0-否、1-是 | 1 |
| └dataId | int64 | 关联数据 ID | 556677 |
| └fieldId | int64 | 字段定义 ID | 81001 |
| └sort | int32 | 字段排序序号 | 1 |
| └prefill | string | 预填值 | 默认值 |
| └hint | string | 输入提示 | 请输入订单号 |
| └customer | int32 | 是否允许访客填写:0-否、1-是 | 1 |
| └show | int32 | 字段展示区域标识 | 1 |
| └displayType | int32 | 转义后的展示类型:1-客户中心、2-在线、4-呼叫 | 2 |
| └system | int32 | 是否为系统预留字段:0-自定义、1-系统预留 | 0 |
| └description | string | 会话备注内容 | 用户咨询退款进度 |
| └transferRgType | string | 机器人转人工的触发原因;仅转人工的机器人会话返回 | 用户主动要求转人工 |
| └roundNumber | int32 | 会话回合数 | 6 |
| └worksheetIds | string | 会话关联工单 ID,多个 ID 以逗号分隔 | 123456,123457 |
| └fromHumanTransfer | int32 | 是否来自客服转接:0-否、1-是 | 1 |
| └humanTransferSessionId | int64 | 客服转接来源会话 ID;非客服转接会话为 null | 199999 |
| └transferFromGroup | string | 转接来源客服组名称;人工转接会话返回 | 机器人客服组 |
| └transferFromStaffName | string | 转接来源客服名称;人工转接会话返回 | 智能客服 |
| └transferRemarks | string | 转接来源会话备注;人工转接会话返回 | 用户要求人工处理 |
| └status | int32 | 客服解决状态:0-未解决、1-已解决、2-解决中 | 1 |
| └userResolvedStatus | int32 | 评价解决状态:0-未选择、1-已解决、2-未解决 | 1 |
| └firstReplyCost | int64 | 客服首次响应时长,即访客首条消息到客服首次回复的时间间隔 | 30000 |
| └avgRespDuration | int64 | 客服在整个会话中的平均响应时长 | 45000 |
| └isValid | int32 | 是否有效会话:0-无效、1-有效 | 1 |
| └transferType | string | 转接类型,例如静默转接或人工转接 | 人工转接 |
| └staffMessageCount | int32 | 客服在整个会话中的消息总数 | 8 |
| └userMessageCount | int32 | 访客在整个会话中的消息总数 | 6 |
| └overflowFrom | string | 会话溢出的来源客服组 | 售前组 |
| └alarmTimes | int32 | 告警次数 | 1 |
| └staffFirstReplyTime | int64 | 客服首次回复时间,毫秒时间戳 | 1720085500000 |
| └stickDuration | int64 | 会话置顶时长 | 60000 |
| └clientFirstMessageTime | int64 | 访客首条消息时间,毫秒时间戳 | 1720085450000 |
| └isEvaluationInvited | int32 | 是否邀请评价:0-未邀评、1-客服主动邀评、2-系统自动邀评 | 1 |
| └satisfactionTags | string[] | 访客评价时选择的标签;仅已评价会话返回 | ["响应快","态度好"] |
| └beginer | int32 | 会话发起方:1-访客、2-客服 | 1 |
| └ender | int32 | 会话终止方:1-访客、2-客服、3-系统 | 2 |
| └originPlatform | string | 来源渠道 | Web |
| └searchKey | string | 关键字 | 退款 |
| └transferTargetRobot | string | 转接目标机器人名称 | 退款机器人 |
| └landPage | string | 着陆页 URL | https://example.com/activity |
| └staffInvitedEvaluateTime | int64 | 客服邀评时间,毫秒时间戳;-1 表示不存在 | 1720088500000 |
| └userJoinEvaluateTime | int64 | 访客参评时间,毫秒时间戳;-1 表示不存在 | 1720088600000 |
| └satisfyMsgCount | int32 | 答案好评数 | 3 |
| └unsatisfyMsgCount | int32 | 答案差评数 | 1 |
| └createTime | string | 访客进入时间的格式化字符串 | 2026-08-09 14:10:00 |
| └queueDuration | string | 访客排队时长,格式为时:分:秒 | 00:00:50 |
| └sessionDuration | string | 会话持续时长,格式为时:分:秒 | 00:50:00 |
| └staffReceptionDuration | string | 人工接待时长,格式为时:分:秒 | 00:45:00 |
| └isRobotHosting | boolean | 是否为机器人托管会话 | true |
| └robotHostingDuration | int64 | 机器人托管时长,单位秒 | 120 |
| └isRobotHostingAlertTriggered | boolean | 是否触发转人工提醒 | true |
| └visitTimes | string | 重复咨询次数,大于 0 时返回 | 2 |
| └staffAccount | string | 客服账号 | agent01@example.com |
| └categoryId | int64 | 客服组 ID,默认为 0 | 20001 |
| └userIpCity | string | 用户 IP 所在省市 | 浙江省杭州市 |
| └overflowRuleName | string | 溢出原因;仅溢出会话返回 | 客服组忙线溢出 |
| └overflowCondition | string | 溢出条件;仅溢出会话返回 | 排队人数超过 10 |
| └startReason | string | 会话开始来源,例如“转自机器人” | 转自机器人 |
| └videoRecordUrlList | string[] | 视频客服的存储地址列表,可用于拉取下载;仅视频会话返回 | ["https://example.com/video/record.mp4"] |
| └preQueue | int32 | 是否提前进线:1-是、0-否;仅批量获取会话接口返回 | 0 |
| └externalUserId | string | 会话用户的第三方 ID;企业微信渠道返回访客企业微信 ID | wmOgQwDgAAcwMTB7 |
| └externalEscrowId | string | 客服对应的托管 ID;企业微信渠道返回客服企业微信账号 ID | zhangsan |
| └assistStaffIdList | int64[] | 协助接待的客服 ID 列表 | [10002,10003] |
| └agentSensitiveWords | string[] | 客服命中的敏感词列表 | ["退款"] |
| └customerSensitiveWords | string[] | 客户命中的敏感词列表 | ["投诉"] |
| └firstResponseTimeout | int32 | 首次响应超时次数,0 表示未超时 | 0 |
| └responseTimeout | int32 | 响应超时次数,0 表示未超时 | 1 |
| └sessionTimeout | int32 | 会话超时次数 | 0 |
| └evaluationAlarm | string | 评价报警内容 | 客户评价不满意 |
| └multipleVisitAlarm | int32 | 多次来访报警次数 | 2 |
| └agentReplied | string | 客服是否有回复:是、否 | 是 |
| └agentRetractedMessageCount | int32 | 客服撤回消息数 | 1 |
| └agentSentForm | string | 客服是否发送表单:是、否 | 否 |
| └invitationSession | string | 是否来自会话邀请:是、否 | 否 |
| └messageContent | string | 留言内容;仅留言类型会话返回 | 请尽快联系我处理退款 |
| └messageTime | int64 | 留言时间,毫秒时间戳 | 1720085400000 |
| └messageCurrentStatus | string | 当前留言状态:未处理、已处理 | 已处理 |
| └messageAllocationTime | int64 | 留言分配时间,毫秒时间戳 | 1720085500000 |
| └messageAllocationPerson | string | 留言分配人,可能为系统或客服真实名称 | 系统 |
| └messageAllocator | string | 留言跟进人,即客服真实名称 | 张三 |
| └messageProcessingTime | int64 | 留言处理时间,毫秒时间戳 | 1720089000000 |
| └messageProcessor | string | 留言处理人,即客服真实名称 | 张三 |
| └messageDivertedGroup | string | 留言分流客服组 | 售后组 |
| └messageTemplate | string | 留言模板 | 售后留言模板 |
| └messageGenerationReason | string | 留言生成原因 | 非服务时间留言 |
| └messageInquiryRemarks | string | 留言咨询备注 | 客户比较着急 |
| └messageProblemResolutionStatus | string | 留言问题解决状态 | 已解决 |
| └messageGenerationType | string | 留言生成类型 | 离线留言 |
| └messageAttachment | object[] | 留言附件,结构与 customFiled 一致;级联字段值包含 path、idpath 和 id | [{"fieldId":90001,"name":"附件","value":"https://example.com/proof.pdf"}] |
| └id | int64 | 字段值记录 ID | 91001 |
| └name | string | 字段名称 | 订单号 |
| └type | int32 | 字段类型:0-文本、1-下拉菜单、2-多选、3-日期 | 0 |
| └description | string | 字段说明 | 客户订单编号 |
| └value | string | 字段值 | SO202608090001 |
| └valueEditable | int32 | 字段值是否可编辑:0-否、1-是 | 1 |
| └assignType | int32 | 字段归属类型 | 1 |
| └status | int32 | 字段状态:0-可用、1-不可用 | 0 |
| └required | int32 | 是否必填:0-否、1-是 | 1 |
| └dataId | int64 | 关联数据 ID | 556677 |
| └fieldId | int64 | 字段定义 ID | 81001 |
| └sort | int32 | 字段排序序号 | 1 |
| └prefill | string | 预填值 | 默认值 |
| └hint | string | 输入提示 | 请输入订单号 |
| └customer | int32 | 是否允许访客填写:0-否、1-是 | 1 |
| └show | int32 | 字段展示区域标识 | 1 |
| └displayType | int32 | 转义后的展示类型:1-客户中心、2-在线、4-呼叫 | 2 |
| └system | int32 | 是否为系统预留字段:0-自定义、1-系统预留 | 0 |
| └level1Category | string | 一级会话咨询分类 | 售后服务 |
| └level2Category | string | 二级会话咨询分类 | 订单问题 |
| └level3Category | string | 三级会话咨询分类 | 退款问题 |
| └level4Category | string | 四级会话咨询分类 | 退款未到账 |
| └level5Category | string | 五级会话咨询分类 | 超过三个工作日 |
| └transferHumanFailReason | string | 转人工失败原因,例如坐席离开、不在线、排队等待超时或接入留言 | 转人工失败{坐席不在线} |
| └transferTargetRobotSessionId | int64 | 机器人转机器人时的目标机器人会话 ID,记录在转出会话上 | 300002 |
| └transferFromRobotSessionId | int64 | 机器人转机器人时的来源机器人会话 ID,记录在被转接会话上 | 300001 |
| └oneOff | int32 | 是否一次性解决;仅人工会话中的非人工转接、非主动发起会话返回 | 1 |
| └robotHostingAlertTriggered | boolean | isRobotHostingAlertTriggered 的兼容别名 | true |
| └sType | int32 | 会话类型:0-正常会话、1/2-离线留言、3-未接入会话、4-群聊、5-群聊离线留言 | 0 |
| └robotHosting | boolean | isRobotHosting 的兼容别名 | true |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体为空、不是合法 JSON、sessionId 缺失、不是数字或超出 64 位整数范围 |
| 14008 | IP 或企业不在导出白名单内 |
| 14009 | 频控限制:同一 appKey 对当前接口 60 秒内请求超过配置阈值 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/export/session/onecurl -X POST "https://qiyukf.com/openapi/export/session/one?time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0&appKey=9f1d7c2b8a6e4d3c" \ -H "Content-Type: application/json" \ -d '{ "sessionId": 123456789 }'{
"code": 200,
"message": "success",
"data": {
"id": 200001,
"startTime": 1720085400000,
"endTime": 1720089000000,
"sType": 0,
"staffId": 10001,
"userId": 556677
}
}{
"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": "服务内部异常"
}这篇文档有帮助吗?