停止发布公共流 StopPushPublicStream--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

停止发布公共流 StopPushPublicStream

最近更新时间：2024.07.16 15:31:21首次发布时间：2024.01.03 20:25:16

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，当你需要停止发布已经发布的公共流时，可以通过调用此接口实现。

注意事项

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

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=StopPushPublicStream&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
BusinessId	String	否	`B****23`	业务标识
PublicStreamId	String	是	`PublicStream1`	公共流 ID。

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=StopPushPublicStream&Version=2023-11-01
{
  "AppId": "661e****543cf",
  "BusinessId": "B****23",
  "PublicStreamId": "PublicStreamId"
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "StopPushPublicStream",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

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