网易七鱼 API
  1. 获取会话记录
网易七鱼 API
  • 概述
  • 通用说明
    • 数据校验
    • 通用错误码列表
    • 服务端登录
      • 服务端登录
      • 获取SDK接入地址
  • CRM 对接
    • 概述
    • 文档约定
    • 对接方式对比与建议
    • Appendix I 错误码
    • 轻量 CRM 对接
      • 概述
      • Web SDK 调用
      • iOS SDK 调用
      • Android SDK 调用
      • 参数说明
    • CRM 接口对接
      • 概述
      • 跨域访问
      • 接口认证方式
      • 访客身份识别
      • 自定义接口参数
      • 获取 token
      • 在线会话获取用户信息
      • 呼叫中心获取电话用户信息
      • 更新用户信息
      • 在线会话获取用户订单信息
      • 呼叫中心获取用户订单信息
      • 更新订单信息
    • 七鱼用户认证机制
      • 概述
      • 术语
      • 认证过程
      • 实施流程
      • 授权接口
      • 认证接口
      • 版本支持
      • 示例代码
      • 注意事项
  • iframe 对接
    • 展示效果
    • 展示区域
    • 参数配置
    • 样例
  • 客户管理
    • 客户信息变更事件
    • 客户标签
      • 概览
      • 获取客户标签信息
      • 修改客户标签
      • 批量修改客户标签
      • 客户标签变更事件
    • 客户导出
      • 概述
      • 接口鉴权
      • 接口示例
      • 接口访问步骤
    • 获取用户服务记录
      • 概述
      • 接口鉴权
      • 接口示例
    • 客户导入
  • 员工管理
    • 客服管理
      • 创建客服
      • 修改客服
      • 删除客服
      • 获取客服列表
      • 查询单个客服信息
    • 客服组管理
      • 创建客服组
      • 修改客服组
      • 删除客服组
      • 分配客服到客服组
      • 获取客服组列表
      • 获取客服组下员工列表
  • 在线系统
    • 接口消息
      • 概述
      • 调用流程
      • 调用说明
      • 数据校验
      • 设置接收事件地址
      • 常见错误码
    • 消息收发
      • 概述
      • 给七鱼发送消息-文本消息
      • 给七鱼发送消息-图片消息
      • 给七鱼发送消息-语音消息
      • 接收七鱼消息
      • 上传文件-MultiPart 方式
      • 上传文件-base64 方式
    • 事件
      • 请求分配客服
      • 客服组排队情况查询
      • 更新用户资料
      • 获取评价设置
      • 评价客服
      • 查询排队状态
      • 主动退出排队
      • 接收会话开始通知
      • 接收会话结束通知
      • 接收客服主动邀评通知
      • 接收用户进入排队通知
      • 接收用户离开排队通知
      • 会话结束推送会话数据
      • 接收会话变更信息通知
      • 接收会话质检事件通知
    • 消息推送
      • 消息推送-发送文本时
      • 消息推送-发送图片时
      • 消息推送-发送富文本时
    • 数据接口
      • 概述
      • 实时数据报表
      • 客服质量报表
      • 客服考勤报表
      • 客服考勤明细
      • 历史数据总览
      • 客服工作量报表
      • 客服满意度报表
    • 订单绩效对接
      • 概述
      • 数据同步流程
      • 接口鉴权
      • 订单属性
      • 示例
      • 上传订单信息接口
      • 订单绩效导出接口
    • 获取会话记录
      • 概述
      • 接口鉴权
      • 接口示例
      • 接口访问步骤
      • 接口地址
      • 字段说明
    • 商品、订单查询
      • 一、 业务流程说明
      • 二、访客端样式
      • 三、接口定义
    • 获取会话关联的用户信息
      POST
    • 行为轨迹
      POST
    • 微信模板消息
      POST
    • 获取咨询分类
      POST
    • 获取在线会话的服务小记记录
      POST
    • 更新会话服务小记
      POST
  • 呼叫系统
    • 呼叫时间对接
      • 概述
      • 数据校验
      • 调用说明
      • curl请求样例如下
      • 第三方接口需返回的数据的说明
      • 第三方接口样例
    • 外呼任务
      • 创建外呼任务
        • 概述
        • 分配到客服
        • 分配到客服组
        • 按客户关系分配
        • 按自定义的客户分配
        • 自动外呼任务
      • 补充自动外呼号码
      • 获取外呼任务详情
      • 获取外呼任务明细详情
      • 编辑手动外呼任务
      • 删除外呼任务号码
    • 服务记录
      • 获取服务记录模板
    • 数据接口
      • 呼叫总览数据
      • 呼叫坐席历史数据
      • 呼叫团队历史总览数据
    • 呼叫工具条
      • 概述
      • 初始化 SDK
      • SDK 事件
      • SDK 方法
      • 获取SDK接入地址
    • 外呼机器人
      • 外呼机器人事件对接
      • 获取机器人话术列表
      • 模糊搜索获取话术列表
      • 获取外呼拦截组配置列表
      • 获取所有可用外呼线路列表
      • 创建外呼机器人任务
      • 获取指定任务的话术中变量
      • 向外呼任务中导入客户
      • 从已呼客户列表重新添加到呼叫任务
      • 获取已经完成外呼的客户信息列表
      • 启动外呼任务
      • 暂停外呼任务
      • 终止外呼任务
      • 获取任务详情
  • 机器人
    • 服务先知-常见问题
    • 服务先知-快捷短语
    • 一触即达
      • 概述
      • 对接方式
      • 对接示例
      • Velocity语法赋值
      • 移动SDK接入指南
    • 知识库管理
      • 概述
      • 获取知识库的问题
      • 获取知识库的知识点
      • 通过分类名称获取当前分类下topN标准问
      • 通过标准问获取当前机器人默认答案
      • 通过常见问题模板id获取常见问题列表
      • 知识库分类查询接口
      • 获取问题列表
      • 获取问题详情信息
      • 删除问题
      • 添加问题
      • 更新问题
      • 更新问题规则答案
      • 更新问题忽略相似问接口
    • 会话评价
      • 概述
      • 获取机器人评价设置
      • 提交机器人会话评价
    • 统计接口
      • 概述
      • 获取机器人会话统计总揽数据
      • 转人工会话统计
    • 消息接口
      • 概述
      • 概念/名词解释
      • 接口通用说明
      • 对接场景示例
      • 会话类接口
        • 会话类接口
        • 创建机器人会话
        • 常见问题
        • 快捷短语
        • 输入联想
        • 获取机器人消息回复
        • 机器人回复消息评价
        • 机器人会话满意度评价
        • 关闭机器人会话
        • 文件上传
        • 机器人辅助人工客服
      • 获取机器人切换配置
      • 微信公众号切换机器人
      • 企业微信切换机器人
  • 工单系统
    • 概述
    • 接口鉴权
    • 接口协议
    • 错误码
    • 工单推送
      • 说明
      • 请求体说明
    • 工单自定义字段同步
      • 基本用法
    • 创建工单
    • 修改工单
    • 批量修改工单
    • 申领工单
    • 转交工单
    • 回复工单
    • 催单接口
    • 完结工单
    • 重新打开工单
    • 搜索工单
    • 获取工单详情
    • 获取工单日志列表
    • 获取工单过滤器列表
    • 获取过滤器下的工单数量
    • 获取过滤器下的工单
    • 获取工单关注人
    • 获取工单模板
    • 获取工单模板字段
    • 获取工单分类
  • 短信
    • 接口鉴权
    • 创建短信发送任务
    • 获取短信任务状态
  • 平台电商(Platform OpenAPI)
    • 接口鉴权
    • 接口协议
    • 获取会话记录
      • 概述
      • 接口鉴权
      • 接口示例
      • 接口访问步骤
      • 字段说明
    • 第三方登录
    • 创建商户
    • 修改商户
    • 启用商户
    • 停用商户
    • 修改商户密码
    • 获取商户列表
    • 获取商户信息
  1. 获取会话记录

