# 网易七鱼 API ## Docs - [概述](https://apifox.com/apidoc/docs-site/605287/doc-436970.md): - 通用说明 [数据校验](https://apifox.com/apidoc/docs-site/605287/doc-436971.md): - 通用说明 [通用错误码列表](https://apifox.com/apidoc/docs-site/605287/doc-436972.md): - 通用说明 > 服务端登录 [服务端登录](https://apifox.com/apidoc/docs-site/605287/doc-436973.md): - CRM 对接 [概述](https://apifox.com/apidoc/docs-site/605287/doc-436974.md): - CRM 对接 [文档约定](https://apifox.com/apidoc/docs-site/605287/doc-436975.md): - CRM 对接 [对接方式对比与建议](https://apifox.com/apidoc/docs-site/605287/doc-436976.md): - CRM 对接 [Appendix I 错误码](https://apifox.com/apidoc/docs-site/605287/doc-436977.md): - CRM 对接 > 轻量 CRM 对接 [概述](https://apifox.com/apidoc/docs-site/605287/doc-436978.md): - CRM 对接 > 轻量 CRM 对接 [Web SDK 调用](https://apifox.com/apidoc/docs-site/605287/doc-436979.md): - CRM 对接 > 轻量 CRM 对接 [iOS SDK 调用](https://apifox.com/apidoc/docs-site/605287/doc-436980.md): - CRM 对接 > 轻量 CRM 对接 [Android SDK 调用](https://apifox.com/apidoc/docs-site/605287/doc-436981.md): - CRM 对接 > 轻量 CRM 对接 [参数说明](https://apifox.com/apidoc/docs-site/605287/doc-436982.md): - CRM 对接 > CRM 接口对接 [概述](https://apifox.com/apidoc/docs-site/605287/doc-436983.md): - CRM 对接 > CRM 接口对接 [跨域访问](https://apifox.com/apidoc/docs-site/605287/doc-436984.md): - CRM 对接 > CRM 接口对接 [接口认证方式](https://apifox.com/apidoc/docs-site/605287/doc-436985.md): - CRM 对接 > CRM 接口对接 [访客身份识别](https://apifox.com/apidoc/docs-site/605287/doc-436986.md): - CRM 对接 > CRM 接口对接 [自定义接口参数](https://apifox.com/apidoc/docs-site/605287/doc-436987.md): - CRM 对接 > 七鱼用户认证机制 [概述](https://apifox.com/apidoc/docs-site/605287/doc-436988.md): - CRM 对接 > 七鱼用户认证机制 [术语](https://apifox.com/apidoc/docs-site/605287/doc-436989.md): - CRM 对接 > 七鱼用户认证机制 [认证过程](https://apifox.com/apidoc/docs-site/605287/doc-436990.md): - CRM 对接 > 七鱼用户认证机制 [实施流程](https://apifox.com/apidoc/docs-site/605287/doc-436991.md): - CRM 对接 > 七鱼用户认证机制 [授权接口](https://apifox.com/apidoc/docs-site/605287/doc-436992.md): - CRM 对接 > 七鱼用户认证机制 [认证接口](https://apifox.com/apidoc/docs-site/605287/doc-436993.md): - CRM 对接 > 七鱼用户认证机制 [版本支持](https://apifox.com/apidoc/docs-site/605287/doc-436994.md): - CRM 对接 > 七鱼用户认证机制 [示例代码](https://apifox.com/apidoc/docs-site/605287/doc-436995.md): - CRM 对接 > 七鱼用户认证机制 [注意事项](https://apifox.com/apidoc/docs-site/605287/doc-436996.md): - iframe 对接 [展示效果](https://apifox.com/apidoc/docs-site/605287/doc-436997.md): - iframe 对接 [展示区域](https://apifox.com/apidoc/docs-site/605287/doc-436998.md): - iframe 对接 [参数配置](https://apifox.com/apidoc/docs-site/605287/doc-436999.md): - iframe 对接 [样例](https://apifox.com/apidoc/docs-site/605287/doc-437000.md): - 客户管理 [客户信息变更事件](https://apifox.com/apidoc/docs-site/605287/doc-437001.md): - 客户管理 > 客户标签 [概览](https://apifox.com/apidoc/docs-site/605287/doc-437002.md): - 客户管理 > 客户导出 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437003.md): - 客户管理 > 客户导出 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437004.md): - 客户管理 > 客户导出 [接口示例](https://apifox.com/apidoc/docs-site/605287/doc-437005.md): - 客户管理 > 客户导出 [接口访问步骤](https://apifox.com/apidoc/docs-site/605287/doc-437006.md): - 客户管理 > 获取用户服务记录 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437007.md): - 客户管理 > 获取用户服务记录 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437008.md): - 客户管理 > 获取用户服务记录 [接口示例](https://apifox.com/apidoc/docs-site/605287/doc-437009.md): - 在线系统 > 接口消息 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437010.md): - 在线系统 > 接口消息 [调用流程](https://apifox.com/apidoc/docs-site/605287/doc-437011.md): - 在线系统 > 接口消息 [调用说明](https://apifox.com/apidoc/docs-site/605287/doc-437012.md): - 在线系统 > 接口消息 [数据校验](https://apifox.com/apidoc/docs-site/605287/doc-437013.md): - 在线系统 > 接口消息 [设置接收事件地址](https://apifox.com/apidoc/docs-site/605287/doc-437014.md): - 在线系统 > 接口消息 [常见错误码](https://apifox.com/apidoc/docs-site/605287/doc-437015.md): - 在线系统 > 消息收发 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437016.md): - 在线系统 > 数据接口 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437017.md): - 在线系统 > 订单绩效对接 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437018.md): - 在线系统 > 订单绩效对接 [数据同步流程](https://apifox.com/apidoc/docs-site/605287/doc-437019.md): - 在线系统 > 订单绩效对接 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437020.md): - 在线系统 > 订单绩效对接 [订单属性](https://apifox.com/apidoc/docs-site/605287/doc-437021.md): - 在线系统 > 订单绩效对接 [示例](https://apifox.com/apidoc/docs-site/605287/doc-437022.md): - 在线系统 > 获取会话记录 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437023.md): - 在线系统 > 获取会话记录 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437024.md): - 在线系统 > 获取会话记录 [接口示例](https://apifox.com/apidoc/docs-site/605287/doc-437025.md): - 在线系统 > 获取会话记录 [接口访问步骤](https://apifox.com/apidoc/docs-site/605287/doc-437026.md): - 在线系统 > 获取会话记录 [接口地址](https://apifox.com/apidoc/docs-site/605287/doc-437027.md): - 在线系统 > 获取会话记录 [字段说明](https://apifox.com/apidoc/docs-site/605287/doc-437028.md): - 在线系统 > 商品、订单查询 [一、 业务流程说明](https://apifox.com/apidoc/docs-site/605287/doc-437029.md): - 在线系统 > 商品、订单查询 [二、访客端样式](https://apifox.com/apidoc/docs-site/605287/doc-437030.md): - 在线系统 > 商品、订单查询 [三、接口定义](https://apifox.com/apidoc/docs-site/605287/doc-437031.md): - 呼叫系统 > 呼叫时间对接 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437032.md): - 呼叫系统 > 呼叫时间对接 [数据校验](https://apifox.com/apidoc/docs-site/605287/doc-437033.md): - 呼叫系统 > 呼叫时间对接 [调用说明](https://apifox.com/apidoc/docs-site/605287/doc-437034.md): - 呼叫系统 > 呼叫时间对接 [curl请求样例如下](https://apifox.com/apidoc/docs-site/605287/doc-437035.md): - 呼叫系统 > 呼叫时间对接 [第三方接口需返回的数据的说明](https://apifox.com/apidoc/docs-site/605287/doc-437036.md): - 呼叫系统 > 呼叫时间对接 [第三方接口样例](https://apifox.com/apidoc/docs-site/605287/doc-437037.md): - 呼叫系统 > 外呼任务 > 创建外呼任务 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437038.md): - 呼叫系统 > 呼叫工具条 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437039.md): - 呼叫系统 > 呼叫工具条 [初始化 SDK](https://apifox.com/apidoc/docs-site/605287/doc-437040.md): - 呼叫系统 > 呼叫工具条 [SDK 事件](https://apifox.com/apidoc/docs-site/605287/doc-437041.md): - 呼叫系统 > 呼叫工具条 [SDK 方法](https://apifox.com/apidoc/docs-site/605287/doc-437042.md): - 呼叫系统 > 外呼机器人 [外呼机器人事件对接](https://apifox.com/apidoc/docs-site/605287/doc-437043.md): - 机器人 [服务先知-常见问题](https://apifox.com/apidoc/docs-site/605287/doc-437044.md): - 机器人 [服务先知-快捷短语](https://apifox.com/apidoc/docs-site/605287/doc-437045.md): - 机器人 > 一触即达 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437046.md): - 机器人 > 一触即达 [对接方式](https://apifox.com/apidoc/docs-site/605287/doc-437047.md): - 机器人 > 一触即达 [对接示例](https://apifox.com/apidoc/docs-site/605287/doc-437048.md): - 机器人 > 一触即达 [Velocity语法赋值](https://apifox.com/apidoc/docs-site/605287/doc-437049.md): - 机器人 > 一触即达 [移动SDK接入指南](https://apifox.com/apidoc/docs-site/605287/doc-437050.md): - 机器人 > 知识库管理 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437051.md): - 机器人 > 会话评价 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437052.md): - 机器人 > 统计接口 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437053.md): - 机器人 > 消息接口 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437054.md): - 机器人 > 消息接口 [概念/名词解释](https://apifox.com/apidoc/docs-site/605287/doc-437055.md): - 机器人 > 消息接口 [接口通用说明](https://apifox.com/apidoc/docs-site/605287/doc-437056.md): - 机器人 > 消息接口 [对接场景示例](https://apifox.com/apidoc/docs-site/605287/doc-437057.md): - 机器人 > 消息接口 > 会话类接口 [会话类接口](https://apifox.com/apidoc/docs-site/605287/doc-437058.md): - 工单系统 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437059.md): - 工单系统 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437060.md): - 工单系统 [接口协议](https://apifox.com/apidoc/docs-site/605287/doc-437061.md): - 工单系统 [错误码](https://apifox.com/apidoc/docs-site/605287/doc-437062.md): - 工单系统 > 工单推送 [说明](https://apifox.com/apidoc/docs-site/605287/doc-437063.md): - 工单系统 > 工单推送 [请求体说明](https://apifox.com/apidoc/docs-site/605287/doc-437064.md): - 工单系统 > 工单自定义字段同步 [基本用法](https://apifox.com/apidoc/docs-site/605287/doc-437065.md): - 短信 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437066.md): - 平台电商（Platform OpenAPI） [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437067.md): - 平台电商（Platform OpenAPI） [接口协议](https://apifox.com/apidoc/docs-site/605287/doc-437068.md): - 平台电商（Platform OpenAPI） > 获取会话记录 [概述](https://apifox.com/apidoc/docs-site/605287/doc-437069.md): - 平台电商（Platform OpenAPI） > 获取会话记录 [接口鉴权](https://apifox.com/apidoc/docs-site/605287/doc-437070.md): - 平台电商（Platform OpenAPI） > 获取会话记录 [接口示例](https://apifox.com/apidoc/docs-site/605287/doc-437071.md): - 平台电商（Platform OpenAPI） > 获取会话记录 [接口访问步骤](https://apifox.com/apidoc/docs-site/605287/doc-437072.md): - 平台电商（Platform OpenAPI） > 获取会话记录 [字段说明](https://apifox.com/apidoc/docs-site/605287/doc-437073.md): ## API Docs - 通用说明 > 服务端登录 [获取SDK接入地址](https://apifox.com/apidoc/docs-site/605287/api-10845434.md): 第三方向七鱼请求`SDK`接入地址的时候，七鱼会执行客服在七鱼的登录事件，并生成含动态口令的`SDK`接入地址返回给第三方 - CRM 对接 > CRM 接口对接 [获取 token](https://apifox.com/apidoc/docs-site/605287/api-10845435.md): 与其他接口不同，获取 token 接口为 GET 请求。该接口由网易七鱼系统后端服务器调用，并根据返回的有效期决定调用时机。 - CRM 对接 > CRM 接口对接 [在线会话获取用户信息](https://apifox.com/apidoc/docs-site/605287/api-10845436.md): 网易七鱼系统在需要获取访客详细信息时，会调用该接口。该接口请求类型不同于token，前端会自动发送两次请求，第一次的请求类型是OPTION，第二次的请求类型是POST，且POST提交数据的方式为`application/json`。 - CRM 对接 > CRM 接口对接 [呼叫中心获取电话用户信息](https://apifox.com/apidoc/docs-site/605287/api-10845437.md): 网易七鱼系统在需要获取访客详细信息时，会调用该接口。该接口请求类型不同于token，前端会自动发送两次请求，第一次的请求类型是OPTION，第二次的请求类型是POST，且POST提交数据的方式为`application/json`。 - CRM 对接 > CRM 接口对接 [更新用户信息](https://apifox.com/apidoc/docs-site/605287/api-10845438.md): 用户的唯一性标识和被修改的信息会被作为请求内容 POST 到该接口，与获取信息不一样的是，更新类接口POST提交数据的方式为`application/x-www-form-urlencoded`。 - CRM 对接 > CRM 接口对接 [在线会话获取用户订单信息](https://apifox.com/apidoc/docs-site/605287/api-10845439.md): 网易七鱼系统在调用获取访客详细信息接口`/get_user_info`时，会调用该接口。该接口企业在发送请求时，前端会自动发送两遍，第一遍的请求类型是OPTION，第二遍的请求类型是POST，提交数据方式采用`application/json`的方式。该接口可用于电商行业订单类信息，也可以用于金融行业交易类信息。 - CRM 对接 > CRM 接口对接 [呼叫中心获取用户订单信息](https://apifox.com/apidoc/docs-site/605287/api-10845440.md): 网易七鱼系统在调用获取访客详细信息接口`/get_user_info`时，会调用该接口。该接口企业在发送请求时，前端会自动发送两遍，第一遍的请求类型是OPTION，第二遍的请求类型是POST，提交数据方式采用`application/json`的方式。该接口可用于电商行业订单类信息，也可以用于金融行业交易类信息。 - CRM 对接 > CRM 接口对接 [更新订单信息](https://apifox.com/apidoc/docs-site/605287/api-11028998.md): 订单用户的唯一标识和被修改的信息会被作为请求内容 POST 到该接口，与获取信息不一样的是，更新类接口POST提交数据的方式为`application/x-www-form-urlencoded`。 - 客户管理 > 客户标签 [获取客户标签信息](https://apifox.com/apidoc/docs-site/605287/api-10845443.md): 该接口由七鱼提供。通过该接口可以获取所有访客标签信息。第三方在获取到访客标签信息后，需要将标签信息存储到本地库中，以便后续标签信息同步时可以快速根据标签id找到对应标签名字。标签同步事件中传递的信息，只有标签id，没有标签名字。 - 客户管理 > 客户标签 [修改客户标签](https://apifox.com/apidoc/docs-site/605287/api-10845444.md): foreignid 和 mobile 两者必传其中之一，如果两个都传，则以 foreignid 为准。 - 客户管理 > 客户标签 [批量修改客户标签](https://apifox.com/apidoc/docs-site/605287/api-10845445.md): 该接口由七鱼提供。当有大量的用户标签需要同步到七鱼系统的访客数据时，可以调用该接口，提高更新效率。 - 客户管理 > 客户标签 [客户标签变更事件](https://apifox.com/apidoc/docs-site/605287/api-10845446.md): - 客户管理 [客户导入](https://apifox.com/apidoc/docs-site/605287/api-10845442.md): 该接口是针对呼叫中心的用户数据设计的，所以phone参数为必须且真实有效的数据。调用该接口需要使用appkey和appsecret，该参数在“管理后台->系统->扩展与集成->开发者ID”中获取。首次进入信息对接页面时，开发者ID中只有appkey，appsecret项只有一个“重置”按钮，点击之后会第一次生产appsecret，之后再次点击就是刷新appsecret。 *开发者ID信息一般用于消息接口，只有专业版及以上才有此模块。 - 员工管理 > 客服管理 [创建客服](https://apifox.com/apidoc/docs-site/605287/api-10845447.md): 错误码说明如下： - 员工管理 > 客服管理 [修改客服](https://apifox.com/apidoc/docs-site/605287/api-10845448.md): 错误码说明如下： - 员工管理 > 客服管理 [删除客服](https://apifox.com/apidoc/docs-site/605287/api-10845449.md): 该接口不支持对企业超级管理员进行删除。 - 员工管理 > 客服管理 [获取客服列表](https://apifox.com/apidoc/docs-site/605287/api-10845450.md): - 员工管理 > 客服管理 [查询单个客服信息](https://apifox.com/apidoc/docs-site/605287/api-10845451.md): 该接口可用于获取单个客服的相关信息，请求参数为客服 ID，返回客服的详细信息字段。 - 员工管理 > 客服组管理 [创建客服组](https://apifox.com/apidoc/docs-site/605287/api-10845452.md): - 员工管理 > 客服组管理 [修改客服组](https://apifox.com/apidoc/docs-site/605287/api-10845453.md): - 员工管理 > 客服组管理 [删除客服组](https://apifox.com/apidoc/docs-site/605287/api-10845454.md): - 员工管理 > 客服组管理 [分配客服到客服组](https://apifox.com/apidoc/docs-site/605287/api-10845455.md): 使用该接口可以分配多个客服到指定分组。 - 员工管理 > 客服组管理 [获取客服组列表](https://apifox.com/apidoc/docs-site/605287/api-10845456.md): - 员工管理 > 客服组管理 [获取客服组下员工列表](https://apifox.com/apidoc/docs-site/605287/api-10845457.md): - 在线系统 > 消息收发 [给七鱼发送消息-文本消息](https://apifox.com/apidoc/docs-site/605287/api-10845464.md): 目前仅支持开发者服务器替用户向客服发送消息。 - 在线系统 > 消息收发 [给七鱼发送消息-图片消息](https://apifox.com/apidoc/docs-site/605287/api-10845465.md): 目前仅支持开发者服务器替用户向客服发送消息。 - 在线系统 > 消息收发 [给七鱼发送消息-语音消息](https://apifox.com/apidoc/docs-site/605287/api-10845466.md): 目前仅支持开发者服务器替用户向客服发送消息。 - 在线系统 > 消息收发 [接收七鱼消息](https://apifox.com/apidoc/docs-site/605287/api-10845467.md): 当客服（人工或者机器人）回复消息后，七鱼平台会把消息推送给开发者。推送地址是开发者在七鱼管理后台->系统->扩展与集成->开发者ID处，填写的消息与事件接收URL。 - 在线系统 > 消息收发 [上传文件-MultiPart 方式](https://apifox.com/apidoc/docs-site/605287/api-10845468.md): 我们提供了两种上传文件的方式，一种是 MultiPart 方式，一种是发送文件内容 base64 运算后的字符串的方式。 上传文件时，同样需要计算checksum，在这两种上传方式中，计算 checksum 的 md5 均为文件内容的 md5 的小写。 两种方式对于文件大小限制均为 **5M**。 - 在线系统 > 消息收发 [上传文件-base64 方式](https://apifox.com/apidoc/docs-site/605287/api-10845469.md): 我们提供了两种上传文件的方式，一种是 MultiPart 方式，一种是发送文件内容 base64 运算后的字符串的方式。 上传文件时，同样需要计算checksum，在这两种上传方式中，计算 checksum 的 md5 均为文件内容的 md5 的小写。 两种方式对于文件大小限制均为 **5M**。 - 在线系统 > 事件 [请求分配客服](https://apifox.com/apidoc/docs-site/605287/api-10845470.md): 分配客服的逻辑如下，按照优先级从高到低匹配： - 在线系统 > 事件 [客服组排队情况查询](https://apifox.com/apidoc/docs-site/605287/api-10845471.md): 该接口提供开放能力，企业可以根据客服组id查询该客服组是否有客服在线和是否需要排队。 - 在线系统 > 事件 [更新用户资料](https://apifox.com/apidoc/docs-site/605287/api-10845472.md): 使用该接口可以更新用户的详细资料，并展示在客服会话界面的右上侧「用户资料」tab页看到。具体的数据格式定义可参见[轻量CRM对接参数说明](http://qiyukf.com/docs/guide/crm/qiyu_crm_interface.html#参数说明)。 - 在线系统 > 事件 [获取评价设置](https://apifox.com/apidoc/docs-site/605287/api-10845473.md): 该接口由七鱼提供给第三方调用，用于第三方自己实现满意度评价功能并与七鱼系统进行对接的方式。满意度评价选项配置在七鱼管理后台设置，第三方可以通过该接口拉取该配置，并自己实现用户信息评价功能。评价完成之后，第三方调用下面用户评价接口将评价结果同步给七鱼系统。 - 在线系统 > 事件 [评价客服](https://apifox.com/apidoc/docs-site/605287/api-10845474.md): 该接口允许用户对当前评价当前客服服务的满意度，满意度评价模型数据 evaluationModel 在请求分配客服接口中返回。根据 evaluationModel 中的 list 数组显示满意度评价项，name 为评价项名称，value 为对应评价值，用户选择某评价项时，将对应 value 值作为下面接口参数 evaluation 的参数值。 - 在线系统 > 事件 [查询排队状态](https://apifox.com/apidoc/docs-site/605287/api-10845475.md): - 在线系统 > 事件 [主动退出排队](https://apifox.com/apidoc/docs-site/605287/api-10845476.md): 如果一个用户已经在排队中，他可以选择主动退出排队，以便继续和机器人会话。通过提示用户自己退出排队，也可以减轻客服的压力。 - 在线系统 > 事件 [接收会话开始通知](https://apifox.com/apidoc/docs-site/605287/api-10845477.md): 当客服主动发起会话时，或者由其他会话转接时，开发者服务器会收到此通知。目前只有人工会话会收到通知，机器人会话开始不会发送通知。 - 在线系统 > 事件 [接收会话结束通知](https://apifox.com/apidoc/docs-site/605287/api-10845478.md): 会话结束后，开发者服务器会收到此通知。 - 在线系统 > 事件 [接收客服主动邀评通知](https://apifox.com/apidoc/docs-site/605287/api-10845479.md): 为了提高用户参评率，七鱼为客服增加了主动邀请用户评价会话的入口。对于使用消息接口的企业，此处相应的增加了一种事件类型通知，通知事件类型为：`EVA_INVITATION`。 客服主动邀评后，开发者服务器会收到如下POST请求 - 在线系统 > 事件 [接收用户进入排队通知](https://apifox.com/apidoc/docs-site/605287/api-10845480.md): 如果用户通过在机器人会话中直接发送rg请求人工客服转到排队，或者直接发送消息，也可能会触发进入人工，导致排队。通过处理这个通知，应用服务器可以更准确的知道用户当前的服务状态。 注意，如果是通过申请客服接口进入排队，不会触发这个通知。 触发后，开发者服务器会收到如下POST请求 - 在线系统 > 事件 [接收用户离开排队通知](https://apifox.com/apidoc/docs-site/605287/api-10845481.md): 在用户离开排队，包括超时退出，主动退出时，开发者服务器会收到该通知。 - 在线系统 > 事件 [会话结束推送会话数据](https://apifox.com/apidoc/docs-site/605287/api-10845482.md): - 在线系统 > 事件 [接收会话变更信息通知](https://apifox.com/apidoc/docs-site/605287/api-10845483.md): 支持修改后实时推的字段：会话分类信息、评价结果、评价内容、会话备注、在线服务记录字段、会话状态。 - 在线系统 > 事件 [接收会话质检事件通知](https://apifox.com/apidoc/docs-site/605287/api-10845484.md): - 在线系统 > 消息推送 [消息推送-发送文本时](https://apifox.com/apidoc/docs-site/605287/api-10845485.md): 采用iOS和Android端接入的企业，可以通过该接口，向访客手机推动消息，访客手机端查看消息并回复后，会触发生成新的会话。以此增强企业主动营销能力。 - 在线系统 > 消息推送 [消息推送-发送图片时](https://apifox.com/apidoc/docs-site/605287/api-10845486.md): 采用iOS和Android端接入的企业，可以通过该接口，向访客手机推动消息，访客手机端查看消息并回复后，会触发生成新的会话。以此增强企业主动营销能力。 - 在线系统 > 消息推送 [消息推送-发送富文本时](https://apifox.com/apidoc/docs-site/605287/api-10845487.md): 采用iOS和Android端接入的企业，可以通过该接口，向访客手机推动消息，访客手机端查看消息并回复后，会触发生成新的会话。以此增强企业主动营销能力。 - 在线系统 > 数据接口 [实时数据报表](https://apifox.com/apidoc/docs-site/605287/api-10845489.md): - 在线系统 > 数据接口 [客服质量报表](https://apifox.com/apidoc/docs-site/605287/api-10845490.md): 提供在线系统->历史数据->坐席报表->工作质量报表，推荐查询周期在一个月（31天）内的数据 - 在线系统 > 数据接口 [客服考勤报表](https://apifox.com/apidoc/docs-site/605287/api-10845491.md): 提供在线系统->历史数据->坐席报表->考勤报表，推荐查询周期在一个月（31天）内的数据，默认只查询所传参数获取数据的前100条数据，若想获取全部客服或客服组的数据，请分批次传客服/客服组 接口使用说明 - 在线系统 > 数据接口 [客服考勤明细](https://apifox.com/apidoc/docs-site/605287/api-10845492.md): 提供在线系统->历史数据->坐席报表->考勤报表->考勤明细，单个客服一天的考勤详情。 接口使用说明 - 在线系统 > 数据接口 [历史数据总览](https://apifox.com/apidoc/docs-site/605287/api-10845493.md): 提供在线系统->历史数据->总览。默认查询31天内数据之和 接口使用说明 - 在线系统 > 数据接口 [客服工作量报表](https://apifox.com/apidoc/docs-site/605287/api-10845494.md): 提供在线系统->历史数据->坐席报表->工作量。默认查询31天内数据之和 - 在线系统 > 数据接口 [客服满意度报表](https://apifox.com/apidoc/docs-site/605287/api-10845495.md): 提供客服维度的满意度报表数据。默认查询31天内数据之和 - 在线系统 > 订单绩效对接 [上传订单信息接口](https://apifox.com/apidoc/docs-site/605287/api-10845496.md): - 在线系统 > 订单绩效对接 [订单绩效导出接口](https://apifox.com/apidoc/docs-site/605287/api-10845497.md): - 编写接口 - 在线系统 [获取会话关联的用户信息](https://apifox.com/apidoc/docs-site/605287/api-10845458.md): 该接口主要用于与获取会话所属用户的信息，特别是该会话所属用户没有关联企业自己的UID时，其信息只是由客服人员手动在七鱼系统记录。企业可以通过本接口将用户信息回流到企业内部系统。由于用户没有关联企业自己的UID，因此调用本接口时，需要传入session id 作为参数。接口鉴权方式可参阅[《消息接口文档》](https://qiyukf.com/docs/guide/message/message_interface.html#数据校验) - 在线系统 [行为轨迹](https://apifox.com/apidoc/docs-site/605287/api-10845459.md): 发送数据主动推送用户行为轨迹 - 在线系统 [微信模板消息](https://apifox.com/apidoc/docs-site/605287/api-10845460.md): 该接口用于将企业发送给用户的资料，以微信模板消息的形式发出。使用该接口前，需要企业的公众号已添加相应的模板，且企业需要按照指定格式提供访问接口，供七鱼获取对应的数据。 通过该接口，七鱼提供了特定业务支持的数据源集。企业设置的模板中支持哪些数据，将对应数据的在模板中的key填入请求中即可完成设置。当用户查询时，七鱼会访问企业提供数据的接口，然后会将对应的数据根据模板配置填入，最后发给用户。 - 在线系统 [获取咨询分类](https://apifox.com/apidoc/docs-site/605287/api-10845461.md): 该接口用于获取企业管理后台配置的咨询分类，以五级树状结构的形式给出。 - 在线系统 [获取在线会话的服务小记记录](https://apifox.com/apidoc/docs-site/605287/api-10845462.md): 该接口用于获取会话所属的客服可以查看的服务小记模版(根据管理后台->客服工作台->服务小记字段模版中所指定的客服组确定客服可查看的模版)以及已经填写的服务小记记录 - 在线系统 [更新会话服务小记](https://apifox.com/apidoc/docs-site/605287/api-10845463.md): 该接口用于更新服务小记的模版填写信息，注意当已选定一个服务小记模版之后，此后的更新只能更新这个服务小记模版的自定义字段信息，不可再切换服务小记模版 接口请求示例 - 呼叫系统 > 外呼任务 > 创建外呼任务 [分配到客服](https://apifox.com/apidoc/docs-site/605287/api-10845503.md): 指定分配到客服，即seatType=0时 - 呼叫系统 > 外呼任务 > 创建外呼任务 [分配到客服组](https://apifox.com/apidoc/docs-site/605287/api-10845504.md): 指定分配到客服组，即seatType=1时 - 呼叫系统 > 外呼任务 > 创建外呼任务 [按客户关系分配](https://apifox.com/apidoc/docs-site/605287/api-10845505.md): 指定按客户关系分配，即seatType=2时 - 呼叫系统 > 外呼任务 > 创建外呼任务 [按自定义的客户分配](https://apifox.com/apidoc/docs-site/605287/api-10845506.md): 指定按自定义的客户分配，即seatType=3时 - 呼叫系统 > 外呼任务 > 创建外呼任务 [自动外呼任务](https://apifox.com/apidoc/docs-site/605287/api-10845507.md): 如果是自动外呼任务时，只需要扩展三项参数即可，其它参数保持不变 - 呼叫系统 > 外呼任务 [补充自动外呼号码](https://apifox.com/apidoc/docs-site/605287/api-10845498.md): 该接口由七鱼提供，第三方调用该接口可以补充自动外呼任务的号码，方便呼叫客服及时联系客户，从而提升营销质量 - 呼叫系统 > 外呼任务 [获取外呼任务详情](https://apifox.com/apidoc/docs-site/605287/api-10845499.md): 该接口由七鱼提供，第三方调用该接口获取任务详情 - 呼叫系统 > 外呼任务 [获取外呼任务明细详情](https://apifox.com/apidoc/docs-site/605287/api-10845500.md): 该接口由七鱼提供，第三方调用该接口获取任务明细详情 - 呼叫系统 > 外呼任务 [编辑手动外呼任务](https://apifox.com/apidoc/docs-site/605287/api-10845501.md): 该接口由七鱼提供，第三方调用该接口可编辑手动外呼任务详情，减少因为内部原因产生的错误呼出量及对用户体验的伤害 - 呼叫系统 > 外呼任务 [删除外呼任务号码](https://apifox.com/apidoc/docs-site/605287/api-10845502.md): 该接口由七鱼提供，第三方调用该接口可删除手动外呼任务详情，减少由于内部原因产生的错误呼出量及对用户体验的伤害 - 呼叫系统 > 服务记录 [获取服务记录模板](https://apifox.com/apidoc/docs-site/605287/api-10845508.md): 该接口由七鱼提供，第三方调用该接口获取服务记录模板 - 呼叫系统 > 数据接口 [呼叫总览数据](https://apifox.com/apidoc/docs-site/605287/api-10845509.md): **注**: 此接口连续两次请求间隔不能小于五分钟 - 呼叫系统 > 数据接口 [呼叫坐席历史数据](https://apifox.com/apidoc/docs-site/605287/api-10845510.md): #### 接口说明 - 呼叫系统 > 数据接口 [呼叫团队历史总览数据](https://apifox.com/apidoc/docs-site/605287/api-10845511.md): #### 接口说明 - 呼叫系统 > 呼叫工具条 [获取SDK接入地址](https://apifox.com/apidoc/docs-site/605287/api-10845512.md): 第三方向七鱼请求`SDK`接入地址的时候，七鱼会执行客服在七鱼的登录事件，并生成含动态口令的`SDK`接入地址返回给第三方 - 呼叫系统 > 外呼机器人 [获取机器人话术列表](https://apifox.com/apidoc/docs-site/605287/api-10845513.md): 通过此接口可以获取所有配置完成的机器人话术。注意：该接口仅能获取发布过的话术（即审核通过或曾今审核通过的，新建外呼任务可选择的话术）。如果想获取全部话术，参考：**模糊搜索获取话术列表**接口 - 呼叫系统 > 外呼机器人 [模糊搜索获取话术列表](https://apifox.com/apidoc/docs-site/605287/api-10845514.md): 通过此接口可以模糊搜索获取所有相关话术列表 - 呼叫系统 > 外呼机器人 [获取外呼拦截组配置列表](https://apifox.com/apidoc/docs-site/605287/api-10845515.md): 通过此接口可以获取所有设置的拦截组 - 呼叫系统 > 外呼机器人 [获取所有可用外呼线路列表](https://apifox.com/apidoc/docs-site/605287/api-10845516.md): 通过接口可以获取所有可用的外呼线路列表 - 呼叫系统 > 外呼机器人 [创建外呼机器人任务](https://apifox.com/apidoc/docs-site/605287/api-10845517.md): 通过此接口可以创建外呼机器人新的任务。 - 呼叫系统 > 外呼机器人 [获取指定任务的话术中变量](https://apifox.com/apidoc/docs-site/605287/api-10845518.md): 通过接口可以获取该任务中的话术变量。 - 呼叫系统 > 外呼机器人 [向外呼任务中导入客户](https://apifox.com/apidoc/docs-site/605287/api-10845519.md): 通过此接口可以向指定的任务导入客户信息，用于拨打电话。（单次导入客户数量不能大于100） 此接口是公网服务，所有客户共用，为保证接口响应速度和吞吐量，并控制服务器压力，将单次导入个数定位100个。数据量大时可以重复调用此接口来实现。 - 呼叫系统 > 外呼机器人 [从已呼客户列表重新添加到呼叫任务](https://apifox.com/apidoc/docs-site/605287/api-10845520.md): 通过接口可以把客户从已呼客户列表中重新添加到呼叫任务。 - 呼叫系统 > 外呼机器人 [获取已经完成外呼的客户信息列表](https://apifox.com/apidoc/docs-site/605287/api-10845521.md): 通过此接口可以获取指定外呼任务中已经完成外呼的客户。 - 呼叫系统 > 外呼机器人 [启动外呼任务](https://apifox.com/apidoc/docs-site/605287/api-10845522.md): 通过此接口可以启动指定的外呼任务 - 呼叫系统 > 外呼机器人 [暂停外呼任务](https://apifox.com/apidoc/docs-site/605287/api-10845523.md): 通过此接口可以暂停指定的外呼任务 - 呼叫系统 > 外呼机器人 [终止外呼任务](https://apifox.com/apidoc/docs-site/605287/api-10845524.md): 通过此接口可以终止指定的外呼任务 - 呼叫系统 > 外呼机器人 [获取任务详情](https://apifox.com/apidoc/docs-site/605287/api-10845525.md): 通过此接口可以获取指定任务的详细信息。 - 机器人 > 知识库管理 [获取知识库的问题](https://apifox.com/apidoc/docs-site/605287/api-10845526.md): 备注： 分页读取知识库数据，每页返回的数据按id从小到大排序； 读取下一页数据时，需要将本次读取的数据中最后一条记录id，作为读取下一页数据的参数mid传过来； - 机器人 > 知识库管理 [获取知识库的知识点](https://apifox.com/apidoc/docs-site/605287/api-10845527.md): - 机器人 > 知识库管理 [通过分类名称获取当前分类下topN标准问](https://apifox.com/apidoc/docs-site/605287/api-10845528.md): 备注： 起始时间和结束时间的值必须大于0，起始时间需小于结束时间，结束时间不能晚于当前时间，查询时间跨度不能超31天 - 机器人 > 知识库管理 [通过标准问获取当前机器人默认答案](https://apifox.com/apidoc/docs-site/605287/api-10845529.md): - 机器人 > 知识库管理 [通过常见问题模板id获取常见问题列表](https://apifox.com/apidoc/docs-site/605287/api-10845530.md): - 机器人 > 知识库管理 [知识库分类查询接口](https://apifox.com/apidoc/docs-site/605287/api-10845531.md): **频率限制：** - 机器人 > 知识库管理 [获取问题列表](https://apifox.com/apidoc/docs-site/605287/api-10845532.md): **频率限制：** - 机器人 > 知识库管理 [获取问题详情信息](https://apifox.com/apidoc/docs-site/605287/api-10845533.md): **频率限制：** - 机器人 > 知识库管理 [删除问题](https://apifox.com/apidoc/docs-site/605287/api-10845534.md): **频率限制：** - 机器人 > 知识库管理 [添加问题](https://apifox.com/apidoc/docs-site/605287/api-10845535.md): **频率限制：** - 机器人 > 知识库管理 [更新问题](https://apifox.com/apidoc/docs-site/605287/api-10845536.md): **频率限制：** - 机器人 > 知识库管理 [更新问题规则答案](https://apifox.com/apidoc/docs-site/605287/api-10845537.md): **频率限制：** - 机器人 > 知识库管理 [更新问题忽略相似问接口](https://apifox.com/apidoc/docs-site/605287/api-10845538.md): **频率限制：** - 机器人 > 会话评价 [获取机器人评价设置](https://apifox.com/apidoc/docs-site/605287/api-10845539.md): 该接口由七鱼提供给第三方调用，用于第三方自己实现机器人满意度评价功能并与七鱼系统进行对接的方式。机器人满意度评价选项配置在七鱼管理后台机器人模块内设置，第三方可以通过该接口拉取该配置，并自己实现用户信息评价功能。评价完成之后，第三方调用下面机器人会话评价接口将评价结果同步给七鱼系统。 - 机器人 > 会话评价 [提交机器人会话评价](https://apifox.com/apidoc/docs-site/605287/api-10845540.md): 该接口允许用户评价当前机器人服务。根据评价设置接口中返回的list数组显示满意度评价项，name 为评价项名称，value 为对应评价值，用户选择某评价项时，将对应 value 值作为下面接口参数 evaluation 的参数值。 - 机器人 > 统计接口 [获取机器人会话统计总揽数据](https://apifox.com/apidoc/docs-site/605287/api-10845541.md): 该接口获取指定时间范围内的机器人会话统计汇总数据，一次最多支持获取30天时间范围内的数据。 - 机器人 > 统计接口 [转人工会话统计](https://apifox.com/apidoc/docs-site/605287/api-10845542.md): 获取转人工会话数据，一次最多支持获取365天范围内的数据。 - 机器人 > 消息接口 > 会话类接口 [创建机器人会话](https://apifox.com/apidoc/docs-site/605287/api-10845546.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [常见问题](https://apifox.com/apidoc/docs-site/605287/api-10845547.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [快捷短语](https://apifox.com/apidoc/docs-site/605287/api-10845548.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [输入联想](https://apifox.com/apidoc/docs-site/605287/api-10845549.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [获取机器人消息回复](https://apifox.com/apidoc/docs-site/605287/api-10845550.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [机器人回复消息评价](https://apifox.com/apidoc/docs-site/605287/api-10845551.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [机器人会话满意度评价](https://apifox.com/apidoc/docs-site/605287/api-10845552.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [关闭机器人会话](https://apifox.com/apidoc/docs-site/605287/api-10845553.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [文件上传](https://apifox.com/apidoc/docs-site/605287/api-10845554.md): **简要描述：** - 机器人 > 消息接口 > 会话类接口 [机器人辅助人工客服](https://apifox.com/apidoc/docs-site/605287/api-10845555.md): **简要描述：** - 机器人 > 消息接口 [获取机器人切换配置](https://apifox.com/apidoc/docs-site/605287/api-10845543.md): **简要描述：** - 机器人 > 消息接口 [微信公众号切换机器人](https://apifox.com/apidoc/docs-site/605287/api-10845544.md): **简要描述：** - 机器人 > 消息接口 [企业微信切换机器人](https://apifox.com/apidoc/docs-site/605287/api-10845545.md): **简要描述：** - 工单系统 [创建工单](https://apifox.com/apidoc/docs-site/605287/api-10845556.md): 接口参数说明如下： - 工单系统 [修改工单](https://apifox.com/apidoc/docs-site/605287/api-10845557.md): 修改工单部分属性。 - 工单系统 [批量修改工单](https://apifox.com/apidoc/docs-site/605287/api-10845558.md): 修改工单部分属性。 - 工单系统 [申领工单](https://apifox.com/apidoc/docs-site/605287/api-10845559.md): 工单在分组内时，可先由组内处理人申领方能继续处理。 - 工单系统 [转交工单](https://apifox.com/apidoc/docs-site/605287/api-10845560.md): 此接口可将工单转交给其他处理人或者客服分组继续处理。 - 工单系统 [回复工单](https://apifox.com/apidoc/docs-site/605287/api-10845561.md): 此接口用于对工单发表回复或添加附件等处理行为。 - 工单系统 [催单接口](https://apifox.com/apidoc/docs-site/605287/api-10845562.md): 此接口用于对未完结的工单执行催单操作。 - 工单系统 [完结工单](https://apifox.com/apidoc/docs-site/605287/api-10845563.md): 此接口用于对已处理完成的工单执行完结操作。 - 工单系统 [重新打开工单](https://apifox.com/apidoc/docs-site/605287/api-10845564.md): 此接口可将工单转交给其他处理人或者客服分组继续处理。 - 工单系统 [搜索工单](https://apifox.com/apidoc/docs-site/605287/api-10845565.md): 接口参数说明如下： - 工单系统 [获取工单详情](https://apifox.com/apidoc/docs-site/605287/api-10845566.md): - 工单系统 [获取工单日志列表](https://apifox.com/apidoc/docs-site/605287/api-10845567.md): actionType说明： - 工单系统 [获取工单过滤器列表](https://apifox.com/apidoc/docs-site/605287/api-10845568.md): - 工单系统 [获取过滤器下的工单数量](https://apifox.com/apidoc/docs-site/605287/api-10845569.md): 用以查询某个过滤器下的工单数量 - 工单系统 [获取过滤器下的工单](https://apifox.com/apidoc/docs-site/605287/api-10845570.md): - 工单系统 [获取工单关注人](https://apifox.com/apidoc/docs-site/605287/api-10845571.md): - 工单系统 [获取工单模板](https://apifox.com/apidoc/docs-site/605287/api-10845572.md): - 工单系统 [获取工单模板字段](https://apifox.com/apidoc/docs-site/605287/api-10845573.md): - 工单系统 [获取工单分类](https://apifox.com/apidoc/docs-site/605287/api-10845574.md): - 短信 [创建短信发送任务](https://apifox.com/apidoc/docs-site/605287/api-10845575.md): code非200的情况 - 短信 [获取短信任务状态](https://apifox.com/apidoc/docs-site/605287/api-10845576.md): code非200的情况 - 平台电商（Platform OpenAPI） [第三方登录](https://apifox.com/apidoc/docs-site/605287/api-10845577.md): 接口参数说明: - 平台电商（Platform OpenAPI） [创建商户](https://apifox.com/apidoc/docs-site/605287/api-10845578.md): 接口参数说明: - 平台电商（Platform OpenAPI） [修改商户](https://apifox.com/apidoc/docs-site/605287/api-10845579.md): 接口参数说明如下: - 平台电商（Platform OpenAPI） [启用商户](https://apifox.com/apidoc/docs-site/605287/api-10845580.md): 接口参数说明如下: - 平台电商（Platform OpenAPI） [停用商户](https://apifox.com/apidoc/docs-site/605287/api-10845581.md): 接口参数说明如下: - 平台电商（Platform OpenAPI） [修改商户密码](https://apifox.com/apidoc/docs-site/605287/api-10845582.md): 接口参数说明如下: - 平台电商（Platform OpenAPI） [获取商户列表](https://apifox.com/apidoc/docs-site/605287/api-10845583.md): - 平台电商（Platform OpenAPI） [获取商户信息](https://apifox.com/apidoc/docs-site/605287/api-10845584.md): 接口参数说明如下: