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

客户导入

POST
https://qiyukf.com/openapi/crm/syncCrmInfo
该接口是针对呼叫中心的用户数据设计的,所以phone参数为必须且真实有效的数据。调用该接口需要使用appkey和appsecret,该参数在“管理后台->系统->扩展与集成->开发者ID”中获取。首次进入信息对接页面时,开发者ID中只有appkey,appsecret项只有一个“重置”按钮,点击之后会第一次生产appsecret,之后再次点击就是刷新appsecret。 *开发者ID信息一般用于消息接口,只有专业版及以上才有此模块。
调用说明
本接口只支持POST请求;
本接口请求Content-Type类型为:application/json;charset=utf-8;
本接口返回类型为JSON,同时进行UTF-8编码。
数据校验
参考通用说明-数据校验
接口参数说明
使用该接口可以批量更新客户中心中的客户资料,支持批量新增、修改、删除客户资料。
请求参数说明如下:
更新JSON参数中必须包含update或delete子元素其一。phone作为客户资料的唯一标识,如果系统中不存在phone对应的客户,则执行新增操作,否则执行更新操作。update中不允许存在两条phone一样的客户资料。在「客户信息字段」中配置了的,并且启用、显示的字段可以作为扩展字段,以「字段名称」作为属性名,如plateNumber参数。若未提前配置并启用,在导入数据后将查看不到对应的扩展字段(因为在调用接口导入过程中,服务端会直接忽略这些数据)。如果扩展字段在「客户信息字段」中配置的字段类型是时间控件,则值必须为毫秒数,如firstContactTime,如果字段类型是数字,则值必须为数字。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://qiyukf.com/openapi/crm/syncCrmInfo?appKey=&time=&checksum=' \
--header 'Content-Type: application/json' \
--data-raw '{
   "update":
   [{
      "name":"周明月",
      "foreignId":"userId",
      "phone":"13725698555",
      "email":"mingyue@163.com",
      "address":"河南省开封市祥符区范庄村",
      "leader":-1,
      "firstContactTime":1483009843582,
      "lastContactTime":1483957441234,
      "plateNumber":"豫BWD001"
   },{
      "name":"鲁城",
      "foreignId":"userId",
      "phone":"13725698666",
      "email":"lucheng@163.com",
      "address":"河南省开封市祥符区范庄村",
      "leader":124548,
      "firstContactTime":1483009963521,
      "lastContactTime":1483957965821,
      "plateNumber":"豫BWD002"
   }],
   "delete":
   [{
      "phone":"13725698001"
   }, {
      "phone":"13725698002"
   }]
}'
响应示例响应示例
{
    "code": "string",
    "message": "string"
}

请求参数

Query 参数
appKey
string 
必需
企业的appKey,1064deea1c3624c9ee26d1de5ce8481f
默认值:
{{appKey}}
time
string 
必需
当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数,1463217187
默认值:
{{time}}
checksum
string 
必需
SHA1(appSecret + md5 + time), 三个参数拼接的字符串,进行SHA1哈希计算,转化成16进制字符(String,小写).示例2f13932c4b7c6888b12360a85261a11b8b543f64
默认值:
{{checksum}}
Body 参数application/json
update
array [object {9}] 
需要更新的客户信息
可选
name
string 
必需
访客姓名,更新时必须传
foreignId
string 
可选
用户的uid,如果传了,则作为客户资料的唯一标识,否则使用 phone 作为唯一标识
phone
string 
必需
email
string 
访客邮箱
可选
address
string 
地址
可选
leader
integer 
可选
负责人客服ID,可在在线系统->设置->会话流程->访客分配->分配规则->ID查询处查询。如果要清除负责人,设置值为-1
firstContactTime
integer 
可选
首次联系时间,必须为毫秒数
lastContactTime
integer 
可选
末次联系时间,必须为毫秒数
plateNumber
string 
作为自定义扩展字段
可选
delete
array [object {1}] 
需要删除的客户信息
可选
phone
string 
必需
电话号码,没有传 foreignId 时做为客户资料的唯一标识
示例

返回响应

🟢200成功
application/json
Body
code
string 
必需
错误码。200表示设置成功。
message
string 
错误提示信息
必需

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

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

扫码加入交流群
上一页
接口示例
下一页
创建客服
Built with