批量發送郵件。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dm:BatchSendMail |
none |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| TemplateName |
string |
是 |
預先建立且通過審核的模板名稱。 |
test1 |
| AccountName |
string |
是 |
管理主控台中配置的發信地址。 |
test@example.com |
| ReceiversName |
string |
是 |
預先建立且上傳了收件者的收件者清單名稱。 注意: 收件者清單人數不得高於剩餘日額度,否則會發信失敗。 收信人列表需要在觸發任務之後至少 10 分鐘後再刪除,否則容易引起發信失敗。 |
test2 |
| AddressType |
integer |
是 |
|
1 |
| TagName |
string |
否 |
郵件標籤名稱。 |
test3 |
| ReplyAddress |
string |
否 |
回信地址 |
test2***@example.net |
| ReplyAddressAlias |
string |
否 |
回信地址別稱 |
小紅 |
| ClickTrace |
string |
否 |
|
0 |
| UnSubscribeLinkType |
string |
否 |
產生的退訂連結類型。參照退訂功能產生連結和過濾機制文檔
顯示語言根據收件者的瀏覽器設定自動識別 |
default |
| UnSubscribeFilterLevel |
string |
否 |
過濾層級。參照退訂功能產生連結和過濾機制文檔
|
mailfrom_domain |
| Headers |
string |
否 |
郵件標頭設定 標準欄位和非標準欄位都需要符合標準中對頭的文法要求,API 發信最多可通過 headers 欄位傳入 10 個標題,超出限制會被忽略,SMTP 沒有限制。 1、標準欄位 Message-ID,List-Unsubscribe,List-Unsubscribe-Post 標準欄位會覆蓋掉郵件標頭中原有的值。 2、非標準欄位 不區分大小寫 a、以 X-User- 開頭(不推送到事件匯流排 EB、Message Service MNS。僅 API 要求,SMTP 任意自訂) b、以 X-User-Notify- 開頭(推送到事件匯流排 EB、Message Service MNS。API 和 SMTP 都支援) 推動到 EB 或 MNS 時,header 欄位下會包含這些欄位 |
{
"Message-ID": " |
| IpPoolId |
string |
否 |
獨立 IP 位址集區 ID。購買了獨立 IP 的使用者可以通過這個參數指定本次發信出口 IP。 |
e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef |
| DomainAuth |
boolean |
否 |
啟用域層級認證
僅在域層級認證時使用,發信地址層級認證請忽略。 1、domain-auth-created-by-system@example.com 控制台建立這個地址,@首碼保持固定不變,尾碼用自己網域名稱。 2、 API 情境 AccountName 填網域名稱,收件者看到的寄件者是 domain-auth-created-by-system@example.com。 SMTP 情境 a.通過 ModifyPWByDomain 介面設定網域名稱密碼。 b.使用網域名稱和設定的密碼認證,真實寄件者 mailfrom 傳自訂的地址,如 user@example.com,收件者看到的寄件者是 user@example.com。 |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| EnvId |
string |
事件 ID |
xxx |
| RequestId |
string |
請求 ID |
12D086F6-8F31-4658-84C1-006DED011A85 |
樣本
正常返回樣本
JSON格式
{
"EnvId": "xxx",
"RequestId": "12D086F6-8F31-4658-84C1-006DED011A85"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。