Commit 32da27448e0b4f707a892ac8a0aea8979ca8a801
1 parent
e7521907
:memo: 编写对接文档
Showing
1 changed file
with
51 additions
and
30 deletions
README.md
| ... | ... | @@ -5,42 +5,63 @@ C端消息中心 |
| 5 | 5 | ### 1. SDK |
| 6 | 6 | ```xml |
| 7 | 7 | <dependency> |
| 8 | - <groupId>cn.fw</groupId> | |
| 9 | - <artifactId>fw-hestia-sdk</artifactId> | |
| 10 | - <version>1.0.0</version> | |
| 11 | - </dependency> | |
| 8 | + <groupId>cn.fw</groupId> | |
| 9 | + <artifactId>fw-hestia-sdk</artifactId> | |
| 10 | + <version>1.0.0</version> | |
| 11 | +</dependency> | |
| 12 | 12 | ``` |
| 13 | -### 2. 接口 | |
| 14 | - 1. #### 发送模板消息 | |
| 15 | - - `IMessageCenterService#send` | |
| 16 | - 1. ##### 参数 | |
| 17 | - |参数名| 必须 |类型|说明| | |
| 13 | +### 2. 接口 | |
| 14 | + | |
| 15 | +1. #### 发送模板消息 | |
| 16 | + | |
| 17 | +- `IMessageCenterService#send` | |
| 18 | + | |
| 19 | + 1. ##### 参数 | |
| 20 | + | |
| 21 | + |参数名| 必须 |类型|说明| | |
| 18 | 22 | |---|:---:|:---:|:---| |
| 19 | - |memberId|是 | Long| 会员id| | |
| 20 | - |title| 是 | String| 标题内容。| | |
| 21 | - |changeType| 是 | String| 变更类型| | |
| 22 | - |changeResult| 是 | String| 变更结果。| | |
| 23 | - |remark| 否 | String| 备注。| | |
| 24 | - |path| 否 | String| 小程序页面路径。| | |
| 25 | - |paramMap| 否 | HashMap<String,String>| 跳转小程序所携带的参数。| | |
| 26 | - 2. ##### 返回值 | |
| 27 | - `sceneToken` 长整型 | |
| 28 | - 3. ##### 说明 | |
| 29 | - > 调用接口成功后小程序上已经能看到对应的消息了，公众号模板消息可能会因为各种原因没有发送到微信上去，所以如果需要监听模板消息发送的情况 需要监听MQ消息通过sceneToken通知发送成功的事件 | |
| 30 | -2. #### 撤回消息 | |
| 31 | - - `IMessageCenterService#revokeMessage` | |
| 32 | - 1. ##### 参数 | |
| 33 | - |参数名| 必须 |类型|说明| | |
| 34 | - |---|:---:|:---:|:---| | |
| 35 | - |sceneToken|是 | Long| sceneToken| | |
| 36 | - 2. ##### 返回值 | |
| 37 | - 返回是否操作成功 | |
| 38 | - 3. ##### 说明 | |
| 39 | - > 撤回消息。 小程序消息中心无法查看，但是发送出去的公众号模板消息无法回滚 | |
| 23 | + |memberId|是 | Long| 会员id| | |
| 24 | + |title| 是 | String| 标题内容。| | |
| 25 | + |changeType| 是 | String| 变更类型| | |
| 26 | + |changeResult| 是 | String| 变更结果。| | |
| 27 | + |remark| 否 | String| 备注。| | |
| 28 | + |path| 否 | String| 小程序页面路径。| | |
| 29 | + |paramMap| 否 | HashMap<String,String>| 跳转小程序所携带的参数。| | |
| 30 | + | |
| 31 | + 2. ##### 返回值 | |
| 32 | + | |
| 33 | + `sceneToken` 长整型 | |
| 34 | + | |
| 35 | + 3. ##### 说明 | |
| 36 | + | |
| 37 | + > 调用接口成功后小程序上已经能看到对应的消息了，公众号模板消息可能会因为各种原因没有发送到微信上去，所以如果需要监听模板消息发送的情况 需要监听MQ消息通过sceneToken通知发送成功的事件 | |
| 38 | + | |
| 39 | +2. #### 撤回消息 | |
| 40 | + | |
| 41 | + - `IMessageCenterService#revokeMessage` | |
| 42 | + | |
| 43 | + 1. ##### 参数 | |
| 44 | + | |
| 45 | + |参数名| 必须 |类型|说明| | |
| 46 | + |---|:---:|:---:|:---| | |
| 47 | + |sceneToken|是 | Long| sceneToken| | |
| 48 | + | |
| 49 | + 2. ##### 返回值 | |
| 50 | + | |
| 51 | + 返回是否操作成功 | |
| 52 | + | |
| 53 | + 3. ##### 说明 | |
| 54 | + | |
| 55 | + > 撤回消息。 小程序消息中心无法查看，但是发送出去的公众号模板消息无法回滚 | |
| 56 | + | |
| 40 | 57 | ### 3. MQ |
| 58 | + | |
| 41 | 59 | - #### 说明 |
| 60 | + | |
| 42 | 61 | > 成功发送公众号模板消息后会发送mq |
| 62 | + | |
| 43 | 63 | - #### topic: message_send |
| 64 | + | |
| 44 | 65 | ```java |
| 45 | 66 | public class MessageSendMq { |
| 46 | 67 | public final static String TOPIC = "message_send"; | ... | ... |