查询单个号码的短信发送记录和发送状态等信息。
接口说明
-
本接口主要用于查询指定日期下，向某个手机号码发送短信的记录详情。您也可以传入发送流水号（BizId），查询该号码的指定发送记录。
-
本接口仅支持查询单个手机号码发送详情。如果需要批量查看短信发送详情，您可以使用 QuerySendStatistics 接口，查询短信发送统计详情；或登录控制台发送记录查询页面，查询发送详情。
QPS 限制
本接口的单用户 QPS 限制为 5000/秒。超过限制，API 调用将会被限流，请合理使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dysms:QuerySendDetails | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PhoneNumber | string | 是 | 需要查询的手机号码。格式：
说明
只能传入一个手机号码。
| 1390000**** |
| BizId | string | 否 | 发送回执 ID。即发送流水号，调用 SendSms 或 SendBatchSms 发送短信时，返回值中的 BizId 字段。 说明
只能传入一个 Bizid 的值，无法传入多个 Bizid。
| 134523^435**** |
| SendDate | string | 是 | 短信发送日期，支持查询最近 30 天的记录。 格式：yyyyMMdd，例如 20181225。 | 20181228 |
| PageSize | long | 是 | 每页显示的短信记录数量，供分页查看发送记录使用。 取值范围为 1~50。 | 10 |
| CurrentPage | long | 是 | 发送记录的当前页码，供分页查看发送记录使用。 | 1 |
您可以访问 OpenAPI 门户，查看各语言 SDK 请求示例。
返回参数
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "819BE656-D2E0-4858-8B21-B2E477085AAF",
"TotalCount": "1",
"SmsSendDetailDTOs": {
"SmsSendDetailDTO": [
{
"ErrCode": "DELIVERED",
"TemplateCode": "SMS_12231****",
"OutId": "123",
"ReceiveDate": "2019-01-08 16:44:13",
"SendDate": "2019-01-08 16:44:10",
"PhoneNum": "1390000****",
"Content": "【阿里云】验证码为：123，您正在登录，若非本人操作，请勿泄露",
"SendStatus": 3
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-09 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记 | 查看变更详情 |