ListBlockSending - Direct Mail - Alibaba Cloud Documentation Center

Operation description

Retrieves data about unsubscriptions or spam reports.

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:ListBlockSending

list

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token to start the query. If this parameter is left empty, the query starts from the beginning.	xxxxxyyyyyy
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 500.	50
BlockType	string	Yes	The block type. UNSUB: Unsubscribe REPORT: Report	UNSUB
SenderEmail	string	No	The sender's email address.	xxxx@sender.com
BlockEmail	string	No	The recipient's email address.	xxxx@rcpt.com
BeginTime	integer	No	The beginning of the time range to query.	1731463398242
EndTime	integer	No	The end of the time range to query.	1732463398242

Response elements

Element	Type	Description	Example
	object	The schema of the response parameters.
RequestId	string	The request ID.	XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
NextToken	string	The token to retrieve the next page of results. An empty string indicates that all results have been returned.	xxxxyyyy
Data	array<object>	A list of unsubscriptions or reports.
	object
BlockEmail	string	The recipient's email address.	xxxx@rcpt.com
SendTime	integer	The time when the email was sent.	1723249364
BlockTime	integer	The time when the email address was blocked.	1723259364
SenderEmail	string	The sender's email address.	xxxx@sender.com
Reason	integer	The reason for the block. The value is a bitset. The meaning of each bit is as follows: 0: The reason is not specified. 1: Not interested in the content. 2: Repetitive content. 3: Content is sent too frequently.	1
MaxResults	integer	The maximum number of entries returned.	50

Examples

Success response

JSON format

{
  "RequestId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "NextToken": "xxxxyyyy",
  "Data": [
    {
      "BlockEmail": "xxxx@rcpt.com",
      "SendTime": 1723249364,
      "BlockTime": 1723259364,
      "SenderEmail": "xxxx@sender.com",
      "Reason": 1
    }
  ],
  "MaxResults": 50
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.