微吼开放平台
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. 消息回调
  • Api介绍
  • 接入必读
    • 快速接入
    • 签名示例
    • 全局状态码
    • 调用频率说明
  • 账号管理
    • 子账号角色
      • 创建子账号角色
      • 更新子账号角色信息
      • 获取子账号角色列表
      • 获取子账号角色详情
    • 子账号管理
      • 创建子账号
      • 更新子账号信息(含角色绑定)
      • 获取子账号个数
      • 获取子账号列表
      • 获取子账号详情
      • 创建子账号应用信息
    • 三方用户管理
      • 创建三方用户
      • 更新三方用户
      • 获取微吼用户ID
      • 获取第三方用户ID
  • 授权服务
    • 获取观众登录Token
      POST
    • 获取控制台登陆Token
      POST
    • 获取控制台免登录地址
      POST
  • 标签管理
    • 创建标签
      POST
    • 删除标签
      POST
    • 更新标签
      POST
    • 置顶标签
      POST
    • 获取标签列表
      POST
    • 批量查询活动标签
      POST
    • 活动标签列表排序重置
      POST
  • 活动中心
    • 活动管理
      • 创建活动
      • 创建活动(点播/定时直播)
      • 删除活动
      • 修改活动信息
      • 活动列表接口
      • 获取活动详情
      • 批量获取活动详情
      • 获取活动场次列表
      • 获取当前视频分辨率详情(定时直播)
    • 角色权限
      • 角色邀请开关
      • 角色名称修改
      • 角色密码修改
      • 角色权限修改
      • 获取活动角色配置
      • 取消嘉宾/助理身份
      • 设置主持人身份信息
      • 获取B端用户参会地址
    • 互动管理
      • 签到
        • 获取进行中的签到任务
        • 创建并配置签到推送
        • 批量删除签到记录
        • 结束签到
        • 获取签到详情
      • 快问快答
        • 获取活动下快问快答列表
        • 快问快答-推送试卷
        • 快问快答-收卷
        • 快问快答-公布成绩
        • 获取快问快答题目
      • 在线抽奖
        • 抽奖管理
          • 创建或更新抽奖信息
          • 保存或更新抽奖条件与中奖用户设置
          • 保存或更新领奖页设置
          • 复制抽奖
          • 删除抽奖
        • 奖品管理
          • 创建或更新奖品信息
          • 批量删除活动下奖品
          • 保存抽奖奖品设置
          • 获取活动下奖品信息
          • 获取活动的奖品列表
        • 获取抽奖详情信息
          • 获取抽奖条件和用户设置
          • 获取抽奖配置基本信息
          • 获取抽奖领奖页设置
          • 获取活动下抽奖列表
        • 推送抽奖
          • 推送抽奖
        • 结束抽奖
          • 结束抽奖
    • 多语言管理
      • 创建活动语种
      • 删除活动语种
      • 修改活动语种
      • 查询活动语种列表
  • 观看限制
    • 全局踢出
      • 批量移除全局踢出观众
      • 新增/编辑全局踢出观众
      • 查询全局踢出观众列表
    • 观众组管理
      • 创建观众组
      • 指定观众组添加新用户
      • 获取观众组分组列表
      • 获取观众组下用户列表
      • 批量删除观众组用户
    • 平台观看限制
      • 设置活动观看限制
      • 查询活动观看限制
    • 外部观众鉴权
      • 外部观众获取活动票据-生成ticket
    • 第三方K值鉴权
      • 设置全局K值鉴权
      • 设置单个活动K值鉴权
      • 删除活动下的k_id
      • 设置活动多K值校验
      • 查询多K值详情列表
      • 查询活动K值详情配置
  • 回放管理
    • 回放设置
      • 回放列表
    • AI创作
      • 提交智能字幕解析任务
      • 智能字幕-编辑及保存
      • 获取智能字幕详情
  • 媒资中心
    • 图片上传
      • 图片上传
    • 文档管理
      • 删除文档
      • 获取文档详情
      • 获取文档章节
      • 获取活动下的文档列表
      • 上传文档
      • 活动关联文档
    • 音视频管理
      • 视频预览
      • 音视频删除
      • 音视频修改
      • 音视频列表
      • 音视频详情
  • 商品中心
    • 商品池
      • 创建商品
      • 更新商品
      • 商品详情
      • 商品列表
      • 复制商品
      • 批量删除
    • 活动商品
      • 获取当前活动未关联商品
      • 活动关联商品
      • 活动商品列表
      • 批量删除活动商品
      • 活动商品上架设置
      • 设置活动商品排序
      • 设置活动商品销售状态
      • 设置活动商品推送状态
      • 获取活动下商品统计数据
  • 数据统计
    • 套餐数据
      • 套餐用量
        • 并发消费查询
          • 财务总览-并发-消费账单
        • 流量数据查询
          • 6.查询用户流量
          • 查询某段时间内流量使用情况
          • 财务总览-流量-消费账单
        • 时常数据查询
          • 查询每天用户时长使用量
          • 查询指定时间内时长使用情况
          • 财务总览-时长-消费账单
      • 短信用量
        • 获取一定时间内短信使用量
        • 获取指定时间内短信消耗总值
        • 财务总览-短信-消费账单-分页明细
    • 互动数据
      • 基础统计
        • 预约
          • 活动预约列表
        • 报名表单
          • 获取报名表单记录
        • 邀请排名
          • 获取邀请榜
          • 获取邀请列表
          • 获取邀请卡详情
          • 邀请详情
        • 分享排名
          • 获取分享排名记录
      • 互动统计
        • 聊天
          • 获取历史聊天记录
        • 问答
          • 获取问答记录总数
          • 获取问答记录列表
        • 点赞
          • 获取房间的点赞数量
        • 快问快答
          • 获取快问快答答题详情
        • 问卷
          • 获取活动下问卷列表
          • 获取活动下问卷使用数据概览
          • 获取问卷ID对应问卷答案
          • 获取问卷提交人数
          • 获取问卷答案详情
        • 签到
          • 获取已推送的签到记录列表
          • 获取活动下已签到的用户记录
          • 获取活动签到统计列表
          • 签到用户列表接口(聚合表查询数据)
        • 现金红包
          • 获取红包发送记录
          • 获取红包领取列表
          • 获取活动下红包统计数据
        • 口令红包
          • 获取红包明细
          • 获取活动下红包统计数据
          • 获取发送红包记录
        • 打赏
          • 获取活动打赏列表
          • 获取活动打赏统计
        • 文件下载
          • 文档下载次数
          • 已下载资料数据列表
        • 连麦
          • 获取用户上麦记录
    • 数据订阅
      • 创建订阅主题与规则
      • 删除数据订阅主题与规则
      • 查询数据订阅主题与规则
      • 查询数据订阅主题与规则明细
    • 账号维度数据
      • 获取指定时间段内并发数据
      • 活动数据列表接口
      • 数据总览
      • 获取指定日期内最高并发
    • 活动维度数据
      • 数据报告
        • 活动统计信息
        • 观看人数趋势
      • 终端信息统计
        • 活动设备信息
        • 活动浏览器信息
      • 地理位置统计
        • 省份信息统计
        • 城市信息统计
      • 获取活动热度信息
        • 活动热度信息
      • 获取活动在线人数
        • 获取当前在线人数
        • 获取指定时间段内在线人数统计
      • 获取活动并发数据
        • 每天并发趋势
        • 获取当前活动最高并发
        • 获取当前活动指定时间段内最高并发
        • 获取指定时间段内活动最大并发
      • 获取用户观看明细
        • 获取用户观看明细(新)
        • 获取用户观看明细(旧)
  • 消息回调
    • 回调事件说明
    • 回调事件列表
    • 回调事件管理
      • 回调事件查询接口
      • 回调事件修改接口
      • 回调事件创建接口
    • 回调事件汇总
      • 活动信息
        • 活动删除
        • 活动创建
        • 活动信息更新
      • 活动状态
        • 活动状态
        • 活动推流状态
        • 活动状态改变
        • 活动恢复预告
      • 回放
        • 生成回放
        • 裁剪回放
        • 回放分辨率
        • 回放下载
        • 回放重制
      • 媒资
        • 视频转码
        • 文档转码
        • 音视频转码进度
      • 订单
        • 订单状态变更
      • AI创作
        • 智能解析
      • 报名
        • 报名表单提交
      • 抽奖
        • 中奖结果通知
        • 抽奖管理
        • 复制抽奖
        • 推送抽奖
        • 结束抽奖
        • 抽奖奖品管理
      • 快问快答
        • 答题记录
      • 签到
        • 推送签到
        • 结束签到
        • 签到管理
      • 商城奖励
        • 领取奖励回调
      • 观看时长
        • 时长达标
      • 房间消息
        • 上下线消息
  • 播放器设置
  • 转推流设置
    • 活动开关播
      • 开始直播
      • 结束直播
    • 平台推流到三方
      • 获取活动下已添加推流地址列表
      • 创建三方推流地址
      • 删除三方推流地址
      • 编辑三方推流地址
      • 开启/关闭三方推流
    • 平台拉流并开播
      • 拉流并开播
    • 获取当前活动推流状态
      • 获取直播间流状态
    • 获取当前活动推流地址
      • 获取直播间推流地址
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. 消息回调

