如果你已发布了一路公共流,你可以调用 StopPushPublicStream 接口,来停止发布。

接口行为

你可以调用 StopPushPublicStream 接口,停止发布公共流。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制

QPS 不得超过 150。

请求方式

使用 Post 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
参数名类型必填示例值描述
ActionString是StopPushPublicStream
VersionString是2020-12-01OpenAPI 版本
Body
参数名类型必填示例值描述
AppIdString是6xxxxxxxxxxxxxxxxxxxxx75你的音视频应用的唯一标志
BusinessIdstring否BusinessId1业务标识
PublicStreamIdString是PublicStream1公共流 ID。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=StopPushPublicStream&Version=2020-12-01
postscript
Body
{
    "AppId" : "Your_AppId",
    "BusinessId" : "Your_BusinessId", 
    "PublicStreamId": "PublicStreamId",
}
json
返回调用结果

返回值 Result 仅在请求成功时返回"ok",时返回错误码和相关信息。

正常返回示例
{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopPushPublicStream",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
        }
}
json