网易七鱼 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
    • 获取咨询分类
      POST
    • 获取在线会话的服务小记记录
      POST
    • 更新会话服务小记
      POST
  • 呼叫系统
    • 呼叫时间对接
      • 概述
      • 数据校验
      • 调用说明
      • curl请求样例如下
      • 第三方接口需返回的数据的说明
      • 第三方接口样例
    • 外呼任务
      • 创建外呼任务
        • 概述
        • 分配到客服
        • 分配到客服组
        • 按客户关系分配
        • 按自定义的客户分配
        • 自动外呼任务
      • 补充自动外呼号码
      • 获取外呼任务详情
      • 获取外呼任务明细详情
      • 编辑手动外呼任务
      • 删除外呼任务号码
    • 服务记录
      • 获取服务记录模板
    • 数据接口
      • 呼叫总览数据
      • 呼叫坐席历史数据
      • 呼叫团队历史总览数据
    • 呼叫工具条
      • 概述
      • 初始化 SDK
      • SDK 事件
      • SDK 方法
      • 获取SDK接入地址
    • 外呼机器人
      • 外呼机器人事件对接
      • 获取机器人话术列表
      • 模糊搜索获取话术列表
      • 获取外呼拦截组配置列表
      • 获取所有可用外呼线路列表
      • 创建外呼机器人任务
      • 获取指定任务的话术中变量
      • 向外呼任务中导入客户
      • 从已呼客户列表重新添加到呼叫任务
      • 获取已经完成外呼的客户信息列表
      • 启动外呼任务
      • 暂停外呼任务
      • 终止外呼任务
      • 获取任务详情
  • 机器人
    • 服务先知-常见问题
    • 服务先知-快捷短语
    • 一触即达
      • 概述
      • 对接方式
      • 对接示例
      • Velocity语法赋值
      • 移动SDK接入指南
    • 知识库管理
      • 概述
      • 获取知识库的问题
      • 获取知识库的知识点
      • 通过分类名称获取当前分类下topN标准问
      • 通过标准问获取当前机器人默认答案
      • 通过常见问题模板id获取常见问题列表
      • 知识库分类查询接口
      • 获取问题列表
      • 获取问题详情信息
      • 删除问题
      • 添加问题
      • 更新问题
      • 更新问题规则答案
      • 更新问题忽略相似问接口
    • 会话评价
      • 概述
      • 获取机器人评价设置
      • 提交机器人会话评价
    • 统计接口
      • 概述
      • 获取机器人会话统计总揽数据
      • 转人工会话统计
    • 消息接口
      • 概述
      • 概念/名词解释
      • 接口通用说明
      • 对接场景示例
      • 会话类接口
        • 会话类接口
        • 创建机器人会话
        • 常见问题
        • 快捷短语
        • 输入联想
        • 获取机器人消息回复
        • 机器人回复消息评价
        • 机器人会话满意度评价
        • 关闭机器人会话
        • 文件上传
        • 机器人辅助人工客服
      • 获取机器人切换配置
      • 微信公众号切换机器人
      • 企业微信切换机器人
  • 工单系统
    • 概述
    • 接口鉴权
    • 接口协议
    • 错误码
    • 工单推送
      • 说明
      • 请求体说明
    • 工单自定义字段同步
      • 基本用法
    • 创建工单
    • 修改工单
    • 批量修改工单
    • 申领工单
    • 转交工单
    • 回复工单
    • 催单接口
    • 完结工单
    • 重新打开工单
    • 搜索工单
    • 获取工单详情
    • 获取工单日志列表
    • 获取工单过滤器列表
    • 获取过滤器下的工单数量
    • 获取过滤器下的工单
    • 获取工单关注人
    • 获取工单模板
    • 获取工单模板字段
    • 获取工单分类
  • 短信
    • 接口鉴权
    • 创建短信发送任务
    • 获取短信任务状态
  • 平台电商(Platform OpenAPI)
    • 接口鉴权
    • 接口协议
    • 获取会话记录
      • 概述
      • 接口鉴权
      • 接口示例
      • 接口访问步骤
      • 字段说明
    • 第三方登录
    • 创建商户
    • 修改商户
    • 启用商户
    • 停用商户
    • 修改商户密码
    • 获取商户列表
    • 获取商户信息
  1. 消息推送

消息推送-发送文本时

POST
https://qiyukf.com/openapi/push/msg
采用iOS和Android端接入的企业,可以通过该接口,向访客手机推动消息,访客手机端查看消息并回复后,会触发生成新的会话。以此增强企业主动营销能力。
senderInfo为客服信息(客服id,名称,头像),action为按钮信息(名称和url) 1.发送文本时:
目前支持三种格式的推送内容:纯文本、图片、富文本。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://qiyukf.com/openapi/push/msg?appKey=&time=&checksum=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userlist":[
        "uid1",
        "uid2"
    ],
    "bid":"upsh",
    "senderInfo":{
        "staffName":"三石",
        "staffIcon":"http://imgsrc.baidu.com/baike/pic/item/e850352ac65c1038bcba9c0eb9119313b17e8932.jpg",
        "staffId":"000"
    },
    "action":{
        "label":"去看看",
        "url":"http://www.163.com"
    },
    "msgtype":"TEXT",
    "content":"推送内容xxx"
}'
响应示例响应示例
{
    "code": 200,
    "message": "{\"valid\":[\"uid1\",\"uid2\"],\"invalid\":[\"uid3\",\"uid4\"],\"unsupport\":[\"uid5\",\"uid6\"]}"
}

请求参数

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
userlist
array[string]
必需
对应访客uid串,uid为对接时的第三方用户ID
bid
string 
可选
推送消息的商户编号。平台电商企业使用,非平台电商企业不传
senderInfo
object 
客服信息
可选
staffName
string 
客服名称
可选
staffIcon
string 
客服头像
可选
staffId
string 
必需
客服id,senderInfo为空时,可以为空
action
object 
跳转按钮信息
可选
label
string 
必需
按钮名称(action为空时可以为空)
url
string 
必需
按钮跳转地址(action为空时可以为空)
msgtype
string 
必需
消息类型,目前支持TEXT,PICTURE,RICHTEXT三种
content
string 
必需
消息内容。文本消息是文本内容,图片和语音消息则是描述的 json, 该字段长度限制最大为 4000 个字符。
示例

返回响应

🟢200成功
application/json
Body
code
integer 
必需
200表示成功,其他为对应错误码
message
string 
必需
格式为String,成功时为 json 结果,失败时为对应错误说明

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

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

扫码加入交流群
上一页
接收会话质检事件通知
下一页
消息推送-发送图片时
Built with