获取直播间直播转推数据--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间直播转推数据

最近更新时间：2024.06.25 12:10:43首次发布时间：2024.04.02 13:37:23

您可通过此接口获取指定直播间的直播次数、转推场次及直播转推时长等转推数据。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityLivePromotionData`	接口名称。当前 API 的名称为 `GetActivityLivePromotionData`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`17927291817616`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
StartTime	Long	否	`1692339016`	查询起始时间。Unix 时间戳，单位为秒。默认取值为`当前时间 - 30 天（即 2,592,000 秒）`。默认查询近 30 天的转推数据。
EndTime	Long	否	`1700115016`	查询结束时间。Unix 时间戳，单位为秒。默认取值为`当前时间`。默认查询近 30 天的转推数据。

返回参数

参数	类型	示例值	描述
LiveCount	Long	`12`	直播场次，即直播间直播的次数。直播间的 1 次开关播，算作 1 个直播场次。单位为次。
LivePromotionCount	Long	`12`	转推场次，即直播间开启直播转推开关的直播场次数。一场直播中，无论转推到多少个第三方平台或账号、转推是否成功，转推场次均算作 1。单位为次。有关如何开启直播转推开关，详见直播转推。
LivePromotionDuration	Long	`3071`	转推时长，即直播间开启直播转推开关的直播场次的直播时长之和。单位为秒。有关如何开启直播转推开关，详见直播转推。1 个直播场次只要转推过，就以该场次完整直播时长计算。例如直播间 A 开启过 2 场直播且均开启了直播转推开关。其中第一场直播的时长为 3600 秒，转推 B 平台 1200 秒，转推 C 平台 3000 秒，则第一场直播的转推时长为 3600 秒。第二场直播的时长为 1800 秒，转推 D 平台 300 秒，则第二场直播的转推时长为 1800 秒。因此，直播间 A 的转推时长为 5400（36000+1800）秒。
LivePromotionPlatformCount	Long	`21`	转推平台数量，即直播间所有直播场次成功转推的平台数之和。单位为个。有关如何开启直播转推开关，详见直播转推。
AppLiveTemplateLiveCount	Long	`2`	手机开播装修场次，即直播间使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层（包括直播模板中的挂件和图层）功能进行装修的直播场次数。单位为次。有关如何使用挂件和图层功能，详见手机开播和 SDK 概览。
AppLiveTemplateLiveDuration	Long	`430`	手机开播装修时长，即直播间使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层（包括直播模板中的挂件和图层）功能进行装修的直播场次的直播时长之和。单位为秒。有关如何使用挂件和图层功能，详见手机开播和 SDK 概览。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024040209212432B72B98C9B9F00E7381",
        "Action": "GetActivityLivePromotionData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1712020884
    },
    "Result": {
        "LiveCount": 12,
        "LivePromotionCount": 12,
        "LivePromotionDuration": 3071,
        "LivePromotionPlatformCount": 21,
        "AppLiveTemplateLiveCount": 2,
        "AppLiveTemplateLiveDuration": 430
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.InvalidTimeRange	The specified time range is invalid.	查询时间范围错误。请修改后重试。