业务统计
更新时间:2023-11-09
描述
获取下发短信的业务统计信息
参数说明
参数名称 | 类型 | 是否必需 | 描述 | 取值示例 |
---|---|---|---|---|
countryType | String | 是 | 适用国家类型 domestic:国内 international:国际/港澳台 |
domestic |
smsType | String | 是 | 短信类型,默认值“all”,查询所有短信 | CommonNotice |
startTime | String | 是 | 数据统计的起始日期,格式为:yyyy-MM-dd 支持获取365天以内的统计数据 |
2023-03-01 |
endTime | String | 是 | 数据统计的截止日期,格式为:yyyy-MM-dd | 2023-10-01 |
signatureId | String | 否 | 短信签名ID,用于指定查询的短信 | sms-signQxkiwz88470 |
templateCode | String | 否 | 短信模板码/模板ID,用于指定查询的短信 | sms-tmpl-KyAUkV11419 |
统计结果属性
属性字段名称 | 类型 | 描述 | 注意事项 |
---|---|---|---|
datetime | String | 统计数据的时间,格式为yyyy-MM-dd | 每次响应包含一条datetime值为“合计”的数据,代表本次查询时间范围内所有数据的共计数据 |
countryAlpha2Code | String | 所属国家的ISO 3166-1的二位字母代码 | 仅当查询参数countryType为“international”时有效 |
submitCount | String | 短信的下发数量 | - |
submitLongCount | String | 长短信(完整短信)下发数量 | - |
responseSuccessCount | String | 下发短信响应成功数量 | - |
responseSuccessProportion | String | 下发短信响应成功比例 | - |
deliverSuccessCount | String | 下发短信抵达成功数量 | 此字段不适用于国际/港澳台短信统计查询 |
deliverSuccessLongCount | String | 长短信(完整短信)下发抵达成功数量 | 此字段不适用于国际/港澳台短信统计查询 |
deliverSuccessProportion | String | 下发短信抵达成功比例 | 此字段不适用于国际/港澳台短信统计查询 |
deliverFailureCount | String | 下发短信抵达失败数量 | 此字段不适用于国际/港澳台短信统计查询 |
deliverFailureProportion | String | 下发短信抵达失败比例 | 此字段不适用于国际/港澳台短信统计查询 |
receiptProportion | String | 下发短信回执比例 | - |
unknownCount | String | 下发短信抵达未知数量 | - |
unknownProportion | String | 下发短信抵达未知比例 | - |
responseTimeoutCount | String | 下发短信响应超时数量 | - |
unknownErrorCount | String | 失败原因未知数量 | - |
notExistCount | String | 失败原因数量统计:手机号不存在 | - |
signatureOrTemplateCount | String | 失败原因数量统计:签名或模板错误 | - |
abnormalCount | String | 失败原因数量统计:运营商网络错误 | - |
overclockingCount | String | 失败原因数量统计:网关下发超时 | - |
otherErrorCount | String | 失败原因数量统计:其他错误 | - |
blacklistCount | String | 失败原因数量统计:手机号在黑名单中 | - |
routeErrorCount | String | 失败原因数量统计:路由或通道错误 | - |
issueFailureCount | String | 失败原因数量统计:运营商下发错误 | - |
parameterErrorCount | String | 失败原因数量统计:参数错误 | - |
illegalWordCount | String | 失败原因数量统计:非法屏蔽词错误 | - |
anomalyCount | String | 失败原因数量统计:手机设备异常 | - |
代码示例
ListStatisticsRequest request = new ListStatisticsRequest();
// 设置必要的参数(注意查询时间的取值范围)
request.setStartTime("2023-10-01");
request.setEndTime("2023-10-10");
request.setSmsType("all");
request.setCountryType("domestic");
// 设置可选参数
request.setSignatureId("sms-signQxkiwz88470");
request.setTemplateCode("sms-tmpl-KyAUkV11419");
// 获取查询结果
try {
ListStatisticsResponse response = smsClient.listStatistics(request);
System.out.println(response.toString());
} catch (BceServiceException e) {
e.printStackTrace();
}