调用QueryReceiverByParam查询收件人列表-邮件推送-阿里云

查询收件人列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dm:QueryReceiverByParam

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNo	integer	否	当前页码	1
PageSize	integer	否	每页数目，默认：10	10
KeyWord	string	否	关键词，默认所有信息	mesh-notification
Status	integer	否	投递结果。不填，代表所有状态。取值： 0：成功 2：无效地址 3：垃圾邮件 4：失败	1

返回参数

名称	类型	描述	示例值
	object
NextStart	string	分页使用。如果还有更多结果，下次请求将该返回值设置到请求中的 NextStart	6aec200853#102#1638894326#test@example.com
PageSize	integer	每页显示的条数。	10
RequestId	string	请求 ID	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	总数量	15
data	object
receiver	array<object>	收件人列表详细信息
	object	详细记录
ReceiversAlias	string	收件人列表别名	10***@example.com
ReceiversName	string	收件人列表名称	TKP000442-333
CreateTime	string	创建时间	2019-09-29T13:28Z
ReceiverId	string	收件人列表 ID	0c910a7143044b1e116719eb678907b3
UtcCreateTime	integer	UTC 格式的创建时间	1569734892
ReceiversStatus	string	列表状态。取值： 0：正在上传 1：上传完成	0
Count	string	收件人地址总数	3
Desc	string	描述	通知

示例

正常返回示例

JSON格式

{
  "NextStart": "6aec200853#102#1638894326#test@example.com",
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "TotalCount": 15,
  "data": {
    "receiver": [
      {
        "ReceiversAlias": "10***@example.com",
        "ReceiversName": "TKP000442-333",
        "CreateTime": "2019-09-29T13:28Z",
        "ReceiverId": "0c910a7143044b1e116719eb678907b3",
        "UtcCreateTime": 1569734892,
        "ReceiversStatus": "0",
        "Count": "3",
        "Desc": "通知"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。