QueryReceiverByParam Query Recipient Lists
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Valid values: QueryReceiverByParam |
PageSize | Integer | No | The number of entries to return on each page. Default value: 10. |
PageNo | Integer | No | Page size |
KeyWord | String | No | KeyWord |
Status | Integer | No | Status |
For information about other request parameters, see Common request parameters.
Response parameters
Parameter | Type | Description |
data | Array | The data entries. |
NextStart | String | The start position of the next record. Default value: 0. |
PageSize | Integer | The number of entries to return on each page. Default value: 10. |
RequestId | String | RequestId |
TotalCount | Integer | Total count |
data
Parameter | Type | Description |
ReceiverId | String | the ID of the Recipient List. |
ReceiversName | String | the Name of Recipient List |
Count | String | Total number of recipient addresses |
ReceiversAlias | String | the Alias Address of Recipient List |
Desc | String | the Description of Recipient List |
ReceiversStatus | String | List Status (Uploading 0 , Completed 1) |
CreateTime | String | The creation time. Example: 2021-09-28T16:40:35Z. |
UtcCreateTime | Long | A timestamp, such as 1632818435. |
Examples
Sample requests
http(s)://dm.aliyuncs.com/?Action=QueryReceiverByParam
&KeyWord=''
&Status=''
&PageNo=''
&PageSize=''
&<Common request parameters>Sample success responses
JSON format
{
"TotalCount": 9,
"RequestId": "E6603A47-F1B4-39E2-A773-87A72F3779C4",
"data": {
"receiver": [
{
"ReceiversStatus": 0,
"ReceiverId": "079984cfc696ce1b5bed3a43d2e6f97a",
"Desc": "list2",
"UtcCreateTime": 1628816320,
"ReceiversName": "234235",
"CreateTime": "2021-08-13T08:58:40Z",
"ReceiversAlias": "test@example.net",
"Count": 1
}
]
}
}