配信予約

配信予約

必要項目を設定し、配信の予約および即時配信指示をおこないます。

メソッドとURL

メソッド URL
POST https://{HOST名}/send

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
delivery Object Array ◯ 配信オブジェクトのリスト。配列で複数の配信を同時にリクエストが可能
詳細説明は以下をご参照ください。
関連記事delivery（配信予約）
mailing-list Object Array ◯ 配信先のリストを登録。配列で複数のアドレスを指定可能
詳細説明は以下をご参照ください。
関連記事mailing-list（配信予約）
to Object ◯ 宛先情報
address String ◯ 宛先メールアドレス
device Number デバイス指定
substitutions Object 差込項目
差込キーワード String 差込キーワードと置換される文字列を指定
unsubscribe_url String ワンクリック登録解除機能で宛先ごとに設定するURL
contents Object ◯ メール内容を記述
詳細説明は以下をご参照ください。
関連記事contents（配信予約）
subject String ◯ メールの件名
設定可能なサイズは500Byte以下です。
body Object ◯ メール本文を設定
text String テキストパートのメール本文
html String HTMLパートのメール本文。htmlタグが利用可能
encode Number 配信時の文字エンコード指定
attachments-list Object 添付ファイルオブジェクトのリスト
filename String 添付ファイル名(拡張子含む)
mimetype String 添付ファイルのMIMEタイプ
data String 添付ファイルをbase64エンコードしたデータ
cc String ccヘッダーに設定する文字列
記載された宛先へccとして配信される
bcc String 記載された宛先へ、bccとして配信される
settings Object ◯ 配信時刻などの配信設定を登録
詳細説明は以下をご参照ください。
関連記事settings（配信予約）
send_time String ◯ 配信時刻指定
request_id String 顧客が任意に設定可能なIDを設定
from Object ◯ Header Fromに設定する内容
name String Header Fromに表示される名称を設定
address String Header Fromに表示するメールアドレス
reply_to Object 返信先メールアドレスを利用する際に設定する
address String 返信先メールアドレス
tc_option Object 配信処理のオプション指定
詳細説明は以下をご参照ください。
関連記事tc_option（配信予約）
stop_send Object 配信禁止時間帯
timemin String timemin～timemaxまで配信を停止する
timemax String timemin～timemaxまで配信を停止する
lifetime String 配信データ生存時間設定
retry_interval Number 配信処理の再送間隔指定
throttle Number 分間あたりのメール送信速度指定
error_count Number エラースコアにて配信対象を絞る指定
ignore_attachments_size Boolean 添付ファイルの総ファイルサイズチェックを制御するフラグ

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
500 Internal Server Error しばらく経ってから再実施いただき、状況が改善しなければ弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。 その場合、RFC2626にて規定されるHTTPレスポンスステータスコード一覧をご確認ください。

関連記事HTTPレスポンスステータスコード一覧

ボティパラメーター

項目 型 説明
items Object Array レスポンスのリスト。配列で結果が格納される
result Object Array 一つの配信の処理結果
code String 配信毎の処理結果のコード
message String 処理結果に対する補足メッセージ
delivery_id String 採番された配信ID
request_id String リクエスト時に指定したrequest_id
count Number itemsに設定されたデータの件数
message String 全体的な失敗時に設定される補足メッセージ

リザルトコード

各配信予約処理で返却されるリザルトコードは、以下の通りです。

コード 説明
201 配信予約受付完了
400 構文不正。フォーマットやパラメーターの不正
409 同一リクエストIDが登録済み
500 しばらく経ってから再実施いただき、状況が改善しなければ弊社までお問い合わせください。

DKIM署名

DKIMドメイン登録APIで配信時に付与するDKIMを登録できます。配信時にHeader Fromドメインと一致する有効な署名ドメインがない場合、ユーザー指定の有効なデフォルトドメインが第三者署名として付与されます。指定がない場合は弊社提供の第三者署名が付与されます。
登録については、DKIMドメイン登録をご確認ください。

レスポンスの契機

配信リクエスト受付後、パラメーターのチェックとリクエスト情報を格納すると、レスポンスが返却されます。 配信データの生成は、リクエスト情報の格納を契機に非同期で実施します。

配信IDの採番

配信IDは、各配信ごとに一意となるIDが発行されます。

注意
配信IDは、配信結果の取得に利用するため必ず保存してください。

サンプル

リクエスト

JSON形式で設定する。

