调用QuerySendDetails接口查看短信发送记录和发送状态。

使用说明

通过调用QuerySendDetails接口,可以根据短信发送日期查看发送记录和短信内容,也可以添加发送流水号,根据流水号查询指定日期指定请求的发送详情。如果指定日期短信发送量较大,可以分页查看。指定每页显示的短信详情数量和查看的页数,即可分页查看发送记录。

QPS限制

本接口的单用户QPS限制为5000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QuerySendDetails

系统规定参数。取值:QuerySendDetails

PhoneNumber String 1590000****

接收短信的手机号码。

格式:

  • 国内短信:11位手机号码,例如1590000****。
  • 国际/港澳台消息:国际区号+号码,例如8520000****。
BizId String 134523^435****

发送回执ID,即发送流水号。调用发送接口SendSms或SendBatchSms发送短信时,返回值中的BizId字段。

SendDate String 20181228

短信发送日期,支持查询最近30天的记录。

格式为yyyyMMdd,例如20181225。

PageSize Long 10

分页查看发送记录,指定每页显示的短信记录数量。

取值范围为1~50。

CurrentPage Long 1

分页查看发送记录,指定发送记录的当前页码。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码,请参见错误码列表
Message String OK

状态码的描述。

RequestId String 819BE656-D2E0-4858-8B21-B2E477085AAF

请求ID。

TotalCount String 1

短信发送总条数。

SmsSendDetailDTOs Array of SmsSendDetailDTO

短信发送明细。

SmsSendDetailDTO
ErrCode String DELIVERED

运营商短信状态码。

  • 短信发送成功:DELIVERED。
  • 短信发送失败:失败错误码请参见错误码
TemplateCode String SMS_12231****

短信模板ID。

OutId String 123

外部流水扩展字段。

ReceiveDate String 2019-01-08 16:44:13

短信接收日期和时间。

SendDate String 2019-01-08 16:44:10

短信发送日期和时间。

PhoneNum String 152****0000

接收短信的手机号码。

Content String 【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露

短信内容。

SendStatus Long 3

短信发送状态,包括:

  • 1:等待回执。
  • 2:发送失败。
  • 3:发送成功。

示例

请求示例

http(s)://dysmsapi.aliyuncs.com/?Action=QuerySendDetails
&CurrentPage=1
&PageSize=10
&PhoneNumber=1590000****
&SendDate=20181228
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QuerySendDetailsResponse>
    <Code>OK</Code>
    <Message>OK</Message>
    <RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>
    <TotalCount>1</TotalCount>
    <SmsSendDetailDTOs>
        <ErrCode>DELIVERED</ErrCode>
        <TemplateCode>SMS_122310183</TemplateCode>
        <OutId>123</OutId>
        <ReceiveDate>2019-01-08 16:44:13</ReceiveDate>
        <SendDate>2019-01-08 16:44:10</SendDate>
        <PhoneNum>152****0000</PhoneNum>
        <Content>【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露</Content>
        <SendStatus>3</SendStatus>
    </SmsSendDetailDTOs>
</QuerySendDetailsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "OK",
  "Message" : "OK",
  "RequestId" : "819BE656-D2E0-4858-8B21-B2E477085AAF",
  "TotalCount" : "1",
  "SmsSendDetailDTOs" : [ {
    "ErrCode" : "DELIVERED",
    "TemplateCode" : "SMS_122310183",
    "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文档请参考本文,如需参考旧版,请参见API参考