ListMessages_人工智能平台 PAI - 用户增长_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求语法

GET /api/v2/messages HTTP/1.1

请求参数

字段名称字段详情
Datetimestring

发送日期,格式为 yyyymmdd。

示例值:20220101
ErrorCodestring

短信错误码过滤。

示例值:DELIVERED
GroupIdstring

关联人群 ID 过滤。

示例值:10ed87f5-3ca8-4a43-9d83-b30519be7241
MessageIdstring

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

示例值:0a54e195-03e2-40bd-869d-b71cb302783e
PageNumberinteger<int32>

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

示例值:1
PageSizeinteger<int32>

分页大小,默认为 10。

示例值:10
PhoneNumberstring

手机号码。

示例值:1234567890
RequestIdstring

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

示例值:62a72a20-8a9b-4060-a510-0c30a9340cba
ScheduleIdstring

关联发送计划 ID。

示例值:08d19262-bd76-48fd-80e8-6a225ac388c1
Signaturestring

签名名称。

示例值:PAI通知参考取值来源:
    GetSignature
    ListSignatures
    CreateSignature
SignatureIdstring

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

示例值:5480e3e7-f578-42d2-8ce8-217dec75f2e6
Statusinteger<int32>

短信发送状态。展开详情

示例值:0
TemplateCodestring

模板号。

示例值:SMS_123456参考取值来源:
    GetTemplate
    CreateTemplate
    ListTemplates
TemplateIdstring

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

示例值:b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3
TemplateTypeinteger<int32>

模板类型过滤。展开详情

示例值:2

返回参数

字段名称字段详情
Dataobject

返回数据。

ErrorCodeinteger<int32>

错误码。

示例值:0
ErrorMessagestring

错误信息。

示例值:OK
RequestIdstring

请求 ID。

示例值:f8651828-609d-4de8-ab49-ab781d7fd85a

返回示例

变更历史

变更时间变更内容概要操作
2022-02-22
变更返回参数

相关示例