API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Dm/2015-11-23) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 78410016550).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Account
|
API |
Title |
Description |
| DescAccountSummary | Get Account Information | Retrieves account information. |
IP White List
|
API |
Title |
Description |
| AddIpfilter | Add IP Whitelist | Add IP Protection Information |
| DeleteIpfilterByEdmId | Delete IP Whitelist | Delete IP Protection Information |
IP Protection
|
API |
Title |
Description |
| UpdateIpProtection | Enable or Disable IP Protection Function | Update IP Protection API |
| GetIpProtection | Check if IP Protection is Enabled | Get IP Protection Information |
| GetIpfilterList | Get IP Filter List | Retrieve IP Protection Information |
Tasks
|
API |
Title |
Description |
| QueryTaskByParam | Query Task | Query task list |
|
API |
Title |
Description |
| Statistics | Statistics | |
| SenderStatisticsByTagNameAndBatchID | Retrieve Sending Data under Specified Conditions | Retrieve Sending Data under Specified Conditions |
| SenderStatisticsDetailByParam | Get Sending Details | Query Delivery Result Details |
| GetTrackList | Retrieve Email Tracking Data | Get tracking information |
| GetTrackListByMailFromAndTagName | Retrieve Email Tracking Data by Sender Address and Tag | Get tracking information based on the sender address and tag name |
| SingleSendMail | Send a Single Email | API for Sending Emails |
| BatchSendMail | Batch Send Emails | Batch Send Emails |
| SendTestByTemplate | Send Test Email | Send Template Test Email |
Domain
|
API |
Title |
Description |
| CreateDomain | Create Domain | Create Domain |
| DeleteDomain | Delete Domain | Delete Domain |
| ModifyPWByDomain | Set the SMTP password for a domain | Modify the domain-level password |
| QueryDomainByParam | Query Domain List Information | Query domain information |
| CheckDomain | Verify Domain | Check Domain Status |
| DescDomain | Configure Domain | Get Domain Details |
MailAddress
|
API |
Title |
Description |
| CreateMailAddress | Create Mail Address | Create a mail address. |
| DeleteMailAddress | Delete Mail Address | Delete Mail Address |
| ModifyMailAddress | Set SMTP Password and Reply Address for Sending Address | Modify the sending address |
| QueryInvalidAddress | Get Invalid Address Information | NextStart changed to string |
| QueryMailAddressByParam | List of Sending Addresses Query | Query the list of sending addresses. |
| ApproveReplyMailAddress | Verify Reply Address | Verify Reply Address |
| CheckReplyToMailAddress | Verify Reply-To Address for Sending Emails | Validate Reply-To Address |
| DeleteInvalidAddress | Delete Invalid Address | Remove invalid addresses from the invalid address database |
Receiver
|
API |
Title |
Description |
| CreateReceiver | Create Receiver List | Create Receiver List |
| DeleteReceiver | Delete Receiver List | Delete Receiver List |
| DeleteReceiverDetail | Delete a Single Recipient | Delete a Single Recipient |
| QueryReceiverByParam | Query Recipient List | Query the details of the recipient list |
| QueryReceiverDetail | Query Details of a Specific Recipient List | Retrieve detailed information about a recipient list |
| SaveReceiverDetail | Create a Single Recipient | Create a Single Recipient |
Tag
|
API |
Title |
Description |
| CreateTag | Create Tag | Create Tag |
| DeleteTag | Delete Tag | Delete Tag |
| ModifyTag | Modify Tag | Modify Tag |
| QueryTagByParam | Retrieve Tags | Call QueryTagByParam to retrieve tags. |
Other
|
API |
Title |
Description |
| ListUserSuppression | List Personal and System Invalid Addresses | List User Invalid Addresses. |
| UpdateUser | Update user information | Update account information |
| GetUser | Get User Information | Get Account Details |
| CreateUserSuppression | Create Invalid Address or Domain | Create User's Invalid Address |
| RemoveUserSuppression | Remove Invalid Addresses for Individuals and Systems | Delete User's Invalid Addresses |
| DedicatedIpNonePoolList | List IPs Not Added to IP Pool | Purchased Independent IPs Not Added to Pool |
| DedicatedIpChangeWarmupType | Update Purchased IP Warmup Method | Change the warmup method for a dedicated IP |
| DedicatedIpPoolCreate | Create IP Pool | Creation of Independent IP Pool |
| DedicatedIpPoolList | List IP Pools | Dedicated IP Pool List |
| DedicatedIpPoolUpdate | Update IP Pool | Update of dedicated IP Pool |
| DedicatedIpAutoRenewal | Set IP Auto Renewal | Set Dedicated IP Auto Renewal |
| DedicatedIpPoolDelete | Delete IP Pool | Dedicated IP Pool Deletion |
| DedicatedIpList | List Purchased IP Addresses | Dedicated IP User IP List |
| UnblockSending | Lift Sending Restrictions | Lift sending restrictions due to unsubscription, reporting, etc. |