短信查询短信下发记录

1. 接口描述

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

本接口 (DescribeSendRecordList) 用于查询单个手机号在指定时间范围内的短信下发记录。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSendRecordList。
Version	是	String	公共参数，本接口取值：2021-01-11。
Region	是	String	公共参数，详见产品支持的地域列表。
PhoneNumber	是	String	下发的手机号码，依据 E.164 标准为：+[国家（或地区）码][手机号] ，示例如：+8613601238015，其中前面有一个+号，86为国家码，13601238015为手机号。示例值：+86136****8015
SmsSdkAppId	是	String	短信 SdkAppId 在短信控制台添加应用后生成的实际 SdkAppId。示例值：140***9515
BeginTime	是	Integer	查询起始时间，以短信发送时间为准，UNIX 时间戳（单位：秒）。注：最早可查询当前时间前 72 小时的数据。单位：秒示例值：1787850451
EndTime	否	Integer	查询截止时间，以短信发送时间为准，UNIX 时间戳（时间：秒）。注：不可以超过当前时间。单位：秒默认值：腾讯云服务当前时间示例值：1787902550
Limit	否	Integer	单次查询最大条数。取值范围：[1, 50] 默认值：20 示例值：10
Offset	否	Integer	偏移量。取值范围：[0, 1000] 默认值：0 注：查询范围内超过 1000 条记录将被截断，最大查询 1000 条，查询记录按发送时间降序。示例值：0

3. 输出参数

参数名称	类型	描述
SendRecordSet	Array of SendRecord	短信下发记录集合。
TotalCount	Integer	查询时间范围内的下发记录总数，注：最大支持查询单个下发手机号码 72 小时内的 1000 条记录。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSendRecordList
<公共请求参数>

{
    "PhoneNumber": "+86136****8015",
    "SmsSdkAppId": "140***9515",
    "BeginTime": 1787850451,
    "EndTime": 1787902550,
    "Limit": 10,
    "Offset": 0
}

输出示例

{
    "Response": {
        "SendRecordSet": [
            {
                "Content": "【腾讯云通信】您的验证码为0****1，5分钟内有效。",
                "IsoCode": "CN",
                "PhoneNumber": "+86136****8015",
                "RequestCode": "Ok",
                "SendStatus": 2,
                "SendTime": 1787902541,
                "SerialNo": "4719:106022169717827487984377125",
                "StatusCode": "DELIVRD",
                "UserReceiveTime": 1787902571
            }
        ],
        "TotalCount": 1,
        "RequestId": "22f73024-57b5-4f32-9657-85ef83239929"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

签名demo

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

Signature V1:

Signature V3

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.JsonParseFail	解析用户参数失败，可联系腾讯云短信小助手。
InternalError.SendAndRecvFail	接口超时或短信收发包超时，请检查您的网络是否有波动，或联系腾讯云短信小助手解决。
InvalidParameterValue.BeginTimeVerifyFail	参数 BeginTime 校验失败。
InvalidParameterValue.EndTimeVerifyFail	参数 EndTime 校验失败。
InvalidParameterValue.IncorrectPhoneNumber	手机号格式错误。
InvalidParameterValue.LimitVerifyFail	参数 Limit 校验失败。
InvalidParameterValue.OffsetVerifyFail	参数 Offset 校验失败。
InvalidParameterValue.SdkAppIdNotExist	SdkAppId 不存在。
MissingParameter	缺少参数错误。
UnauthorizedOperation.SmsSdkAppIdVerifyFail	SmsSdkAppId 校验失败，请检查 SmsSdkAppId 是否属于云API密钥的关联账户。

查询短信下发记录

本页目录：