logoドキュメント
Email
ドキュメントホーム
クイックスタート手順REST APISMTPUseMarketingWebHookリソース
検索
日本語
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
ログイン
REST API / 配信履歴

送信関連

最新更新：2025-07-22

呼び出しアドレス

データセンター URL
シンガポール https://email.api.engagelab.cc
トルコ https://emailapi-tr.engagelab.com

REST APIを使用する際は、選択したデータセンターが適切なベースURLに対応していることを確認してください。

POST/v1/mail/send

一般送信

URL

https://email.api.engagelab.cc/v1/mail/send
              
              https://email.api.engagelab.cc/v1/mail/send
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(api_user:api_key)

リクエストパラメーター

パラメーター タイプ 必須 説明
from string Yes 送信者。例: support@mail.engagelab.com, EngageLab Team<support@mail.engagelab.com>。製品または会社のブランド名を表示するには、EngageLab Team<support@mail.engagelab.com>の形式を使用します。EngageLab Teamは送信者名で、製品または会社のブランド名にできます。<support@mail.engagelab.com>は送信者アドレスです。
to array[string] Yes 受信者。最大100アドレスをサポートします。例: ["support@mail.engagelab.com","support@engagelab.com"]
body object Yes メール設定
custom_args object No クライアント定義のオプションのカスタムフィールド、最大1KBをサポート。custom_argsの値には"."記号を含めることはできません。
request_id string No この送信操作のリクエストID。最大128文字をサポート。

本文

パラメーター タイプ 必須 説明
cc array[string] No CCアドレス。最大100アドレスをサポート。send_mode = 1の場合にのみ有効。
bcc array[string] No BCCアドレス。最大100アドレスをサポート。send_mode = 1の場合にのみ有効。
reply_to array[string] No 返信先アドレス。最大3アドレスをサポート。指定されていない場合、返信先アドレスはfromがデフォルトになります。
subject string Yes メール件名。最大256文字をサポート。変数や絵文字もサポート。
content object Yes メール本文。
html string * text/html形式のメールコンテンツ。
text string * text/plain形式のメールコンテンツ。
preview_text string No メールプレビュー本文。
vars object No 変数。最大1MBをサポート。send_mode=0またはsend_mode=1の場合に有効。
dynamic_vars array[object] No 動的テンプレート変数。最大1MBをサポート。send_mode=0またはsend_mode=1の場合に有効。
label_id string No この送信操作で使用されるラベルID。
label_name string No この送信操作で使用されるラベル名。
headers object No メールヘッダー。最大1KBをサポート。
attachments array[object] No メール添付ファイル。合計サイズは10MBを超えてはなりません。
content string Yes 添付ファイルのBase64エンコードされたコンテンツ。
filename string Yes 添付ファイル名、例: example.pdf。
disposition string Yes 許可される値: attachment, inline。
content_id string No dispositionがinlineに設定され、ファイルタイプが画像の場合、この値を設定する必要があります。
settings object No 送信設定。
send_mode int No 送信モード。0は個別送信、1は全受信者が見えるブロードキャスト送信、2はアドレスリスト送信（toの値はアドレスリストのエイリアス）。デフォルトは0。
return_email_id boolean No メールIDを返すかどうか。デフォルトはtrue。
sandbox boolean No サンドボックスモードを使用するかどうか。デフォルトはfalse。trueの場合、メールは配信されず、リクエストパラメーターのみ検証されます。
notification boolean No 開封確認を使用するかどうか。デフォルトはfalse。受信ルートと併用する必要があります。
open_tracking boolean No 開封トラッキングを有効にするかどうか。デフォルトはシステム設定。send_mode=0またはsend_mode=1の場合に有効。
click_tracking boolean No クリックトラッキングを有効にするかどうか。デフォルトはシステム設定。send_mode=0またはsend_mode=1の場合に有効。
unsubscribe_tracking boolean No 購読解除トラッキングを有効にするかどうか。デフォルトはシステム設定。send_mode=0またはsend_mode=1の場合に有効。
unsubscribe_page_id array[int] No カスタム購読解除ページ。デフォルトはシステム設定。send_mode=0またはsend_mode=1の場合に有効。

注意:

  1. send_mode=2の場合、toの値はアドレスリストのエイリアスで、エイリアスの数は5を超えてはなりません。この場合、ccおよびbccパラメーターは無効です。
  2. htmlとplainの両方が空であってはなりません。
  3. preview_textはhtmlと一緒にのみ使用できます。htmlが提供されていない場合、preview_textの値は無効になります。
  4. varsはメールコンテンツ内の変数置換に使用され、JSONオブジェクトとしてフォーマットされます: {"varname":["value1","value2"]}。変数値が空またはスペースの場合、メール内の対応するテキストは空として表示されます。
メールコンテンツ: 親愛なる%name%様、%sp%メールサービスへようこそ。 対応するvars値: {"name":["mike"], "sp":["engagelab"]} メールコンテンツ置換: 親愛なるmike様、engagelabメールサービスへようこそ。
              
                     メールコンテンツ: 親愛なる%name%様、%sp%メールサービスへようこそ。

       対応するvars値: {"name":["mike"], "sp":["engagelab"]}
    
       メールコンテンツ置換: 親愛なるmike様、engagelabメールサービスへようこそ。
