短链接 / V2 接口

响应数据及返回码

吕遥
发布于 2024-12-04 00:01:28

响应数据格式

全部接口返回的数据均为 json 格式,并配合 HTTP 响应状态码来表示接口调用是否成功。

调用成功返回的 json 数据示例如下:

{
	"code": 0,
	"message": "请求成功",
	"data": {
		...  // 与接口功能相关的业务数据
	}
}

调用失败返回的 json 数据示例如下:

{
	"code": 10,  // 返回码,参考下文
	"message": "请求数据格式错误",  // 错误信息,参考下文
	"data": {}
}

返回码以及 HTTP 状态码说明

返回码(code)错误信息(message)具体错误描述或解决方法HTTP状态码
0请求成功-
200
1apikey未授权传入的 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目标网站存在安全风险,禁止跳转具体请参考小码至营使用规范
3271offset/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
小码至营logo