Query Recipient Lists by Keyword and Status via QueryReceiverByParam - Direct Mail - Alibaba Cloud - Direct Mail

Retrieves recipient lists.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dm:QueryReceiverByParam

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	This deprecated field is kept for backward compatibility. You can omit this parameter. The page number.	1
PageSize	integer	No	The page size. Default value: 100. Omitting this parameter returns all results. However, because the PageNo parameter is deprecated, the effect of PageSize on pagination is limited.	10
KeyWord	string	No	The keyword to search for recipient lists. If omitted, all recipient lists are returned.	mesh-notification
Status	integer	No	This deprecated field is kept for backward compatibility. You can omit this parameter. The list status. Valid values: 0: uploading 1: upload complete	1

Response elements

Element	Type	Description	Example
	object
NextStart	string	A token indicating that more results are available. To get the next page of results, include this token in the NextStart parameter of your next request.	6aec200853#102#1638894326#test@example.com
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	The total count.	15
data	object
receiver	array<object>	Details about the recipient lists.
	object	The details of a recipient list.
ReceiversAlias	string	The recipient list alias.	10***@example.com
ReceiversName	string	The recipient list name.	TKP000442-333
CreateTime	string	The creation time.	2019-09-29T13:28Z
ReceiverId	string	The recipient list ID.	0c910a7143044b1e116719eb678907b3
UtcCreateTime	integer	The creation time in UTC.	1569734892
ReceiversStatus	string	This deprecated field is kept for backward compatibility. The list status. Valid values: 0: uploading 1: upload complete	0
Count	string	The recipient address count.	3
Desc	string	The description.	通知

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.