QueryReceiverByParam - 查询收件人列表

查询收件人列表。

调试

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

授权信息

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

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

请求参数

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

当前页码

1
PageSizeinteger

每页数目,默认:10

10
KeyWordstring

关键词,默认所有信息

mesh-notification
Statusinteger

投递结果。不填,代表所有状态。取值:

  • 0:成功
  • 2:无效地址
  • 3:垃圾邮件
  • 4:失败
1

返回参数

名称类型描述示例值
object
NextStartstring

分页使用。如果还有更多结果,下次请求将该返回值设置到请求中的 NextStart

6aec200853#102#1638894326#test@example.com
PageSizeinteger

每页显示的条数。

10
RequestIdstring

请求 ID

10A1AD70-E48E-476D-98D9-39BD92193837
TotalCountinteger

总数量

15
dataarray<object>

收件人列表详细信息

receiverobject

详细记录

ReceiversAliasstring

收件人列表别名

10***@example.com
ReceiversNamestring

收件人列表名称

TKP000442-333
CreateTimestring

创建时间

2019-09-29T13:28Z
ReceiverIdstring

收件人列表 ID

0c910a7143044b1e116719eb678907b3
UtcCreateTimelong

UTC 格式的创建时间

1569734892
ReceiversStatusstring

列表状态。取值:

  • 0:正在上传
  • 1:上传完成
0
Countstring

收件人地址总数

3
Descstring

描述

通知

示例

正常返回示例

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": "通知"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史