diff --git a/README.md b/README.md index c0aaa1f..e6ccb6f 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,62 @@ # C端消息中心(fw-hestia) -### 简介 -C端消息中心 -### 对接文档 -### 1. SDK +## 简介 +> C端消息中心 + +## 1. SDK ```xml - + cn.fw fw-hestia-sdk 1.0.0 ``` -### 2. 接口 - -1. #### 发送模板消息 - -- `IMessageCenterService#send` - - 1. ##### 参数 - - |参数名| 必须 |类型|说明| - |---|:---:|:---:|:---| - |memberId|是 | Long| 会员id| - |title| 是 | String| 标题内容。| - |changeType| 是 | String| 变更类型| - |changeResult| 是 | String| 变更结果。| - |remark| 否 | String| 备注。| - |path| 否 | String| 小程序页面路径。| - |paramMap| 否 | HashMap| 跳转小程序所携带的参数。| +## 2. 接口 - 2. ##### 返回值 +### 发送模板消息 +`IMessageCenterService#send` - `sceneToken` 长整型 +**参数** - 3. ##### 说明 +|参数名|必须|类型|说明| +|----|:----:|:----:|:----| +|memberId|是 | Long| 会员id| +|title| 是 | String| 标题内容。| +|changeType| 是 | String| 变更类型| +|changeResult| 是 | String| 变更结果。| +|remark| 否 | String| 备注。| +|path| 否 | String| 小程序页面路径。| +|paramMap| 否 | HashMap| 跳转小程序所携带的参数。| - > 调用接口成功后小程序上已经能看到对应的消息了,公众号模板消息可能会因为各种原因没有发送到微信上去,所以如果需要监听模板消息发送的情况 需要监听MQ消息通过sceneToken通知发送成功的事件 +**返回值** -2. #### 撤回消息 +`sceneToken` 长整型 - - `IMessageCenterService#revokeMessage` +**说明** +> 调用接口成功后小程序上已经能看到对应的消息了,公众号模板消息可能会因为各种原因没有发送到微信上去,所以如果需要监听模板消息发送的情况 需要监听MQ消息通过sceneToken通知发送成功的事件 - 1. ##### 参数 +### 撤回消息 +`IMessageCenterService#revokeMessage` - |参数名| 必须 |类型|说明| - |---|:---:|:---:|:---| - |sceneToken|是 | Long| sceneToken| +**参数** - 2. ##### 返回值 +|参数名| 必须 |类型|说明| +|---|:---:|:---:|:---| +|sceneToken|是 | Long| sceneToken| - 返回是否操作成功 +**返回值** - 3. ##### 说明 +返回是否操作成功 - > 撤回消息。 小程序消息中心无法查看,但是发送出去的公众号模板消息无法回滚 +**说明** +> 撤回消息。 小程序消息中心无法查看,但是发送出去的公众号模板消息无法回滚 -### 3. MQ +## 3. MQ -- #### 说明 +### 说明 - > 成功发送公众号模板消息后会发送mq +> 成功发送公众号模板消息后会发送mq -- #### topic: message_send +### topic: message_send ```java public class MessageSendMq {