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

文档中心

立即注册

导航

企业直播

获取直播转推的平台列表

最近更新时间：2023.11.08 09:30:20首次发布时间：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": "202201201826170101501312091D1C09D2",
    "Action": "ListLivePromotionsAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "LivePromotionsInfos": [
      {
        "Id": 123,
        "Name": "example",
        "PushUrl": "rtmp://example",
        "Status": 1
      }
    ]
  }
}

错误码

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