StopAutoMix

POST

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

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

调用频率限制

100 次/秒

Request

Query Parameters

Action stringrequired

Possible values: [StopAutoMix]

接口原型参数

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

AppId uint32required

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

SignatureNonce stringrequired

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

Timestamp int64required

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

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

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

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

application/json

Body

required

TaskId stringrequired

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

RoomId stringrequired

房间 ID。

Sequence int

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

UserId string

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

Responses

操作成功

application/json

Schema
Example (from schema)

Schema

Code int

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

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

Message string

操作结果描述。

RequestId string

请求 ID。

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

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

CURL

RESPONSEClear

Click the "Send" button above and see the response here!