ListUserSuppression - Direct Mail - Alibaba Cloud Documentation Center

List User Invalid Addresses.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartCreateTime	integer	No	Start creation time, timestamp, accurate to the second.	1715668852
EndCreateTime	integer	No	End creation time, timestamp, accurate to the second. The span between start and end times cannot exceed 7 days.	1715669077
StartBounceTime	integer	No	Start time of the last bounce hit, timestamp, accurate to the second.	1715668852
EndBounceTime	integer	No	End time of the last bounce hit, timestamp, accurate to the second. The span between start and end times cannot exceed 7 days.	1715669077
Address	string	No	Email address or domain name	test@example.net
PageNo	integer	No	Current page number	1
PageSize	integer	No	Page size	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	Page size	10
RequestId	string	Request ID	1A846D66-5EC7-551B-9687-5BF1963DCFC1
PageNumber	integer	Page number	1
TotalCount	integer	Total count	2
Data	object
UserSuppressions	array<object>	Returned results.
	object	detailed information
SuppressionId	integer	Invalid address ID	59511
Address	string	Email address or domain name	test@example.net
LastBounceTime	integer	Last bounce hit time, timestamp, accurate to the second.	1715667451
CreateTime	integer	Creation time, timestamp, accurate to the second.	1715667435
Type	string	Source of entry, invalid address type system user	user

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "1A846D66-5EC7-551B-9687-5BF1963DCFC1",
  "PageNumber": 1,
  "TotalCount": 2,
  "Data": {
    "UserSuppressions": [
      {
        "SuppressionId": 59511,
        "Address": "test@example.net",
        "LastBounceTime": 1715667451,
        "CreateTime": 1715667435,
        "Type": "user"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.