文档

QuerySendDetails - 查询短信发送详情

更新时间:

查询单个号码的短信发送记录和发送状态等信息。

接口说明

如果需要批量查看短信发送详情,您可以登录短信服务控制台,在业务统计-发送记录查询页面查看发送详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

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

发送回执 ID,即发送流水号。调用 SendSmsSendBatchSms 发送短信时,返回值中的 BizId 字段。

说明 只能传入一个 Bizid 的值,无法传入多个 Bizid。
134523^435****
SendDatestring

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

格式为 yyyyMMdd,例如 20181225。

20181228
PageSizelong

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

取值范围为 1~50。

10
CurrentPagelong

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

1

返回参数

名称类型描述示例值
object
Codestring

请求状态码。

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

状态码的描述。

OK
RequestIdstring

请求 ID。

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

短信发送总条数。

1
SmsSendDetailDTOsarray<object>

短信发送明细。

object
ErrCodestring

运营商短信状态码。

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

短信模板 Code。

说明 如果您选择[测试专用]阿里云通信和[测试专用]阿里云通信测试模板发送的测试短信,此接口不返回 TemplateCode 等字段信息。
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": {
    "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
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
说明 当前页面为新版 API 接口,我们强烈推荐您使用新版 API 接口和 SDK 。旧版 SDK 和 API 已不再维护。如您仍需访问和使用旧版 SDK 和 API,可参见短信查询 API(QuerySendDetails)---Java