API概覽-Direct Mail-阿里雲 - Direct Mail

API標準及多語言預置SDK

本產品（Dm/2015-11-23）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

帳戶

API	標題	API概述
DescAccountSummary	擷取賬戶資訊	擷取賬戶資訊。
UpdateUser	更新使用者資訊	更新使用者相關的資訊，包括設定等資訊。
GetUser	擷取使用者資訊	擷取使用者相關的資訊，包含設定等資訊。

白名單

API	標題	API概述
AddIpfilter	添加IP白名單	添加 IP 白名單。
DeleteIpfilterByEdmId	刪除IP白名單	刪除IP保護資訊。

IP 防護

API	標題	API概述
UpdateIpProtection	開啟或者關閉IP保護功能	開啟或者關閉IP保護功能。
GetIpProtection	擷取IP防護功能是否開啟	擷取IP防護功能是否開啟。
GetIpfilterList	擷取 IP 篩選器列表	擷取 IP 篩選器列表。

任務

API	標題	API概述
QueryTaskByParam	查詢任務	查詢任務。

郵件

API	標題	API概述
統計	統計
SenderStatisticsByTagNameAndBatchID	擷取指定條件下的發送資料	擷取指定條件下的發送資料。
SenderStatisticsDetailByParam	擷取發送詳情	擷取發送詳情。
GetTrackList	郵件跟蹤擷取發送資料	郵件跟蹤擷取發送資料。
GetTrackListByMailFromAndTagName	根據發信地址和標籤擷取郵件跟蹤發送資料	郵件跟蹤擷取指定條件下的發送資料。
SingleSendMail	發送單條郵件	發送單條郵件。
BatchSendMail	批次傳送郵件	批次傳送郵件。
SendTestByTemplate	發送測試郵件	發送測試郵件。

網域

API	標題	API概述
CreateDomain	建立網域名稱	建立網域名稱。
DeleteDomain	刪除網域名稱	刪除網域名稱。
ModifyPWByDomain	設定網域名稱的 SMTP 的密碼	設定網域名稱的SMTP的密碼。
QueryDomainByParam	查詢網域名稱列表資訊	查詢網域名稱列表資訊。
CheckDomain	驗證網域名稱	驗證網域名稱。
DescDomain	佈建網域名	佈建網域名。

地址

API	標題	API概述
CreateMailAddress	建立發信地址	建立發信地址。
DeleteMailAddress	刪除發信地址	刪除發信地址。
ModifyMailAddress	設定發信地址SMTP密碼和回信地址	設定發信地址SMTP密碼和回信地址。
QueryInvalidAddress	擷取無效地址資訊	擷取無效地址資訊。
QueryMailAddressByParam	查詢發信地址清單	查詢發信地址清單。
ApproveReplyMailAddress	驗證回信地址	驗證回信地址。
CheckReplyToMailAddress	驗證回信地址發送郵件	驗證回信地址發送郵件。
DeleteInvalidAddress	刪除無效地址	從全域無效地址庫移除無效地址。

收件人

API	標題	API概述
CreateReceiver	建立收件者清單	建立收件者清單。
DeleteReceiver	刪除收件者清單	刪除收件者清單。
DeleteReceiverDetail	刪除單個收件者	刪除單個收件者。
QueryReceiverByParam	查詢收件者清單	查詢收件者清單。
QueryReceiverDetail	查詢某個收件者清單詳情	查詢某個收件者清單詳情。
SaveReceiverDetail	建立單個收件者	建立單個收件者。

獨立 IP

API	標題	API概述
DedicatedIpPoolCreate	建立IP池	IP池建立。
DedicatedIpPoolDelete	刪除IP池	IP池刪除。
DedicatedIpPoolUpdate	更新IP池	更新IP池。
DedicatedIpPoolList	列出IP池	列出IP池。
DedicatedIpNonePoolList	列出未加入IP池IP	列出未加入IP池IP，用於IP池設定。
DedicatedIpAutoRenewal	設定IP自動續約	設定IP自動續約。
DedicatedIpChangeWarmupType	更新已購買IP預熱方式	更新已購買IP預熱方式。
DedicatedIpList	列出購買IP列表	列出購買IP列表。

無效地址

API	標題	API概述
ListUserSuppression	列出個人和系統無效地址	列出使用者手動錄入和系統判別的無效地址。
CreateUserSuppression	建立無效地址或網域名稱	建立無效地址或網域名稱。
RemoveUserSuppression	移除個人和系統無效地址	刪除個人層級無效地址庫（“系統判別”和“個人錄入”）。
UnblockSending	解除發信限制	解除退訂、舉報等發信限制。
ListBlockSending	擷取發信黑名單	擷取發信黑名單列表。

配置集

API	標題	API概述
ConfigSetCreate	建立配置集	建立配置集，上限100個。
ConfigSetDelete	刪除配置集	配置集刪除。
ConfigSetUpdate	更新配置集	更新配置集。
ConfigSetDetail	擷取配置集	擷取配置集詳情。
ConfigSetList	列出配置集列表	列出配置集列表。
ConfigSetRelationFromAddress	配置集關聯發信地址	關聯配置集和發信地址。
ConfigSetCancelRelationFromAddress	配置集取消關聯發信地址	取消配置集關聯發信地址。

範本

API	標題	API概述
CreateTemplate	建立郵件模板	在Direct Mail服務中建立新的郵件模板。
DescTemplate	查看範本資訊	查看範本資訊。
QueryTemplateByParam	分頁查詢範本列表資訊	範本列表資訊分頁查詢。

地址校驗

API	標題	API概述
GetValidationQuota	擷取校正額度	擷取電子郵件校正額度。
ValidateEmail	驗證電子郵件	驗證電子郵件地址。
SendValidateFile	上傳檢驗檔案	上傳所需校正的地址清單。
GetValidateFileStatus	擷取校正結果檔案狀態	擷取校正檔案的狀態。
GetValidateFile	擷取校正結果檔案	擷取批量校正任務的結果檔案。
DeleteValidateFile	刪除校正結果檔案	在校正完成後，刪除校正檔案。

其他

API	標題	API概述
ListValidateFile	列出上傳的校正檔案	擷取上傳的校正檔案的列表

Others

API	標題	API概述
DeleteTemplate	範本刪除API	查看範本資訊。
ModifyTemplate	修改郵件範本	修改郵件範本。

API	標題	API概述
CreateTag	建立標籤	建立標籤。
DeleteTag	刪除標籤	刪除標籤。
ModifyTag	修改標籤	修改標籤。
QueryTagByParam	擷取標籤	擷取標籤。