回调事件说明

在直播过程中,状态变更和回放转码等事件可能影响客户的业务系统展示和动作。为了将这些关键事件变更通知客户,微吼直播提供了主动的消息推送服务。当事件触发时,微吼会调用客户配置的回调事件接口进行通知,以便客户进行相应的动态更新。

注意事项#

在使用回调服务前,请确保已设置回调事件。您可以通过 API 接口或在 控制台 > 设置中心 > 开发设置 > 回调设置 完成配置。当事件触发时,接口会通过 HTTP POST 方式将状态变化发送到您的服务器。
如若服务器存在安全策略限制,禁止访问,请将微吼回调服务的出口 IP 设置为允许访问的白名单。
回调服务出口 IP:
82.156.84.44
82.156.44.216
82.156.103.174
82.156.121.115

消息组织格式#

通知信息通过 HTTP POST 方式发送,支持以下两种 Content-Type 消息格式:
1.
application/x-www-form-urlencoded(默认)
2.
application/json

消息失败重试机制#

系统默认发送一次通知。如需在消息接受失败后重新发送,请开启失败重试开关。开启后,业务系统需在接收到消息后5秒内返回 success(不区分大小写),以视为通知成功,否则将按以下间隔重试:
10 秒
30 秒
1 分钟~10 分钟
20 分钟
30 分钟
1 分钟
2 小时
注意:消息中的 mid 属性是唯一标识,业务系统需确保幂等性处理。

