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

查询单个会话详情

按会话 ID 查询会话基础信息。接口不校验凌晨导出时间窗口,但仍会校验 appKey、checksum、IP 白名单与企业白名单。

请求参数

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

请求体

名称类型必填描述示例值
sessionIdint64是会话 ID,必须是 64 位整数范围内的数字123456789

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messagestring成功提示success
dataobject在线会话详情{"id":200001,"startTime":1720085400000,"endTime":1720089000000,"sType":0,"staffId":10001,"userId":556677}
└idint64会话 ID,全局唯一200001
└startTimeint64会话开始时间,毫秒时间戳1720085400000
└endTimeint64会话结束时间,毫秒时间戳1720089000000
└treatedTimeint64留言处理时间;仅留言会话有业务含义,单位毫秒1720090800000
└categorystring会话末级咨询分类名称退款问题
└categoryDetailstring会话咨询分类明细,格式为一级/二级/三级/四级/五级分类名售后服务/订单问题/退款问题
└evaluationint32满意度值;2 级模型支持 100/1,3 级支持 100/50/1,5 级支持 100/75/50/25/1,其他值表示未评价100
└evaluationTypeint32满意度类型,支持 2、3、5,分别表示 2/3/5 级满意度5
└evaluationRemarkstring满意度评价内容处理及时,问题已解决
└relatedTypeint32关联会话类型:0-无关联、1-从机器人转入、2-机器人转人工、3-历史会话发起、4-客服间转接、5-被接管、6-排队会话提前进线、7-留言分配、8-多机器人切换、9-主企业转子企业、10-从主企业转入、11-子企业转主企业、12-从子企业转入2
└relatedIdint64被关联的会话 ID;无关联时该字段未定义200000
└interactionint32会话交互类型:0-客服正常会话、1-机器人会话、2-呼叫中心会话、3-推送消息0
└closeReasonint32会话结束原因,取值参照会话结束通知的 closeReason1
└fromGroupIdint64分流客服组 ID,可能为空20001
└fromGroupstring分流客服组名称,可能为空售后组
└fromStaffstring会话来源客服,可能为空张三
└inQueueTimeint64开始排队时间,毫秒时间戳;小于等于 0 时忽略1720085350000
└visitRangeint64与上一次来访的时间差,单位毫秒;默认按 360 天86400000
└vipLevelint32VIP 级别,0 表示非 VIP 用户3
└staffIdint64接待客服 ID;小于等于 0 时表示机器人10001
└staffNamestring接待客服名称;机器人会话可能返回“机器人”张三
└userIdint64访客 ID556677
└foreignIdstring企业提供的访客外部 IDexternal-user-001
└userNamestring访客名称李四
└userPhonestring访客电话13800138000
└userEmailstring访客邮箱lisi@example.com
└userAddressstring访客地址杭州市滨江区
└userCrmInfostring访客 CRM 信息 JSON 字符串{"crmId":"crm_78901"}
└userTagsobject[]访客标签列表[{"id":1,"name":"VIP"}]
└namestring标签名称重点客户
└tagIdint64标签 ID10001
└fromIpstring访客来源 IP,可能为空203.0.113.10
└fromPagestring来源页面 URL,可能为空https://example.com/order/10001
└fromTitlestring来源页面标题,可能为空订单详情
└fromTypestring来源类型:Ios、Android、Web(含 H5)、Wx、wx_ma、Wb、OpenWeb
└fromSubTypestring终端明细,与管理端导出会话的终端明细一致Chrome
└intelligentEvaluationResultsstring智能满意度评价;企业开启 AI 智能满意度评价后返回满意
└intelligentEvaluationBasisstring智能满意度依据;企业开启 AI 智能满意度评价后返回客服响应及时且解决了用户问题
└llmConsumptionCountint32大模型资源点消耗数量12
└emotionTransSentimentstring情绪转人工命中的情绪类型,例如消极、生气、焦急焦急
└customFiledobject[]所有会话自定义字段;级联字段值包含 path、idpath 和 id[{"fieldId":81001,"name":"订单号","value":"SO202608090001"}]
└idint64字段值记录 ID91001
└namestring字段名称订单号
└typeint32字段类型:0-文本、1-下拉菜单、2-多选、3-日期0
└descriptionstring字段说明客户订单编号
└valuestring字段值SO202608090001
└valueEditableint32字段值是否可编辑:0-否、1-是1
└assignTypeint32字段归属类型1
└statusint32字段状态:0-可用、1-不可用0
└requiredint32是否必填:0-否、1-是1
└dataIdint64关联数据 ID556677
└fieldIdint64字段定义 ID81001
└sortint32字段排序序号1
└prefillstring预填值默认值
└hintstring输入提示请输入订单号
└customerint32是否允许访客填写:0-否、1-是1
└showint32字段展示区域标识1
└displayTypeint32转义后的展示类型:1-客户中心、2-在线、4-呼叫2
└systemint32是否为系统预留字段:0-自定义、1-系统预留0
└descriptionstring会话备注内容用户咨询退款进度
└transferRgTypestring机器人转人工的触发原因;仅转人工的机器人会话返回用户主动要求转人工
└roundNumberint32会话回合数6
└worksheetIdsstring会话关联工单 ID,多个 ID 以逗号分隔123456,123457
└fromHumanTransferint32是否来自客服转接:0-否、1-是1
└humanTransferSessionIdint64客服转接来源会话 ID;非客服转接会话为 null199999
└transferFromGroupstring转接来源客服组名称;人工转接会话返回机器人客服组
└transferFromStaffNamestring转接来源客服名称;人工转接会话返回智能客服
└transferRemarksstring转接来源会话备注;人工转接会话返回用户要求人工处理
└statusint32客服解决状态:0-未解决、1-已解决、2-解决中1
└userResolvedStatusint32评价解决状态:0-未选择、1-已解决、2-未解决1
└firstReplyCostint64客服首次响应时长,即访客首条消息到客服首次回复的时间间隔30000
└avgRespDurationint64客服在整个会话中的平均响应时长45000
└isValidint32是否有效会话:0-无效、1-有效1
└transferTypestring转接类型,例如静默转接或人工转接人工转接
└staffMessageCountint32客服在整个会话中的消息总数8
└userMessageCountint32访客在整个会话中的消息总数6
└overflowFromstring会话溢出的来源客服组售前组
└alarmTimesint32告警次数1
└staffFirstReplyTimeint64客服首次回复时间,毫秒时间戳1720085500000
└stickDurationint64会话置顶时长60000
└clientFirstMessageTimeint64访客首条消息时间,毫秒时间戳1720085450000
└isEvaluationInvitedint32是否邀请评价:0-未邀评、1-客服主动邀评、2-系统自动邀评1
└satisfactionTagsstring[]访客评价时选择的标签;仅已评价会话返回["响应快","态度好"]
└beginerint32会话发起方:1-访客、2-客服1
└enderint32会话终止方:1-访客、2-客服、3-系统2
└originPlatformstring来源渠道Web
└searchKeystring关键字退款
└transferTargetRobotstring转接目标机器人名称退款机器人
└landPagestring着陆页 URLhttps://example.com/activity
└staffInvitedEvaluateTimeint64客服邀评时间,毫秒时间戳;-1 表示不存在1720088500000
└userJoinEvaluateTimeint64访客参评时间,毫秒时间戳;-1 表示不存在1720088600000
└satisfyMsgCountint32答案好评数3
└unsatisfyMsgCountint32答案差评数1
└createTimestring访客进入时间的格式化字符串2026-08-09 14:10:00
└queueDurationstring访客排队时长,格式为时:分:秒00:00:50
└sessionDurationstring会话持续时长,格式为时:分:秒00:50:00
└staffReceptionDurationstring人工接待时长,格式为时:分:秒00:45:00
└isRobotHostingboolean是否为机器人托管会话true
└robotHostingDurationint64机器人托管时长,单位秒120
└isRobotHostingAlertTriggeredboolean是否触发转人工提醒true
└visitTimesstring重复咨询次数,大于 0 时返回2
└staffAccountstring客服账号agent01@example.com
└categoryIdint64客服组 ID,默认为 020001
└userIpCitystring用户 IP 所在省市浙江省杭州市
└overflowRuleNamestring溢出原因;仅溢出会话返回客服组忙线溢出
└overflowConditionstring溢出条件;仅溢出会话返回排队人数超过 10
└startReasonstring会话开始来源,例如“转自机器人”转自机器人
└videoRecordUrlListstring[]视频客服的存储地址列表,可用于拉取下载;仅视频会话返回["https://example.com/video/record.mp4"]
└preQueueint32是否提前进线:1-是、0-否;仅批量获取会话接口返回0
└externalUserIdstring会话用户的第三方 ID;企业微信渠道返回访客企业微信 IDwmOgQwDgAAcwMTB7
└externalEscrowIdstring客服对应的托管 ID;企业微信渠道返回客服企业微信账号 IDzhangsan
└assistStaffIdListint64[]协助接待的客服 ID 列表[10002,10003]
└agentSensitiveWordsstring[]客服命中的敏感词列表["退款"]
└customerSensitiveWordsstring[]客户命中的敏感词列表["投诉"]
└firstResponseTimeoutint32首次响应超时次数,0 表示未超时0
└responseTimeoutint32响应超时次数,0 表示未超时1
└sessionTimeoutint32会话超时次数0
└evaluationAlarmstring评价报警内容客户评价不满意
└multipleVisitAlarmint32多次来访报警次数2
└agentRepliedstring客服是否有回复:是、否是
└agentRetractedMessageCountint32客服撤回消息数1
└agentSentFormstring客服是否发送表单:是、否否
└invitationSessionstring是否来自会话邀请:是、否否
└messageContentstring留言内容;仅留言类型会话返回请尽快联系我处理退款
└messageTimeint64留言时间,毫秒时间戳1720085400000
└messageCurrentStatusstring当前留言状态:未处理、已处理已处理
└messageAllocationTimeint64留言分配时间,毫秒时间戳1720085500000
└messageAllocationPersonstring留言分配人,可能为系统或客服真实名称系统
└messageAllocatorstring留言跟进人,即客服真实名称张三
└messageProcessingTimeint64留言处理时间,毫秒时间戳1720089000000
└messageProcessorstring留言处理人,即客服真实名称张三
└messageDivertedGroupstring留言分流客服组售后组
└messageTemplatestring留言模板售后留言模板
└messageGenerationReasonstring留言生成原因非服务时间留言
└messageInquiryRemarksstring留言咨询备注客户比较着急
└messageProblemResolutionStatusstring留言问题解决状态已解决
└messageGenerationTypestring留言生成类型离线留言
└messageAttachmentobject[]留言附件,结构与 customFiled 一致;级联字段值包含 path、idpath 和 id[{"fieldId":90001,"name":"附件","value":"https://example.com/proof.pdf"}]
└idint64字段值记录 ID91001
└namestring字段名称订单号
└typeint32字段类型:0-文本、1-下拉菜单、2-多选、3-日期0
└descriptionstring字段说明客户订单编号
└valuestring字段值SO202608090001
└valueEditableint32字段值是否可编辑:0-否、1-是1
└assignTypeint32字段归属类型1
└statusint32字段状态:0-可用、1-不可用0
└requiredint32是否必填:0-否、1-是1
└dataIdint64关联数据 ID556677
└fieldIdint64字段定义 ID81001
└sortint32字段排序序号1
└prefillstring预填值默认值
└hintstring输入提示请输入订单号
└customerint32是否允许访客填写:0-否、1-是1
└showint32字段展示区域标识1
└displayTypeint32转义后的展示类型:1-客户中心、2-在线、4-呼叫2
└systemint32是否为系统预留字段:0-自定义、1-系统预留0
└level1Categorystring一级会话咨询分类售后服务
└level2Categorystring二级会话咨询分类订单问题
└level3Categorystring三级会话咨询分类退款问题
└level4Categorystring四级会话咨询分类退款未到账
└level5Categorystring五级会话咨询分类超过三个工作日
└transferHumanFailReasonstring转人工失败原因,例如坐席离开、不在线、排队等待超时或接入留言转人工失败{坐席不在线}
└transferTargetRobotSessionIdint64机器人转机器人时的目标机器人会话 ID,记录在转出会话上300002
└transferFromRobotSessionIdint64机器人转机器人时的来源机器人会话 ID,记录在被转接会话上300001
└oneOffint32是否一次性解决;仅人工会话中的非人工转接、非主动发起会话返回1
└robotHostingAlertTriggeredbooleanisRobotHostingAlertTriggered 的兼容别名true
└sTypeint32会话类型:0-正常会话、1/2-离线留言、3-未接入会话、4-群聊、5-群聊离线留言0
└robotHostingbooleanisRobotHosting 的兼容别名true

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体为空、不是合法 JSON、sessionId 缺失、不是数字或超出 64 位整数范围
14008IP 或企业不在导出白名单内
14009频控限制:同一 appKey 对当前接口 60 秒内请求超过配置阈值
14500服务内部异常
postEndpoint
/openapi/export/session/one
POST
/openapi/export/session/one
curl -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": "服务内部异常"
}

这篇文档有帮助吗?