全局返回码说明

每次调用接口时,可能获得正确或错误的返回码,开发者可以根据返回码信息调试接口,排查错误。

接口返回格式

如果请求及权限正确,平台返回HTTP协议状态码200及JSON数据包形式如下:

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

如果请求或权限有误,平台将返回4XX, 5XX等HTTP协议状态码。错误时的返回JSON数据包如下(示例为权限信息有误)::

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

通过HTTP协议状态码及”result”字段可以判断请求结果,”success”为成功,”error”为失败。 其中”errorCode”为错误代码,”desp”为更详尽的错误解释信息。

错误代码(errorCode)说明如下

 错误代码(errorCode) 说明
 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  输入field参数不正确
 invalid_read_key  只读密钥不正确
 invalid_timezone  时区格式不正确
 missing_field_data  缺少field数据值
 request_too_fast  请求过于频繁
 low_balance  账户余额不足,无法进行操作
 field_length_over_limit  field值超过限制
 group_name_exist  输入的组名已经存在
 field_length_over_limit  field值超过限制
 openid_not_binded  微信公众号尚未绑定
 permission_denied  无权限进行访问
 internal_error  服务器内部错误
 account_require_verify  账户尚未进行激活(邮箱或短信)
 wrong_password  密码有误