メール配信API・メルマガ配信API「クルメル」

メールの一覧を取得するAPIです。

https://●●●●●/■■■■■/api/index.php?ac=GetMailList
●●●●●/■■■■■ は、弊社からお知らせしたログイン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_status	メール状態	整数		取得するメール状態を指定。 ※複数指定可能（カンマ区切りで指定） 1 : 配信待ち 2 : 配信中 3 : 配信完了 4 : 一時停止 5 : キャンセル 6 : 承認待ち 7 : 差し戻し ※省略すると、すべてを対象。
mail_type	メール形式	整数		取得するメール形式を指定。 ※複数指定可能（カンマ区切りで指定） 1 : テキスト 2 : HTML 3 : 絵文字 4 : デコメール ※省略すると、すべてを対象。
from_date	期間指定（FROM)	日付		指定された日付より大きい開始日を対象。（形式：YYYY/MM/DD） ※入力例：2012/01/05
to_date	期間指定（TO)	日付		指定された日付より小さい開始日を対象。（形式：YYYY/MM/DD） ※入力例：2012/01/05

CSV項目名	xmlタグ名	表示例
メールID	mail_id	1
状態	mail_status	配信完了
送信日時	send_date	2012/2/28 12:59
件名	subject	○×メルマガNo.1
配信数	number	1000
配信リスト	list_name	メルマガリスト(梅田店) ※店舗なしの場合、配信リスト名のみ
メール形式	mail_type	テキスト

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

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

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 の整数を指定してください。
81462	bad mail_type	mail_typeには、1～4 の整数を指定してください。
81463	bad mail_status	mail_statusには、1～7 の整数を指定してください。
81464	bad date	from_dateもしくはto_dateが正しく指定されていません。
99500	internal error	処理に失敗しました。

機能一覧