機能一覧

通信方式 ：

POST（HTTPS）

文字コード ：

UTF-8、Shift-JIS、EUC-JP
※パラメータ「charset」に、該当する文字コードを指定してください。

API 連携機能は 1 日あたりの利用回数に制限を設けています。
制限回数を超えた場合はエラーになり、夜 0:00 に回数がリセットされるまで利用することができません。

利用制限 ：

1000 回/日

※エラーを除くすべての API の利用回数が対象となります。

[ 制限を超えた際のエラーコード ]

CODE	STATUS	メッセージ
81404	too many calls	API の実行回数が制限を超えました。

CSV もしくは、XML 形式でレスポンスを受け取ることができます。

※形式はパラメータの「return_format」で指定できます。
※文字コードはパラメータの「charset」で指定できます。

CSV 形式

1行目 ：

ヘッダが出力されます。

2行目移行 ：

データが出力されます。

※エラー時には、結果コード（エラーコード）が出力され
成功時には、取得内容が出力されます。

※ヘッダ行が”CODE,STATUS,MESSAGE”となっていればエラーと判定できます。

XML 形式

XML 形式では、かならず結果コードが返る仕様となっています。
※成功時は code に 10200 が設定されます。

また、取得内容がリスト形式の場合には下記のような戻り値となります。

実行結果を以下のような形式で返します。

【成功した場合のレスポンス】

ヘッダ（共通）

CSV 形式	HTTP/1.1 200 OK Cache-Control: public Pragma: public Content-Type:20120328161734.csv; name=20120328161734.csv Content-Disposition: attachment ; filename=20120328161734.csv
XML 形式	HTTP/1.1 200 OK Content-Type: text/xml; charset=UTF-8

※CSV 形式の場合、出力データがない場合には CSV 形式のヘッダは出力されません。

ボディ（操作系）

戻り値がある場合

CSV 形式	メール ID 118
XML 形式	<response> <code>10200</code> <status>success</status> <message>成功</message> <data> <mail_id>119</mail_id> </data> </response>

戻り値がない場合

CSV 形式
XML 形式	<response> <code>10200</code> <status>success</status> <message>成功</message> </response>

ボディ（取得系）

戻り値がある場合

CSV 形式

メールアドレス,最終更新日,永続的,一時的,原因不明,合計 xxxx@xxxxx.co.jp ,2012/03/14 10:55,7,3,10,20 xxxx@xxxxx.co.jp ,2012/03/14 10:54,5,4,6,15

XML 形式

<response> <code>10200</code> <status>success</status> <message>成功</message> <data> <list> <mail_address>test002@user02.dd1.ldomain</mail_address> <last_update_date>2012/03/14 10:55</last_update_date> <permanent_error>7</permanent_error> <temporary_error>3</temporary_error> <unknown_error>10</unknown_error> <summary>20</summary> </list> <list> <mail_address>test001@user02.dd1.ldomain</mail_address> <last_update_date>2012/03/14 10:54</last_update_date> <permanent_error>5</permanent_error> <temporary_error>4</temporary_error> <unknown_error>6</unknown_error> <summary>15</summary> </list> </data> </response>

※リスト取得の通信の場合は、ボディにリスト内容が設定されます。

【失敗した場合のレスポンス】

ヘッダ

CSV 形式	HTTP/1.1 200 OK Cache-Control: public Pragma: public Content-Type:20120328161734.csv; name=20120328161734.csv Content-Disposition: attachment ; filename=20120328161734.csv
XML 形式	HTTP/1.1 200 OK Content-Type: text/xml; charset=UTF-8

※CSV 形式の場合、出力データがない場合には CSV 形式のヘッダは出力されません。

ボディ

※ボディ部の表記は一例です。

パラメータエラーによって処理に失敗した場合

CSV 形式	CODE,STATUS,MESSAGE 81423,no password,transport_password が入力されていません。
XML 形式	<response> <code>81423</code> <status>no password</status> <message>transport_password が入力されていません。 </message> </response>

認証エラーによって処理に失敗した場合

CSV 形式	CODE,STATUS,MESSAGE 81401,unauthorized,接続情報が正しくありません。
XML 形式	<response> <code>81401</code> <status>unauthorized</status> <message>接続情報が正しくありません。</message> </response>

サーバエラーによって処理に失敗した場合

CSV 形式	CODE,STATUS,MESSAGE 99500,internal error,サーバ内で処理に失敗しました。
XML 形式	<response> <code>99500</code> <status>internal error</status> <message>サーバ内で処理に失敗しました。</message> </response>

【CSV ファイルのフォーマットについて】

• CSV ファイル内の項目の並び順などに指定はございません。
• CSV ファイル内のメールアドレスに該当する項目名は「メールアドレス(カタカナ全角)」と記載してください。
  「メールアドレス」以外の文言を記載する場合は、管理画面の各種設定画面より項目名称を指定してください。
• CSV ファイルの項目数の上限は 100 項目となります。
• CSV ファイル 1 行目（ヘッダ行）の項目名は必須入力です。
• CSV ファイルのサイズ制限は 30MB までです。
• CSV を圧縮した ZIP ファイルの送信ができます。
  ※処理できる CSV ファイルは 1 つだけです。複数の CSV ファイルを圧縮した ZIP ファイルは送信できません。
• 文字コードは UTF-8、Shift-JIS、EUC-JP です。
• CSV ファイル内のひとつの項目の制限文字数は 900 文字です。
• 「\r,\n（改行コード）」は項目名としてご利用できません。