首页 短信服务 API参考 API目录 发送查询 QuerySendDetails - 查询短信发送详情

QuerySendDetails - 查询短信发送详情

查询短信发送记录和发送状态等信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dysms:QuerySendDetailsRead
  • SMS
    acs:dysms:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
PhoneNumberstring

接收短信的手机号码。格式:

  • 国内短信:11位手机号码,例如1390000****。
  • 国际/港澳台消息:国际区号+号码,例如8520000****。
1390000****
BizIdstring

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

134523^435****
SendDatestring

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

格式为yyyyMMdd,例如20181225。

20181228
PageSizelong

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

取值范围为1~50。

10
CurrentPagelong

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

1

返回参数

名称类型描述示例值
object
Codestring

请求状态码。

OK
Messagestring

状态码的描述。

OK
RequestIdstring

请求ID。

819BE656-D2E0-4858-8B21-B2E477085AAF
TotalCountstring

短信发送总条数。

1
SmsSendDetailDTOsarray

短信发送明细。

object
ErrCodestring

运营商短信状态码。

  • 短信发送成功:DELIVERED。
  • 短信发送失败:失败错误码请参见错误码
DELIVERED
TemplateCodestring

短信模板ID。

SMS_12231****
OutIdstring

外部流水扩展字段。

123
ReceiveDatestring

短信接收日期和时间。

2019-01-08 16:44:13
SendDatestring

短信发送日期和时间。

2019-01-08 16:44:10
PhoneNumstring

接收短信的手机号码。

1390000****
Contentstring

短信内容。

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

短信发送状态,包括:

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

示例

正常返回示例

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": "1390000****",
      "Content": "【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露",
      "SendStatus": 3
    }
  ]
}

错误码

访问错误中心查看更多错误码。

说明当前页面为新版API接口,我们强烈推荐您使用新版API接口和SDK。旧版SDK和API已不再维护。如您仍需访问和使用旧版SDK和API,可参见短信查询API(QuerySendDetails)---Java
阿里云首页 短信服务 相关技术圈