查询用量明细(QueryUsageDetails)
查询当前账号下服务数字员工的资源用量统计数据,返回各计费周期的通话时长额度总量、已用额度、剩余额度、使用率及坐席数等汇总信息,用于用量概览展示。
前提条件
-
已安装SDK。
-
已获取并使用AccessKey的方式,请参考获取AccessKey并配置到环境变量。
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
|
Action |
String |
是 |
要执行的操作。取值:QueryUsageDetails。 |
QueryUsageDetails |
|
Version |
String |
是 |
API版本号。格式为:YYYY-MM-DD。取值:2025-11-27。 |
固定为2025-11-27 |
|
StartDate |
String |
否 |
任务开始日期。 |
2024-01-01 |
|
EndDate |
String |
否 |
任务结束日期。 |
2024-01-31 |
|
UsageType |
String |
否 |
CALL / SMS |
CALL |
|
TaskId |
Number |
否 |
任务 ID |
1 |
|
Current |
Number |
否 |
当前页码。 |
1 |
|
Size |
Number |
否 |
每页条数。 |
10 |
响应参数
|
名称 |
类型 |
描述 |
示例值 |
|
RequestId |
String |
请求ID。 |
xxxx-xxxx-xxxx |
|
Success |
Boolean |
请求是否成功。 |
True |
|
Code |
String |
错误码。请求成功时为空。 |
None |
|
Message |
String |
错误信息或成功提示。 |
操作成功 |
|
Total |
Long |
总记录数。 |
50 |
|
Current |
Long |
当前页码。 |
1 |
|
Size |
Long |
每页条数。 |
10 |
|
Records |
Array |
返回数据,包含DetailId, TaskId, TaskName, UsageType, CallCount, Duration, Cost, UsageDate, GmtCreate等字段,具体说明请参见下方返回参数说明。 |
使用示例
Python
import json
import os
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_openapi.client import Client as OpenApiClient
from alibabacloud_tea_util import models as util_models
from alibabacloud_openapi_util.client import Client as OpenApiUtilClient
def main():
config = open_api_models.Config(
access_key_id=os.getenv("ACCESS_KEY_ID"),
access_key_secret=os.getenv("ACCESS_KEY_SECRET"),
)
config.endpoint = "thirdswaicall.aliyuncs.com"
config.protocol = "HTTPS"
client = OpenApiClient(config)
params = open_api_models.Params(
style="RPC",
version="2025-11-27",
action="QueryUsageDetails",
method="POST",
pathname="/",
protocol="HTTPS",
auth_type="AK",
req_body_type="json",
body_type="json",
)
body = {'StartDate': '2024-01-01', 'EndDate': '2024-01-31', 'Current': 1, 'Size': 10}
request = open_api_models.OpenApiRequest(query=OpenApiUtilClient.query(body))
runtime = util_models.RuntimeOptions(autoretry=True, max_attempts=3)
try:
resp = client.call_api(params, request, runtime)
print(json.dumps(resp.get("body", {}), ensure_ascii=False, indent=2))
except Exception as e:
print(f"调用失败: {e}")
if __name__ == "__main__":
main()
Java
import com.aliyun.teaopenapi.Client;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teaopenapi.models.OpenApiRequest;
import com.aliyun.teaopenapi.models.Params;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;
import java.util.HashMap;
import java.util.Map;
public class Demo {
public static void main(String[] args) throws Exception {
// 初始化配置
Config config = new Config()
.setAccessKeyId(System.getenv("ACCESS_KEY_ID"))
.setAccessKeySecret(System.getenv("ACCESS_KEY_SECRET"))
.setEndpoint("thirdswaicall.aliyuncs.com")
.setProtocol("HTTPS");
Client client = new Client(config);
// 设置 API 参数
Params params = new Params()
.setStyle("RPC")
.setVersion("2025-11-27")
.setAction("QueryUsageDetails")
.setMethod("POST")
.setPathname("/")
.setProtocol("HTTPS")
.setAuthType("AK")
.setReqBodyType("json")
.setBodyType("json");
// 构建请求参数
Map<String, Object> body = new HashMap<>();
// 根据实际需求添加请求参数
OpenApiRequest request = new OpenApiRequest()
.setQuery(com.aliyun.openapiutil.Client.query(body));
// 设置运行时选项(自动重试)
RuntimeOptions runtime = new RuntimeOptions()
.setAutoretry(true)
.setMaxAttempts(3);
try {
// 调用 API
Map<String, ?> response = client.callApi(params, request, runtime);
Gson gson = new Gson();
System.out.println(gson.toJson(response.get("body")));
} catch (Exception e) {
System.err.println("调用失败: " + e.getMessage());
}
}
}
返回示例
{
"Success": true,
"Code": null,
"Message": "操作成功",
"RequestId": "xxxx-xxxx-xxxx",
"Total": 50,
"Current": 1,
"Size": 10,
"Records": [
{
"DetailId": 1,
"TaskId": 1,
"TaskName": "春节促销外呼任务",
"UsageType": "CALL",
"CallCount": 100,
"Duration": 500,
"Cost": 50.0,
"UsageDate": "2024-01-01",
"GmtCreate": "2025-01-10 10:00:00"
}
]
}
具体的处理结果在Records节点中,以下为Records节点的参数说明。
|
名称 |
类型 |
描述 |
示例值 |
|
DetailId |
Number |
明细ID |
1 |
|
TaskId |
Number |
任务ID |
1 |
|
TaskName |
String |
任务名称 |
春节促销外呼任务 |
|
UsageType |
String |
用量类型 |
CALL |
|
CallCount |
Number |
通话次数 |
100 |
|
Duration |
Number |
通话时长(分钟) |
500 |
|
Cost |
Number |
费用(元) |
50.0 |
|
UsageDate |
String |
使用日期 |
2024-01-01 |
|
GmtCreate |
String |
创建时间 |
2025-01-10 10:00:00 |
错误信息
如果执行报错,请参考错误信息进行解决。