セットアップ

API v1基本仕様

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

もくじ

〔配信管理〕配信予約API
〔配信管理〕配信予約削除API
〔配信管理〕配信結果リスト取得API
〔配信管理〕エラーリスト取得API
〔配信管理〕配信ステータス取得API
クリックカウントログ取得API
エラーフィルターリスト取得API
ワンクリック登録解除設定API
ワンクリック登録解除者リスト取得API
ワンクリック登録解除者除外API

〔配信管理〕配信予約API

概要	メールの配信指示をするAPI。
認証方法	HTTPヘッダに認証情報を記載
リクエストファイルに定義する項目	配信設定 Envelope-From 差出人情報（Header Fromアドレスと差出人名称) 返信先情報送信時間（即時もしくは日時を指定）配信速度配信禁止時時間開封確認メールコンテンツ件名本文テンプレートID 添付ファイルURL 送信先情報送信対象のメールアドレスリストメールアドレスごとの差し込み文字列
レスポンスで返却される情報	処理結果割り当てられた配信ID メール処理数

〔配信管理〕配信予約削除API

概要	配信予約中の配信データを削除するAPI。
認証方法	リクエストファイルに認証情報を記載
リクエストファイルに定義する項目	配信予約を削除したいリクエストIDもしくは、配信ID
レスポンスで返却される情報	処理結果

〔配信管理〕配信結果リスト取得API

概要	実際に配信処理を行ったメールアドレス毎の、配信結果を取得するAPI。
認証方法	リクエストファイルに認証情報を記載
リクエストファイルに定義する項目	配信結果を取得したい配信IDもしくは、情報を取得したい期間
レスポンスで返却される情報	送信日時配信処理を行ったメールアドレス一覧 Header Fromアドレスエラーの内容

〔配信管理〕エラーリスト取得API

概要	配信後、エラーとなったメールアドレスだけに絞って配信結果を取得するAPI。メールアドレスが存在しないなどの恒久的なエラーだけに絞るか、受信サーバの容量不足等の一時的なエラーを含む全エラーか、選んで取得することができます。
認証方法	リクエストファイルに認証情報を記載
リクエストファイルに定義する項目	配信結果を取得したい配信IDもしくは、情報を取得したい期間恒久的なエラーに絞るか、全てのエラーを含むかの指定
レスポンスで返却される情報	送信日時送信先メールアドレス Header Fromアドレスエラーの内容

〔配信管理〕配信ステータス取得API

概要	配信や削除処理などの、処理結果を取得するAPI。指定した配信が配信完了、送信中、配信待ち、などの配信ステータスを確認できます。
認証方法	リクエストファイルに認証情報を記載
リクエストファイルに定義する項目	配信ステータスを取得したいリクエストIDか配信ID、もしくは配信の期間
レスポンスで返却される情報	配信成功数配信失敗数（エラー数）現在の配信ステータス(配信完了、送信中、配信待ち、等)

クリックカウントログ取得API

概要	クリックカウントや開封数の詳細ログを取得するAPI。
認証方法	リクエストパラメータに認証情報を記載
リクエストで定義する項目	詳細ログを取得したい配信IDもしくは、配信期間取得モード（開封のみ、クリックのみ、両方、の選択）
レスポンスで返却される情報	クリックカウント・開封の日時遷移先ＵＲＬメールアドレスユーザエージェント配信ID 開封フラグ

エラーフィルターリスト取得API

概要	管理画面のエラーリスト管理、配信除外リスト管理に登録されているメールアドレスを取得する API。
認証方法	リクエストパラメータに認証情報を記載
リクエストで定義する項目	取得したいリストのサイトID
レスポンスで返却される情報	エラーリストに登録されているメールアドレスの数エラーリストや配信除外リストに登録されているメールアドレスエラーの回数もしくは、配信除外リストの登録有無登録された日時更新された日時

ワンクリック登録解除設定API

概要	ワンクリック登録解除システムにワンクリック登録解除の対象Header Fromアドレスを登録するAPI。
認証方法	リクエストパラメータに認証情報を記載
リクエストで定義する項目	ワンクリック登録解除機能を適用するHeader Fromアドレス
レスポンスで返却される情報	なし

ワンクリック登録解除者リスト取得API

概要	ワンクリック登録解除システムが受理した、解除リクエスト情報を取得するAPI。
認証方法	リクエストパラメータに認証情報を記載
リクエストで定義する項目	登録解除の対象となったHeader Fromアドレス登録解除リクエストを受理した年登録解除リクエストを受理した月登録解除リクエストを受理した日
レスポンスで返却される情報	リクエストしたHeader Fromアドレス配信時にmessage-idヘッダに指定された文字列登録解除リクエストを受理した配信先メールアドレス登録解除リクエストを受理した日時該当の配信先メールアドレスが配信先から除外される対象かどうか（除外の対象：1 / 除外の対象外：0）

ワンクリック登録解除者除外API

概要	ワンクリック登録解除システムの解除者リストから、指定したHeader Fromアドレスと配信先メールアドレスの組み合わせを処理対象外にするAPI。
認証方法	リクエストパラメータに認証情報を記載
リクエストで定義する項目	処理対象外にするHeader Fromアドレス処理対象外にする配信先メールアドレス
レスポンスで返却される情報	なし

補足説明
本APIによる設定の変更結果はワンクリック登録解除者リスト取得API でご確認いただけます。