联诚科技集团Message-Middle-Platform消息中间平台SDK接入指南（java版）

使用前提

• 使用 message-middle-platform 消息中间平台 java SDK， 您需要使用消息平台提供的App Key、App Secret和消息中间平台 URL 地址
• LicOS SDK 支持JAVA JDK1.8及其以上版本

SDK获取和安装

推荐您通过 Maven 安装依赖的方式使用 SDK。

pom.xml配置

<!-- 请使用最新版SDK -->
<dependency>
  <groupId>com.kmlc.message</groupId>
  <artifactId>message-sdk</artifactId>
  <version>1.0.1-RELEASE</version>
</dependency> 

配置文件说明：

统一返回结果 Result<T> 说明：

请求成功返回结果
Result<T> reuslt:

{
   "success" : true,
   "message" : "操作成功",
   "code" : 200,
   "timestamp" : 1670910618211,
   "content" : { //返回 T 对象 或 T 对象集合
	...
  }
}

请求失败返回结果
Result<T> reuslt:

{
   "success" : false,
   "message" : "错误信息",
   "code" : xxx, //错误状态码
   "timestamp" : 1670910618211,
   "content" : { //返回一个为 null 的 T 对象

  }
}

用户注册/修改方法 register(RequestDto request)
请求参数

响应参数

请求示例：

public static void main(String[] args) {
       
	RequestDto request = new RequestDto();
        request.setAlias("test_957aba78d04b1"); // 第三方用户唯一别名
        request.setName("test_name");//发消息者名字
        request.setCid("test_59b916c29628");//客户端id
        request.setPhone("13312341234");//用户手机号码
	...
	/*
	String ak="0000001"
	String sk="kmlc3302133"
	String url ="http://127.0.0.1:8081/msgv2"
	*/
        MessageClient messageClient = new MessageClient("0000001", "kmlc3302133", "http://127.0.0.1:8081/msgv2");
        Result<UserVO> register = messageClient.register(request);
	//TODO 执行其它逻辑
	...
    }

请求成功返回结果
Result<UserVO> reuslt:

{
   "success" : true,
   "message" : "操作成功",
   "code" : 200,
   "timestamp" : 1670910618211,
   "content" : { //返回 T 对象
	"ak" : "0000001" ,
	"alias" : "test_licos" ,
	"phone" : "13312341234" ,
	"cid" : "test_122321321"
  }
}

请求失败返回结果
Result<UserVO> reuslt:

{
   "success" : false,
   "message" : "错误信息",
   "code" : xxx, //错误状态码
   "timestamp" : 1670910618211,
   "content" : { //返回一个为 null 的 T 对象
	
  }
}

统一推送接口 push(PushDTO dto)
请求参数

Result<Object> result:
返回结果参照统一结果返回 Result<T> 结构 ，泛型为Object表示后端没有对象返回，content 为 null

获取socket连接token socketToken(SocketTokenDTO dto)
请求参数

响应参数

请求返回示例
Result<SocketTokenVO> reuslt:

{
   "success" : true,
   "message" : "操作成功",
   "code" : 200,
   "timestamp" : 1670910618211,
   "content" : { //返回 T 对象
	"token" : "0000001" ,
	"userId" : "test_licos" ,
	"type" : "13312341234" ,
	"connectUrl" : "test_122321321"
  }
}

获取平台消息 分页 多条件 getPlatformMessage(GetPlatformMessageDTO getMessage)
请求参数

响应参数

Result<PageResponse<MessagePlatformVO>> result:
返回结果参照统一结果返回 Result<T> 结构

获取某条消息并且设置已读 getPlatformMessageById(String msgId)
请求参数类型

响应参数

Result<MessagePlatformVO> result:
返回结果参照统一结果返回 Result<T> 结构

按条件设置消息已读 readPlatformMessage(SetPlatformMessageReadDTO dto)
请求参数类型

Result<Object> result:
返回结果参照统一结果返回 Result<T> 结构 泛型为Object表示后端没有对象返回，content 为 null

按条件设置消息已完成 completePlatformMessage(SetPlatformMessageReadDTO dto)
请求参数类型

Result<Object> result:
返回结果参照统一结果返回 Result<T> 结构 泛型为Object表示后端没有对象返回，content 为 null

获取某条消息的已读未读信息 getPlatformMessageRead(String outId)
请求参数类型

响应参数

Result<ReadInfoVO> result:
返回结果参照统一结果返回 Result<T> 结构

条件删除消息 deletePlatformMessage(DeleteMessageDTO dto)
请求参数类型

Result<Object> result:
返回结果参照统一结果返回 Result<T> 结构

消息对应的接收者简要信息 getPlatformMessageIdsByOutId(String outId)
请求参数类型

响应参数

Result<List<MsgSimple>> result:
返回结果参照统一结果返回 Result<T> 结构

根据sendId分组列表 getPlatformMessageGroupBySendId(GetPlatformMessageGroupBySendIdDTO dto)
请求参数类型

响应参数

Result<List<SendIdGroupVO>> result:
返回结果参照统一结果返回 Result<T> 结构

查询最新的一条消息 getPlatformMessageLatest(GetPlatformMessageLatestDTO dto)
请求参数类型

响应参数

Result<MessagePlatformVO> result:
返回结果参照统一结果返回 Result<T> 结构

查询消息数量 getCount(GetNoCompletedNumDTO dto)
请求参数类型

响应参数

Result<CountVO> result:
返回结果参照统一结果返回 Result<T> 结构