获取直播流量使用信息--企业直播-火山引擎

文档中心

立即注册

导航

获取直播流量使用信息

最近更新时间：2024.06.27 11:56:27首次发布时间：2024.04.09 09:00:21

您可通过此接口获取指定直播间或指定账号在指定时间范围内直播流量预付费和后付费的使用情况。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityIds	Array of Long	否	`[1795096013214780,1795096013214781]`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明最多支持同时查询 100 个直播间。本参数和 `ActivityCreator` 参数至少需要传一个。若两者同时传入，则本参数的优先级更高，即仅查询该字段中直播间的直播流量使用情况。
ActivityCreator	Object of ActivityCreatorForm	否	`-`	账号信息。说明本参数和 `ActivityIds` 参数至少需要传一个。若两者同时传入，则 `ActivityIds` 参数的优先级更高，即仅查询 `ActivityIds` 字段中直播间的直播流量使用情况。
StartDay	String	是	`20240330`	查询开始日期。格式为 `yyyymmdd`。查询开始日期需同时满足以下条件：大于等于 `T-31`，其中 T 表示当前日期。小于等于 `EndDay` 的取值。
EndDay	String	是	`20240401`	查询结束日期。格式为 `yyyymmdd`。查询结束日期需同时满足以下条件：大于等于 `StartDay` 的取值。小于等于 `T-1`，其中 T 表示当前日期。

ActivityCreatorForm

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
IsMainAccount	Boolean	否	`false`	是否为主账号。支持以下取值： `true`：是 `false`：否
SubAccountName	String	否	`+86123456`	子账号。您可以在企业直播控制台的账户中心 > 权限管理 > 用户管理页面查询子账号的账号信息。说明 `IsMainAccount` 取值为 `false` 时，该参数必传。 `IsMainAccount` 取值为 `true` 时，若传入本参数，则 `IsMainAccount` 参数的优先级更高，即查询主账号的直播流量使用情况。

IsMainAccount

Boolean

否

false

是否为主账号。支持以下取值：

true：是
false：否

SubAccountName

String

否

+86123456

子账号。您可以在企业直播控制台的账户中心 > 权限管理 > 用户管理页面查询子账号的账号信息。

说明

IsMainAccount 取值为 false 时，该参数必传。
IsMainAccount 取值为 true 时，若传入本参数，则 IsMainAccount 参数的优先级更高，即查询主账号的直播流量使用情况。

返回参数

参数	类型	示例值	描述
EstimatedResult	Array of LiveTrafficData	`-`	直播流量后付费的预估信息。T 日的数据一般可在 T+1 日 12 时前获取。
ActualResult	Array of LiveTrafficData	`-`	直播流量后付费的实际信息。T 日的数据一般可在 T+1 日 17 时前获取。
ActualPrePayResult	Array of LiveTrafficData	`-`	直播流量预付费的实际信息，T 日的数据一般可在 T+1 日 18 时前获取。

LiveTrafficData

参数	类型	示例值	描述
ActivityId	Long	`1795096013214780`	直播间 ID。
ActivityCreator	Object of ActivityCreatorForm	`-`	直播间所属账号。
LiveUV	Long	`10`	查询时间范围内，直播间内观众使用播放器观看的累计观看人数。使用相同设备（即设备 ID 相同）观看的观众被判定为同一人，人数算作 1。例如 1 位观众使用设备 A 观看了 2 次、使用设备 B 观看了 1 次，1 位观众使用设备 C 观看了 3 次，则观看人数增加 3 人。
LiveTraffic	Double	`1.1`	查询时间范围内，直播间内观众观看直播所消耗的总流量。单位为 GB。

ActivityCreatorForm

参数类型示例值描述

参数	类型	示例值	描述
IsMainAccount	Boolean	`false`	是否为主账号。支持以下取值： `true`：是 `false`：否
SubAccountName	String	`+86123456`	子账号。

IsMainAccount

Boolean

false

是否为主账号。支持以下取值：

true：是
false：否

SubAccountName String +86123456 子账号。

请求示例

POST https://livesaas.volcengineapi.com/?Action=GetLiveTrafficPostPayData&Version=2023-08-01
{
    "StartDay": "20240330",
    "EndDay": "20240401",
    "ActivityIds": [1795096013214780]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetLiveTrafficPostPayData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1700019846
    },
    "Result": {
        "EstimatedResult": [
            {
                "ActivityId": 1795096013214780,
                "ActivityCreator": {
                    "IsMainAccount": false,
                    "SubAccountName": "+86123456"
                },
                "LiveUV": 10,
                "LiveTraffic": 1.1
            }
        ],
        "ActualResult": [
            {
                "ActivityId": 1795096013214780,
                "ActivityCreator": {
                    "IsMainAccount": false,
                    "SubAccountName": "+86123456"
                },
                "LiveUV": 10,
                "LiveTraffic": 1.15
            }
        ],
        "ActualPrePayResult": [
            {
                "ActivityId": 1795096013214780,
                "ActivityCreator": {
                    "IsMainAccount": false,
                    "SubAccountName": "+86123456"
                },
                "LiveUV": 10,
                "LiveTraffic": 2.25
            }
        ]
    }
}

错误码

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