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: 147535001692).
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. |
| UpdateUser | Update user information | Update account information |
| GetUser | Get User Information | Get Account Details |
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 Job | Query jobs. |
|
API |
Title |
Description |
| Statistics | Statistics | |
| SenderStatisticsByTagNameAndBatchID | Retrieve the send data under specified conditions. | Retrieve the send data under specified conditions. |
| SenderStatisticsDetailByParam | Get Sending Details | Queries the details of sent emails. |
| GetTrackList | Retrieve sent email tracking data | Email tracking retrieves sent data. |
| GetTrackListByMailFromAndTagName | Retrieve email tracking sending data by sender address and label | Email tracking retrieves sending data that meets specified conditions. |
| SingleSendMail | Send a Single Email | Sends a single email. |
| 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 | Query sender address list | Query the sender address list. |
| 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 | Creates a single recipient. |
Tag
|
API |
Title |
Description |
| CreateTag | Create Tag | Creates a tag. |
| DeleteTag | Delete Tag | Delete Tag |
| ModifyTag | Modify Tag | Modify Tag |
| QueryTagByParam | Retrieve Tags | Call QueryTagByParam to retrieve tags. |
Independent IP
|
API |
Title |
Description |
| DedicatedIpPoolCreate | Create IP Pool | Creates a dedicated IP pool. |
| DedicatedIpPoolDelete | Delete IP Pool | Deletes a dedicated IP pool. |
| DedicatedIpPoolUpdate | Update IP Pool | Updates an IP pool. |
| DedicatedIpPoolList | List IP Pools | Queries a list of dedicated IP pools. |
| DedicatedIpNonePoolList | List IPs Not Added to IP Pool | Lists the IP addresses that are not assigned to any IP pool. This operation is used for IP pool configuration. |
| DedicatedIpAutoRenewal | Set IP Auto Renewal | Sets auto-renewal for a dedicated IP address. |
| DedicatedIpChangeWarmupType | Update Purchased IP Warmup Method | Updates the prefetch method for a dedicated IP address. |
| DedicatedIpList | List Purchased IP Addresses | Queries the IP addresses that you have purchased. |
Invalid address
|
API |
Title |
Description |
| ListUserSuppression | List Personal and System Invalid Addresses | List User Invalid Addresses. |
| CreateUserSuppression | Create Invalid Address or Domain | Create User's Invalid Address |
| RemoveUserSuppression | Remove Invalid Addresses for Individuals and Systems | Deletes email addresses from the user-level suppression list, which contains both system-identified and manually added addresses. |
| UnblockSending | Lift Sending Restrictions | Removes sending restrictions caused by unsubscribes or complaints. |
| ListBlockSending | ListBlockSending | Retrieves the sending blacklist. |
Configuration Sets
|
API |
Title |
Description |
| ConfigSetCreate | ConfigSetCreate | Creates a configuration set. You can create up to 100 configuration sets. |
| ConfigSetDelete | ConfigSetDelete | Deletes configuration sets. |
| ConfigSetUpdate | ConfigSetUpdate | Updates a configuration set. |
| ConfigSetDetail | ConfigSetDetail | Retrieves the details of a configuration set. |
| ConfigSetList | ConfigSetList | Retrieves a list of configuration sets. |
| ConfigSetRelationFromAddress | ConfigSetRelationFromAddress | Associates a configuration set with a sender address. |
| ConfigSetCancelRelationFromAddress | ConfigSetCancelRelationFromAddress | Disassociates a sender address from a configuration set. |
Template
|
API |
Title |
Description |
| DescTemplate | DescTemplate | Views the information about a template. |
| QueryTemplateByParam | QueryTemplateByParam | Performs a paged query to retrieve a list of templates. |
Address validation
|
API |
Title |
Description |
| GetValidationQuota | GetValidationQuota | Queries the email validation quota. |
| ValidateEmail | ValidateEmail | Validates an email address. |
| SendValidateFile | SendValidateFile | Uploads a file of addresses for validation. |
| GetValidateFileStatus | GetValidateFileStatus | Retrieves the status of a validation file. |
| GetValidateFile | GetValidateFile | Retrieves the result file of a batch validation task. |
| DeleteValidateFile | DeleteValidateFile | Deletes the validation file after validation is complete. |