文档

ListMessages - 获取短信列表

更新时间:

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

调试

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

授权信息

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

请求语法

GET /api/v2/messages

请求参数

名称类型必填描述示例值
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

返回数据。

Messagesobject []

短信列表。

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

示例

正常返回示例

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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-02-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ErrorCode
出参OpenAPI 返回结构发生变更
2022-02-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:SignatureId
    新增入参:TemplateId
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