服务端 API v2
  • API概览
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 调测指南

停止混流

更新时间:2021-10-25 17:43

1 描述

调用本接口停止混流。相关回调请参考 混流结束回调

2 接口原型

  • 请求方法:POST/JSON
  • 请求地址:https://rtc-api.zego.im/?Action=StopMix
  • 传输协议:HTTPS
  • 调用频率限制:100 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

名称
类型
是否必选 描述
TaskId String 混流任务 ID,需要和开始混流传入的 TaskId 保持一致。
Sequence Int 混流任务的序列号,用于保证时序,同个任务的参数修改需要保证序列号的递增。
UserId String 用户 ID。当开启混流任务归属时停止某个 TaskId 的混流任务必须输入开始混流任务时指定的 UserId 。

4 请求示例

  • 请求 url
    https://rtc-api.zego.im/?Action=StopMix
    &AppId=1234567890
    &SignatureNonce=15215528852396
    &Timestamp=1234567890
    &Signature=7a2c0f11145fb760d607a07b54825013
    &SignatureVersion=2.0
    &IsTest=false
  • 请求消息体
    {
      "TaskId": "2213699902971205739", 
      "Sequence": 1, 
      "UserId": "456"
    }

5 响应参数

参数 类型 描述
Code Number 返回码。
Message String 操作结果描述。
RequestId String 请求 ID。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"6351841974556802202"
}

7 返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明
110200001 失败。
110200002 输入参数错误。
110200003 鉴权失败。
110200004 解析输入参数失败。
110200005 混流开始获取分布式锁失败。
110200006 混流结束获取分布式锁失败。
110200007 更新混流请求失败。
110200008 混流开始协议转换失败。
110200009 混流开始请求转发失败。
110200010 混流开始回调失败。
110200011 混流开始数据旁路失败。
110200012 关闭混流发起者其他混流任务失败。
110200013 更新混流归属失败。
110200014 混流结束协议转换失败。
110200015 混流结束请求转发失败。
110200016 混流结束回调失败。
110200017 清理混流状态信息失败。
110200103 seq 错误。
110200150 混流输入流不存在。
110200151 混流失败。
110200152 结束混流失败。
110200153 混流输入流错误。
110200154 混流输出流错误。
110200155 混流输入流格式错误。
110200156 混流输出流格式错误。
110200157 混流权限未开。
110200158 混流输入流条数过限。
110200159 混流 dispatch 失败。
110200160 非所有者关闭混流。
110200170 水印参数错误。
110200171 水印参数为空。
110200172 扩展参数错误。
110200173 背景图超出数量限制。
110200174 水印图超出数量限制。
110200175 输入流重复。
110200176 输出流重复。
110200177 焦点语音超出限制。
110200178 输出流超出数量限制。
110200180 开始混流 token 为空。
110200181 开始混流 token 非法。
110200182 结束混流 token 为空。
110200183 结束混流 token 非法。
110200184 混流开始参数解析失败。
110200185 混流结束参数解析失败。
110200190 混流开始请求过载。
110200191 混流结束请求过载。
110200192 混流任务批量查询请求过载。
110200193 混流任务查询请求过载。
110200194 混流请求过载。
110240002 token 非法。
110240003 AppId 为空。
110240004 AppId 错误。
110200901 LiveRoom 混流命令参数为空。
110200902 LiveRoom 混流命令参数值不存在。
110208000 混流状态转推服务错误。
110208001 混流状态转推服务解码错误。
110208002 没有配置混流转推服务地址。
110208003 混流转推服务过载。
110208004 混流转推服务请求错误。