AddLivePromotionsAPI - 批量添加直播转推自定义平台--企业直播-火山引擎

AddLivePromotionsAPI - 批量添加直播转推自定义平台

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

通过本接口，您可以为指定直播间批量添加直播转推的自定义平台。直播间开始直播后，企业直播会向开启推流开关的自定义平台推流。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`175980616`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
AddLivePromotionsInfos	Array of AddLivePromotionsInfos	是	`-`	直播转推自定义平台的信息。说明最多支持添加 5 个自定义平台信息。

AddLivePromotionsInfos

参数	类型	是否必选	示例值	描述
Name	String	是	`example`	直播转推自定义平台的名称。最多支持输入 20 个字符。
PushUrl	String	是	`rtmp://example`	直播转推自定义平台的推流地址。说明仅支持配置使用 RTMP 和 RTMPS 协议的推流地址。

返回参数

参数	类型	示例值	描述
LivePromotionsInfos	Array of LivePromotionsInfos	`-`	添加自定义平台的结果信息。

LivePromotionsInfos

参数	类型	示例值	描述
Id	Long	`123`	直播转推自定义平台 ID。
Name	String	`example`	直播转推自定义平台的名称。
PushUrl	String	`rtmp://example`	直播转推自定义平台的推流地址。
Status	Integer	`1`	是否开启直播转推自定义平台的推流开关。支持以下取值： `1`：开启 `2`：关闭

请求示例

POST https://livesaas.volcengineapi.com/?Action=AddLivePromotionsAPI&Version=2020-06-01
{
    "ActivityId": 175980616,
    "AddLivePromotionsInfos": [
        {
            "Name": "example",
            "PushUrl": "rtmp://example"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202201201826170101501312091D1C09D2",
        "Action": "AddLivePromotionsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    },
    "Result": {
        "LivePromotionsInfos": [
            {
                "Id": 123,
                "Name": "example",
                "PushUrl": "rtmp://example",
                "Status": 1
            }
        ]
    }
}

错误码

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