查询短信发送记录和发送状态等信息。
接口说明
使用说明
通过调用QuerySendDetails接口,可以根据短信发送日期查看发送记录和短信内容,也可以添加发送流水号,根据流水号查询指定日期指定请求的发送详情。如果指定日期短信发送量较大,可以分页查看。指定每页显示的短信详情数量和查看的页数,即可分页查看发送记录。
QPS限制
本接口的单用户QPS限制为5000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PhoneNumber | string | 是 | 接收短信的手机号码。 格式:
| 1590000**** |
BizId | string | 否 | 发送回执ID,即发送流水号。调用发送接口SendSms或SendBatchSms发送短信时,返回值中的BizId字段。 | 134523^435**** |
SendDate | string | 是 | 短信发送日期,支持查询最近30天的记录。 格式为yyyyMMdd,例如20181225。 | 20181228 |
PageSize | integer | 是 | 分页查看发送记录,指定每页显示的短信记录数量。 取值范围为1~50。 | 10 |
CurrentPage | integer | 是 | 分页查看发送记录,指定发送记录的当前页码。 | 1 |
返回参数
示例
请求示例
http(s)://dysmsapi.aliyuncs.com/?Action=QuerySendDetails
&CurrentPage=1
&PageSize=10
&PhoneNumber=1590000****
&SendDate=20181228
&<公共请求参数>
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "819BE656-D2E0-4858-8B21-B2E477085AAF",
"TotalCount": "1",
"SmsSendDetailDTOs": [
{
"ErrCode": "DELIVERED",
"TemplateCode": "SMS_12231****",
"OutId": "123",
"ReceiveDate": "2019-01-08 16:44:13",
"SendDate": "2019-01-08 16:44:10",
"PhoneNum": "152****0000",
"Content": "【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露",
"SendStatus": 3
}
]
}
错误码
访问错误中心查看更多错误码。
说明当前页面为新版API接口,我们强烈推荐您使用新版API接口和SDK。旧版SDK和API已不再维护。如您仍需访问和使用旧版SDK和API,可参见短信查询API(QuerySendDetails)---Java。