配信エラー情報取得API

概要

メール配信で配信エラーとなったアドレス一覧を取得するAPIです。

接続先URL

https://●●●●●/■■■■■/api/index.php?ac=GetFailureAddressList
●●●●●/■■■■■ は、弊社からお知らせしたログインURLに置き換えてください。

例)お客様のログインURLが https://m.crmf.jp/api_sample/index.php の場合、
●●●●● は、m.crmf.jp
■■■■■ は、api_sample に置き換えてください。

パラメータ

パラメータ名 項目名 属性 必須 設定内容
transport_password 接続用パスワード 文字列 API連携接続用パスワード
charset 文字コード 整数 CSVファイルの文字コード・通信文字コード。
1 : UTF-8
2 : Shift-JIS
3 : EUC-JP
return_format 取得形式 文字列 取得する形式を指定。
"csv" :CSV形式
"xml" :XML形式
※省略すると、CSV形式。
mail_id メールID 整数 取得するメールIDを指定。
※取得できるメール状態
・配信完了
・一時停止
・キャンセル

取得内容

CSV項目名 xmlタグ名 表示例
メールアドレス mail_address tanto@example.com
エラー種別 error_type 一時的なエラー
エラー詳細 error_info 送信先メールボックスの容量不足

※並び順:メールアドレスの昇順

エラーコード

レスポンスのボディ部に書かれたエラーコードから、エラーの理由を判別することが可能です。

CODE STATUS メッセージ
81401 unauthorized 接続情報が正しくありません。
81402 access denied 許可されていないIPアドレスからのアクセスです。
81404 too many calls APIの実行回数が制限を超えました。
81423 no password transport_password が入力されていません。
81424 bad return_format return_formatには、「csv」もしくは「xml」を指定してください。
81461 bad charset charsetには、1~3 の整数を指定してください。
81465 denied to get mail 指定したmail_idのメールは、取得できません。
81466 no mail_id mail_idを指定してください。
81467 bad mail_id mail_idが整数ではない、または存在しないmail_idです。
99500 internal error 処理に失敗しました。

クルメル関連サイト情報

  • 配配メール
  • メルラボ
  • メールディーラー
  • 楽楽販売
  • Pマーク