配信リストを登録するAPIです。
https://●●●●●/■■■■■/api/index.php?ac=UploadAddressCSV
●●●●●/■■■■■ は、弊社からお知らせしたログインURLに置き換えてください。
例)お客様のログインURLが https://m.crmf.jp/api_sample/index.php の場合、
●●●●● は、m.crmf.jp
■■■■■ は、api_sample に置き換えてください。
パラメータ名 | 項目名 | 属性 | 必須 | 設定内容 |
---|---|---|---|---|
transport_password | 接続用パスワード | 文字列 | ★ | API連携接続用パスワード |
csvfile | CSVファイル | CSVファイル または ZIPファイル |
★ | CSVファイル、またはCSVファイルを圧縮したZIPファイル。 文字コードはUTF-8、Shift-JIS、EUC-JP。 ※ファイルサイズ制限は最大30MB まで。 ※処理できるCSVファイルは1つだけです。複数のCSVファイルを圧縮したZIPファイルは送信できません。 |
charset | 文字コード | 整数 | ★ | CSVファイルの文字コード・通信文字コード。 1:UTF-8 2:Shift-JIS 3:EUC-JP |
list_name | リスト名 | 文字列 | 画面表示のリスト名称 ※50文字以内 ※使用できない文字『\ / : * ? “ < > |』 |
|
list_target | リスト登録先 | 整数 | ★ | リストの登録先(1:本部、2:エリア、3:店舗) ※パラメータまたは値がない場合は "1"。 |
areaid | エリアID | 整数 | ▲ | リスト登録先が「2:エリア」の場合、必須 |
shopid | 店舗ID | 整数 | ▲ | リスト登録先が「3:店舗」の場合、必須 |
report_option | レポートオプション | 整数 | 一括処理終了後にレポートメールを送信するかどうか。 0:送信しない 1:送信する 2:エラー時のみ送信する ※パラメータまたは値がない場合は "1"。 |
なし
レスポンスのボディ部に書かれたエラーコードから、エラーの理由を判別することが可能です。
CODE | STATUS | メッセージ |
---|---|---|
81401 | unauthorized | 接続情報が正しくありません。 |
81402 | access denied | 許可されていないIPアドレスからのアクセスです。 |
81404 | too many calls | APIの実行回数が制限を超えました。 |
81423 | no password | transport_password が入力されていません。 |
82431 | bad list_target | list_targetには、リストの登録先(1:本部, 2:エリア, 3:店舗)いずれかの値を設定してください。 |
81438 | bad report_option | report_option には、0~2 の整数を指定してください。 |
81441 | too big file | 送信できるファイルサイズは 30MB 未満です。 |
81442 | no file | ファイルが存在しません。 |
81443 | bad file type | ファイルの拡張子が csv, zip ではない、またはZIPファイル内のファイルが csv ではありません。 |
81444 | too many files | ZIPファイル内に複数のファイルが存在します。 |
82445 | no mailaddress column | CSVファイルの1行目に「メールアドレス」の項目名がありません。 |
82446 | bad list_name | list_nameに使用できない文字が含まれています。 |
82447 | too long list_name | list_nameが長すぎます。 |
82448 | too many column | CSVファイルの1行目は100項目以内で指定してください。 |
82449 | blank column | CSVファイルの1行目の項目名に空の値が含まれています。 |
82450 | bad column | CSVファイルの1行目に使用できない文字が含まれています。 |
82453 | bad areaid | areaidが整数ではない、または存在しないareaidです。 |
82454 | no areaid | areaidを指定してください。※list_targetが2の場合、areaidの指定が必要です。 |
82451 | bad shopid | shopidが整数ではない、または存在しないshopidです。 |
82452 | no shopid | shopidを指定してください。※list_targetが3の場合、shopidの指定が必要です。 |
81461 | bad charset | charsetには、1~3 の整数を指定してください。 |
99500 | internal error | 処理に失敗しました。 |