You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

停止发布公共流 StopPushPublicStream

最近更新时间：2024.04.11 11:50:49

首次发布时间：2024.01.03 20:25:16

我的收藏

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

使用说明

接口行为

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

请求频率：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
是
Your_AppId
你的音视频应用的唯一标志
BusinessId
String
否
Your_BusinessId
业务标识
PublicStreamId
String
是
Your_PublicStream
公共流 ID。

返回参数

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

请求示例

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

返回示例

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

错误码

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