QueryReceiverByParam - Direct Mail - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the details of the recipient list

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dm:QueryReceiverByParam	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	Current page number	1
PageSize	integer	No	Number of items per page, default: 10	10
KeyWord	string	No	Keyword, defaults to all information if not specified	mesh-notification
Status	integer	No	Delivery result. If not filled, it represents all statuses. Values: 0: Success 2: Invalid address 3: Spam 4: Failure	1

Response parameters

Parameter	Type	Description	Example
	object
NextStart	string	Used for pagination. If there are more results, set this returned value to the NextStart in the next request.	6aec200853#102#1638894326#test@example.com
PageSize	integer	Number of items displayed per page.	10
RequestId	string	Request ID	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	Total count	15
data	array<object>	Detailed information of the recipient list
receiver	object	Detailed records
ReceiversAlias	string	Recipient list alias	10***@example.com
ReceiversName	string	Recipient list name	TKP000442-333
CreateTime	string	Creation time	2019-09-29T13:28Z
ReceiverId	string	Recipient list ID	0c910a7143044b1e116719eb678907b3
UtcCreateTime	long	UTC formatted creation time	1569734892
ReceiversStatus	string	List status. Values: 0: Uploading 1: Upload completed	0
Count	string	Total number of recipient addresses	3
Desc	string	Description	Description

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history