首页 短信服务 API参考 API目录 发送查询 QuerySendStatistics - 查询短信发送统计信息

QuerySendStatistics - 查询短信发送统计信息

查询短信发送量详情。

接口说明

可以通过本接口查询短信发送量详情,包括短信发送时间、短信发送成功条数、接收回执条数等。如果指定日期短信发送量较大,可以分页查看。指定每页显示的短信详情数量和查看的页数,即可分页查看发送记录。

QPS限制

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

调试

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

调试

授权信息

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

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

请求参数

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

短信发送范围。取值:

  • 1:国内短信发送记录。

  • 2:国际/港澳台短信发送记录。

1
StartDatestring

开始日期,格式为yyyyMMdd,例如20181225。

20201002
EndDatestring

结束日期,格式为yyyyMMdd,例如20181225。

20201003
PageIndexinteger

当前页码。默认取值为1

1
PageSizeinteger

每页显示的条数。取值范围:1~50

10
TemplateTypeinteger

模板类型。取值:

  • 0:验证码。

  • 1:通知短信。

  • 2:推广短信。(仅支持企业客户)

  • 3:国际/港澳台消息。(仅支持企业客户)

  • 7:数字短信。

0
SignNamestring

签名名称。

有人云平台

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

819BE656-D2E0-4858-8B21-B2E47708****
Codestring

请求状态码。

OK
Messagestring

状态码的描述。

OK
Dataobject

返回数据。

TotalSizelong

返回数据的总条数。

20
TargetListarray

返回数据列表。

object
TotalCountlong

发送成功的短信条数。

20
RespondedSuccessCountlong

接收到回执成功的短信条数。

17
RespondedFailCountlong

接收到回执失败的短信条数。

2
NoRespondedCountlong

未收到回执的短信条数。

1
SendDatestring

短信发送日期,格式为yyyyMMdd,例如20181225。

20201010

示例

正常返回示例

JSON格式

{
  "RequestId": "819BE656-D2E0-4858-8B21-B2E47708****",
  "Code": "OK",
  "Message": "OK",
  "Data": {
    "TotalSize": 20,
    "TargetList": [
      {
        "TotalCount": 20,
        "RespondedSuccessCount": 17,
        "RespondedFailCount": 2,
        "NoRespondedCount": 1,
        "SendDate": "20201010"
      }
    ]
  }
}

错误码

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

阿里云首页 短信服务 相关技术圈