Java服务端开发帮助
为方便开发者使用消息推送服务端Java SDK,本文对SDK中主要接口的功能、参数及属性、返回值,以及SDK与服务端交互过程中存在的错误进行介绍。另外,为使开发者能够较快的熟悉和使用 SDK接口,给出了接口的调用流程实例。
接入指南
请您访问消息推送接入指南,创建应用并获取API KEY。
下载服务端API接口文档
请您下载JAVA API接口文档,获取服务端API接口文档。
服务错误码
用户使用SDK与后端server端交互中,通常存在多种错误。依据交互的成功与否,将错误分阶段进行梳理,并给出相应的错误码、错误信息和相关描述,以便分析问题时进行查找。详细如下
码值 | 说明 |
---|---|
200 | 成功 |
500 | 服务器内部异常 |
2004 | 参数为空 |
2005 | 参数无效 |
3000 | 数据不存在 |
3001 | 数据已存在 |
3002 | 数据保存失败 |
5000 | 定时任务添加失败 |
常用类
PushRequestBuilder
该类为工具类,提供了构造推送消息的接口。
RequestClient
该类为消息发送类,提供了发送消息的接口。
PushRequest
该类为消息实体类,定了消息的各个属性,由PushRequestBuilder.build()生成。
PushResponse
该类为消息发送结果类,包含了消息的发送结果。
示例代码
public class Test {
public static void main(String[] args){
PushRequestBuilder builder = PushRequestBuilder.newInstance();
PushRequest request = builder.setMessageType(MessageType.NOTICE) //发送通知
.setApiKey("xxxxxxxxx") //应用注册时生成的apiKey
.setTitle("测试消息")
.setContent("消息体")
.setActionType(ActionType.ACTION_IMMEDIATE) //立即发送
.setPersistType(PersistType.persist) //持久化时间
.setExpireTime(new Date()) //过期时间,实际使用时设置为将来时间
.setBroadcastType(BroadcastType.Broadcast_TYPE_ALL) //广播到所有设备
.setRegionIds("北京市,武汉市") //发送区域
.setVersionType(VersionType.VERSION_TYPE_ALL)
.setClearable(Clearable.no) //不可清除
.setShakeable(Shakeable.yes) //可震动
.setBellable(Bellable.yes) //可响铃
.build();
RequestClient client = new RequestClient();
PushResponse response = client.sendRequest(request);
System.out.println(response);
}
}