QueryInvalidAddress - Direct Mail - Alibaba Cloud Documentation Center

Operation description

Retrieve deduplicated invalid address information. If an email is sent to the same invalid address multiple times, only the first occurrence will be recorded. The query should be based on the time when the address was first classified as invalid.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	Start time, which cannot be earlier than 30 days ago, in the format yyyy-MM-dd.	2019-09-29
EndTime	string	No	End time, with a span from the start time that cannot exceed 30 days, in the format yyyy-MM-dd.	2019-09-29
KeyWord	string	No	Keyword. If not provided, it represents all invalid addresses.	info
Length	integer	No	Number of items per request.	100
NextStart	string	No	Request starting position.	***

Response elements

Element	Type	Description	Example
	object
NextStart	string	Next request starting position.	2
RequestId	string	Request ID.	95A7D497-F8DD-4834-B81E-C1783236E55F
TotalCount	integer	Total count.	3
data	object
mailDetail	array<object>	Records.
	object	Detailed records.
LastUpdateTime	string	Update time.	2021-04-28T17:11Z
ToAddress	string	Recipient address.	toaddress@example.com
UtcLastUpdateTime	integer	Update time (in timestamp format).	1619601108

Examples

Success response

JSON format

{
  "NextStart": "2",
  "RequestId": "95A7D497-F8DD-4834-B81E-C1783236E55F",
  "TotalCount": 3,
  "data": {
    "mailDetail": [
      {
        "LastUpdateTime": "2021-04-28T17:11Z",
        "ToAddress": "toaddress@example.com",
        "UtcLastUpdateTime": 1619601108
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.