API レスポンス形式

概要

データリクエストが正常に処理された場合、HTTP ステータスコード 200 が返されます。エラーが発生した場合は、200 以外の HTTP コードとともに、プラットフォームのエラーコードおよびエラーの説明が返されます。

 

成功

現在の認証情報を使用して有効なリクエストを行うと、HTTP 200 が返されます。レスポンスの本文は、以下のような JSON ファイル形式になります:

{
 "result": "success",
 "server_time": "2017-10-09T08:48:34Z",
 ......
}

 

失敗

無効なリクエスト、または認証できないリクエストの場合は、エラーコード(4XX または 5XX)が返されます。レスポンスの本文には、以下のように詳細情報が含まれます:

{
 "result": "error",
 "server_time": "2017-10-09T08:53:18Z",
 "errorCode": "permission_denied_force_log_off",
 "desp": "account_key, or token_id is not correct"
}

すべての失敗したリクエストには、詳細を示す errorCode および desp フィールドが含まれます。

 

エラーコード一覧

エラーコード 説明
permission_denied_force_log_off 提供された認証情報が無効、またはアカウント情報が最近変更された
missing_data リクエストに必要なデータが欠落している
invalid_format リクエストデータの形式が正しくない
over_limit システムの制限を超えた
error_method_invalid リクエストメソッドが無効
invalid_created_at created_at フィールドの形式が無効
invalid_json_format 入力された JSON 文字列の形式が無効
invalid_channel_id channel_id が無効
invalid_api_key API Key が無効
invalid_field_value 入力フィールドの値が無効
invalid_read_key read_key の値が無効
invalid_timezone タイムゾーンの値が無効
missing_field_data リクエストにフィールドデータが欠落している
request_too_fast 同時リクエストが多すぎる
low_balance  アカウント残高が不足している
field_length_over_limit フィールド文字列の長さが制限を超えている
group_name_exist 入力した group_name がすでにプラットフォームに存在する
openid_not_binded WeChat アカウントがプラットフォームアカウントに紐付けられていない
account_require_verify アカウントがまだ有効化されていない
wrong_password パスワードが間違っている
ブログに戻る