调用 GetActivityLivePromotionData
接口,获取指定直播间的直播次数、转推场次及直播转推时长等转推数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetActivityLivePromotionData | 接口名称。当前 API 的名称为 GetActivityLivePromotionData 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
StartTime | Long | 否 |
| 查询起始时间。Unix 时间戳,单位为秒。默认取值为 说明 当不传 |
EndTime | Long | 否 |
| 查询结束时间。Unix 时间戳,单位为秒。默认取值为 说明 当不传 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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=17927****17616&StartTime=1692339016&EndTime=1700115016
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetActivityLivePromotionData", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "LiveCount": 12, "LivePromotionCount": 12, "LivePromotionDuration": 3071, "LivePromotionPlatformCount": 21, "AppLiveTemplateLiveCount": 2, "AppLiveTemplateLiveDuration": 430 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.InvalidTimeRange | The specified time range is invalid. | 查询时间范围错误。请修改后重试。 |