1. 接口描述
接口请求域名: sms.tencentcloudapi.com 。
拉取单个号码短信下发状态
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:PullSmsSendStatusByPhoneNumber |
Version | 是 | String | 公共参数,本接口取值:2019-07-11 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
SendDateTime | 是 | Integer | 拉取起始时间,UNIX 时间戳(时间:秒) |
Offset | 是 | Integer | 偏移量 注:目前固定设置为0 |
Limit | 是 | Integer | 拉取最大条数,最多 100 |
PhoneNumber | 是 | String | 下发目的手机号码,依据 e.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。 |
SmsSdkAppid | 是 | String | 短信SdkAppid在短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PullSmsSendStatusSet | Array of PullSmsSendStatus | 下发状态响应集合 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
https://sms.tencentcloudapi.com/?Action=PullSmsSendStatusByPhoneNumber
&SendDateTime=1464624000
&Offset=0
&Limit=2
&PhoneNumber=+8615291996666
&SmsSdkAppid=1400006874
&<公共请求参数>
输出示例
{
"Response": {
"PullSmsSendStatusSet": [
{
"UserReceiveTime": "2019-10-08 17:18:37",
"NationCode": "86",
"PurePhoneNumber": "+8615291996666",
"PhoneNumber": "15291996666",
"SerialNo": "14:19325917feb3914eb78b50d6182d7e452e",
"ReportStatus": "SUCCESS",
"Description": "用户短信接收成功"
},
{
"UserReceiveTime": "2019-10-08 17:18:37",
"NationCode": "86",
"PurePhoneNumber": "+8615291996666",
"PhoneNumber": "15291996666",
"SerialNo": "14:19325917feb3914eb78b50d6182d7e452e",
"ReportStatus": "SUCCESS",
"Description": "用户短信接收成功"
}
],
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AlreadyRegistered | 已经注册 |
FailedOperation.FailResolvePacket | 请求包解析失败,通常情况下是由于没有遵守 API 接口说明规范导致的,请参考请求包体解析1004错误详解 |
FailedOperation.InsufficientBalanceInSmsPackage | 套餐包余量不足 |
FailedOperation.JsonParseFail | 解析请求包体时候失败 |
FailedOperation.MarketingSmsTimeConstraint | 营销短信发送时间限制 |
FailedOperation.PhoneNumberOnBlacklist | 手机号在黑名单库中,通常是用户退订或者命中运营商黑名单导致的,可联系 sms helper 解决 |
FailedOperation.SignatureIncorrectOrUnapproved | 签名格式错误或者签名未审批 |
FailedOperation.SmsContainSensitiveWord | 短信内容中含有敏感词,请联系 sms helper 解决 |
FailedOperation.TemplateIncorrectOrUnapproved | 模版未审批或请求的内容与审核通过的模版内容不匹配,请参考 1014错误详解 |
InternalError.NotHaveThisRestApiInterface | 不存在该 RESTAPI 接口 |
InternalError.OtherError | 其他错误,请联系 sms helper 并提供失败手机号 |
InternalError.RequestTimeException | 请求发起时间不正常,通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的 |
InternalError.SigFieldMissing | 后端包体中请求包体没有 Sig 字段或 Sig 为空 |
InternalError.SigVerificationFail | 后端校验 Sig 失败 |
InternalError.Timeout | 请求下发短信超时,请参考 60008错误详解 |
InternalError.UnknownError | 未知错误类型 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.IncorrectPhoneNumber | 手机号格式错误,请参考 1016错误详解 |
InvalidParameterValue.LengthOfSmsContentExceedLimit | 请求的短信内容太长,短信长度规则请参考 国内短信内容长度计算规则 或 国际/港澳台短信内容长度计算规则 |
InvalidParameterValue.LengthOfTemplateParameterExceed | 单个模板变量字符数超过12个,企业认证用户不限制单个变量值字数,您可以 变更实名认证模式,变更为企业认证用户后,该限制变更约1小时左右生效 |
InvalidParameterValue.SdkAppidNotExist | SdkAppid 不存在 |
LimitExceeded.AmountOfDailyExceedLimit | 业务短信日下发条数超过设定的上限 |
LimitExceeded.AmountOfOneHourExceedLimit | 单个手机号1小时内下发短信条数超过设定的上限 |
LimitExceeded.AmountOfPhoneNumberSameContenetDailExceedLimit | 单个手机号下发相同内容超过设定的上限 |
LimitExceeded.AmountOfThirtySecondExceedLimit | 单个手机号30秒内下发短信条数超过设定的上限 |
LimitExceeded.CountOfPhoneNumberExceed | 调用群发 API 接口单次提交的手机号个数超过200个,请遵守 API 接口说明 规范 |
LimitExceeded.DeliveryFrequencyLimit | 下发短信命中了频率限制策略,可自行到控制台调整短信频率限制策略,如有其他需求请联系 sms helper |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation.IndividualUserSendMarketingSmsPermissionDeny | 个人用户没有发营销短信的权限,请参考 权益区别 |
UnauthorizedOperation.RequestIpNotOnWhitelist | 请求 IP 不在白名单中,您配置了校验请求来源 IP,但是检测到当前请求 IP 不在配置列表中,如有需要请联系 sms helper |
UnauthorizedOperation.RequestPermissionDeny | 请求没有权限,请联系 sms helper 并提供失败手机号 |
UnauthorizedOperation.SdkAppidIsDisabled | 此 sdkappid 禁止提供服务,如有需要请联系 sms helper |
UnauthorizedOperation.SerivceSuspendByDueArrear | 欠费被停止服务 |
UnsupportedOperation. | 不支持该请求 |
UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber | 群发请求里既有国内手机号也有国际手机号 |
UnsupportedOperation.UnsuportedRegion | 不支持该地区短信下发 |