このコードブロックはフローティングウィンドウ内に表示されます
  1. dynamic_varsは動的テンプレート変数置換に使用され、JSONオブジェクトとしてフォーマットされます: [{"varname1":"value1","varname2":"value2"}]。
メールコンテンツ: 親愛なる{{name}}様、{{sp}}メールサービスへようこそ。 dynamic_vars値: [{"name":"jim","sp":"engagelab"}] メールコンテンツ置換: 親愛なるjim様、engagelabメールサービスへようこそ。
              
              メールコンテンツ: 親愛なる{{name}}様、{{sp}}メールサービスへようこそ。

dynamic_vars値: [{"name":"jim","sp":"engagelab"}]

メールコンテンツ置換: 親愛なるjim様、engagelabメールサービスへようこそ。
このコードブロックはフローティングウィンドウ内に表示されます

  1. label_idとlabel_nameの両方が提供されている場合、label_nameがシステムに存在しない場合は無視され、システムが自動的に作成します。

  2. headersはカスタムメールヘッダーフィールドに使用され、JSONオブジェクトとしてフォーマットされます: {"User-Define":"123", "User-Custom":"abc"}。ただし、キー文字列には以下の値を含めることはできません（大文字小文字を区別しない）:

    DKIM-Signature, Received, Sender, Date, From, To, Reply-To, Cc, Bcc, Subject, Content-Type, Content-Transfer-Encoding, X-SENDCLOUD-UUID, X-SENDCLOUD-LOG, X-Remote-Web-IP, X-SMTPAPI, Return-Path, X-SENDCLOUD-LOG-NEW.

  3. dispositionがinlineに設定され、添付ファイルのコンテンツが画像の場合、添付ファイルはメール本文内で直接インライン画像としてレンダリングされます。content_idを設定する必要があり、ユニークな文字列でなければなりません。この文字列はメール本文内の画像のsrcとして使用されます。

