调用ListMessages获取指定日期的短信发送状态_人工智能平台 PAI(PAI)-阿里云帮助中心

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

调试

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

授权信息

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

请求语法

GET /api/v2/messages

请求参数

名称	类型	必填	描述	示例值
Datetime	string	是	发送日期，格式为 yyyymmdd。	20220101
ErrorCode	string	否	短信错误码过滤。	DELIVERED
GroupId	string	否	关联人群 ID 过滤。	10ed87f5-3ca8-4a43-9d83-b30519be7241
MessageId	string	否	短信 ID 过滤，短信 ID 为 SendMessage 成功返回的 ID。	0a54e195-03e2-40bd-869d-b71cb302783e
PageNumber	integer	否	分页数，从 1 开始，默认为 1。	1
PageSize	integer	否	分页大小，默认为 10。	10
PhoneNumber	string	否	手机号码。	1234567890
RequestId	string	否	短信批处理 ID 过滤，短信批处理 ID 为 SendMessage 成功返回的 RequestId。	62a72a20-8a9b-4060-a510-0c30a9340cba
ScheduleId	string	否	关联发送计划 ID。	08d19262-bd76-48fd-80e8-6a225ac388c1
Signature	string	否	签名名称。	PAI通知
SignatureId	string	否	签名 ID，同时只能指定签名名称或签名 ID 其中之一。	5480e3e7-f578-42d2-8ce8-217dec75f2e6
Status	integer	否	短信发送状态。 0 : 发送中。 1 : 发送成功。 2 : 发送失败。	0
TemplateCode	string	否	模板号。	SMS_123456
TemplateId	string	否	模板 ID，同时只能指定模板 Code 或模板 ID 其中之一。	b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3
TemplateType	integer	否	模板类型过滤。 0 : 验证码。 1 : 短信通知。 2 : 推广短信。	2

返回参数

名称	类型	描述	示例值
	object	成功。
Data	object	返回数据。
Messages	object []	短信列表。
ErrorCode	string	短信错误码。	DELIVERED
GroupId	string	关联人群 ID。	51d20163-1b10-4af2-8a23-58ad52201f2f
Id	string	短信序列号。	92d05e19-751b-4346-a7c5-8808bb49b8a2
OutId	string	外部拓展字段。	1234567890
PhoneNumber	string	手机号码。	1234567890
ScheduleId	string	关联发送计划 ID。	0604d49d-fd23-4515-bb26-9b537cbf1f6d
Signature	string	签名名称。	PAI通知
Status	integer	短信发送状态。 0 : 发送中。 1 : 发送成功。 2 : 发送失败。	0
TemplateCode	string	模板号。	SMS_123456
TemplateParams	string	模板参数。	{}
TemplateType	integer	模板类型。 0 : 验证码。 1 : 短信通知。 2 : 推广短信。	2
PageNumber	integer	分页数，从 1 开始，默认为 1。	1
PageSize	integer	分页大小，默认为 10。	10
TotalCount	integer	短信数量。	10
ErrorCode	integer	错误码。	0
ErrorMessage	string	错误信息。	OK
RequestId	string	请求 ID。	f8651828-609d-4de8-ab49-ab781d7fd85a

示例

正常返回示例

JSON格式

{
  "Data": {
    "Messages": [
      {
        "ErrorCode": "DELIVERED",
        "GroupId": "51d20163-1b10-4af2-8a23-58ad52201f2f",
        "Id": "92d05e19-751b-4346-a7c5-8808bb49b8a2",
        "OutId": "1234567890",
        "PhoneNumber": "1234567890",
        "ScheduleId": "0604d49d-fd23-4515-bb26-9b537cbf1f6d",
        "Signature": "PAI通知",
        "Status": 0,
        "TemplateCode": "SMS_123456",
        "TemplateParams": "{}",
        "TemplateType": 2
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10
  },
  "ErrorCode": 0,
  "ErrorMessage": "OK",
  "RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2024-06-18

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。

2022-02-22

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2022-02-22

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2022-02-22

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：ErrorCode
出参	OpenAPI 返回结构发生变更。

2022-02-22

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：SignatureId
	新增入参：TemplateId
出参	OpenAPI 返回结构发生变更。