1. 接口描述
接口请求域名: sms.tencentcloudapi.com 。
本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SendStatusStatistics。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BeginTime | 是 | String | 起始时间,格式为yyyymmddhh,精确到小时,例如2021050113,表示2021年5月1号13时。 示例值:2016090800 |
EndTime | 是 | String | 结束时间,格式为yyyymmddhh,精确到小时,例如2021050118,表示2021年5月1号18时。 注:EndTime 必须大于 BeginTime。 示例值:2016090823 |
SmsSdkAppId | 是 | String | 短信 SdkAppId 在 短信控制台 添加应用后生成的实际 SdkAppId,示例如1400006666。 示例值:1400006874 |
Limit | 是 | Integer | 最大上限。 注:目前固定设置为0。 示例值:0 |
Offset | 是 | Integer | 偏移量。 注:目前固定设置为0。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SendStatusStatistics | SendStatusStatistics | 发送数据统计响应包体。 示例值:{"FeeCount":1880,"RequestCount":1880,"RequestSuccessCount":1880} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendStatusStatistics
<公共请求参数>
{
"SmsSdkAppId": "1400006874",
"EndTime": "2021050123",
"Limit": 0,
"BeginTime": "2021050113",
"Offset": 0
}
输出示例
{
"Response": {
"SendStatusStatistics": {
"FeeCount": 1880,
"RequestCount": 1880,
"RequestSuccessCount": 1880
},
"RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
签名demo
下面提供了各个语言生成签名的过程,demo 只是起到演示的作用,不具备通用性,在实际的开发中还是推荐使用 SDK。
Signature V1:
- Signature V1 demo for Python
- Signature V1 demo for Java
- Signature V1 demo for PHP
- Signature V1 demo for Go
- Signature V1 demo for NodeJS
- Signature V1 demo for .NET
Signature V3
- Signature V3 demo for Python
- Signature V3 demo for Java
- Signature V3 demo for PHP
- Signature V3 demo for Go
- Signature V3 demo for NodeJS
- Signature V3 demo for .NET
- Signature V3 demo for C++
- Signature V3 demo for Ruby
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.FailResolvePacket | 请求包解析失败,通常情况下是由于没有遵守 API 接口说明规范导致的,请参考 请求包体解析1004错误详解。 |
FailedOperation.JsonParseFail | 解析请求包体时候失败。 |
FailedOperation.PhoneNumberInBlacklist | 手机号在免打扰名单库中,通常是用户退订或者命中运营商免打扰名单导致的,可联系 腾讯云短信小助手 解决。 |
FailedOperation.TemplateIncorrectOrUnapproved | 模板未审批或内容不匹配。(1)可登录 短信控制台,核查模板是否已审批并审批通过;(2)核查是否符合 格式规范,若存在疑问可联系 腾讯云短信小助手。 |
InternalError.OtherError | 其他错误,请联系 腾讯云短信小助手 并提供失败手机号。 |
InternalError.ParseBackendResponseFail | 解析运营商包体失败,可联系 sms helper 。 |
InternalError.RequestTimeException | 请求发起时间不正常,通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的,请核对服务器时间及 API 接口中的时间字段是否正常。 |
InternalError.RestApiInterfaceNotExist | 不存在该 RESTAPI 接口,请核查 REST API 接口说明。 |
InternalError.SendAndRecvFail | 接口超时或短信收发包超时,请检查您的网络是否有波动,或联系 腾讯云短信小助手 解决。 |
InternalError.SigFieldMissing | 后端包体中请求包体没有 Sig 字段或 Sig 为空。 |
InternalError.SigVerificationFail | 后端校验 Sig 失败。 |
InternalError.Timeout | 请求下发短信超时,请参考 60008错误详解。 |
InternalError.UnknownError | 未知错误类型。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.BeginTimeVerifyFail | 参数 BeginTime 校验失败。 |
InvalidParameterValue.EndTimeVerifyFail | 参数 EndTime 校验失败。 |
InvalidParameterValue.IncorrectPhoneNumber | 手机号格式错误。 |
InvalidParameterValue.LimitVerifyFail | 参数 Limit 校验失败。 |
InvalidParameterValue.OffsetVerifyFail | 参数 Offset 校验失败。 |
InvalidParameterValue.SdkAppIdNotExist | SdkAppId 不存在。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation.RequestIpNotInWhitelist | 请求 IP 不在白名单中,您配置了校验请求来源 IP,但是检测到当前请求 IP 不在配置列表中,如有需要请联系 腾讯云短信小助手。 |
UnauthorizedOperation.RequestPermissionDeny | 请求没有权限,请联系 腾讯云短信小助手。 |
UnauthorizedOperation.SdkAppIdIsDisabled | 此 SdkAppId 禁止提供服务,如有需要请联系 腾讯云短信小助手。 |
UnauthorizedOperation.ServiceSuspendDueToArrears | 欠费被停止服务,可自行登录腾讯云充值来缴清欠款。 |
UnauthorizedOperation.SmsSdkAppIdVerifyFail | SmsSdkAppId 校验失败,请检查 SmsSdkAppId 是否属于 云API密钥 的关联账户。 |
UnsupportedOperation. | 不支持该请求。 |