拉取短信下发状态-短信-文档中心-腾讯云

1. 接口描述

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

本接口 (PullSmsSendStatus) 用于拉取短信下发状态。

说明：
此接口需要联系腾讯云短信小助手开通。
下发状态也支持配置回调的方式获取。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：PullSmsSendStatus。
Version	是	String	公共参数，本接口取值：2019-07-11。
Region	否	String	公共参数，本接口不需要传递此参数。
Limit	是	Integer	拉取最大条数，最多100条。示例值：100
SmsSdkAppid	是	String	短信SdkAppid在短信控制台添加应用后生成的实际SdkAppid，例如1400006666。示例值：1400006666

3. 输出参数

参数名称	类型	描述
PullSmsSendStatusSet	Array of PullSmsSendStatus	下发状态响应集合。示例值：[{"UserReceiveTime":"2019-10-08 17:18:37", "UserReceiveUnixTime":1570526317, "NationCode":"86", "PurePhoneNumber":"+8618501234444", "PhoneNumber":"18501234444", "SerialNo":"5000:1045710669157053657849499619", "ReportStatus":"SUCCESS", "Description":"DELIVRD"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://sms.tencentcloudapi.com/?Action=PullSmsSendStatus
&Limit=2
&SmsSdkAppid=1400006874
&<公共请求参数>

输出示例

{
    "Response": {
        "PullSmsSendStatusSet": [
            {
                "UserReceiveTime": "2019-10-08 17:18:37",
                "UserReceiveUnixTime": 1570526317,
                "NationCode": "86",
                "PurePhoneNumber": "+8618501234444",
                "PhoneNumber": "18501234444",
                "SerialNo": "5000:1045710669157053657849499619",
                "ReportStatus": "SUCCESS",
                "Description": "DELIVRD"
            },
            {
                "UserReceiveTime": "2019-10-08 17:18:37",
                "UserReceiveUnixTime": 1570526317,
                "NationCode": "86",
                "PurePhoneNumber": "+8618501234445",
                "PhoneNumber": "18501234445",
                "SerialNo": "5000:1045710669157053657849499718",
                "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。

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

命令行工具

Tencent Cloud CLI 3.0

签名demo

下面提供了各个语言生成签名的过程，demo 只是起到演示的作用，不具备通用性，在实际的开发中还是推荐使用 SDK。

Signature V1:

Signature V3

6. 错误码

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

错误码	描述
FailedOperation.FailResolvePacket	请求包解析失败，通常情况下是由于没有遵守 API 接口说明规范导致的，请参考请求包体解析1004错误详解。
FailedOperation.JsonParseFail	解析请求包体时候失败。
FailedOperation.PhoneNumberInBlacklist	手机号在免打扰名单库中，通常是用户退订或者命中运营商免打扰名单导致的，可联系腾讯云短信小助手解决。
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.IncorrectPhoneNumber	手机号格式错误。
InvalidParameterValue.SdkAppIdNotExist	SdkAppId 不存在。
UnauthorizedOperation.RequestIpNotInWhitelist	请求 IP 不在白名单中，您配置了校验请求来源 IP，但是检测到当前请求 IP 不在配置列表中，如有需要请联系腾讯云短信小助手。
UnauthorizedOperation.RequestPermissionDeny	请求没有权限，请联系腾讯云短信小助手。
UnauthorizedOperation.SdkAppIdIsDisabled	此 SdkAppId 禁止提供服务，如有需要请联系腾讯云短信小助手。
UnauthorizedOperation.ServiceSuspendDueToArrears	欠费被停止服务，可自行登录腾讯云充值来缴清欠款。
UnauthorizedOperation.SmsSdkAppIdVerifyFail	SmsSdkAppId 校验失败，请检查 SmsSdkAppId 是否属于云API密钥的关联账户。
UnsupportedOperation	操作不支持。

拉取短信下发状态

本页目录：