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

在线会话获取用户信息

POST
/get_user_info
网易七鱼系统在需要获取访客详细信息时,会调用该接口。该接口请求类型不同于token,前端会自动发送两次请求,第一次的请求类型是OPTION,第二次的请求类型是POST,且POST提交数据的方式为application/json。
返回的数据将显示在“当前会话”中右侧用户资料区的“更多信息”标签页下,以及“历史会话”中右侧会话详情区的“更多信息”标签页下。
用户的唯一性标识会被作为请求内容 POST 到该接口。
请求参数:
注意:userid来源于用户发起会话时,调用各端 SDK 的初始化代码时传递给网易七鱼系统的参数中。
**备注:**平台电商中的用户信息对接参数将增加shopid,获取对应商户下的用户信息。
返回参数:
其中data字段用一个数组描述用户的详细信息,数组中每个元素代表一个数据项。数据项以<key, value>对的形式为基础,增加了额外的字段以控制显示样式。
注意: 返回的数据将根据预设的样式直接显示在网易七鱼页面相应的位置上。如果数据敏感、保密性要求高,应当在返回时就做脱敏处理。网易七鱼系统不会对数据做额外的处理。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://qiyukf.com/get_user_info' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appid": "qiyukf",
    "token": "qiyukf_security_token",
    "userid": "zhangsan",
    "staffphone": "057189850000"
}'
响应示例响应示例
{
    "rlt": 0,
    "uid": "zhangsan",
    "data": [
        {
            "index": 0,
            "key": "account",
            "label": "账号",
            "value": "zhangsan",
            "href": "url"
        },
        {
            "index": 1,
            "key": "name",
            "label": "姓名",
            "value": "土豪",
            "edit": true,
            "map": "real_name",
            "href": "url"
        },
        {
            "index": 2,
            "key": "phone",
            "label": "手机",
            "value": "13800000000",
            "edit": true,
            "map": "mobile_phone",
            "href": "url"
        },
        {
            "index": 3,
            "key": "email",
            "label": "EMail",
            "value": "13800000000@163.com",
            "edit": true,
            "map": "email",
            "href": "url"
        },
        {
            "index": 4,
            "key": "vip",
            "label": "会员",
            "value": [
                {
                    "id": 0,
                    "name": "类型一"
                },
                {
                    "id": 1,
                    "name": "类型三",
                    "check": true
                },
                {
                    "id": 2,
                    "name": "类型二"
                }
            ],
            "select": true
        }
    ],
    "modify_cb": "url"
}

请求参数

Body 参数application/json
appid
string 
必需
企业分配给网易七鱼系统的 appid。
token
string 
必需
当前有效的 token。
userid
string 
用户的唯一性标识。
必需
staffphone
string 
可选
企业和用户联系时使用的中继号码。
示例

返回响应

🟢200成功
application/json
Body
rlt
integer 
必需
表明接口调用是否成功。值为0时表示接口调用成功。关于错误码的详细描述,见Appendix I节。
uid
string 
可选
get_call_user_info接口返回该字段,用于将同一用户手机号和uid关联,打通呼叫和在线历史咨询记录
data
array [object {8}] 
必需
用一个数组表示用户详细信息的数据。
index
integer 
可选
用于排序,显示数据时数据项按index值升序排列;不设定index的数据项将排在后面;index相同或未设定的数据项将按照其在 JSON 中出现的顺序排列。
key
string 
必需
数据项的名称,用于区别不同的数据。特别地,如果该数据可编辑(见edit字段说明),key将作为请求的内容提交给回调接口。
label
string 
必需
该项数据显示的名称。
value
array [object {3}] 
必需
该数据显示的值,类型不做限定,根据实际需要进行设定。
href
string 
可选
超链接地址。若指定该值,则该项数据将显示为超链接样式,点击后跳转到其值所指定的 URL 地址。
edit
boolean 
可选
表示该项数据是否可编辑,true为可编辑,false为不可编辑。可编辑时该项数据的值将显示在一个输入框内,内容被编辑后将调用modify_cb接口提交更新。
map
string 
可选
表明该项数据是否与网易七鱼系统中固定的数据项有映射关系。如真实姓名为real_name,手机号为mobile_phone,电子邮箱为email。如果一个数据项指定了正确的map值,则该数据也会同步显示在“当前会话”中右侧用户资料区的“用户资料”标签页下对应的项目中,以及“历史会话”中右侧会话详情区的“用户资料”标签页下对应的项目中。
select
boolean 
可选
用于标识该项数据是否为select下拉框。true表示该项数据为select下拉框的形式,且当select选项为true时,value字段应该为一个数组的形式(可以在value中指定初始化check为true的默认选中现,如果没指定则默认选中第一项)。
modify_cb
string 
可选
如果企业希望客服可以在网易七鱼系统中更新客户的信息,则在此提供一个接口的地址,用于客户信息修改后回调。接口定义见下。

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

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

扫码加入交流群
上一页
获取 token
下一页
呼叫中心获取电话用户信息
Built with