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

メールの詳細情報を取得するAPIです。

https://●●●●●/■■■■■/api/index.php?ac=GetMailInfo
●●●●●/■■■■■ は、弊社からお知らせしたログイン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タグ名	表示例
メッセージID	mail_id	1
状態	mail_status	配信完了
配信開始日時	start_date	2012/02/28 12:59
配信終了日時	end_date	2012/02/28 13:05
配信リスト	list_name	1:メルマガリスト(梅田店) ※店舗なしの場合、配信リスト名のみ
配信数	number	1000
配信成功数	success	950
エラー数	error	50
メール形式	mail_type	テキスト
From	from	○×梅田店 <umeda@example.com>
件名	subject	○×メルマガNo.1
本文（テキスト）本文（絵文字）	text_part
本文（HTML）本文（デコメール）	html_part	※デコメールの場合、以下の文言を出力します。デコメールの本文は、取得できません。

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

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

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	処理に失敗しました。

機能一覧