QueryReceiverByParam - Direct Mail - Alibaba Cloud Documentation Center

Query the recipient list.

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	Page number.	1
PageSize	integer	No	Number of entries per page. Default value: 10.	10
KeyWord	string	No	Search keyword. Default value: all information.	mesh-notification
Status	integer	No	List status. Valid values: 0: uploading 1: upload complete	1

Response elements

Element	Type	Description	Example
	object
NextStart	string	Used for paging. If more results are available, set this value as the NextStart parameter in your next request.	6aec200853#102#1638894326#test@example.com
PageSize	integer	Number of entries per page.	10
RequestId	string	Request ID.	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	Total number of entries.	15
data	object
receiver	array<object>	Detailed information about recipients.
	object	Detailed record.
ReceiversAlias	string	Alias of the recipient list.	10***@example.com
ReceiversName	string	Name of the recipient list.	TKP000442-333
CreateTime	string	Creation time.	2019-09-29T13:28Z
ReceiverId	string	ID of the recipient list.	0c910a7143044b1e116719eb678907b3
UtcCreateTime	integer	Creation time in UTC format.	1569734892
ReceiversStatus	string	List status. Valid values: 0: uploading 1: upload complete	0
Count	string	Total number of email addresses in the recipient list.	3
Desc	string	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.