响应数据及返回码
吕遥
发布于 2024-12-04 00:01:28
响应数据格式
全部接口返回的数据均为 json 格式,并配合 HTTP 响应状态码来表示接口调用是否成功。
调用成功返回的 json 数据示例如下:
{
"code": 0,
"message": "请求成功",
"data": {
... // 与接口功能相关的业务数据
}
}
调用失败返回的 json 数据示例如下:
{
"code": 10, // 返回码,参考下文
"message": "请求数据格式错误", // 错误信息,参考下文
"data": {}
}
返回码以及 HTTP 状态码说明
返回码(code) | 错误信息(message) | 具体错误描述或解决方法 | HTTP状态码 |
---|---|---|---|
0 | 请求成功 | - | 200 |
1 | apikey未授权 | 传入的 apikey 不正确 | 401 |
10 | 请求数据格式错误 | 请检查请求主体是否为有效的 json 字符串 | 400 |
20 | 请求参数缺失 | 请按接口说明补充必须传入的参数 | |
30 | 请求参数数据类型错误 | 请按接口说明修改参数的数据类型 | |
41 | 日期格式错误 | 请按“yyyy-mm-dd”的格式传入日期 | |
42 | 数量必须是正整数 | 表示数量的字段请勿传入负数或零 | |
101 | 账号已被封禁 | 账号或团队处于全部或部分功能禁用的状态,如有异议请联系客服处理 | 403 |
102 | 团队已被封禁 | ||
103 | 团队已被禁止使用短链接产品 | ||
3030 | 不支持的域名格式 | 请按有效的域名格式填写,暂不支持中文域名 | 400 |
3080 | 不支持的跳转链接格式 | 请检查跳转链接是否是以 http:// 或者 https:// 开头的链接或应用跳转链接,是否符合 URL 语法 | |
3081 | 短链URL格式错误 | 请按正确的 URL 格式填写短链地址 | |
3203 | 项目id错误 | 请参考「获取项目列表 API」返回的数据,传入正确的项目id | |
3209 | 短链分组id错误 | 请参考短链分组相关接口返回的数据,或者直接从小码后台查询,传入正确的分组id | |
3261 | 目标网站存在安全风险,禁止跳转 | 具体请参考小码至营使用规范 | |
3271 | offset/count超出取值范围 | offset 不能小于0;count 须大于0且不大于100 | |
3272 | 起止日期跨度无效 | 查询日期区间的跨度不能超过31天,且起始日期不能早于一年前 | |
3290 | 短链域名无效 | 请检查您填写的自有域名是否正确,是否已成功绑定到您的团队并应用到了所需的项目中 | |
3291 | 自定义后缀格式错误 | 自定义后缀可使用英文字母、数字、连字符和下划线,长度不超过32个字符 | |
3292 | 随机后缀长度无效 | 随机后缀的最小长度为4,最大长度为8 | |
3293 | 已存在指定后缀的短链 | 请将指定后缀修改为其它的值再生成短链,或者直接编辑该后缀的短链 | |
3294 | 缺少可用的指定长度的后缀 | 指定长度的随机后缀已用完或接近用完,无法继续生成短链,请修改后缀长度 | |
3320 | 白名单域名的数量超出限制 | 白名单域名的数量默认不超过5个,每月提交白名单的次数默认不超过4次,如果数量无法满足您的使用需求,请联系客服并说明您的应用场景 | |
3321 | 本月的白名单提交次数已用完 | ||
3322 | 跳转链接的域名不在白名单中 | 请参考「使用前必读」中关于域名白名单的说明 | |
3323 | 场景值的长度超出限制 | 事件推送场景值的长度不能超过128个字符 | |
3324 | 名称长度超出限制 | 请参考具体接口对相应参数的长度限制 | |
3325 | 批量操作的短链数量超出限制 | 请参考具体接口对批量操作短链数量的限制 | |
3330 | 短链无效 | 找不到符合查询条件的短链 | |
3331 | 短链已被封禁 | 具体请参考小码至营使用规范 | |
3351 | 短链API资源包额度不足 | 资源包额度已用完,请及时购买 API 资源包,以免影响您的业务 | |
-1 | 系统错误 | 系统出现未知异常,请联系客服反馈处理 | 500 |
-2 | 系统繁忙,请稍候重试 | 请稍后重新调用接口 | 503 |