查询收件人列表
描述
QueryReceiverByParam 查询收件人列表。
请求参数
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 系统规定参数,取值:QueryReceiverByParam |
PageSize | Integer | 否 | 每页数目,默认:10 |
PageNo | Integer | 否 | 当前页码 |
KeyWord | String | 否 | 关键词,默认所有信息 |
Status | Integer | 否 | 投递结果。不填,代表所有状态。 |
其他请求参数,请参见公共请求参数。
返回参数
名称 | 类型 | 描述 |
data | Array | 收件人列表详细信息 |
NextStart | String | 分页使用。如果还有更多结果,下次请求将该返回值设置到请求中的NextStart |
PageSize | Integer | 每页显示的条数。 |
RequestId | String | 请求ID |
TotalCount | Integer | 总数量 |
data
名称 | 类型 | 描述 |
ReceiverId | String | 收件人列表ID |
ReceiversName | String | 收件人列表名称 |
Count | String | 收件人地址总数 |
ReceiversAlias | String | 收件人列表别名 |
Desc | String | 描述 |
ReceiversStatus | String | 列表状态(正在上传0,上传完成1) |
CreateTime | String | 创建时间,如:2021-09-28T16:40:35Z |
UtcCreateTime | Long | 时间戳,如:1632818435 |
示例
请求示例
http(s)://dm.aliyuncs.com/?Action=QueryReceiverByParam
&KeyWord=''
&Status=''
&PageNo=''
&PageSize=''
&<公共请求参数>
正常返回示例
JSON 格式
{
"TotalCount": 9,
"RequestId": "E6603A47-F1B4-39E2-A773-87A72F3779C4",
"data": {
"receiver": [
{
"ReceiversStatus": 0,
"ReceiverId": "079984cfc696ce1b5bed3a43d2e6f97a",
"Desc": "列表2",
"UtcCreateTime": 1628816320,
"ReceiversName": "234235",
"CreateTime": "2021-08-13T08:58:40Z",
"ReceiversAlias": "test@example.net",
"Count": 1
}
]
}
}