{
  "delivery":[
    {
      "mailing-list":[
        {
          "to":{"address":"xxx@example.com","device":0},
          "substitutions":{
            "sashikomi1":"差込データ",
            "sashikomi2":"差込データ",
            "sashikomi3":"差込データ"
          }
        },
        {
          "to":{"address":"xxx@example.com"}
        },
        {...}
      ],
      "contents":{
        "subject":"##sample_1##xxxxxxxxxxxxxxxxxxxxxxxx",
        "body":{
          "text":"xxxxxxxxxxx##sample_2##xxxxxxxxxxxxxxxx",
          "html":"xxxxxxxxxxx##sample_3##xxxxxxxxxxxxxxxx"
        },
        "encode":0,
        "attachments-list":[
          {
            "filename": "sample_1.txt",
            "mimetype": "text/plain",
            "data": "c2FtcGxlXzHjga7jg4fjg7zjgr/jgafjgZnjgIIK"
          },
          {
            "filename": "sample_2.txt",
            "mimetype": "text/plain",
            "data": "c2FtcGxlXzLjga7jg4fjg7zjgr/jgafjgZnjgIIK"
          }
        ]
      },
      "settings":{
        "send_time":"yyyy-mm-ddThh:mm+09:00",
        "request_id":"xxxxxxxxxxxxxxxxxxxxxxxxx",
        "from":{
          "name":"from表示名",
          "address":"xxx@example.com"
        },
        "reply_to":{
          "address":"xxx@example.com"
        },
        "tc_option":{
          "stop_send":{"timemin":"hh:mm+09:00","timemax":"hh:mm+09:00"},
          "lifetime":3600,
          "retry_interval":60,
        },
        "throttle":300,
        "error_count":0,
        "ignore_attachments_size":false
      },
    },
    {....},
    {....}
  ]
}

cc/bcc利用時は、mailing-list要素は１件のみ設定可能です。

{
  "delivery":[
    {
      "mailing-list":[
        {
          "to":{"address":"xxx@example.com","device":0},
          "substitutions":{
            "sashikomi1":"差込データ",
            "sashikomi2":"差込データ",
            "sashikomi3":"差込データ"
          }
        }
      ],
      "contents":{
        "subject":"##sample_1##xxxxxxxxxxxxxxxxxxxxxxxx",
        "body":{
          "text":"xxxxxxxxxxx##sample_2##xxxxxxxxxxxxxxxx",
          "html":"xxxxxxxxxxx##sample_3##xxxxxxxxxxxxxxxx"
        },
        "encode":0,
        "attachments-list":[
          {
            "filename": "sample_1.txt",
            "mimetype": "text/plain",
            "data": "c2FtcGxlXzHjga7jg4fjg7zjgr/jgafjgZnjgIIK"
          },
          {
            "filename": "sample_2.txt",
            "mimetype": "text/plain",
            "data": "c2FtcGxlXzLjga7jg4fjg7zjgr/jgafjgZnjgIIK"
          }
        ],
        "cc":"cc1@example.com,cc2@example.com",
        "bcc":"bcc1@example.com,bcc2@example.com"
      },
      "settings":{
        "send_time":"yyyy-mm-ddThh:mm+09:00",
        "request_id":"xxxxxxxxxxxxxxxxxxxxxxxxx",
        "from":{
          "name":"from表示名",
          "address":"xxx@example.com"
        },
        "reply_to":{
          "address":"xxx@example.com"
        },
        "tc_option":{
          "stop_send":{"timemin":"hh:mm+09:00","timemax":"hh:mm+09:00"},
          "lifetime":3600,
          "retry_interval":60,
        },
        "throttle":300,
        "error_count":0,
        "ignore_attachments_size":false
      },
    },
    {....},
    {....}
  ]
}

レスポンス

正常

{
  "items": [
    {
      "result": {
        "code": "201",
         "message": "success"
       },
       "delivery_id": "000000",
       "request_id": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
     },
     {...}
  ],
  "count": 2
}

指定した配信それぞれの処理結果に成功を意味するcodeが返却されます。

一部エラー

{
  "items": [
    {
      "result": {
        "code": "201",
        "message": "success"
      },
      "delivery_id": "000000",
      "request_id": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
    },
    {
      "result": {
        "code": "409",
        "message": "This RequestID is already exists."
      },
      "delivery_id": "000000",
      "request_id": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  ],
  "count": 2
}

失敗と判定されたタイミングにより、delivery_idは付与されません。

エラー

{
 "message": "Too Many Requests"
}

各配信の処理に入る前に失敗した場合は、補足情報が返却されます。