GetLiveLinkDurationData - 获取连麦时长使用信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetLiveLinkDurationData - 获取连麦时长使用信息

最近更新时间：2025.07.16 11:47:52首次发布时间：2025.07.16 11:47:52

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备账户中心 > 账号总览 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
使用场景：仅在消耗连麦时长包或按照连麦时长后付费时，调用该接口可以获取连麦时长使用信息。具体场景如下所示：
- 购买了连麦时长包
- 在没有连麦时长包时，开通了连麦时长后付费
您可以在企业直播控制台的账户中心 > 账号总览页面查看购买的资源包或开通的后付费情况，也可以联系商务获取相关信息。
数据延迟
- 购买了连麦时长包：连麦时长包会在购买的当天生效，您可在次日调用该接口获取连麦时长使用信息。
- 在没有连麦时长包时，开通了连麦时长后付费：开通当天即可按照连麦时长后付费，您可在次日调用该接口获取连麦时长使用信息。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
StartDay	String	是	`20240330`	查询开始日期（UTC+8）。格式为 `yyyymmdd`。查询开始日期需同时满足以下条件：大于等于 `T-31`，其中 T 表示当前日期。小于等于 `EndDay` 的取值。
EndDay	String	是	`20240401`	查询结束日期（UTC+8）。格式为 `yyyymmdd`。查询结束日期需同时满足以下条件：大于等于 `StartDay` 的取值。小于等于 `T-1`，其中 T 表示当前日期。
ActivityIds	Array of Long	否	`[179509**4214780,17950**414781]`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明最多支持同时查询 100 个直播间。本参数和 `ActivityCreator` 参数至少需要传一个。若两者同时传入，则本参数的优先级更高，即仅查询该字段中直播间的连麦时长使用情况。使用子账号调用接口时，如需传入该参数，请确保直播间对于该子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
ActivityCreator	Object of ActivityCreator	否	`-`	创建直播间的账号。说明本参数和 `ActivityIds` 参数至少需要传一个。若两者同时传入，则 `ActivityIds` 参数的优先级更高，即仅查询 `ActivityIds` 字段中直播间的连麦时长使用情况。使用子账号调用接口时，如果未传入 `ActivityIds`，则默认查询该子账号创建的所有直播间的连麦时长使用情况，该参数不生效。

ActivityCreator

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

参数	类型	是否必选	示例值	描述
IsMainAccount	Boolean	否	`false`	是否为主账号，即是否查询主账号创建的所有直播间的连麦时长使用情况。取值如下： `true`：是 `false`：否。您必须传入 `SubAccountName`，查询指定子账号创建的所有直播间的连麦时长使用情况。说明仅在使用主账号调用接口时，该参数生效。
SubAccountName	String	否	`+8613****00000`	子账号的账号，即查询该子账号创建的所有直播间的连麦时长使用情况。您可调用 ListSubAccounts 接口，通过参数 `Name` 获取子账号的账号。说明仅在使用主账号调用接口，且 `IsMainAccount` 取值为 `false` 时，该参数必选且生效。

IsMainAccount

Boolean

否

false

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

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

说明

仅在使用主账号调用接口时，该参数生效。

SubAccountName

String

否

+8613****00000

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

说明

仅在使用主账号调用接口，且 IsMainAccount 取值为 false 时，该参数必选且生效。

返回参数

参数	类型	示例值	描述
PrePayData	Array of PrePayData	`-`	连麦时长的预付费信息，T 日的数据一般可在 T+1 日 0 点（UTC+8）后获取，即在北京时间（UTC+8）7 月 14 日凌晨 0 点之后，可以获取 7 月 13 日的数据。
PostPayData	Array of PostPayData	`-`	连麦时长的后付费信息，T 日的数据一般可在 T+1 日 0 点（UTC+8）后获取，即在北京时间（UTC+8）7 月 14 日凌晨 0 点之后，可以获取 7 月 13 日的数据。

PrePayData

参数	类型	示例值	描述
ActivityId	Long	`179509****4214780`	直播间 ID。
ActivityCreator	Object of ActivityCreator	`-`	创建直播间的账号。
DurationMinute	Integer	`100`	查询时间范围内，直播间内的连麦总时长。单位为分钟。

PostPayData

参数	类型	示例值	描述
ActivityId	Long	`17950****414781`	直播间 ID。
ActivityCreator	Object of ActivityCreator	`-`	创建直播间的账号。
DurationMinute	Integer	`200`	查询时间范围内，直播间内的连麦总时长。单位为分钟。

ActivityCreator

参数类型示例值描述

参数	类型	示例值	描述
IsMainAccount	Boolean	`false`	是否为主账号创建的直播间。取值如下： `true`：是 `false`：否
SubAccountName	String	`+8613****00000`	创建直播间的子账号的账号。说明该参数仅在 `IsMainAccount` 取值为 `false` 时生效。

IsMainAccount

Boolean

false

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

true：是
false：否

SubAccountName

String

+8613****00000

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

说明

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetLiveLinkDurationData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "PrePayData": [
            {
                "ActivityId": 179509****4214780,
                "ActivityCreator": {
                    "IsMainAccount": false,
                    "SubAccountName": "+8613****00000"
                },
                "DurationMinute": 100
            }
        ],
        "PostPayData": []
    }
}

错误码

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