logo
实时音视频
服务端 API
场景服务接口
当前页

StopAutoMix

POST

https://rtc-api.zego.im/

调用本接口停止 音频 自动混流任务。相关回调请参考 混流结束回调

调用频率限制
100 次/秒

Request

Query Parameters

    Action string必填

    可选值: [StopAutoMix]

    接口原型参数

    https://rtc-api.zego.im?Action=StopAutoMix

    AppId uint32必填

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce string必填

    💡公共参数。随机字符串。

    Timestamp int64必填

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

Body

required
    TaskId string必填

    混流任务 ID,需要和开始混流传入的 TaskId 保持一致。

    RoomId string必填

    房间 ID。

    Sequence int

    混流任务的序列号,用于保证时序,同个任务的参数修改需要保证序列号的递增。

    UserId string

    用户 ID。当开启混流任务归属时停止某个 TaskId 的混流任务必须输入开始混流任务时指定的 UserId。

Responses

操作成功
Schema
    Code int

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

    返回码说明处理建议
    110200001失败。请重试。
    110200002输入参数错误。请参考 Message 信息处理。
    110200003鉴权失败。请确认鉴权信息是否正确或过期,详情请参考 调用方式 中的 "3 签名机制"。
    110200004解析输入参数失败。请检查混流参数是否正确。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。


Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
Body必填
{
"TaskId": "2213699902971205739",
"RoomId": "room123",
"Sequence": 1,
"UserId": "user1"
}
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

开始自动混流

Next

开始单流转码

当前页

返回到顶部