メール一覧取得API(個別メール配信)

概要

メールの一覧を取得するAPIです。※個別メール配信のAPIで配信したメールを取得します。

接続先URL

https://●●●●●/■■■■■/api/index.php?ac=GetMailListLite
●●●●●/■■■■■ は、弊社からお知らせしたログイン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形式。
from_date 期間指定(FROM) 日付 指定された日付より大きい開始日を対象。
(形式:YYYY/MM/DD)
※入力例:2012/01/05
to_date 期間指定(TO) 日付 指定された日付より小さい開始日を対象。
(形式:YYYY/MM/DD)
※入力例:2012/01/05
mail_group_code グループコード 文字列 メール識別用文字列
※20文字以内の半角英数を指定可能。
delivery_results 配信結果 整数 配信先アドレスの配信結果を指定。
0 : 指定なし
1 : 配信成功のみ
2 : 配信エラーのみ
※省略すると、0 : 指定なし。
open_html_mail HTML開封 整数 開封状況を指定。
0 : 指定なし
1 : 開封されたメールのみ
2 : 未開封のメールのみ
※省略すると、0 : 指定なし。

取得内容

CSV項目名 xmlタグ名 表示例
メールID lite_mail_id 1
状態 mail_status 配信完了
送信日時 send_date 2012/2/28 12:59
件名 subject ○×メルマガNo.1
メール形式 mail_type テキスト
Toアドレス to_address user01@example.com
配信状況 delivery_results 配信済み
エラー種別 error_type 一時的なエラー
エラー詳細 error_info 送信先メールボックスの容量不足
HTML開封 open_html_mail 開封済
※テキストメールの場合は、値なし
クリックカウント click_count 2/3
※クリックされたURL数/クリックカウントとして設定されたURL数
グループコード mail_group_code GR

※並び順:配信日時の降順

エラーコード

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

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 の整数を指定してください。
81464 bad date from_dateもしくはto_dateが正しく指定されていません。
81472 bad delivery_results delivery_results には、0~2 の整数を指定してください。
81473 bad open_html_mail open_html_mailには、0~2 の整数を指定してください。
82486 bad mail_group_code mail_group_codeには、20字以内 の半角英数が指定可能です。
99500 internal error 処理に失敗しました。

クルメル関連サイト情報

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