响应数据以及返回码说明
侯小猴
发布于 2024-08-09 01:24:01
响应数据格式
数据接口响应均为 json 数据格式,并配合 HTTP 响应状态码来表示接口调用是否成功,返回的 json 数据格式说明如下:
{
"code": 0, // 返回码,参考下文
"message": "错误信息", // 参考下文
"data": {} // 返回的数据对象
}
返回码以及 HTTP 状态码说明
返回码(code) | 错误信息(message) | 具体错误描述或解决方法 | HTTP状态码 |
---|---|---|---|
0 | 请求成功 | - | 200 |
1 | 请求头错误 | 请检查Content-Type是否为application/json | 400 |
2 | 请求数据格式错误 | 请检查请求主体是否为有效的json字符串 | 400 |
3 | 请求参数缺失 | 请按接口说明补充必须传入的参数 | 400 |
4 | 请求参数数据类型错误 | 请按接口说明修改参数的数据类型 | 400 |
11 | 链接分组sid错误 | 请参考获取链接分组接口返回的数据,传入正确的分组sid | 400 |
12 | 跳转链接的格式错误 | 请检查跳转链接是否是以 http:// 或者 https:// 开头的链接或应用跳转链接,是否符合 URL 语法 | 400 |
13 | 跳转链接的域名不在白名单之内 | 请在 API 设置 里,将想要跳转的域名添加到白名单中 | 403 |
14 | 一天内短链接创建数量超过限制 | 超过了每日调用接口创建链接数的限制,请 升级API套餐 获取更高额度 | 403 |
15 | 自定义域名未绑定或不可用 | 请在 自定义域名设置 里绑定并启用想要使用的域名,如果想在协作空间下使用自定义域名,绑定了域名的账号还需要将域名应用到正确的协作空间中 | 403 |
16 | 短链接的格式错误 | 请按正确的格式传入短链接URL | 400 |
17 | 短链接无效 | 没有找到符合查询条件的短链接 | 400 |
18 | 禁止循环跳转 | 跳转链接与短链接的URL不可以相同 | 400 |
19 | 日期格式错误 | 请按“yyyy-mm-dd”的格式传入日期 | 400 |
20 | 日期跨度无效 | 查询日期区间的长度不能超过31天 | 400 |
21 | offset/limit超出取值范围 | offset 不能小于0;limit 须大于0且不大于1000 | 400 |
22 | 场景值长度超出限制 | 场景值的长度不能超过128个字符 | 400 |
101 | apikey错误 | 传入的 apikey 不正确 | 401 |
102 | 账号异常 | 账号状态异常,请联系客服 | 401 |
103 | 没有API权限 | 账号没有开通API权限 | 401 |
104 | 没有此API的调用权限 | 账号没有此API的调用权限,请 升级API套餐 获取更多的开放API功能 | 401 |
-1 | 系统错误 | 系统出现未知异常,请联系客服 | 500 |
-2 | 系统繁忙 | 请稍候重试 | 503 |