Email content： <html> <img src="cid:image_1000"></img> <img src="cid:image_1001"></img> </html> attachments parameter: [ {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"}, {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"}, ]
              
                  Email content：
    <html>
        <img src="cid:image_1000"></img>
        <img src="cid:image_1001"></img>
    </html>
    
    attachments parameter:
    [
      {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"},
      {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"},
    ]
このコードブロックはフローティングウィンドウ内に表示されます
  1. custom_argsはクライアント定義のカスタムコンテンツとして使用され、メールヘッダーに埋め込まれます。その後のWebHookデータでクライアントに返されます。custom_argsの値には"."記号を含めることはできません。
  2. request_idは重複送信を防ぐために使用され、1時間有効です。同じリクエストが1時間以内に送信された場合、前回のリクエストの結果が返されます。
  3. メールの合計サイズは70MBを超えてはなりません。

リクエスト例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{ "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", "to": ["111@qq.com", "222<222@qq.com>"], "body": { "cc": ["noreply@mail.engagelab.com"], "bcc": ["intern<intern@mail.engagelab.com>"], "reply_to": ["reply@mail.engagelab.com"], "subject": "%date% Newsletter ", "content": { "html": "<a href=\"https://www.engagelab.com\">Newsletter %kkk%</a>", "text": "Today's news is %ttt%", "preview_text": "preview_text is ..." }, "vars": { }, "label_id": 100233, "label_name": "", "headers": {}, "attachments": [{ "content": "The Base64 encoded content of the attachment", "type": "text/html", "filename": "The attachment's filename", "disposition": "inline | attachment", "content_id": "" }], "settings": { "send_mode": 0, "return_email_id": true, "sandbox": true, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1,2] } }, "custom_args": {}, "request_id": "" }' 'https://email.api.engagelab.cc/v1/mail/send' 
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{
  "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", 
  "to": ["111@qq.com", "222<222@qq.com>"],
  "body": {
      "cc": ["noreply@mail.engagelab.com"],                            
      "bcc": ["intern<intern@mail.engagelab.com>"],                  
      "reply_to": ["reply@mail.engagelab.com"],                         
      "subject": "%date% Newsletter ",                                       
      "content": {                                                     
        "html": "<a href=\"https://www.engagelab.com\">Newsletter %kkk%</a>", 
        "text": "Today's news is %ttt%",                                      
        "preview_text": "preview_text is ..."                          
         },
      "vars": { },
      "label_id": 100233, 
      "label_name": "",
      "headers": {},
      "attachments": [{                                                
        "content": "The Base64 encoded content of the attachment",     
        "type": "text/html",
        "filename": "The attachment's filename",            
        "disposition": "inline | attachment",                           
        "content_id": ""  
      }],
      "settings": {                 
        "send_mode": 0, 
        "return_email_id": true,  
        "sandbox": true,
        "notification": false,
        "open_tracking": true,                                           
        "click_tracking": false,                                         
        "unsubscribe_tracking": true,                              
        "unsubscribe_page_id": [1,2]
      }
  },
  "custom_args": {},           
  "request_id": "" 
}'  'https://email.api.engagelab.cc/v1/mail/send'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス例

  • アドレスリスト以外の送信（send_mode=0またはsend_mode=1）

Response-success

HTTP Status: 200

{ "email_ids":[ "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$111@qq.com", "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$222@qq.com"], "request_id":"" } 
              
              {
"email_ids":[
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$111@qq.com",
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$222@qq.com"],
"request_id":""
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :400

{ "code": 30801, "message": "From can not be empty" }
              
              {
    "code": 30801,
    "message": "From can not be empty"
}
このコードブロックはフローティングウィンドウ内に表示されます
  • アドレスリスト送信（send_mode=2）

Response-success

HTTP Status: 200

{ "task_id":[102923], "request_id":"" } 
              
              {
"task_id":[102923],
"request_id":""
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :400

{ "code": 30801, "message": "From can not be empty" }
              
              {
    "code": 30801,
    "message": "From can not be empty"
}
このコードブロックはフローティングウィンドウ内に表示されます

テンプレート送信

URL

https://email.api.engagelab.cc/v1/mail/sendtemplate
              
              https://email.api.engagelab.cc/v1/mail/sendtemplate
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

Content-Type: application/json; charset=utf-8
              
              Content-Type: application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(api_user:api_key)

リクエストパラメータ

パラメータ タイプ 必須 説明
from string Yes 差出人。例: support@mail.engagelab.com, EngageLab Team<support@mail.engagelab.com>。製品または会社のブランド名を表示するには、EngageLab Team<support@mail.engagelab.com>の形式を使用します。ここで、EngageLab Teamは送信者名であり、製品または会社のブランド名に置き換えることができます。<support@mail.engagelab.com>は送信者のメールアドレスです。
to array[string] Yes 受信者。最大100アドレスをサポート。例: ["xjm@hotmail.com","xjm2@gmail.com"]
body object Yes メール設定
custom_args object No ユーザーが定義したオプションのカスタムフィールド。最大1KBをサポート。custom_argsの値には"."記号を含めることはできません。
request_id string No この送信のリクエストID。最大128文字をサポート。

ボディ

パラメータ タイプ 必須 説明
cc array[string] No CCアドレス。最大100アドレスをサポート。send_mode = 1の場合のみ有効。
bcc array[string] No BCCアドレス。最大100アドレスをサポート。send_mode = 1の場合のみ有効。
reply_to array[string] No 返信先アドレス。最大3アドレスをサポート。指定されない場合、返信先メールアドレスはfromにデフォルト設定されます。
subject string No メール件名。最大256文字をサポート。変数や絵文字をサポートします。指定された場合、呼び出されるテンプレートの件名を上書きします。
template_invoke_name string Yes テンプレート呼び出し名。
vars object No 変数。最大1MBをサポート。send_mode=0またはsend_mode=1の場合に有効。
dynamic_vars array[object] No 動的テンプレート変数。最大1MBをサポート。send_mode=0またはsend_mode=1の場合に有効。
label_id string No この送信で使用されるラベルID。
label_name string No この送信で使用されるラベル名。
headers object No メールヘッダー情報。最大1KBをサポート。
attachments array[object] No 添付ファイル設定。
content string Yes Base64エンコードされた添付ファイルの内容。
filename string Yes 添付ファイル名、例: example.pdf。
disposition string Yes 許可される値: attachment, inline。
content_id string No dispositionがinlineに設定され、ファイルタイプが画像の場合、この値を設定する必要があります。
settings object No 送信設定。
send_mode int No 送信モード。0は個別送信を示し、1は一斉送信を示します。全受信者が同時に表示されます。2はアドレスリスト送信を示し、toの値はアドレスリストのエイリアスです。デフォルトは0です。
return_email_id boolean No メールIDを返すかどうか。デフォルトはtrueです。
sandbox boolean No サンドボックスモードを使用するかどうか。デフォルトはfalseです。trueの場合、メールは配信されず、リクエストパラメータの有効性のみが検証されます。
notification boolean No 開封通知を使用するかどうか。デフォルトはfalseです。デフォルトの通知はfromに送信され、受信ルートと一緒に使用する必要があります。
open_tracking boolean No 開封トラッキングを有効にするかどうか。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に有効。
click_tracking boolean No クリックトラッキングを有効にするかどうか。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に有効。
unsubscribe_tracking boolean No 購読解除トラッキングを有効にするかどうか。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に有効。
unsubscribe_page_id array[int] No カスタム購読解除ページ。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に有効。

注意事項:

  1. send_mode=2の場合、toの値はアドレスリストのエイリアスであり、数は5を超えることはできません。この場合、パラメータccおよびbccは無効です。

  2. varsはメール内容の変数置換に使用され、JSONオブジェクトとしてフォーマットされます: {"varname":["value1","value2"]}。varnameはメール内容の変数です。変数値が空またはスペースの場合、メール内の対応するテキストは空として表示されます。

    メール内容: 親愛なる%name%様、%sp%メールサービスへようこそ。 対応する`vars`値: {"name":["mike"], "sp":["engagelab"]} メール内容置換: 親愛なるmike様、engagelabメールサービスへようこそ。
                  
              メール内容: 親愛なる%name%様、%sp%メールサービスへようこそ。
    
 対応する`vars`値: {"name":["mike"], "sp":["engagelab"]}
    
 メール内容置換: 親愛なるmike様、engagelabメールサービスへようこそ。
    このコードブロックはフローティングウィンドウ内に表示されます

  3. dynamic_varsは動的テンプレート変数置換に使用され、JSONオブジェクトとしてフォーマットされます: [{"varname1":"value1","varname2":"value2"}]

メール内容: 親愛なる{{name}}様、{{sp}}メールサービスへようこそ。 対応する`dynamic_vars`値: [{"name":"jim","sp":"engagelab"}] メール内容置換: 親愛なるjim様、engagelabメールサービスへようこそ。
              
              メール内容: 親愛なる{{name}}様、{{sp}}メールサービスへようこそ。
     
対応する`dynamic_vars`値: [{"name":"jim","sp":"engagelab"}]
     
メール内容置換: 親愛なるjim様、engagelabメールサービスへようこそ。
このコードブロックはフローティングウィンドウ内に表示されます

  1. ユーザーがlabel_idまたはlabel_nameを提供し、label_nameが存在しない場合、システムは自動的に作成します。label_idとlabel_nameの両方が提供された場合、label_nameは無視されます。

  2. headersはメールのヘッダーフィールドをカスタマイズするために使用され、JSONオブジェクトとしてフォーマットされます: {"User-Define":"123", "User-Custom":"abc"}。ただし、キー文字列には以下の値を含めることはできません（大文字小文字を区別しません）:

    DKIM-Signature, Received, Sender, Date, From, To, Reply-To, Cc, Bcc, Subject, Content-Type, Content-Transfer-Encoding, X-SENDCLOUD-UUID, X-SENDCLOUD-LOG, X-Remote-Web-IP, X-SMTPAPI, Return-Path, X-SENDCLOUD-LOG-NEW

  3. dispositionがinlineに設定され、添付ファイルの内容が画像の場合、添付ファイルはメール本文内で直接インライン画像としてレンダリングされます。content_idは設定され、ユニークな文字列である必要があります。これはメール本文内で表示される画像のsrcとして機能します。

    Email content： <html> <img src="cid:image_1000"></img> <img src="cid:image_1001"></img> </html> attachments parameter: [ {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"}, {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"}, ]
                  
              Email content：
<html>
    <img src="cid:image_1000"></img>
    <img src="cid:image_1001"></img>
</html>

attachments parameter:
[
  {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"},
  {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"},
]
    このコードブロックはフローティングウィンドウ内に表示されます

  4. custom_argsは顧客が定義したカスタムコンテンツとして使用され、メールヘッダーに埋め込まれ、後続のWebHookデータで顧客に返されます。custom_argsの値には"."記号を含めることはできません。

  5. request_idは重複送信を防ぐために使用され、1時間有効です。1時間以内に繰り返し送信された場合、最後のリクエストの結果が返されます。

  6. メール全体のサイズは70MBを超えることはできません。

例

month_billテンプレートの内容

Dear %name%: Hello! Your consumption amount this month is: %money% .
              
              Dear %name%:
  Hello! Your consumption amount this month is: %money% .
このコードブロックはフローティングウィンドウ内に表示されます

通常のテンプレート送信例（テンプレートmonth_billを呼び出し）

curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "from": "support@mail.engagelab.com", "to": ["xjmfc@126.com", "xjmfcme@gmail.com"], "body": { "subject": "test email", "template_invoke_name": "month_bill", "label_id": 10143, "label_name": "", "vars": { "%name%": ["jack", "jone"], "%money%": ["30", "50"] }, "headers": { "userdefine-tag-location": "us", "userdefine-tag-user": "fashion" }, "attachments": [{ "content": "The Base64 encoded content of the attachment", "filename": "The attachment's filename", "disposition": "inline | attachment", "content_id": "" }], "settings": { "send_mode": 0, "return_email_id": true, "sandbox": true, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1, 2] } }, "custom_args": {}, "request_id": "" }' #xjmfc@126.com received: Dear jack: Hello! Your consumption amount this month is: 30 . #--------------------------------------------------- # xjmfcme@gmail.com received: Dear Joe: Hello! Your consumption amount this month is: 50 .
              
              curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "from": "support@mail.engagelab.com",
    "to": ["xjmfc@126.com", "xjmfcme@gmail.com"],
    "body": {
        "subject": "test email",
        "template_invoke_name": "month_bill",
        "label_id": 10143,
        "label_name": "",
        "vars": {
            "%name%": ["jack", "jone"],
            "%money%": ["30", "50"]
        },
        "headers": {
            "userdefine-tag-location": "us",
            "userdefine-tag-user": "fashion"
        },
        "attachments": [{
            "content": "The Base64 encoded content of the attachment",
            "filename": "The attachment's filename",
            "disposition": "inline | attachment",
            "content_id": ""
        }],
        "settings": {
            "send_mode": 0,
            "return_email_id": true,
            "sandbox": true,
            "notification": false,
            "open_tracking": true,
            "click_tracking": false,
            "unsubscribe_tracking": true,
            "unsubscribe_page_id": [1, 2]
        }
    },
    "custom_args": {},
    "request_id": ""
        
}'


#xjmfc@126.com received:
Dear jack:
    Hello! Your consumption amount this month is: 30 .
#---------------------------------------------------
# xjmfcme@gmail.com received:
Dear Joe:
  
    Hello! Your consumption amount this month is: 50 .
このコードブロックはフローティングウィンドウ内に表示されます

Response-success

HTTP Status: 200

{ "email_ids":[ "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$xjmfc@126.com", "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$xjmfcme@gmail.com"], "request_id":"" }
              
              {
"email_ids":[
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$xjmfc@126.com",
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$xjmfcme@gmail.com"],
"request_id":""
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :404

not found 
              
              not found
このコードブロックはフローティングウィンドウ内に表示されます

テンプレートアドレスリスト送信（テンプレートmonth_billを呼び出し、アドレスリストusers@maillist.email.engagelab.comを呼び出し）

curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "from":{"admin@engaelab.com"}, "to":["users@maillist.email.engagelab.com"], "body":{ "subject":"bill", "template_invoke_name":"month_bill", "label":"gangz" }}' 
              
              curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
        "from":{"admin@engaelab.com"},
        "to":["users@maillist.email.engagelab.com"],
        "body":{
            "subject":"bill",
             "template_invoke_name":"month_bill",
             "label":"gangz"
}}'
このコードブロックはフローティングウィンドウ内に表示されます

Response-success

HTTP Status: 200

{ "task_id":[102923], "request_id":"" }
              
              {
"task_id":[102923],
"request_id":""
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :404

not found
              
              not found
このコードブロックはフローティングウィンドウ内に表示されます

会議カレンダーの送信

URL

https://email.api.engagelab.cc/v1/mail/sendcalendar
              
              https://email.api.engagelab.cc/v1/mail/sendcalendar
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

Content-Type: application/json; charset=utf-8
              
              Content-Type: application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(api_user:api_key)

リクエストパラメータ

パラメータ タイプ 必須 説明
from string Yes 送信者。例: support@mail.engagelab.com, EngageLab Team<support@mail.engagelab.com>。製品または会社のブランド名を表示するには、EngageLab Team<support@mail.engagelab.com>の形式を使用します。EngageLab Teamは送信者名であり、製品または会社のブランド名を表すことができます。<support@mail.engagelab.com>は送信者アドレスです。
to array[string] Yes 受信者。最大100アドレスをサポートします。例: ["xjm@hotmail.com","xjm2@gmail.com"]。
body object Yes メール設定
custom_args object No クライアントが定義したオプションのカスタムフィールド。custom_argsの値には"."記号を含めることはできません。
request_id string No リクエストID

本文

パラメータ タイプ 必須 説明
cc array[string] No CCアドレス。最大100アドレスをサポートします。send_mode = 1の場合のみ有効です。
bcc array[string] No BCCアドレス。最大100アドレスをサポートします。send_mode = 1の場合のみ有効です。
reply_to array[string] No 返信アドレス。最大3アドレスをサポートします。指定されない場合、返信先アドレスは送信者のアドレスにデフォルト設定されます。
subject string Yes メール件名。最大256文字。変数と絵文字をサポートします。
content object Yes メール内容設定。
html string * メール内容（text/html形式）。
text string * メール内容（text/plain形式）。
preview_text string No メールプレビューのテキスト。
vars object No 変数。最大1MBをサポートします。send_mode=0またはsend_mode=1の場合に有効です。
dynamic_vars array[object] No 動的テンプレート変数。最大1MBをサポートします。send_mode=0またはsend_mode=1の場合に有効です。
label_id string No この送信に使用されるラベルID。
label_name string No この送信に使用されるラベル名。
headers object No メールヘッダー情報。最大1KB。
attachments array[object] No メール添付ファイル。合計サイズは10MBを超えてはなりません。
content string Yes 添付ファイルの内容（base64エンコード）。
filename string Yes 添付ファイル名。例: example.pdf。
disposition string Yes 許可される値: inline, attachment。
content_id string Yes dispositionがinlineに設定され、ファイルタイプが画像の場合、この値を設定する必要があります。
settings object No 送信設定。
send_mode int No 送信モード。0は個別送信、1は全受信者が見えるブロードキャスト送信。デフォルトは0。
return_email_id boolean No メールIDを返すかどうか。デフォルトはtrue。
sandbox boolean No サンドボックスモードを使用するかどうか。デフォルトはfalse。trueの場合、メールは送信されず、リクエストパラメータが検証されます。
notification boolean No 受信通知を使用するかどうか。デフォルトはfalse。デフォルトの通知は送信者に送られ、受信ルートとの協力が必要です。
open_tracking boolean No 開封トラッキングを有効にするかどうか。デフォルトはシステム設定値。send_mode=0またはsend_mode=1の場合に有効です。
click_tracking boolean No クリックトラッキングを有効にするかどうか。デフォルトはシステム設定値。send_mode=0またはsend_mode=1の場合に有効です。
unsubscribe_tracking boolean No 退会トラッキングを有効にするかどうか。デフォルトはシステム設定値。send_mode=0またはsend_mode=1の場合に有効です。
unsubscribe_page_id array[int] No カスタム退会ページ。デフォルトはシステム設定値。send_mode=0またはsend_mode=1の場合に有効です。
calendar object Yes カレンダー設定。
time_zone_id string Yes カレンダータイムゾーン辞書を参照してください。
start_time string Yes イベント開始時間（形式: yyyy-MM-dd HH:mm:ss）。
end_time string Yes イベント終了時間（形式: yyyy-MM-dd HH:mm:ss）。
title string Yes 会議タイトル。最大256文字。
organizer object Yes 主催者。
name string No 名前。最大64文字。
email string Yes メールアドレス。
location string Yes 会議場所。最大128文字。
description string No 会議説明。最大1024文字。
participators array[object] No 参加者。
name string No 名前。最大64文字。
email string Yes メールアドレス。
alarm_min_before integer No 会議前にリマインダーを送る分数。範囲: 1 ~ 60。
action object No カレンダーアクション。
name string No アクション名。許可される値: create, update, cancel。デフォルトはcreate。
uid string No updateおよびcancelアクションに必要です。カレンダーのメールを作成する際にインターフェースから返されるuid値。

注意事項:

  1. htmlとplainの両方を空にすることはできません。

  2. preview_textはhtmlと一緒にのみ使用できます。htmlが提供されていない場合、preview_textは効果を発揮しません。

  3. varsはメール内容内の変数置換に使用され、JSONオブジェクトとしてフォーマットされます: {"varname":["value1","value2"]}。変数が空またはスペースのみの場合、メール内の対応するテキストも空になります。

    メール内容: 親愛なる%name%様、%sp%のメールサービスへようこそ。

    対応するvars: {"name":["mike"], "sp":["engagelab"]} 置換後のメール内容: 親愛なるmike様、engagelabのメールサービスへようこそ。
                  
              対応するvars: {"name":["mike"], "sp":["engagelab"]}

置換後のメール内容: 親愛なるmike様、engagelabのメールサービスへようこそ。
    このコードブロックはフローティングウィンドウ内に表示されます

  4. dynamic_varsは動的テンプレート変数置換に使用され、JSONオブジェクトとしてフォーマットされます: [{"varname1":"value1","varname2":"value2"}]。

メール内容: 親愛なる{{name}}様、{{sp}}のメールサービスへようこそ。 dynamic_vars: [{"name":"jim","sp":"engagelab"}] 置換後のメール内容: 親愛なるjim様、engagelabのメールサービスへようこそ。
              
              メール内容: 親愛なる{{name}}様、{{sp}}のメールサービスへようこそ。
     
dynamic_vars: [{"name":"jim","sp":"engagelab"}]
     
 置換後のメール内容: 親愛なるjim様、engagelabのメールサービスへようこそ。
このコードブロックはフローティングウィンドウ内に表示されます

  1. ユーザーがlabel_idとlabel_nameの両方を提供し、label_nameが存在しない場合、システムは自動的に作成します。label_idとlabel_nameの両方が提供されている場合、label_nameは無視されます。

  2. headersはメールヘッダーフィールドをカスタマイズするために使用され、JSONオブジェクトとしてフォーマットされます: {"User-Define":"123", "User-Custom":"abc"}。ただし、キー文字列には以下の値を含めることはできません（大文字小文字を区別しません）:

    DKIM-Signature, Received, Sender, Date, From, To, Reply-To, Cc, Bcc, Subject, Content-Type, Content-Transfer-Encoding, X-SENDCLOUD-UUID, X-SENDCLOUD-LOG, X-Remote-Web-IP, X-SMTPAPI, Return-Path, X-SENDCLOUD-LOG-NEW.

  3. dispositionがinlineに設定され、添付ファイルの内容が画像の場合、添付ファイルはメール本文内で直接インライン画像としてレンダリングされます。content_idを設定する必要があり、ユニークな文字列である必要があります。これはメール本文内で表示される画像のsrcとして機能します。

Email content： <html> <img src="cid:image_1000"></img> <img src="cid:image_1001"></img> </html> attachments parameter: [ {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"}, {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"}, ]
              
                  Email content：
    <html>
        <img src="cid:image_1000"></img>
        <img src="cid:image_1001"></img>
    </html>
    
    attachments parameter:
    [
      {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"},
      {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"},
    ]
このコードブロックはフローティングウィンドウ内に表示されます

  1. custom_argsはクライアントが定義したカスタムコンテンツとして使用され、メールヘッダーに埋め込まれます。その後のWebHookデータはクライアントに返されます。custom_argsの値には"."記号を含めることはできません。

  2. request_idは重複送信を防ぐために使用され、1時間有効です。1時間以内に重複送信が行われた場合、前回のリクエスト結果が返されます。

  3. メールの総サイズは70MBを超えてはなりません。

リクエスト例

curl -X POST 'https://email.api.engagelab.cc/v1/mail/sendcalendar' \ --header 'Authorization: Basic MTIyNF94am06MTJkOGIwODVlNjZhZGUyMmNlNGIwOWI5NjQ2YWQ1ODE=' \ --header 'Content-Type: application/json' \ --data '{ "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", "to": ["111@qq.com", "222<222@qq.com>"], "body": { "cc": ["noreply@mail.engagelab.com"], "bcc": ["intern<intern@mail.engagelab.com>"], "reply_to": ["reply@mail.engagelab.com"], "subject": "%date% Newsletter ", "content": { "html": "<a href=\"https://www.engagelabe.com\">Newsletter %kkk%</a>", "text": "Newsletter %ttt%", "preview_text": "preview_text is ..." }, "label_id": "1233", "label_name": "", "headers": { "userdefine-tag-location": "us", "userdefine-tag-user": "fashion" }, "settings": { "send_mode": 0, "return_email_id": true, "sandbox": true, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1,2] }, "calendar": { "time_zone_id":"America/New_York", "start_time": "2020-12-10 10:00:00", "end_time": "2020-12-10 12:00:00", "title": "meeting titel", "organizer": { "name": "David", "email": "david@mail.engagelab.com" }, "location": "room208", "description": "hello", "alarm_min_before": 5, "participators": [ { "name": "p1", "email": "p1@engagelab.org" }, { "email": "p2@engagelab.org", "name": "p2"}, { "email": "p3@engagelab.org"} ], "action": { "name": "create", "uid": "329r239h239888" } } }, "custom_args": {}, "request_id": "" }'
              
              curl -X POST 'https://email.api.engagelab.cc/v1/mail/sendcalendar' \
--header 'Authorization: Basic MTIyNF94am06MTJkOGIwODVlNjZhZGUyMmNlNGIwOWI5NjQ2YWQ1ODE=' \
--header 'Content-Type: application/json' \
--data '{
  "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>",       
  "to": ["111@qq.com", "222<222@qq.com>"],    
  "body": {
      "cc": ["noreply@mail.engagelab.com"],       
      "bcc": ["intern<intern@mail.engagelab.com>"],         
      "reply_to": ["reply@mail.engagelab.com"], 
      "subject": "%date% Newsletter ", 
      "content": { 
        "html": "<a href=\"https://www.engagelabe.com\">Newsletter %kkk%</a>", 
        "text": "Newsletter %ttt%",   
        "preview_text": "preview_text is ..." 
      },
      "label_id": "1233",  
      "label_name": "",
      "headers": {                   
        "userdefine-tag-location": "us",  
        "userdefine-tag-user": "fashion"
      },
     
      "settings": {                                                    
        "send_mode": 0,        
        "return_email_id": true,     
        "sandbox": true,        
        "notification": false, 
        "open_tracking": true,                          
        "click_tracking": false,                       
        "unsubscribe_tracking": true,  
        "unsubscribe_page_id": [1,2]
      },
      "calendar": {
        "time_zone_id":"America/New_York",
        "start_time": "2020-12-10 10:00:00",  
        "end_time": "2020-12-10 12:00:00",  
        "title": "meeting titel",                                              
        "organizer": {      
          "name": "David",        
          "email": "david@mail.engagelab.com"                    
        },
        "location": "room208",                                         
        "description": "hello",                                        
        "alarm_min_before": 5,                                         
        "participators": [  
          { 
            "name": "p1",                                                
            "email": "p1@engagelab.org"
          },                      
          { "email": "p2@engagelab.org", "name": "p2"},
          { "email": "p3@engagelab.org"}
        ],
        "action": {                                                      
          "name": "create",   
          "uid": "329r239h239888"                                    
        }
      }
  },
  "custom_args": {},           
  "request_id": "" 
}'
このコードブロックはフローティングウィンドウ内に表示されます

Response-success

HTTP Status: 200

{ "uid": "20230103T065922Z-uidGen@PC201503200437", "email_ids": [ "1672729159224_15_2942_8497.sc-10_2_226_96-test0$111@qq.com", "1672729159224_15_2942_8497.sc-10_2_226_96-test1$222@qq.com" ], "request_id": "" }
              
              {
    "uid": "20230103T065922Z-uidGen@PC201503200437",
    "email_ids": [
        "1672729159224_15_2942_8497.sc-10_2_226_96-test0$111@qq.com",
        "1672729159224_15_2942_8497.sc-10_2_226_96-test1$222@qq.com"
    ],
    "request_id": ""
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :400

{ "code": 30801, "message": "From can not be empty" }
              
              {
    "code": 30801,
    "message": "From can not be empty"
}
このコードブロックはフローティングウィンドウ内に表示されます

MIME送信

URL

https://email.api.engagelab.cc/v1/mail/send_mime
              
              https://email.api.engagelab.cc/v1/mail/send_mime
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(api_user:api_key)

リクエストパラメータ

パラメータ タイプ 必須かどうか 説明
from string いいえ 送信者。例：support@mail.engagelab.com，EngageLab Team<support@mail.engagelab.com>。製品または会社のブランド名を表示する必要がある場合は、EngageLab Team< support@mail.engagelab.com >を使用してください。EngageLab Teamは送信者名であり、製品または会社のブランド名を渡すことができます。< support@mail.engagelab.com >は送信者アドレスです。
to array[string] はい 受信者。最大100個のアドレスをサポートします。例：["xjm@hotmail.com","xjm2@gmail.com"]
body object はい メール設定
custom_args object いいえ ユーザー定義のオプションフィールド。最大サイズは1KBです。custom_argsの値には「.」記号を含めることはできません。
request_id string いいえ この送信リクエストのID。最大128文字。

本文

パラメータ タイプ 必須かどうか 説明
cc array[string] いいえ CCアドレス。最大100個のアドレスをサポートします。send_mode=1の場合にのみ、このパラメータが有効です。
bcc array[string] いいえ BCCアドレス。最大100個のアドレスをサポートします。send_mode=1の場合にのみ、このパラメータが有効です。
reply_to array[string] いいえ 返信アドレス。最大3個のアドレスをサポートします。値が渡されない場合、返信アドレスは送信者アドレスになります。
subject string いいえ メールの件名。最大256文字。変数と絵文字をサポートします。
content object はい メール本文。
raw_message string はい メール内容。形式はMIMEである必要があります。
vars object いいえ 変数。最大1MB。send_mode=0またはsend_mode=1の場合に、このパラメータが有効です。
label_id string いいえ この送信で使用されるラベルID
label_name string いいえ この送信で使用されるラベル名
headers object いいえ メールヘッダー情報。最大1KB。
settings object いいえ 送信設定。
send_mode int いいえ 送信方法。0は個別送信を意味します。1はブロードキャスト送信を意味し、すべての受信者が同時に表示されます。2はアドレスリスト送信を意味します。toの値はアドレスリストのアドレスです。デフォルト値は0です。
return_email_id boolean いいえ メールIDを返すかどうか。デフォルトはtrueです。
sandbox boolean いいえ サンドボックスモードを使用するかどうか。デフォルトはfalseです。trueの場合、メールは配信されず、リクエストパラメータの有効性のみが検証されます。
notification boolean いいえ 既読通知を使用するかどうか。デフォルトはfalseです。デフォルトの通知先は送信者アドレスであり、受信ルーティングと組み合わせて使用する必要があります。
open_tracking boolean いいえ 開封トラッキングを有効にするかどうか。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に、このパラメータが有効です。
click_tracking boolean いいえ クリックトラッキングを有効にするかどうか。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に、このパラメータが有効です。
unsubscribe_tracking boolean いいえ 退会機能を有効にするかどうか。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に、このパラメータが有効です。
unsubscribe_page_id array[int] いいえ カスタム退会ページ。デフォルトはシステム設定値です。send_mode=0またはsend_mode=1の場合に、このパラメータが有効です。

注意:

  1. varsはメール内容の変数置換に使用され、JSONオブジェクトとしてフォーマットされます: {"varname":["value1,"value2"]}。ここで、varnameはメール内容内の変数です。

  2. label_idまたはlabel_nameのいずれか一方のみが有効です。両方が指定された場合、label_idがlabel_nameを上書きします。label_nameが存在しない場合、システムが自動的に作成します。

    メール内容: 親愛なる%name%様、%sp%メールサービスへようこそ。 対応するvars値: {"name":["mike"], "sp":["engagelab"]} メール内容の置換結果: 親愛なるmike様、engagelabメールサービスへようこそ。
                  
              メール内容: 親愛なる%name%様、%sp%メールサービスへようこそ。

対応するvars値: {"name":["mike"], "sp":["engagelab"]}

メール内容の置換結果: 親愛なるmike様、engagelabメールサービスへようこそ。
    このコードブロックはフローティングウィンドウ内に表示されます

  3. headersはメールヘッダーフィールドをカスタマイズするために使用され、JSONオブジェクトとしてフォーマットされます: {"User-Define":"123", "User-Custom":"abc"}。ただし、キー文字列には以下の値を含めることはできません（大文字小文字を区別しない）:

    DKIM-Signature ,Received ,Sender ,Date ,From ,To ,Reply-To ,Cc ,Bcc ,Subject ,Content-Type , Content-Transfer-Encoding ,X-SENDCLOUD-UUID ,X-SENDCLOUD-LOG ,X-Remote-Web-IP ,X-SMTPAPI, Return-Path,X-SENDCLOUD-LOG-NEW

  4. customer_argsは顧客が定義したカスタムコンテンツで、メールヘッダーに埋め込まれます。その後のWebHookデータで顧客に返されます。

  5. request_idは重複送信を防ぐために使用され、1時間有効です。1時間以内に再送信された場合、前回のリクエスト結果が返されます。

  6. メールの合計サイズは70MBを超えることはできません。

リクエスト例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' --data '{ "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", "to": ["111@qq.com", "222<222@qq.com>"], "body": { "reply_to": ["reply@mail.engagelab.com"], "subject": "%date% Newsletter ", "content": { "raw_message": "Date: Fri, 8 Aug 2025 18:33:00 +0800 (CST)\r\nFrom: TEST <test@trip.com>\r\nReply-To: test_reply@trip.com\r\nTo: fan_tang@trip.com\r\nMessage-ID:....... ", }, "vars": { }, "label_id": 100233, //or label_name="test" "headers": {}, "settings": { "send_mode": 0, "return_email_id": true, "sandbox": false, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1,2] } }, "custom_args": {}, "request_id": "" }' 'https://email.api.engagelab.cc/v1/mail/send_mime' 
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{
  "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", 
  "to": ["111@qq.com", "222<222@qq.com>"],
  "body": {          
      "reply_to": ["reply@mail.engagelab.com"],                         
      "subject": "%date% Newsletter ",                                       
      "content": {                                                     
        "raw_message": "Date: Fri, 8 Aug 2025 18:33:00 +0800 (CST)\r\nFrom: TEST <test@trip.com>\r\nReply-To: test_reply@trip.com\r\nTo: fan_tang@trip.com\r\nMessage-ID:....... ",         
         },
      "vars": { },
      "label_id": 100233, //or label_name="test"
      "headers": {},
      "settings": {                 
        "send_mode": 0, 
        "return_email_id": true,  
        "sandbox": false,
        "notification": false,
        "open_tracking": true,                                           
        "click_tracking": false,                                         
        "unsubscribe_tracking": true,                              
        "unsubscribe_page_id": [1,2]
      }
  },
  "custom_args": {},           
  "request_id": "" 
}'  'https://email.api.engagelab.cc/v1/mail/send_mime'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス例

Response-success

HTTP Status: 200

{ "email_ids":[ "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$111@qq.com", "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$222@qq.com"], "request_id":null }
              
              {
"email_ids":[
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$111@qq.com",
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$222@qq.com"],
"request_id":null
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :400

{ "code": 30893, "message": "The custom_args must be json format" }
              
              {
    "code": 30893,
    "message": "The custom_args must be json format"
}
このコードブロックはフローティングウィンドウ内に表示されます
icon
お問い合わせ