You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

获取通话时长数据 ListUsages

最近更新时间：2024.02.29 19:30:22

首次发布时间：2021.08.04 20:13:06

我的收藏

你可以使用此接口查询一段时间内，某个应用的通话时长数据。

使用说明

接口行为

指定时间段，和应用对应的 AppID，获取通话时长数据（粒度为天）。

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

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

请求示例

POST https://rtc.volcengineapi.com?Action=ListUsages&Version=2020-12-01
{
  "AppId": "Your_AppId",
  "StartTime": "2021-07-24T08:00:00+08:00",
  "EndTime": "2021-07-28T08:00:00+08:00"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"Your_RequestId",
        "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
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。