You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

更新直播转推自定义平台

最近更新时间：2024.03.01 14:04:34

首次发布时间：2022.07.13 15:53:37

我的收藏

通过本接口，您可以更新指定直播间中指定自定义平台的推流状态、平台名称等。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

  • 请求方式：POST
  • 请求地址：https://livesaas.volcengineapi.com/?Action=UpdateLivePromotionsStatusAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是UpdateLivePromotionsStatusAPI接口名称。当前 API 的名称为 UpdateLivePromotionsStatusAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是1231231231直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
IdLong是12直播转推自定义平台 ID。您可以通过 ListLivePromotionsAPI 接口查询 ID。

Status

Integer

否

1

是否开启直播转推自定义平台的推流开关。支持以下取值：

  • 1：开启
  • 2：关闭

Name

String

否

转推平台名称

直播转推自定义平台的名称。最多支持输入 20 个字符。

说明

不支持更新抖音平台的名称。

PushUrl

String

否

rtmp://example

直播转推自定义平台的推流地址。

说明

  • 仅支持配置使用 RTMP 和 RTMPS 协议的推流地址。
  • 不支持更新抖音平台的推流地址。

返回参数

参数类型示例值描述
ActivityIdLong1231231231直播间 ID。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLivePromotionsStatusAPI&Version=2020-06-01
{
  "ActivityId": 1231231231,
  "Id": 12,
  "Status": 1,
  "Name":"转推平台名称",
  "PushUrl":"rtmp://example"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D2",
    "Action": "UpdateLivePromotionsStatusAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "ActivityId": 1231231231
  }
}

错误码

访问公共错误码和错误码获取详细信息。