API v1基本仕様

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

API v1のAPIリクエスト一覧

  • 配信管理
    • 配信予約API
    • 配信予約削除API
    • 配信結果リスト取得API
    • エラーリスト取得API
    • 配信ステータス取得AIP
  • CSV自動インポート
    • CSV登録API
    • 登録状況確認API
  • クリックカウントログ取得API
  • エラーフィルターリスト取得API

 

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

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

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

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

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

    〔CSV自働インポート〕CSV登録API
    概要 管理画面のデータ入出力メニュー「エンドユーザリスト」の 登録・更新をするAPI。
    認証方法 リクエストパラメータに認証情報を記載
    リクエストで定義する項目
    • リクエストID
    • 登録モード
      • 新規登録
        • 既存データを削除して、上書き登録
      • 追加登録
        • 元データを残し、追加で登録。重複データは登録しない
      • レコード更新
        • キーが一致した行全体を更新。一致するキーがなければ追加で登録
      • 削除
        • キーが一致したデータを削除
    • ユニーク登録するキー(列番号)
    • アップロードするCSVファイル
    • CSVファイルをアップロードするリストの番号
      ※複数リストオプション利用時のみ必要
    レスポンスで返却される情報
    • 処理結果
    • ジョブID

    〔CSV自働インポート〕CSV登録状況確認API
    概要 CSV登録APIの登録状況が確認できるAPI。
    CSV登録APIでリクエストIDを指定した場合のみ利用できます。
    認証方法 リクエストパラメータに認証情報を記載
    リクエストで定義する項目 CSV登録APIで返却されたジョブID
    レスポンスで返却される情報
    • 処理結果
    • 登録成功数

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

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