アララメッセージAPI v1を理解していただくための基本的な仕様を記載しています。
もくじ
〔配信管理〕配信予約API
| 概要 | メールの配信指示をするAPI。 |
| 認証方法 | HTTPヘッダに認証情報を記載 |
| リクエストファイルに定義する項目 | 配信設定
メールコンテンツ
送信先情報
|
| レスポンスで返却される情報 |
|
〔配信管理〕配信予約削除API
| 概要 | 配信予約中の配信データを削除するAPI。 |
| 認証方法 | リクエストファイルに認証情報を記載 |
| リクエストファイルに定義する項目 | 配信予約を削除したいリクエストIDもしくは、配信ID |
| レスポンスで返却される情報 | 処理結果 |
〔配信管理〕配信結果リスト取得API
| 概要 | 実際に配信処理を行ったメールアドレス毎の、配信結果を取得するAPI。 |
| 認証方法 | リクエストファイルに認証情報を記載 |
| リクエストファイルに定義する項目 | 配信結果を取得したい配信IDもしくは、情報を取得したい期間 |
| レスポンスで返却される情報 |
|
〔配信管理〕エラーリスト取得API
| 概要 | 配信後、エラーとなったメールアドレスだけに絞って配信結果を取得するAPI。 メールアドレスが存在しないなどの恒久的なエラーだけに絞るか、受信サーバの容量不足等の一時的なエラーを含む全エラーか、選んで取得することができます。 |
| 認証方法 | リクエストファイルに認証情報を記載 |
| リクエストファイルに定義する項目 |
|
| レスポンスで返却される情報 |
|
〔配信管理〕配信ステータス取得API
| 概要 | 配信や削除処理などの、処理結果を取得するAPI。 指定した配信が配信完了、送信中、配信待ち、などの配信ステータスを確認できます。 |
| 認証方法 | リクエストファイルに認証情報を記載 |
| リクエストファイルに定義する項目 | 配信ステータスを取得したいリクエストIDか配信ID、もしくは配信の期間 |
| レスポンスで返却される情報 |
|
クリックカウントログ取得API
| 概要 | クリックカウントや開封数の詳細ログを取得するAPI。 |
| 認証方法 | リクエストパラメータに認証情報を記載 |
| リクエストで定義する項目 |
|
| レスポンスで返却される情報 |
|
エラーフィルターリスト取得API
| 概要 | 管理画面のエラーリスト管理、配信除外リスト管理に登録されているメールアドレスを取得する API。 |
| 認証方法 | リクエストパラメータに認証情報を記載 |
| リクエストで定義する項目 | 取得したいリストのサイトID |
| レスポンスで返却される情報 |
|
