セットアップ

API v2基本仕様

アララメッセージAPI v2を理解していただくための基本的な仕様を記載しています。

アララ メッセージV2の認証方法

アララ メッセージ v2では、認証用アクセストークンを発行し、各リクエストでヘッダ情報にアクセストークンを設定しリクエストをおこないます。
発行されたトークンの有効期間は1時間となり、有効期限が切れるまで複数回利用できます。

〔配信予約〕配信予約API
概要 メールの配信指示をするAPI。
リクエストファイルに定義する項目
配信設定
  • 差出人情報（Header Fromアドレスと差出人名称)
  • 返信先情報
  • 送信時間（即時もしくは日時を指定）
  • 配信速度
  • 配信禁止時時間
  • バウンス回数
メールコンテンツ
  • 件名
  • 本文
  • 添付ファイル情報(base64エンコードしたデータ)
  • CC、BCCメールアドレス
送信メールアドレス
  • 送信対象のメールアドレスリスト
  • メールアドレスごとの差し込み文字列
レスポンスで返却される情報
  • 処理結果
  • 割り当てられた配信ID
  • メール処理数
〔配信予約〕配信予約キャンセルAPI
概要 配信予約中の配信データを削除するAPI
URLパラメータ 配信予約を削除したい配信IDをURLに指定
レスポンスで返却される情報 成功時：キャンセルした配信ID
（エラー時はエラーメッセージを表示）
〔配信状況確認〕配信結果取得API
概要 配信処理をしたメールアドレスごとの配信結果を取得するAPI
URLパラメータ 配信結果を取得したい配信IDもしくは、情報を取得したい期間をURLに指定
レスポンスで返却される情報
  • 宛先アドレスのタイプ（To,CC,BCC）
  • 配信処理を行ったメールアドレス一覧
  • Header Fromアドレス
  • メールアドレスごとの送信成否
  • 配信結果情報
  • ステータスが更新された日時
〔配信状況確認〕配信ステータス取得API
概要 配信予約や配信予約削除処理の、処理結果を取得するAPI
URLパラメータ
  • 配信ID
  • リクエストID
  • 配信予約を指定した期間を指定
レスポンスで返却される情報
  • 配信成功数
  • 配信失敗数（エラー数）
  • 現在の配信ステータス(配信完了、配信処理中、等)
  • 検索結果数
〔エラーフィルター〕エラーフィルター登録情報取得API
概要 指定されたメールアドレスのエラーフィルター登録情報を取得するAPI
リクエストファイルに定義する項目
  • 設定するメールアドレス
レスポンスで返却される情報
  • メールアドレス
  • エラーカウント
  • エラーフィルタの初回登録日時
  • エラーフィルタの最終更新日時
〔エラーフィルター〕エラーフィルター登録情報更新API
概要 エラーフィルタに登録されたメールアドレスのエラーカウントを更新するAPI
指定されたメールアドレスがない場合は、新規で登録します。
リクエストファイルに定義する項目
  • 設定するメールアドレス
  • 設定する値
レスポンスで返却される情報
  • メールアドレス
  • エラーカウント
  • エラーフィルタの初回登録日時
  • エラーフィルタの最終更新日時
〔ドメイン管理〕DKIMドメイン登録API
概要 DKIMを利用するドメインを登録するAPI
リクエストファイルに定義する項目 認証の対象となる署名ドメイン
レスポンスで返却される情報
  • 処理結果
  • 認証の対象となるドメイン情報
  • DKIM情報を識別するためのセレクタ
  • 鍵生成時のキー長
  • 対象セレクタの利用開始日時
  • 第三者署名として利用可能とする指定
  • DNSにDKIM情報を設定する際に利用する情報
    • FQDN
    • type
    • value
  • 登録日時
