API接口定制规范

返回码总体说明:
ret = 0: 正确返回

ret > 0: 调用OpenAPI时发生错误,需要开发者进行相应的处理。

-50 <= ret <= -1: 接口调用不能通过接口代理机校验,需要开发者进行相应的处理。

ret <-50: 系统内部错误,请联系技术支持,调查问题原因并获得解决方案。 

公共返回码说明:

 

错误码错误描述-英文含义说明建议解决方案
1 ParameterError 请求参数错误  查看具体Msg描述
1004   账户余额不足  
1100-1200   支付相关错误,预留码段,已经有的错误码说明如下,其他暂不可用:

1100:cdkey不存在;
1101:用户和cdkey不存在绑定关系,或礼品赠送完毕。
1102:参加活动受限。

 
1300   多区选服页面登录验证失败,原因:用户登录记录不存在,或登录已超时。  
-1   请求参数无效。错误消息里会给出具体哪个参数不合法,不合法的原因可以参看接口说明中关于该参数的解释。  
-2   请求中的appid不存在  
-3   无API访问权限。

关于OpenAPI权限的说明:
(1)hosting应用创建后即自动分配出现在API列表中除支付接口以及试点接口外的其它所有接口权限。支付接口需申请接入支付后才分配权限,试点接口需按照该接口文档中的提示进行权限申请。
(2)non-hosting应用不能调用好友关系链OpenAPI。应用创建时默认分配v3/user/get_info接口权限;申请接入支付后分配支付接口权限;其余接口权限需申请开通(申请方式即将推出,推出前暂不接受申请)。

 
-4   IP没有权限。nonhosting应用需排查是否对错误提示中的IP进行了授权。  
-5   签名参数sig校验失败。

(1)常见签名失败原因详见:
为什么总是返回“-5:signature verification failed”?
(2)开发者可以使用平台提供的签名验证工具来计算签名:http://open.qq.com/tools 。
(3)如果您是PHP开发者,可以使用PHP SDK中的签名生成函数来生成签名,避免自己去进行复杂的签名生成逻辑的开发。

 
-6   访问频率超限  
-7   协议不合法(要求必须为https协议的地方,使用了http协议)  
-8   请求受限,通常是安全审计没通过  
-9   API不存在。

注意,出现该错误有可能有以下原因:
(1)开发者使用了错误的API名称,请仔细核对API说明中API的名称。
(2)开发者手动构造了pf参数,传入的pf与实际pf不符,导致报错(例如微博类接口,如果传入pf为空间或朋友,则会报该错)。
(3)系统内部错误。

 
-12   在测试环境中进行OpenAPI调试时,传入的是非调试者QQ号对应的OpenID ,将会返回本返回码,详见: 应用测试环境说明#3.2 测试OpenAPI  
-20   应用调用的OpenAPI未经用户授权。  
-21   access_token已废除,请重新获取access_token。  
-22   openid不合法。注意校验规则详见概念和术语#2.1 OpenID  
-23   openkey不合法。注意校验规则详见概念和术语#2.2 OpenKey  
-24   openid或者openkey验证失败。注意校验规则详见概念和术语#2.1 OpenID  
-58   OpenAPI的系统容错率为0.1%,如果应用后台调用OpenAPI报-58的频率占调用OpenAPI总次数的0.1%以下,是正常情况,请合理设置应用的容错与重试机制。

如果某个OpenAPI报错几率大于0.1%,请通联系技术支持,调查问题原因并获得解决方案。

 
-60   OpenAPI的系统容错率为0.1%,如果应用后台调用OpenAPI报-60的频率占调用OpenAPI总次数的0.1%以下,是正常情况,请合理设置应用的容错与重试机制。

如果某个OpenAPI报错几率大于0.1%,请通过联系技术支持,调查问题原因并获得解决方案。

 
-65   OpenAPI的系统容错率为0.1%,如果应用后台调用OpenAPI报-65的频率占调用OpenAPI总次数的0.1%以下,是正常情况,请合理设置应用的容错与重试机制。

如果某个OpenAPI报错几率大于0.1%,请通过联系技术支持,调查问题原因并获得解决方案。

 
其它<= -50的返回码   都属于系统内部错误,请通过联系技术支持,调查问题原因并获得解决方案。

 
posted @ 2016-11-16 10:28  Aseven  阅读(1198)  评论(0)    收藏  举报