ListLivePromotionsAPI - 获取直播转推的平台列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListLivePromotionsAPI - 获取直播转推的平台列表

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

获取直播间内已添加的直播转推平台的信息列表。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListLivePromotionsAPI`	接口名称。当前 API 的名称为 `ListLivePromotionsAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`175980616`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数	类型	示例值	描述
LivePromotionsInfos	Array of LivePromotionsInfos	`-`	直播转推信息列表。

LivePromotionsInfos

参数	类型	示例值	描述
Id	Long	`123`	转推平台 ID。
Name	String	`example`	平台名称。
PushUrl	String	`rtmp://example`	推流地址。说明直播转推平台为抖音时，不会返回推流地址。
Status	Integer	`1`	分发状态，支持以下两种取值。 `1`：启用 `2`：停止

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListLivePromotionsAPI&Version=2020-06-01&ActivityId=175980616

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListLivePromotionsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "LivePromotionsInfos": [
            {
                "Id": 123,
                "Name": "example",
                "PushUrl": "rtmp://example",
                "Status": 1
            }
        ]
    }
}

错误码

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