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