字段说明

  1. session说明如下:
字段数据库中字段类型和长度含义规则细节
idbigint(20)会话id全局唯一
startTimebigint(20)会话开始时间单位毫秒
endTimebigint(20)会话结束时间单位毫秒
sTypetinyint(4)会话类型0:正常会话.1(2):离线留言,3:排队超时
treatedTimebigint(20)留言处理时间(如果该会话是留言)单位毫秒
categoryvarchar(128)会话末级咨询分类末级咨询分类名
categoryDetailvarchar(128)会话咨询分类明细一级分类名/二级分类名/三级分类名/四级分类名/五级分类名
evaluationtinyint(4)满意度值2:(100满意; 1不满意);3:(100满意; 50一般; 1不满意);5:(100非常满意; 75满意; 50一般; 25不满意; 1非常不满意)否则未评价
evaluationTypebigint(20)满意度类型
evaluationRemarkvarchar(255)满意度评价内容
staffInvitedEvaluateTimebigint(20)客服邀评时间单位毫秒 返回-1则为不存在该时间值
userJoinEvaluateTimebigint(20)访客参评时间单位毫秒 返回-1则为不存在该时间值
relatedTypetinyint(4)关联会话类型0:无关联; 1=从机器人转接过来; 2:机器人会话转接人工; 3:历史会话发起; 4:客服间转接; 5:被接管
relatedIdbigint(20)被关联的会话id若是无关联则此字段未定义
interactiontinyint(4)会话交互类型0:客服正常会话,1:机器人会话,2:呼叫中心会话3=推送消息
closeReasontinyint(4)会话关闭原因参照[接收会话结束通知]中的closeReason
fromGroupvarchar(255)会话来自分流组名或为空
fromGroupIdbigint(20)会话来自分流组id或为空
fromStaffvarchar(255)会话来自哪个客服或为空
inQueueTimebigint(20)排队开始时间点若<=0忽略此字段
visitRangebigint(20)与上一次来访的时间差默认一年(360天),单位毫秒
vipLeveltinyint(4)VIP级别0=非VIP用户
staffIdbigint(20)客服id<=0 则为机器人
staffNamevarchar(255)客服名字或为"机器人"
userIdvarchar(255)访客id
foreignIdvarchar(255)外部id由企业提供
fromIpvarchar(64)访客来源ip或为空
fromPagevarchar(128)来源页或为空
fromTitlevarchar(128)来源页标题或为空
fromTypevarchar(64)来源类型Ios:苹果设备; Android:安卓设备; Web:网页版(含H5); Wx:微信; wx_ma:微信小程序; Wb:微博; Open:消息接口
customFiledvarchar(6000)自定义字段所有自定义字段, 是一个 KV类型的JSON字段,而如果是级联类型自定义字段值见下述说明。
descriptionvarchar(128)备注备注
transferRgTypevarchar(128)转人工类型机器人会话转成人工会话的触发原因
fromHumanTransfertinyint(4)是否来自客服转接0:非转接会话;1:客服转接过来的会话
transferFromStaffNamevarchar(128)转接来源分流客服名称转接会话有该字段
transferFromGroupvarchar(128)转接来源分流客服组名称转接会话有该字段
transferRemarksvarchar(2046)转接来源分流会话备注转接会话有该字段
humanTransferSessionIdbigint(20)客服转接来源会话ID如果该会话不是客服转接过来的,该值为null,否则值为转接来源会话的ID
worksheetIdsvarchar(1000)会话关联工单id会话关联工单id, 逗号分隔
roundNumberbigint(20)会话回合数会话回合数
statustinyint(4)客服解决状态0:未解决,1:已解决,2:解决中
userResolvedStatustinyint(4)用户解决状态0:未选择,1:已解决,2:未解决
firstReplyCostbigint(20)客服首次响应时长访客首条消息与客服首次回复消息的时间间隔
avgRespDurationbigint(20)客服平均响应时长客服整个会话中的平均响应时长
isValidtinyint(4)是否是有效会话0:无效会话,1:有效会话
transferTypevarchar(128)转接类型静默转接/人工转接
staffMessageCounttinyint(4)客服消息数客服在整个会话中的消息总量
userMessageCounttinyint(4)用户消息数用户在整个会话中的消息总量
overflowFromvarchar(128)溢出来源会话溢出的来源客服组
alarmTimestinyint(4)告警次数告警次数
staffFirstReplyTimebigint(20)客服首次响应的时间客服首次响应的时间
stickDurationbigint(20)会话置顶时长会话置顶时长
clientFirstMessageTimebigint(20)访客首条消息时间访客首条消息时间
isEvaluationInvitedtinyint(4)客服是否邀评0:邀评,1:主动评价
beginertinyint(4)会话发起方1:访客,2:客服
endertinyint(4)会话终止方1:访客,2:客服,3:系统
originPlatformvarchar(128)来源渠道来源渠道
searchKeyvarchar(128)关键字关键字
landPagevarchar(6000)着陆页url着陆页url

