获取通话时长数据 ListUsages--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取通话时长数据 ListUsages

最近更新时间：2024.07.16 15:31:23首次发布时间：2024.02.27 14:52:18

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，你可以通过调用此接口获取特定应用在指定时间段内的通话时长数据。数据以天为单位进行汇总。

注意：由于汇总粒度不同，此处获取的数据和账单通话时长数据差异。最终数据以账单数据为准。

注意事项

最大请求次数：2次/秒
最远可查询时间：30 天
数据粒度：1 天
数据延迟：8 小时

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=ListUsages&Version=2023-11-01

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
StartTime	String	是	`2021-07-24T00:00:00+08:00`	查询数据的开始时间，格式要求符合 RFC3339 规范
EndTime	String	是	`2021-07-28T00:00:00+08:00`	查询数据的结束时间，格式要求符合 RFC3339 规范。起止时间的跨度最多为 30 天

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
Usages	Object[]	`-`	具体的通话时长数据
Audio	Long	`123456`	计价档位为纯音频的通话时长，单位为分钟
VideoHD	Long	`123456`	计价档位为 1080P 视频的通话时长，单位为分钟
VideoSD	Long	`123456`	计价档位为 720P 视频的通话时长，单位为分钟
VideoSDM	Long	`123456`	计价档位为 360P 视频的通话时长，单位为分钟
TimeStamp	String	`2021-07-24T00:00:00+08:00`	指标聚合的时间，格式为 RFC3339 规范。这个参数的值，指通话时长对应时间段的开始时刻。以示例值为例，意味着对应的时间段为北京时间 2021 年 7 月 24 日 0 点起的 1 天。

请求示例

POST https://rtc.volcengineapi.com?Action=ListUsages&Version=2023-11-01
{
  "AppId": "661e****543cf",
  "StartTime": "2021-07-24T08:00:00+08:00",
  "EndTime": "2021-07-28T08:00:00+08:00"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "ListUsages",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Usages": [
            {
                "TimeStamp": "2021-07-24T00:00:00+08:00",
                "Audio": 12345,
                "VideoSDM": 123456,
                "VideoSD": 11111,
                "VideoHD": 12321
            },
            {
                "TimeStamp": "2021-07-25T00:00:00+08:00",
                "Audio": 12345,
                "VideoSDM": 123456,
                "VideoSD": 11111,
                "VideoHD": 12321
            }
        ]
    }
}