API standards and multilingual preset SDKs
The OpenAPI of this product (Dm/2015-11-23) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Account
|
API |
Title |
Description |
| DescAccountSummary | Get Account Information | Retrieves account information. |
Whitelist
|
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 |
| GetIpfilterList | Get IP Filter List | Retrieve IP Protection Information |
Task
|
API |
Title |
Description |
| QueryTaskByParam | Query Job | Queries tasks based on specified parameters. |
|
API |
Title |
Description |
| Statistics | Statistics | |
| SenderStatisticsByTagNameAndBatchID | Retrieve the send data under specified conditions. | Retrieves sending statistics that match specified criteria. |
| SenderStatisticsDetailByParam | Get Sending Details | Queries sending details. |
| GetTrackList | Retrieve sent email tracking data | Email Tracking retrieves data on sent emails. |
| GetTrackListByMailFromAndTagName | Retrieve email tracking sending data by sender address and label | Retrieves email tracking data that meets specified conditions. |
| SingleSendMail | Send a Single Email | Send a single email. |
| BatchSendMail | Send emails in batches | Sends emails in batches. |
| SendTestByTemplate | Send Test Email | Sends a test email using a template. |
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 | Configure the domain name. |
Address
|
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 | Queries a list of sender 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 |
Recipient
|
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 | Retrieves recipient lists. |
| 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 | Creates a tag. |
| DeleteTag | Delete Tag | Delete Tag |
| ModifyTag | Modify Tag | Modify Tag |
| QueryTagByParam | Retrieve Tags | Call QueryTagByParam to retrieve tags. |
Dedicated 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 | Lists 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 | Lists purchased IPs. |
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 system-identified and manually added addresses from the user-level suppression list. |
| UnblockSending | Lift Sending Restrictions | Removes sending restrictions caused by unsubscribes or complaints. |
| ListBlockSending | ListBlockSending | Queries the email sending blacklist. |
Configuration set
|
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 specified configuration set. |
| ConfigSetList | ConfigSetList | Lists ConfigSets. |
| ConfigSetRelationFromAddress | ConfigSetRelationFromAddress | Associates a configuration set with a sender address. |
| ConfigSetCancelRelationFromAddress | ConfigSetCancelRelationFromAddress | Disassociates a sender address from a configuration set. |
Template
|
API |
Title |
Description |
| CreateTemplate | CreateTemplate | Creates a new mail template in DirectMail. |
| DescTemplate | View template information | Queries template information. |
| QueryTemplateByParam | Paging query of template list information | Queries template list information by paging. |
Address verification
|
API |
Title |
Description |
| GetValidationQuota | GetValidationQuota | Retrieves the email validation quota. |
| ValidateEmail | ValidateEmail | Validate an email address. |
| SendValidateFile | SendValidateFile | You can upload the list of addresses to be verified. |
| GetValidateFileStatus | GetValidateFileStatus | Retrieves the status of a file validation task. |
| GetValidateFile | GetValidateFile | Retrieves the results file of a batch validation task. |
| DeleteValidateFile | DeleteValidateFile | Deletes the verification file after the verification process is complete. |
Other
|
API |
Title |
Description |
| ListValidateFile | ListValidateFile | Retrieves a list of uploaded validation files. |
Others
|
API |
Title |
Description |
| DeleteTemplate | Delete template | Queries template information. |
| GetIpProtection | Check if IP Protection is Enabled | Get IP Protection Information |
| GetUser | Get User Information | Get Account Details |
| ModifyTemplate | Modify email template | Modifies an email template. |
| UpdateUser | Update user information | Update account information |