QueryReceiverDetail - Direct Mail - Alibaba Cloud Documentation Center

Retrieve detailed information about a 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:QueryReceiverDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ReceiverId	string	Yes	Recipient list ID (returned when creating a recipient list using the CreateReceiver API).	1235
PageSize	integer	No	Number of items per page, default: 10	10
KeyWord	string	No	Recipient address, length 0-50	b***@example.net
NextStart	string	No	Starting position for the next item, default: 0	0

Response elements

Element	Type	Description	Example
	object
DataSchema	string	Field name for the Data of recipients	UserName,NickName,Gender,Birthday,Mobile
NextStart	string	Used for pagination. If there are more results, set this returned value to the NextStart in the next request.	90f0243616#40test@example.com
RequestId	string	Request ID	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	Total count (deprecated field, kept for historical compatibility)	361
data	object
detail	array<object>	Detailed information
	object	Detailed information
Data	string	Content	{'Domains': ['a.example.net', 'b.example.net', 'c.example.net', 'd.example.net']}
UtcCreateTime	integer	Creation time in UTC format	1569734892
Email	string	Recipient address	a***@example.net
CreateTime	string	Creation Time	2019-09-29T13:28Z

Examples

Success response

JSON format

{
  "DataSchema": "UserName,NickName,Gender,Birthday,Mobile",
  "NextStart": "90f0243616#40test@example.com",
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "TotalCount": 361,
  "data": {
    "detail": [
      {
        "Data": "{'Domains': ['a.example.net', 'b.example.net', 'c.example.net', 'd.example.net']}",
        "UtcCreateTime": 1569734892,
        "Email": "a***@example.net",
        "CreateTime": "2019-09-29T13:28Z"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.