アララメッセージAPI v2を理解していただくための基本的な仕様を記載しています。
アララ メッセージ v2では、認証用アクセストークンを発行し、各リクエストでヘッダ情報にアクセストークンを設定しリクエストをおこないます。
発行されたトークンの有効期間は1時間となり、有効期限が切れるまで複数回利用できます。
| 概要 |
メールの配信指示をするAPI。 |
| リクエストファイルに定義する項目 |
|
| レスポンスで返却される情報 |
|
| 概要 |
配信予約中の配信データを削除するAPI |
| URLパラメータ |
配信予約を削除したい配信IDをURLに指定 |
| レスポンスで返却される情報 |
成功時：キャンセルした配信ID
（エラー時はエラーメッセージを表示） |
| 概要 |
配信処理をしたメールアドレスごとの配信結果を取得するAPI |
| URLパラメータ |
配信結果を取得したい配信IDもしくは、情報を取得したい期間をURLに指定 |
| レスポンスで返却される情報 |
- 宛先アドレスのタイプ（To,CC,BCC）
- 配信処理を行ったメールアドレス一覧
- Fromアドレス
- メールアドレスごとの送信成否
- 配信結果情報
- ステータスが更新された日時
|
| 概要 |
配信予約や配信予約削除処理の、処理結果を取得するAPI |
| URLパラメータ |
- 配信ID
- リクエストID
- 配信予約を指定した期間を指定
|
| レスポンスで返却される情報 |
- 配信成功数
- 配信失敗数（エラー数）
- 現在の配信ステータス(配信完了、配信処理中、等)
- 検索結果数
|
| 概要 |
指定されたメールアドレスのエラーフィルター登録情報を取得するAPI |
| リクエストファイルに定義する項目 |
|
| レスポンスで返却される情報 |
- メールアドレス
- エラーカウント
- エラーフィルタの初回登録日時
- エラーフィルタの最終更新日時
|
| 概要 |
エラーフィルタに登録されたメールアドレスのエラーカウントを更新するAPI
指定されたメールアドレスがない場合は、新規で登録します。 |
| リクエストファイルに定義する項目 |
|
| レスポンスで返却される情報 |
- メールアドレス
- エラーカウント
- エラーフィルタの初回登録日時
- エラーフィルタの最終更新日時
|
| 概要 |
DKIMを利用するドメインを登録するAPI |
| リクエストファイルに定義する項目 |
認証の対象となる署名ドメイン |
| レスポンスで返却される情報 |
- 処理結果
- 認証の対象となるドメイン情報
- DKIM情報を識別するためのセレクタ
- 鍵生成時のキー長
- 対象セレクタの利用開始日時
- 第三者署名として利用可能とする指定
- DNSにDKIM情報を設定する際に利用する情報
- 登録日時
|
| 概要 |
登録済みのドメインの一覧を取得するAPI |
| URLパラメータ |
取得したいドメイン名。未指定の場合は全件取得。 |
| レスポンスで返却される情報 |
- 対象のドメイン
- DNSに関する情報
- SPFに関する情報
- DKIMに関する情報
- 処理件数
|
| 概要 |
登録済みのDKIM情報を更新するAPI |
| URLパラメータ |
|
| レスポンスで返却される情報 |
- 対象のドメイン
- DKIM情報を識別するためのセレクタ
- 鍵生成時のキー長
- 対象セレクタの利用開始日時
- 第三者署名として利用可能とする指定
- 対象セレクタの利用有効フラグ
- DNSにDKIM情報を設定する際に利用する情報
- 登録日時
|
| 概要 |
登録済みのDKIM情報を削除するAPI |
| URLパラメータ |
|
| レスポンスで返却される情報 |
処理結果 |
| 概要 |
現在の契約プランを取得するAPI |
| URLパラメータ |
契約プランを確認したい環境のURL |
| レスポンスで返却される情報 |
- 契約プラン
- 配信超過単価。配信予定数を超えた配信1通あたりの料金
|
| 概要 |
指定された年月の配信実績情報を取得するAPI |
| URLパラメータ |
取得対象の過去年月 |
| レスポンスで返却される情報 |
|
