公共请求参数
以下参数是调用每个接口都需要使用的参数
header参数
名称 |
类型 |
是否必须 |
默认值 |
说明 |
token |
String |
是 |
无 |
接口访问凭据,获取方式请参考获取鉴权token |
公共返回结构
以下参数格式为每个接口返回的数据的通用格式。
名称 |
类型 |
描述 |
code |
Number |
成功或失败code码,详细含义见业务返回码说明 |
msg |
String |
提示信息,成功或者失败 |
data |
Json |
成功后返回的数据,详见接口说明 |
map |
Json |
其他额外需要返回的数据 |
HTTP code码说明
code |
错误描述 |
解决措施 |
200 |
成功 |
查看基础返回码 |
400 |
参数错误 |
具体异常信息请参考业务返回码 |
401 |
权限相关 |
具体异常信息请参考业务返回码 |
403 |
套餐相关 |
具体异常信息请参考业务返回码 |
404 |
url错误 |
请检查Http路径是否正确 |
405 |
方法不支持 |
该接口不支持该方法请求,请查看文档确认请求方式 |
业务返回码说明
基础返回码
code |
错误描述 |
解决措施 |
对应http code |
0 |
失败 |
接口入参要求是 json 格式,非 json 格式会无法识别导致报错,建议检查一下代码 |
200 |
1 |
成功 |
不涉及 |
200 |
2 |
服务正在启动 |
请等待 |
200 |
301 |
域名错误 |
请检查域名是否与appid机房匹配 |
200 |
404 |
url错误 |
请检查Http路径是否正确 |
404 |
405 |
方法不支持 |
该接口不支持该方法请求,请查看文档确认请求方式 |
405 |
10000 - 权限相关
code |
错误描述 |
解决措施 |
对应http code |
10001 |
token错误/失效 |
调用接口重新获取token |
401 |
10002 |
appId或ip在黑名单中 |
|
401 |
10003 |
每分钟鉴权频率超限 |
接口调用过于频繁 |
401 |
10004 |
没有查询消息明细的权限 |
可以申请权限,若有需要,请点击右侧“技术咨询”了解详情 |
401 |
10005 |
每分钟调用频率超限 |
|
401 |
20000 - 参数相关
code |
msg |
错误描述 |
解决措施 |
对应http code |
20001 |
{param} is invalid |
参数不合法 |
请检查参数 |
400 |
20001 |
{param} can not be empty |
参数不能为空 |
请检查参数 |
400 |
20001 |
target user is invalid |
cid错误或者cid不是当前应用的 |
|
400 |
20001 |
contains duplicate {param} |
数据重复,一般是cid/alias重复 |
|
400 |
20001 |
please choose one of notification and transmission and revoke |
notification、transmission、revoke参数只能使用一个 |
|
400 |
22001 |
scheduled task has been executed and cannot be deleted |
定时任务已经执行,无法删除 |
|
400 |
22002 |
scheduled task time is invalid |
任务无效或定时任务时间不合法 |
|
400 |
23001 |
failed to modifytag |
操作tag失败 |
|
400 |
30000 - 套餐相关,关于套餐相关的返回码,可以针对应用特殊配置,若有需要,请点击右侧“技术咨询”了解详情。
code |
错误描述 |
对应http code |
30000 |
没有推送fast_custom_tag的权限 |
403 |
30001 |
没有修改和删除custom_tag的权限 |
403 |
30002 |
没有推送定时任务的权限 |
403 |
30003 |
app/tag 接口无权限,或tag无效 |
403 |
30004 |
tag每日推送总数超限(VIP用户可根据应用特殊配置) |
403 |
30005 |
tag长度超限(tag长度<32) |
403 |
30006 |
fast_custom_tag次数超过每日推送总数限制(VIP用户可根据应用特殊配置) |
403 |
30007 |
app/all推送,推送次数超过每日推送总数限制,每日最多推送100次 |
403 |
30008 |
list推送次数超过每日推送总数限制,每日最多推送2000000次 |
403 |
30009 |
推送次数超过每日推送总数限制 |
403 |
30010 |
app/tag 推送次数超过每日推送总数限制,每日最多推送100次,和接口app/all共享限制 |
403 |
30011 |
设置tag次数超过每日次数限制 |
403 |
30012 |
修改和删除tag 超过每分钟频率限制,每分钟最多操作5次 |
403 |
30013 |
推送fast_custom_tag频率超过每分钟频率限制(VIP用户可根据应用特殊配置) |
403 |
30014 |
app 推送 频率超过每分钟频率限制,每分钟最多操作5次 |
403 |
30015 |
list推送 频率超过每分钟频率限制 |
403 |
30016 |
push/tag tag个数超过限制 |
403 |
30017 |
没有查询单推实时报表的权限 |
403 |
30018 |
查询单推实时报表 频率超过每分钟频率限制 |
403 |
30019 |
系统繁忙,请稍后重试 |
403 |
R返回数据模版
package com.tj.reggie.controller.utils;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
/**
* 通用返回结果,服务端响应的数据最终都会封装成此对象
*
* @param <T>
*/
@Data
public class R<T> {
private Integer code;//编码:1=成功,0=失败
private String msg; //信息提醒文字
private T data; //返回数据
private Map map = new HashMap();
//成功返回
public static <T> R<T> success(T obj) {
R<T> r = new R<>();
r.data = obj;
r.code = 1;
return r;
}
//失败返回
public static <T> R<T> error(String msg) {
R<T> r = new R<>();
r.msg = msg;
r.code = 0;
return r;
}
public R<T> add(String key, Object value) {
this.map.put(key, value);
return this;
}
}