- 東 京：03-6675-3612
- 名古屋：052-218-6937
- 大 阪：06-6376-5222
- 福 岡：092-739-8085
指定した１アドレスに対してメール配信予約を行うAPIです。
※TOアドレスに指定したメールアドレスにメールを送信します。
※HTMLメールを送信する場合はhtml_part、テキストメールを送信する場合はtext_partに本文を入力してください。
※配信日時に指定できる範囲は現在から翌年末までです。
※添付ファイルを指定する場合は、添付ファイル送信オプションの契約が必要です。
https://●●●●●/■■■■■/api/index.php?ac=CreateNewMailLite
●●●●●/■■■■■ は、弊社からお知らせしたログイン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 |
| mail_lang | 配信言語 | 整数 | ※このパラメータは多言語配信オプションの契約が必要です。 0：日本語 1：中国語（繁体字） 2：中国語（簡体字） 3：韓国語（ハングル） 4：その他の言語 |
|
| return_format | 取得形式 | 整数 | 取得する形式を指定。 "csv" ：CSV形式 "xml" ：XML形式 ※省略すると、csv形式。 |
|
| to_address | 宛先（to） | 文字列 | ★ | メールのToに仕様するメールアドレス |
| from_address | Fromのメールアドレス | 文字列 | ★ | メールのFromに使用するメールアドレス |
| from_name | Fromの差出人名 | 文字列 | メールのFromの差出人名 | |
| replacement_data | 顧客情報 | 文字列 | 顧客情報として使用するCSVフォーマットデータ 例) 名前,都道府県、年齢 山田,東京都,28 ※項目名を差し込みコードとして使用可能 |
|
| mail_group_code | グループコード | 文字列 | メール識別用文字列 ※20文字以内の半角英数を指定可能。 |
|
| subject | 件名 | 文字列 | ★ | メールの件名 |
| text_part | 本文（テキストパート） | 文字列 | △ | メールのテキストパート テキストメールの場合は必須 |
| html_part | 本文（HTMLパート） | 文字列 | △ | メールのHTMLパート HTMLメールの場合は必須 |
| schedule_type | 予約種別 | 整数 | ★ | メールの予約種別 1 : 即時配信 2 : 予約配信 |
| schedule_date | 配信日時 | 日時 | △ | メールの配信を行う日時（yyyy/mm/dd hh24:mi） ※過去日時は指定できない。 ※予約配信の場合のみ必須。 ※5分間隔でのみ設定可能 |
| report_option | レポートオプション | 整数 | 一括処理終了後にレポートメールを送信するかどうか。 0 : 送信しない 1 : 送信する 2 : エラー時のみ送信する ※パラメータまたは値がない場合は "1"。 | |
| attach_file_01 | 添付ファイル１ | ファイル | ※このパラメータは添付ファイル送信オプションの契約が必要です。 メールに添付するファイル。 |
|
| attach_file_02 | 添付ファイル２ | ファイル | 〃 | |
| attach_file_03 | 添付ファイル３ | ファイル | 〃 | |
| attach_file_04 | 添付ファイル４ | ファイル | 〃 | |
| attach_file_05 | 添付ファイル５ | ファイル | 〃 | |
| attach_file_06 | 添付ファイル６ | ファイル | 〃 | |
| attach_file_07 | 添付ファイル７ | ファイル | 〃 | |
| attach_file_08 | 添付ファイル８ | ファイル | 〃 | |
| attach_file_09 | 添付ファイル９ | ファイル | 〃 | |
| attach_file_10 | 添付ファイル１０ | ファイル | 〃 |
| CSV項目名 | xmlタグ名 | 表示例 |
|---|---|---|
| メールID | lite_mail_id | 105 |
レスポンスのボディ部に書かれたエラーコードから、エラーの理由を判別することが可能です。
| CODE | STATUS | メッセージ |
|---|---|---|
| 81401 | unauthorized | 接続情報が正しくありません。 |
| 81402 | access denied | 許可されていないIPアドレスからのアクセスです。 |
| 81404 | too many calls | APIの実行回数が制限を超えました。 |
| 81423 | no password | transport_password が入力されていません。 |
| 81461 | bad charset | charsetには、1～3 の整数を指定してください。 |
| 82476 | bad charset | 多言語配信の場合はcharsetに1：UTF-8を指定してください。 |
| 82474 | multilingual option not available |
多言語配信オプションは利用できません（オプション契約が必要です）。 |
| 82475 | bad mail_lang | mail_langには、0～4 の整数を指定してください。 |
| 81424 | bad return_format | return_formatには、「csv」もしくは「xml」を指定してください。 |
| 81438 | bad report_option | report_option には、0～2 の整数を指定してください。 |
| 81441 | too big file | 送信できるファイルサイズは 30MB 未満です。 |
| 81442 | no file | ファイルが存在しません。 |
| 82460 | bad from_address | from_addressがメールアドレスの形式ではありません。 |
| 82461 | no from_address | from_addressを指定してください。 |
| 82462 | no subject | subjectを指定してください。 |
| 82463 | no body | text_partまたはhtml_partを指定してください。 |
| 82464 | bad schedule_type | schedule_typeには、1～2 の整数を指定してください。 |
| 82465 | bad schedule_date | schedule_dateが正しく指定されていません。 |
| 82466 | too old schedule_date | schedule_dateに過去の日付は使用できません。 |
| 82472 | too big attachment | 添付ファイルのサイズが合計3MBを超えています。 |
| 82473 | attachment option not available |
添付ファイルのオプションは利用できません（オプション契約が必要です）。 |
| 82477 | too long subject | subject の長さが上限を超えています。（900文字） |
| 82478 | too long text_part | text_part の1行の長さが上限を超えています。（半角：990文字、全角：約330文字） |
| 82479 | no to_address | to_addressを指定してください。 |
| 82480 | bad to_address | to_addressがメールアドレスの形式ではありません。 |
| 82481 | bad replacement_data row number |
replacement_dataは2行（1行目に項目名、2行目にデータ）で記述してください。 |
| 82482 | bad replacement_data columns |
replacement_dataの項目列とデータ列の数が合っていません。 |
| 82483 | too many columns in replacement_data |
replacement_dataの1行目は100項目以内で指定してください。 |
| 82484 | blank column in replacement_data |
replacement_dataの1行目の項目名に空の値が含まれています。 |
| 82485 | bad replacement_data | replacement_dataの1行目に使用できない文字（改行文字 \r \n）が含まれています。 |
| 82486 | bad mail_group_code | mail_group_codeには、20字以内 の半角英数が指定可能です。 |
| 99500 | internal error | 処理に失敗しました。 |
顧客情報項目を利用してメール件名・本文中にデータの差し込みが可能です。
件名・本文に差し込みたい項目を ##__項目名__## の形式で記述して下さい。
※'#' と '_' (アンダースコア)、それぞれ2つずつで項目名を挟みます。
例） 下記のような顧客情報を利用してメール作成する場合
| お名前 | 都道府県 | 年齢 |
|---|---|---|
| 山田 | 東京都 | 29 |
【作成した件名と本文】
---件名-------------------------------------------------------------------
##__都道府県__##在住のみなさんへお得な情報です！
---本文-------------------------------------------------------------------
##__お名前__##さんへ
×××店からのお知らせ
○月○日からセール開催です！
【実際に送信される件名と本文】
---件名-------------------------------------------------------------------
東京都在住のみなさんへお得な情報です！
---本文-------------------------------------------------------------------
山田さんへ
×××店からのお知らせ
○月○日からセール開催です！
