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

SDK 事件

qiConnect对象提供了一系列事件监听功能,通过qiConnect.on({ [eventType]:[eventHandler] })进行注册。
注意: SDK事件操作需要在sdk脚本加载完成后才能注册监听。
事件 eventType说明
onload加载成功
session会话开始
answered会话接通
byeFailed通话挂断失败
sessionClose会话结束
statusOptionsChanged状态可选项变更
statusChanged状态设置成功
statusChangeFailed状态设置失败

加载完成 onload#

工具条加载完成后,可进行面板操作或调用SDK方法。
使用方式#
qiConnect.on({onload: function(){
    // other code ……
}});

会话开始事件 session#

呼叫会话的创建事件,包括外呼和呼入。监听该事件可获取当前会话信息。
使用方式#
qiConnect.on({session: function(data){
    // other code ……
}});
data字段#
名称类型含义
sessionidNumber会话id
addressString号码归属地
usernumberNumber客户号码
staffnumberNumber坐席号码
staffidNumber坐席id
staffnameString坐席名
directionNumber会话方向 1 呼入 2 呼出
ivrpathnameStringIVR路径名称 格式:节点名称1-节点名称2……-节点名称N

会话结束事件 sessionClose#

呼叫会话的结束事件,包括呼出和呼入。监听该事件可获取当前会话信息。
使用方式#
qiConnect.on({sessionClose: function(data){
    // other code ……
}});
data字段#
名称类型含义
addressNumber号码归属地
usernumberNumber客户号码
sessionidNumber会话id
staffidNumber
staffnameNumber坐席名

会话接通事件 answered#

表示会话双发已准备就绪,可以开始通话。当呼叫会话为呼入时,坐席接起电话后触发的事件 或者 当呼叫会话为呼出时,被外呼客户接起后触发的事件。监听该事件可获取当前会话的拨号方式和接起方式。
使用方式#
qiConnect.on({ answered: function(data){
    // other code ……
}});
data字段#
名称类型含义
directionString"IN" 呼入通话 "OUT" 外呼通话
typeString"SIP" sip话机 "AUTOANSWER" 自动应答 "CALLPANEL" 面板点击 "" 外呼通话接起类型未知

通话挂断失败事件 byeFailed#

当执行挂断通话的操作失败后触发,如当前处于非通话状态时,调用了bye()方法,故建议在有answered事件相应后调用bye()方法。监听该事件可获取失败原因。
使用方式#
qiConnect.on({ byeFailed: function(data){
    // other code ……
}});
data字段#
名称类型含义
hasErrorBoolean是否有错误
causeString挂断失败的具体原因

坐席可选状态变更事件 statusOptionsChanged#

坐席可选状态变更事件,当软电话、SIP话机、手机在线等服务模式发生变更时,伴随着坐席可用状态的变更,此事件会通知变更信息。
使用方式#
qiConnect.on({statusOptionsChanged: function(data){
    // other code ……
}});
data字段#
名称类型含义
statusArray当前状态
statusOptionsArray可选状态选项

坐席状态设置成功事件 statusChanged#

坐席状态设置成功事件,工具条坐席当前状态发生变更,此事件会通知变更成功的状态。
使用方式#
qiConnect.on({statusChanged: function(data){
    // other code ……
}});
data字段#
名称类型含义
statusArray当前设置的状态

坐席状态设置失败事件 statusChangeFailed#

坐席状态设置失败事件,此事件会通知变更失败的状态以及失败原因。
使用方式#
qiConnect.on({statusChangeFailed: function(data){
    // other code ……
}});
data字段#
名称类型含义
statusArray设置的状态
errorMsgstring失败信息

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

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

扫码加入交流群
上一页
初始化 SDK
下一页
SDK 方法
Built with