签名方法#

API 签名用于系统交互,以确保请求数据的准确性和接口的安全性。
特别注意:
在微吼主动推送数据到对接系统的场景中,微吼会对推送的数据进行签名。对接系统应使用相同的签名机制来验证签名无误,然后再进行业务处理。
处理中待签名字符串时,所有返回的参数键值对(kv)都需按照规则处理。切勿使用固定字段的顺序进行字符串拼装,因为微吼可能在后续系统升级中增加返回参数。这可能导致签名验证失败。因此,在进行回调对接时,请避免依赖固定字段顺序,应依据动态的参数处理方式,以确保签名验证的正确性和兼容性。
签名中如遇到接口参数有数组或字典字段 ,(如key=>[1,2,3])或字典(如key=>{"id": 123}),​仅保留键名​(即key=后的值不参与拼接)
**签名步骤 : **
参数准备
需从请求中提取所有参数(Body中的字段),排除signature字段后参与签名计算(切勿使用固定字段的顺序进行字符串拼装 , 因为微吼可能在后续系统升级中增加返回参数 )
注意:必须排除回调请求中的signature参数本身
注意:统一去除参数名和参数值的前后空格
参数排序
将所有参数按字典顺序(A-Z)进行严格升序排列(不含 signature 参数)。
密钥处理
需对贵司提供的secret_key进行MD5加密(从而生成固定长度的加密字符串)
字符串拼接
对每个排序后的参数按固定格式拼接:
参数名|md5_secret_key|参数值
非复合类型(字符串、数字等):直接拼接参数值
复合类型(数组 List、字典 Map):仅拼接 参数名|md5_secret_key|(跳过参数值)
生成签名
对拼接完成的字符串进行 MD5 加密,生成最终签名

Java签名方法示例#

Java签名方法DEMO#

下载地址 : https://gitee.com/vhall/vop-callback-demo
上一页
获取用户观看明细(旧)
下一页
回调事件列表
Built with