You need to enable JavaScript to run this app.
导航

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

最近更新时间2023.11.08 09:30:20

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

指定直播间,批量添加直播转推的自定义平台。直播间开始直播后,企业直播会向启用的自定义平台推流。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong175980616直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

AddLivePromotionsInfos

Array of AddLivePromotionsInfos

-

直播转推自定义平台的信息。

说明

最多支持添加 5 个自定义平台信息。

AddLivePromotionsInfos

参数类型是否必选示例值描述
NameStringexample平台名称,最大长度为 20 个字符。
PushUrlStringrtmp://example推流地址。

返回参数

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

LivePromotionsInfos

参数类型示例值描述
IdLong123转推平台 ID。
NameStringexample平台名称。
PushUrlStringrtmp:/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
      }
    ]
  }
}

错误码

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