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

接口行为

指定时间段,和应用对应的 AppID,获取通话时长数据(粒度为天)。

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

请求方式

使用 POST 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
参数名类型必填示例值描述
ActionString是ListUsages
VersionString是2020-12-01OpenAPI 版本
Body
参数名类型必填示例值描述
AppIdString是Your_AppId你的音视频应用的唯一标志
StartTimeString是2021-07-24T00:00:00+08:00查询数据的开始时间,格式要求符合 RFC3339 规范
EndTimeString是2021-07-28T00:00:00+08:00查询数据的结束时间,格式要求符合 RFC3339 规范。起止时间的跨度最多为30天
请求示例代码
Query
https://rtc.volcengineapi.com?Action=ListUsages&Version=2020-12-01
Body
{
"AppId" : "Your_AppId",
"StartTime" : "2021-07-24T08:00:00+08:00",
"EndTime" : "2021-07-28T08:00:00+08:00"
}
返回调用结果

返回结果参看 BaseResponse。
其中 Result 的结构如下:

Result
参数名类型示例值描述
UsagesArray of Usage/具体的通话时长数据
Usage
参数名类型示例值描述
TimeStampstring2021-07-24T00:00:00+08:00指标聚合的时间,格式为 RFC3339 规范。这个参数的值,指通话时长对应时间段的开始时刻。以示例值为例,意味着对应的时间段为 北京时间2021年7月24日0点起的1天。
Audioint123456计价档位为纯音频的通话时长,单位:分钟
VideoSDMint123456计价档位为 360P 视频的通话时长,单位:分钟
VideoSDint123456计价档位为 720P 视频的通话时长,单位:分钟
VideoHDint123456计价档位为 1080P 视频的通话时长,单位:分钟

关于计价档位,参看计费规则。

返回结果
正常返回示例
{
    "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
            }
        ]
    }
}
json