添加伴侣转播直播间--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

添加伴侣转播直播间

最近更新时间：2024.06.28 17:47:00首次发布时间：2024.06.28 10:59:25

您可通过此接口为指定直播间添加伴侣转播的直播间并作为直播伴侣内该直播间的直播源。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=AddActivityPartnerRebroadcast&Version=2023-08-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770637083012`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
RebroadcastActivityIds	Array of Long	是	`[1770637083013,1770637083014]`	待添加的伴侣转播的直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。说明每个直播间最多支持添加 20 个。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否添加成功。支持以下取值： `true`：成功 `false`：失败

Status

Boolean

true

是否添加成功。支持以下取值：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=AddActivityPartnerRebroadcast&Version=2023-08-01
{
    "ActivityId": 1770637083012,
    "RebroadcastActivityIds": [
        1770637083013,
        1770637083014
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddActivityPartnerRebroadcast",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1717269866
    },
    "Result": {
        "Status": true
    }
}

错误码

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