You need to enable JavaScript to run this app.
导航
停止发布公共流 StopPushPublicStream
最近更新时间:2024.07.11 18:53:51首次发布时间:2022.05.20 20:23:14

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

使用说明

接口行为

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

注意事项

请求频率:QPS 不得超过 150。

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=StopPushPublicStream&Version=2020-12-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必选
示例值
描述
Action
String
StopPushPublicStream
接口名称。当前 API 的名称为 StopPushPublicStream
Version
String
2020-12-01
接口版本。当前 API 的版本为 2020-12-01

Body

参数
类型
是否必选
示例值
描述
AppId
String
Your_AppId
你的音视频应用的唯一标志
BusinessId
String
Your_BusinessId
业务标识
PublicStreamId
String
Your_PublicStream
公共流 ID。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=StopPushPublicStream&Version=2020-12-01
{
  "AppId": "Your_AppId",
  "BusinessId": "Your_BusinessId",
  "PublicStreamId": "PublicStreamId"
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopPushPublicStream",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。