Use QueryReceiverByParam to query a recipient list - - Alibaba Cloud Documentation Center

Query a recipient list

Description

This operation queries a recipient list.

Request parameters

Name	Type	Required	Description
Action	String	Yes	A required parameter. Set the value to QueryReceiverByParam.
PageSize	Integer	No	The number of entries per page. Default value: 10.
PageNo	Integer	No	The current page number.
KeyWord	String	No	Keywords. By default, all information is returned.
Status	Integer	No	The delivery status. If you leave this parameter empty, recipients in all states are returned.

For more information about other request parameters, see Common request parameters.

Response parameters

Name	Type	Description
data	Array	The details of the recipient list.
NextStart	String	Used for paging. If more results are available, set the NextStart parameter in your next request to this value.
PageSize	Integer	The number of entries displayed per page.
RequestId	String	The request ID.
TotalCount	Integer	The total number of entries.

data

Name	Type	Description
ReceiverId	String	The ID of the recipient list.
ReceiversName	String	The name of the recipient list.
Count	String	The total number of recipient addresses.
ReceiversAlias	String	The alias of the recipient list.
Desc	String	The description.
ReceiversStatus	String	The status of the list. 0: Uploading. 1: Upload complete.
CreateTime	String	The time when the list was created. For example: 2021-09-28T16:40:35Z.
UtcCreateTime	Long	The UNIX timestamp. For example: 1632818435.

Examples

Request example

http(s)://dm.aliyuncs.com/?Action=QueryReceiverByParam
&KeyWord=''
&Status=''
&PageNo=''
&PageSize=''
&<Common request parameters>

Example of a successful response

JSON format

{
  "TotalCount": 9,
  "RequestId": "E6603A47-F1B4-39E2-A773-87A72F3779C4",
  "data": {
    "receiver": [
      {
        "ReceiversStatus": 0,
        "ReceiverId": "079984cfc696ce1b5bed3a43d2e6f97a",
        "Desc": "List 2",
        "UtcCreateTime": 1628816320,
        "ReceiversName": "234235",
        "CreateTime": "2021-08-13T08:58:40Z",
        "ReceiversAlias": "test@example.net",
        "Count": 1
      }
    ]
  }
}