短信

产品简介

审核标准

购买指南

图说短信

国内短信

国际/港澳台短信

控制台指南

最佳实践

API 文档

SDK 文档

常见问题

相关协议

公告

联系我们

词汇表
文档中心 > 短信 > API 文档 > 拉取状态相关接口 > 拉取单个号码短信下发状态

拉取单个号码短信下发状态

最近更新时间：2020-11-18 08:30:23

查看 PDF

本页目录：

1. 接口描述

接口请求域名： sms.tencentcloudapi.com 。

拉取单个号码短信下发状态。 目前也支持 配置回调 的方式来获取下发状态。

  • 注：由于云 API3.0 安全性有所提升，所以接口鉴权较为复杂，建议使用 SDK 来使用云短信服务。
  • 您可以在 API 3.0 Explorer 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以自动生成SDK代码示例。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：PullSmsSendStatusByPhoneNumber。
Version 是 String 公共参数，本接口取值：2019-07-11。
Region 否 String 公共参数，本接口不需要传递此参数。
SendDateTime 是 Integer 拉取起始时间，UNIX 时间戳（时间：秒）。
注：最大可拉取当前时期7天前的数据。
Offset 是 Integer 偏移量。
注：目前固定设置为0。
Limit 是 Integer 拉取最大条数，最多 100。
PhoneNumber 是 String 下发目的手机号码，依据 e.164 标准为：+[国家（或地区）码][手机号] ，示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号。
SmsSdkAppid 是 String 短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid，例如1400006666。
EndDateTime 否 Integer 拉取截止时间，UNIX 时间戳（时间：秒）。

3. 输出参数

参数名称 类型 描述
PullSmsSendStatusSet Array of PullSmsSendStatus 下发状态响应集合。
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://sms.tencentcloudapi.com/?Action=PullSmsSendStatusByPhoneNumber
&SendDateTime=1464624000
&EndDateTime=1464624123
&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": "DELIVRD"
      },
      {
        "UserReceiveTime": "2019-10-08 17:18:37",
        "NationCode": "86",
        "PurePhoneNumber": "+8615291996666",
        "PhoneNumber": "15291996666",
        "SerialNo": "14:19325917feb3914eb78b50d6182d7e452e",
        "ReportStatus": "SUCCESS",
        "Description": "DELIVRD"
      }
    ],
    "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.FailResolvePacket 请求包解析失败，通常情况下是由于没有遵守 API 接口说明规范导致的，请参考 请求包体解析1004错误详解。
FailedOperation.JsonParseFail 解析请求包体时候失败。
FailedOperation.PhoneNumberOnBlacklist 手机号在黑名单库中，通常是用户退订或者命中运营商黑名单导致的，可联系 sms helper 解决。
InternalError.OtherError 其他错误，请联系 sms helper 并提供失败手机号。
InternalError.RequestTimeException 请求发起时间不正常，通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的，请核对服务器时间及 API 接口中的时间字段是否正常。
InternalError.RestApiInterfaceNotExist 不存在该 RESTAPI 接口，请核查 REST API 接口说明。
InternalError.SendAndRecvFail 接口超时或后短信收发包超时，请检查您的网络是否有波动，或联系 sms helper 解决。
InternalError.SigFieldMissing 后端包体中请求包体没有 Sig 字段或 Sig 为空。
InternalError.SigVerificationFail 后端校验 Sig 失败。
InternalError.Timeout 请求下发短信超时，请参考 60008错误详解。
InternalError.UnknownError 未知错误类型。
InvalidParameter 参数错误。
InvalidParameterValue.IncorrectPhoneNumber 手机号格式错误，请参考 1016错误详解。
InvalidParameterValue.InvalidStartTime 无效的拉取起始/截止时间，具体原因可能是请求的 SendDateTime 大于 EndDateTime。
InvalidParameterValue.SdkAppidNotExist SdkAppid 不存在。
MissingParameter 缺少参数错误。
UnauthorizedOperation.RequestIpNotInWhitelist 请求 IP 不在白名单中，您配置了校验请求来源 IP，但是检测到当前请求 IP 不在配置列表中，如有需要请联系 sms helper。
UnauthorizedOperation.RequestPermissionDeny 请求没有权限，请联系 sms helper。
UnauthorizedOperation.SdkAppidIsDisabled 此 sdkappid 禁止提供服务，如有需要请联系 sms helper。
UnauthorizedOperation.SerivceSuspendDueToArrears 欠费被停止服务，可自行登录腾讯云充值来缴清欠款。
UnauthorizedOperation.SmsSdkAppidVerifyFail SmsSdkAppid 校验失败。
UnsupportedOperation. 不支持该请求。
目录
中国站