ListMessages - 获取短信列表

按指定过滤条件获取指定日期的短信发送状态。

调试

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

调试

授权信息

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

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

请求参数

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

发送日期,格式为yyyymmdd。

20220101
ErrorCodestring

短信错误码过滤。

DELIVERED
GroupIdstring

关联人群ID过滤。

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

短信ID过滤,短信ID为SendMessage成功返回的ID。

0a54e195-03e2-40bd-869d-b71cb302783e
PageNumberinteger

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

1
PageSizeinteger

分页大小,默认为10。

10
PhoneNumberstring

手机号码。

1234567890
RequestIdstring

短信批处理ID过滤,短信批处理ID为SendMessage成功返回的RequestId。

62a72a20-8a9b-4060-a510-0c30a9340cba
ScheduleIdstring

关联发送计划ID。

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

签名名称。

PAI通知
SignatureIdstring

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

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

短信发送状态。

  • 0 : 发送中。
  • 1 : 发送成功。
  • 2 : 发送失败。
0
TemplateCodestring

模板号。

SMS_123456
TemplateIdstring

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

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

模板类型过滤。

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

返回参数

名称类型描述示例值
object

成功。

Dataobject

返回数据。

Messagesarray

短信列表。

object
ErrorCodestring

短信错误码。

DELIVERED
GroupIdstring

关联人群ID。

51d20163-1b10-4af2-8a23-58ad52201f2f
Idstring

短信序列号。

92d05e19-751b-4346-a7c5-8808bb49b8a2
OutIdstring

外部拓展字段。

1234567890
PhoneNumberstring

手机号码。

1234567890
ScheduleIdstring

关联发送计划ID。

0604d49d-fd23-4515-bb26-9b537cbf1f6d
Signaturestring

签名名称。

PAI通知
Statusinteger

短信发送状态。

  • 0 : 发送中。
  • 1 : 发送成功。
  • 2 : 发送失败。
0
TemplateCodestring

模板号。

SMS_123456
TemplateParamsstring

模板参数。

{}
TemplateTypeinteger

模板类型。

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

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

1
PageSizeinteger

分页大小,默认为10。

10
TotalCountinteger

短信数量。

10
ErrorCodeinteger

错误码。

0
ErrorMessagestring

错误信息。

OK
RequestIdstring

请求ID。

f8651828-609d-4de8-ab49-ab781d7fd85a

错误码

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

变更历史

变更时间变更内容概要操作
2022-02-22OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-22OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-22OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ErrorCode
出参OpenAPI 返回结构发生变更
2022-02-22OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:SignatureId
    新增入参:TemplateId
出参OpenAPI 返回结构发生变更
阿里云首页 机器学习 相关技术圈