ListMessageMetrics - 获取短信发送统计

更新时间: 2022-12-23 10:44:26

获取短信发送统计数据,可按指定条件获取分类别详细数据。

接口说明

获取 [开始日期, 结束日期] 闭区间内的数据,返回数据按日期升序排列,发送统计为空的日期不返回。

发送数据在48小时内会随实际短信发送状态不断更新,最终数据以48小时后数据为准。

调试

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

调试

授权信息

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

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

请求参数

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

结束日期,格式20220102。

20210321
GroupIdstring

关联人群ID。

10ed87f5-3ca8-4a43-9d83-b30519be7241
PageNumberinteger

分页数,从1开始,默认为1。

1
PageSizeinteger

分页大小,默认为10。

10
ScheduleIdstring

关联触达计划ID。

08d19262-bd76-48fd-80e8-6a225ac388c1
Signaturestring

签名名称。

PAI通知
SignatureIdstring

签名ID,同时只能指定签名名称或签名ID其中之一。

b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3
StartDatestring

开始日期,格式20220102。

20210321
TemplateCodestring

模板号。

SMS_123456
TemplateIdstring

模板ID,同时只能指定模板Code或模板ID其中之一。

5480e3e7-f578-42d2-8ce8-217dec75f2e6
TemplateTypeinteger

模板类型。

  • 0 : 验证码。
  • 1 : 短信通知。
  • 2 : 推广短信。
2

返回参数

名称类型描述示例值
object

成功获取短信发送统计列表。

Dataobject

返回数据。

Metricsarray

分页返回的统计数据条目列表。

object
Datestring

发送日期。

20210321
Failinteger

发送失败。

0
Pendinginteger

发送中。

0
Ratenumber

发送成功率。

0.8
Successinteger

发送成功。

0
Totalinteger

总计短信数量。

0
PageNumberinteger

分页数,从1开始,默认为1。

1
PageSizeinteger

分页大小,默认为10。

10
TotalCountinteger

总统计数据条目数量。

0
ErrorCodeinteger

错误码。

0
ErrorMessagestring

错误信息。

OK
RequestIdstring

请求ID。

f8651828-609d-4de8-ab49-ab781d7fd85a

错误码

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

变更历史

变更时间变更内容概要操作
2022-03-01OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-03-01新增 OpenAPI
2022-03-01OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-03-01OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 人工智能平台 PAI 相关技术圈