全部產品
Search

搜尋本產品

    Direct Mail：BatchSendMail

    文件中心

    Direct Mail：BatchSendMail

    更新時間：Jun 26, 2026

    批次傳送郵件。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dm:BatchSendMail

    none

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TemplateName

    string

    否

    預先建立且通過審核的範本名稱。

    test1
    AccountName

    string

    是

    管理控制台中配置的發信地址。

    test@example.com
    ReceiversName

    string

    否

    預先建立且上傳了收件人的收件人列表名稱。

    注意：

    收件人列表人數不得高於剩餘日額度，否則會發信失敗。

    收信人列表需要在觸發任務之後至少 10 分鐘後再刪除，否則容易引起發信失敗。

    test2
    AddressType

    integer

    是

    • 0：為隨機帳號

    • 1：為發信地址。

    1
    TagName

    string

    否

    郵件標籤名稱。

    test3
    ReplyAddress

    string

    否

    回信地址。

    test2***@example.net
    ReplyAddressAlias

    string

    否

    回信地址別稱。

    小红
    ClickTrace

    string

    否

    • 1：為開啟資料追蹤功能

    • 0（預設）：為關閉資料追蹤功能。

    0
    UnSubscribeLinkType

    string

    否

    產生的退訂連結類型。參照退訂功能產生連結和過濾機制文件

    • disabled: 不產生

    • default: 採用預設策略：對批次類型的發信地址發給特定網域時會產生退訂連結，如帶有關鍵字"gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", "ymail.com"等

    顯示語言根據收件人的瀏覽器設定自動識別。

    default
    UnSubscribeFilterLevel

    string

    否

    過濾級別。參照退訂功能產生連結和過濾機制文件

    • disabled: 不過濾

    • default: 採用預設策略，批次地址採用發信地址級別過濾

    • mailfrom: 發信地址級別過濾

    • mailfrom_domain: 發信網域級別過濾

    • edm_id: 帳號級別過濾。

    mailfrom_domain
    Headers

    string

    否

    郵件標頭設定

    標準欄位和非標準欄位都需要符合標準中對標頭的語法要求，API 發信最多可透過 headers 欄位傳入 10 個標頭，超出限制會被忽略，SMTP 沒有限制。

    1、標準欄位

    Message-ID，List-Unsubscribe，List-Unsubscribe-Post

    標準欄位會覆蓋掉郵件標頭中原有的值。

    2、非標準欄位

    不區分大小寫

    a、以 X-User- 開頭（不推送到事件匯流排 EB、訊息服務 MNS。僅 API 要求，SMTP 任意自訂）

    b、以 X-User-Notify- 開頭（推送到事件匯流排 EB、訊息服務 MNS。API 和 SMTP 都支援）

    推送到 EB 或 MNS 時，header 欄位下會包含這些欄位。

    { "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001", "X-User-Notify-UID1": "UID-3-000001", "X-User-Notify-UID2": "UID-4-000001" }
    IpPoolId

    string

    否

    獨立 IP 位址池 ID。購買了獨立 IP 的使用者可以透過這個參數指定本次發信出口 IP。

    e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef
    DomainAuth

    boolean

    否

    啟用網域級別認證

    • true

    • false

    僅在網域級別認證時使用，發信地址級別認證請忽略。

    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
    TemplateContent

    object

    否

    自訂郵件內容，直接指定傳送內容無需預先建立範本，與 TemplateName 二選一。如果 TemplateContent 和 TemplateName 同時存在，優先使用 TemplateName。

    Subject

    string

    否

    指定郵件主旨。

    黑色星期五，专属折扣来袭
    HtmlBody

    string

    否

    郵件 html 正文。

    注意：HtmlBody 和 TextBody 是針對不同類型的郵件內容，兩者必須傳其一。

    新版 SDK 採用 Body 傳參限制約 8MB（ java 1.4.0 及以上， python3 1.4.0 及以上， php 1.4.0 及以上 ）。

    全场九折，仅限今日
    TextBody

    string

    否

    郵件 text 正文。

    注意：HtmlBody 和 TextBody 是針對不同類型的郵件內容，兩者必須傳其一。

    新版 SDK 採用 Body 傳參限制約 8MB（ java 1.4.0 及以上， python3 1.4.0 及以上， php 1.4.0 及以上 ）。

    全场九折，仅限今日
    Alias

    string

    否

    寄件人顯示名稱。

    Jackie
    Receivers

    array<object>

    否

    收件人列表，數量不得超過 100，與 ReceiversName 二選一。Receivers 和 ReceiversName 同時設定，優先使用 ReceiversName。

    示例：[{"To":["Jackie@example.com"],"TemplateData":{"UserName":"Jackie"}},{"To":["Tom@example.com"],"TemplateData":{"UserName":"Tom"}}]。

    array<object>

    否

    一組自訂收件人詳情。

    To

    array

    否

    收件人列表，陣列類型。

    string

    否

    郵件地址。

    Jackie@example.com
    TemplateData

    object

    否

    郵件範本參數，json map 資料類型。

    string

    否

    key-value 字符串

    {"UserName": "Jackie"}

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    EnvId

    string

    事件 ID。

    xxx
    RequestId

    string

    請求 ID。

    12D086F6-8F31-4658-84C1-006DED011A85

    樣本

    正常返回樣本

    JSON格式

    {
  "EnvId": "xxx",
  "RequestId": "12D086F6-8F31-4658-84C1-006DED011A85"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。