级联类型自定义字段其fieldValue格式如:

{
  "path": "1级/1.1级",  // 每一级的完整名称
  "idpath": [1555974, 1555977], // 每一级对应的ID
  "id": 1555977 //级联自定义字段ID
}
  1. message说明如下:
字段数据库中字段类型和长度描述规则细节
idbigint(20)消息id全局唯一
sessionIdbigint(20)会话id全局唯一
staffIdbigint(20)客服id<=0 则为机器人
staffNamevarchar(255)客服名
userIdbigint(20)访客id
userNamevarchar(255)访客名
fromtinyint(2)消息流向1=来自访客0=来自客服
timebigint(20)消息创建时间单位毫秒
mTypetinyint(4)消息类型系统消息:0-系统消息;1-文本消息;2-图片消息;3-语音消息;4-文件消息;5-视频消息;6-系统提示消息;100-自定义消息;110-机器人答案;111-机器人答案反馈;112-超时关闭前提醒;113-超时关闭提醒;114-工单流程消息;115-富文本消息;116-敏感词屏蔽消息
autoReplytinyint(4)消息回复类型0=手动1=自动
msgvarchar(10240)消息体或为空
statustinyint(2)消息状态1-正常, 2-已撤回
isRichMediatinyint(4)是否富媒体类型消息类型为:2-图片消息;3-语音消息;4-文件消息;5-视频消息;115-富文本消息,值为1,其他为0

【网易七鱼】API开发者 微信交流群

用微信扫右侧二维码,加入【网易七鱼】API开发者 交流群,互助沟通

扫码加入交流群
修改于 2022-01-25 06:30:05
上一页
接口地址
下一页
一、 业务流程说明
Built with