〔ドメイン管理〕ドメイン一覧取得API
概要 登録済みのドメインの一覧を取得するAPI
URLパラメータ 取得したいドメイン名。未指定の場合は全件取得。
レスポンスで返却される情報
  • 対象のドメイン
  • DNSに関する情報
  • SPFに関する情報
  • DKIMに関する情報
  • 処理件数
〔ドメイン管理〕DKIMドメイン更新API
概要 登録済みのDKIM情報を更新するAPI
URLパラメータ
  • 対象のドメイン
  • セレクタ
  • 署名ドメインの情報
レスポンスで返却される情報
  • 対象のドメイン
  • DKIM情報を識別するためのセレクタ
  • 鍵生成時のキー長
  • 対象セレクタの利用開始日時
  • 第三者署名として利用可能とする指定
  • 対象セレクタの利用有効フラグ
  • DNSにDKIM情報を設定する際に利用する情報
    • FQDN
    • type
    • value
  • 登録日時
〔ドメイン管理〕DKIMドメイン削除API
概要 登録済みのDKIM情報を削除するAPI
URLパラメータ
  • 削除したいドメイン名
  • セレクタ情報
レスポンスで返却される情報 処理結果
〔契約管理機能〕契約プラン取得API
概要 現在の契約プランを取得するAPI
URLパラメータ 契約プランを確認したい環境のURL
レスポンスで返却される情報
  • 契約プラン
  • 配信超過単価。配信予定数を超えた配信1通あたりの料金
〔契約管理機能〕配信実績取得API
概要 指定された年月の配信実績情報を取得するAPI
URLパラメータ 取得対象の過去年月
レスポンスで返却される情報
  • 全ユーザの配信合計数
  • ユーザ、日付ごとの配信数
〔ワンクリック登録解除〕登録解除設定API
概要 ワンクリック登録解除システムにワンクリック登録解除の対象Header Fromメールアドレスを登録するAPI。
URLパラメータ
  • ワンクリック登録解除機能を適用するHeader Fromメールアドレス
レスポンスで返却される情報
  • ワンクリック登録解除のURLのホスト名を含む一部分
〔ワンクリック登録解除〕登録解除者リスト取得API:自動付与
概要 ワンクリック登録解除システムが受理した、解除リクエスト情報を取得するAPI。
※本システムによって自動的に登録解除URLが付与されたメールに対する登録解除者リストの取得
URLパラメータ
  • 登録解除の対象となったHeader Fromメールアドレス
  • 登録解除リクエストを受理した日付
レスポンスで返却される情報
  • リクエストしたHeader Fromメールアドレス
  • 配信時にmessage-idヘッダに指定された文字列
  • 登録解除リクエストを受理した配信先メールアドレス
  • 登録解除リクエストを受理した日時
  • 該当の配信先メールアドレスが配信先から除外される対象かどうか（true / false）
〔ワンクリック登録解除〕登録解除者除外API
概要 ワンクリック登録解除システムの解除者リストから、指定したHeader Fromメールアドレスと配信先メールアドレスの組み合わせを処理対象外にするAPI。
URLパラメータ
  • 処理対象外にするHeader Fromメールアドレス
  • 処理対象外にする配信先メールアドレス
レスポンスで返却される情報 なし
補足説明
本APIによる設定の変更結果は ワンクリック登録解除者リスト取得API:自動付与 でご確認いただけます。
〔ワンクリック登録解除〕登録解除者リスト取得API:repica sender利用時
概要 ワンクリック登録解除システムが受理した、解除リクエスト情報を取得するAPI。
※配信先メールアドレス毎にお客様で任意の登録解除URLを指定したメールに対する登録解除者リストの取得
URLパラメータ
  • 登録解除の対象となったHeader Fromメールアドレス
  • 登録解除リクエストを受理した日付
レスポンスで返却される情報
  • リクエストしたHeader Fromメールアドレス
  • List-Unsubscribeヘッダ付与時に指定したURLのうち、お客様側によって連結された文字列（本システムで定義されているURL部分を除いた文字列）
  • 登録解除リクエストを受理した日時