You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/数据查询/Version：2023-08-01/获取直播流量使用信息
获取直播流量使用信息
最近更新时间：2025.01.21 15:22:13首次发布时间：2024.04.09 09:00:21
我的收藏

调用 GetLiveTrafficPostPayData 接口，获取指定直播间或指定账号创建的所有直播间在指定时间范围内直播流量预付费和后付费的使用情况。

注意事项

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

  • 使用场景：仅在消耗直播流量包或按照直播流量后付费时，调用该接口可以获取直播流量使用信息。具体场景如下所示：

    • 在没有并发包时，购买了直播流量包
    • 在没有并发包、直播流量包和观看时长包时，开通了直播流量后付费

    您可以在企业直播控制台的账户中心 > 账号总览页面查看购买的资源包或开通的后付费情况，也可以联系商务获取相关信息。

  • 数据延迟：

    • 如果您当前拥有观看时长包，则直播流量包会在购买的次日生效，您可在购买的两天后调用该接口获取直播流量使用信息。例如，如果您今天购买直播流量包，直播流量包会在明天生效，您可在后天调用该接口获取直播流量使用信息。
    • 在没有任何并发包、直播流量包和观看时长包时，购买了直播流量包或开通了直播流量后付费。
      • 购买了直播流量包：直播流量包会在购买的当天生效，您可在次日调用该接口获取直播流量使用信息。
      • 开通了直播流量后付费：开通当天即可按照直播流量后付费，您可在次日调用该接口获取直播流量使用信息。

请求说明

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

请求参数

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

Query

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

Body

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

ActivityIds

Array of Long

否

[179509****214780,179509****214781]

直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

说明

  • 最多支持同时查询 100 个直播间。
  • 本参数和 ActivityCreator 参数至少需要传一个。若两者同时传入，则本参数的优先级更高，即仅查询该字段中直播间的直播流量使用情况。

ActivityCreator

Object of ActivityCreatorForm

否

-

创建直播间的账号。

说明

本参数和 ActivityIds 参数至少需要传一个。若两者同时传入，则 ActivityIds 参数的优先级更高，即仅查询 ActivityIds 字段中直播间的直播流量使用情况。

StartDay

String

是

20240330

查询开始日期（UTC+8）。格式为 yyyymmdd。查询开始日期需同时满足以下条件：

  1. 大于等于 T-31，其中 T 表示当前日期。
  2. 小于等于 EndDay 的取值。

EndDay

String

是

20240401

查询结束日期（UTC+8）。格式为 yyyymmdd。查询结束日期需同时满足以下条件：

  1. 大于等于 StartDay 的取值。
  2. 小于等于 T-1，其中 T 表示当前日期。

ActivityCreatorForm

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

IsMainAccount

Boolean

否

false

是否为主账号，即是否查询主账号创建的所有直播间的直播流量使用情况。取值如下：

  • true：是
  • false：否。您必须传入 SubAccountName，查询指定子账号创建的所有直播间的直播流量使用情况

SubAccountName

String

否

+8613****00000

子账号的账号，即查询该子账号创建的所有直播间的直播流量使用情况。您可调用 ListSubAccounts 接口，通过参数 Name 获取子账号的账号。

说明

当 IsMainAccount 取值为 false 时，该参数必选。

返回参数

参数类型示例值描述
EstimatedResultArray of LiveTrafficData-直播流量后付费的预估信息。T 日的数据一般可在 T+1 日 12 点（UTC+8）后获取。
ActualResultArray of LiveTrafficData-直播流量后付费的实际信息。T 日的数据一般可在 T+1 日 17 点（UTC+8）后获取。
ActualPrePayResultArray of LiveTrafficData-直播流量预付费的实际信息，T 日的数据一般可在 T+1 日 18 点（UTC+8）后获取。

LiveTrafficData

参数类型示例值描述
ActivityIdLong179509****214780直播间 ID。
ActivityCreatorObject of ActivityCreatorForm-创建直播间的账号。

LiveUV

Long

10

查询时间范围内，直播间内观众使用播放器观看的累计观看人数。使用相同设备（即设备 ID 相同）观看的观众被判定为同一人，人数算作 1。
例如 1 位观众使用设备 A 观看了 2 次、使用设备 B 观看了 1 次，1 位观众使用设备 C 观看了 3 次，则观看人数增加 3 人。

LiveTrafficDouble1.1查询时间范围内，直播间内观众观看直播所消耗的总流量。单位为 GB。

ActivityCreatorForm

参数类型示例值描述

IsMainAccount

Boolean

false

是否为主账号创建的直播间。取值如下：

  • true：是
  • false：否

SubAccountName

String

+8613****00000

创建直播间的子账号的账号。

说明

该参数仅在 IsMainAccount 取值为 false 时生效。

请求示例

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

返回示例

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

错误码

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