UpdateLivePromotionsStatusAPI - 更新直播转推自定义平台--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateLivePromotionsStatusAPI - 更新直播转推自定义平台

最近更新时间：2025.03.24 16:50:54首次发布时间：2022.07.13 15:53:37

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

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的营销互动 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1231231231`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Id	Long	是	`12`	直播转推自定义平台 ID。您可以通过 ListLivePromotionsAPI 接口查询 ID。
Status	Integer	否	`1`	是否开启直播转推自定义平台的推流开关。支持以下取值： `1`：开启 `2`：关闭
Name	String	否	`转推平台名称`	直播转推自定义平台的名称。最多支持输入 20 个字符。说明不支持更新抖音平台的名称。
PushUrl	String	否	`rtmp://example`	直播转推自定义平台的推流地址。说明仅支持配置使用 RTMP 和 RTMPS 协议的推流地址。不支持更新抖音平台的推流地址。

返回参数

参数	类型	示例值	描述
ActivityId	Long	`1231231231`	直播间 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLivePromotionsStatusAPI&Version=2020-06-01
{
    "ActivityId": 1231231231,
    "Id": 12,
    "Status": 1
}

返回示例

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

错误码

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