黑盒语音机器人帮助文档
  1. 在线媒体流
黑盒语音机器人帮助文档
  • 教程
  • 开发者服务协议
  • 使用交流
  • 更新日志
  • 开发计划
  • 基础框架须知
  • 资源
    • 请求速率限制
    • Websocket
    • Bot命令
  • WEBSOCKET 连接请求
    • 连接到黑盒语音服务
  • HTTP接口
    • 消息接口
      • 发送消息接口的参数
      • 发送消息接口的返回值
      • 发送图片形式的频道消息
      • 发送Markdown文档
      • 更新指定频道消息
      • 删除指定的频道消息
      • 对某条频道消息增加/取消回应(小表情)
      • 发送卡片消息
      • 给用户发送私聊消息
      • 发送频道图片消息
      • 发送频道消息
      • 发送卡片消息
      • 发送频道消息@全体成员/@在线成员
      • 更新指定的频道消息
      • 删除指定的频道消息
      • 对某条频道消息增加/取消回应(小表情)
      • 给用户发送私聊消息
    • 媒体文件上传
      • 上传媒体文件的参数解析
      • 上传媒体文件
    • 房间角色接口
      • 权限相关说明
      • 接口说明
      • 获取房间角色列表
      • 创建角色
      • 更新角色
      • 删除角色
      • 对指定用户授予指定权限
      • 对指定用户剥夺指定权限
    • 房间表情
      • 房间表情包
      • 获取房间上传的表情包
      • 房间删除表情包
      • 房间更新表情包名称
    • 房间接口
      • 房间相关接口文档
      • 修改房间内昵称
      • 分页获取加入的房间列表
      • 获取房间信息
      • 退出房间
      • 房间踢人
      • 语音频道之间移动用户
      • 踢出语音频道中的用户
      • 禁言/解禁用户
      • 频道内麦克风静音/解禁
      • 房间内麦克风静音/解禁
      • 房间内扬声器静音/解禁
      • 获取用户所在频道
      • 获取语音频道内在线成员列表
      • 创建频道邀请链接
      • 频道设置修改
      • 频道名编辑
      • 设置频道密码
      • 修改权限组或成员权限
      • 获取房间用户列表
      • 获取用户频道权限
      • 创建频道
      • 删除频道
    • 在线媒体流
      • 在线媒体流说明文档
      • 推流至语音频道
        POST
      • 停止推流至语音频道
        POST
    • OAuth
      • OAuth使用说明
      • 获取授权码
      • 获取AccessToken
      • 刷新AccessToken
      • 获取用户信息
      • 获取用户房间内语音时长
      • 获取用户房间内语音游戏时长
      • 获取用户信息-自动触发授权
  • 服务端推送事件
    • 事件说明
    • 通用推送字段
    • 机器人命令
      • 用户使用Bot命令
    • 频道消息事件
      • 频道消息事件
    • 房间消息事件
      • 房间消息事件
  • 自定义卡片消息
    • 自定义卡片编辑器
    • 物料组件
      • 卡片
      • 文本
      • 标题
      • 图片
      • 按钮组
      • 分割线
      • 倒计时
  1. 在线媒体流

在线媒体流说明文档

输入在线媒体流回调#

服务端输入在线媒体流回调支持将您使用 输入在线媒体流 REST API 产生输入在线媒体流的事件,以 HTTP 请求的形式通知到您的服务器。

配置信息#

在推流至语音频道传入 stream_url 参数,配置完成后即可接收事件回调通知。

超时重试#

事件回调服务器在发送消息通知后,5秒内没有收到您的服务器的响应,即认为通知失败。失败后会以10秒的间隔继续重试,直到消息存续时间超过1分钟,不再重试。

事件回调消息格式#

事件回调消息以 HTTP/HTTPS POST 请求发送给您的服务器,其中:
字符编码格式:UTF-8。
请求:body 格式为 JSON。
请求头: 线路1和线路2的回调格式不同 通过SDK-Type区分 线路一为trtc 线路二为volc
应答:HTTP STATUS CODE = 200,服务端忽略应答包具体内容。
包体示例:下述为“trtc 输入在线媒体流开始成功”事件的包体示例。
下述为“volc 输入在线媒体流开始成功”事件的包体示例。

参数说明#

回调消息参数#

Header 中包含以下字段:#

字段名值
Content-Typeapplication/json
SDK-Typetrtc/volc

trtc#

Body 中包含以下字段:#

字段名类型含义
EventGroupIdNumber事件组 ID,混流转推事件固定为 4
EventTypeNumber回调通知的事件类型
CallbackMsTsNumber事件回调服务器向您的服务器发出回调请求的 Unix 时间戳(毫秒)
EventInfoJSON Object事件信息对象

事件组 ID 对照表#

字段名值含义
EVENT_GROUP_STREAM_INGEST7输入在线媒体流事件组

事件类型对照表#

字段名值含义
EVENT_TYPE_STREAM_INGEST_START701输入在线媒体流开始
EVENT_TYPE_STREAM_INGEST_STOP702输入在线媒体流停止

当 EventType = 701 (EVENT_TYPE_STREAM_INGEST_START) 时,EventInfo 字段定义如下:#

字段名类型含义
EventMsTsString事件发生的 Unix 时间戳(单位为毫秒)
TaskIdString输入在线媒体流任务 ID
StatusNumber状态码

volc#

EventType为RelayStreamStateChanged

EventData#

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID,是房间的唯一标志
TaskIdStringYour_TaskId任务 ID
UserIdStringYour_UserId在线媒体流对应的 UserId
StreamUrlStringrtmp://xxx在线流媒体地址
StatusInt1任务状态:
1:待机中
2:连接中
3:运行中
4:已停止
5:重试中
StartTimeStampInt0任务起始时间戳,用于定时播放,Unix时间,单位为秒。默认为 0,表示立即启动。
MsgString/描述信息
ReasonInt1任务停止原因,仅当 Status = 4 时有效:
1:空闲超时
2:停止接口调用
3:流播放结束
4:内部错误
5:url 地址异常
6:编码格式不支持
7:token 错误
8:没有发布权限
9:被移除房间

推流至语音频道#

接口约定#

operator 为操作者的UID, 如小明使用了 /点歌 指令, 此处应为小明的UID
stream_url 为形如 https://a.b/test.mp4 的音频直链
一个频道同时只能有一个推送中的媒体流
回调的RoomId为黑盒语音的channel_id
线路二(volc)仅能接受编码格式为AAC、Opus的音频媒体

接口地址#

推流至语音频道

停止推流至语音频道#

接口地址#

停止推流至语音频道
修改于 2025-07-25 07:54:06
上一页
删除频道
下一页
推流至语音频道
Built with