获取伴侣转播直播间信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取伴侣转播直播间信息

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

您可通过此接口获取指定直播间的伴侣转播直播间信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityPartnerRebroadcast`	接口名称。当前 API 的名称为 `GetActivityPartnerRebroadcast`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1770637083012`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数	类型	示例值	描述
RebroadcastActivities	Array of RebroadcastActivities	`-`	伴侣转播直播间信息列表。

RebroadcastActivities

参数	类型	示例值	描述
CoverImage	String	`https://p1-live.example.com/tos-cn-i/~tplv--image.image`	直播封面图 URL。包含协议头。
Name	String	`直播间 A`	直播间名称。
ViewPageUrl	String	`https://live.example.com/1111/22222`	PC 和移动端横屏模式的观看页地址。
ActivityId	Long	`1770637083013`	直播间 ID。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityPartnerRebroadcast&Version=2023-08-01&ActivityId=1770637083012

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityPartnerRebroadcast",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1717269866
    },
    "Result": {
        "RebroadcastActivities": [
            {
                "CoverImage": "https://p1-live.example.com/tos-cn-i/~tplv--image.image",
                "Name": "直播间 A",
                "ViewPageUrl": "https://live.example.com/1111/22222",
                "ActivityId": 1770637083013
            }
        ]
    }
}

错误码

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