通信方式 :
POST(HTTPS)
文字コード :
UTF-8、Shift-JIS、EUC-JP
※パラメータ「charset」に、該当する文字コードを指定してください。
利用制限 :
1000 回/日
※エラーを除くすべての API の利用回数が対象となります。
[ 制限を超えた際のエラーコード ]
CODE | STATUS | メッセージ |
---|---|---|
81404 | too many calls | API の実行回数が制限を超えました。 |
※形式はパラメータの「return_format」で指定できます。
※文字コードはパラメータの「charset」で指定できます。
1行目 :
ヘッダが出力されます。
2行目移行 :
データが出力されます。
※エラー時には、結果コード(エラーコード)が出力され
成功時には、取得内容が出力されます。
※ヘッダ行が”CODE,STATUS,MESSAGE”となっていればエラーと判定できます。
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 ファイルのフォーマットについて】