停止自动混流
描述
调用本接口停止 音频 自动混流任务。相关回调请参考 混流结束回调。
接口原型
- 请求方法：POST
说明
使用 POST 请求方法传递参数时：
- Body 中的参数直接传 JsonObject 格式即可，无需序列化为 String 格式。
- Headers 中，设置 “Content-type” 为 “application/json”。
- 请求地址：
https://rtc-api.zego.im/?Action=StopAutoMix - 传输协议：HTTPS
- 调用频率限制：100 次/秒
请求参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 完整公共参数列表请参考 调用方式 中的 “公共请求参数”。
| 名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| TaskId | String | 是 | 混流任务 ID，需要和开始混流传入的 TaskId 保持一致。 |
| RoomId | String | 是 | 房间 ID。 |
| Sequence | Int | 否 | 混流任务的序列号，用于保证时序，同个任务的参数修改需要保证序列号的递增。 |
| UserId | String | 否 | 用户 ID。当开启混流任务归属时停止某个 TaskId 的混流任务必须输入开始混流任务时指定的 UserId。 |
请求示例
-
请求 URL
https://rtc-api.zego.im/?Action=StopAutoMix &<公共请求参数> -
请求消息体
{ "TaskId": "2213699902971205739", "Sequence": 1, "RoomId": "room123" }
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| Code | Number | 返回码。 |
| Message | String | 操作结果描述。 |
| RequestId | String | 请求 ID。 |
响应示例
{
"Code":0,
"Message":"success",
"RequestId":"6351841974556802202"
}返回码
以下仅列出了接口业务逻辑相关的部分返回码，完整返回码请参考 全局返回码。
| 返回码 | 说明 | 处理建议 |
|---|---|---|
| 110200001 | 失败。 | 请重试。 |
| 110200002 | 输入参数错误。 | 请参考 Message 信息处理。 |
| 110200003 | 鉴权失败。 | 请确认鉴权信息是否正确或过期，详情请参考 调用方式 中的 “3 签名机制”。 |
| 110200004 | 解析输入参数失败。 | 请检查混流参数是否正确。 |