消息配置模块文档 - MOMpro平台文档

# 消息配置模块

## 消息类型

消息类型名称不可重复，消息

### 消息子类型

消息子类型名称不可重复
需要在此配置子类别的基础信息

必填字段

- 选定发送渠道
- 选定弹窗设置
- 设置接收对象
- 设置循环定时
- 选择[引用模板](#选用模板)

#### 选用模板
选择在[模板管理](#模板管理)中创建的模板，会自动带出模板内容。可以在该模板的基础上进行修改，此操作不会影响模板管理的中原始模板数据。
每个消息子类别最多只能绑定一条模板

## 轻应用

### 轻应用管理

轻应用即向第三方发送消息的“中转站”，根据消息子类别中给定的发送渠道来决定给哪些渠道发送消息。

可以添加多个轻应用，轻应用的名称不能重复，自动生成轻应用编号“LA(年份)(月份)(三位自增数字)”

### 轻应用配置

属于轻应用的子表，一个轻应用下有多个轻应用配置，对应不同渠道的配置信息

在保存轻应用配置时，会调用后台接口以确认该配置的正确性

每个渠道的轻应用配置只能有一条数据，不可以在同一渠道下添加多个配置信息

#### 短信

暂未实现

#### 企业微信

字段要求

- 企业ID

- Secret 应用密钥

- AgentId 应用id

![AgentId Secret](/media//202401/image-20230308143348906_1706236061.png)
	![企业ID](/media//202401/image-20230308143811819_1706236104.png)

获取方式

- [官方文档](https://developer.work.weixin.qq.com/document/path/90665#corpid)

注意事项

- 企业微信需要配置“可信IP地址”，需要管理员到应用管理后台配置应用的可信IP地址

#### 钉钉

字段要求

- appKey
- appSecret
- agentId

获取方式

1. 企业内部开发

2. 创建应用（输入应用名称、描述、开发方式选择“企业自主开发”）

3. 进入“应用详情"查看应用信息-应用凭证

![](/media//202401/image-20230308144525007_1706236157.png)

#### 飞书

所需字段

- AppId
- AppSecret

获取方式

1. 打开飞书开发者后台-创建企业自建应用

2. 填入应用信息 描述等内容

3. 选择“机器人能力”

4. 点击“凭证与基础信息”

![](/media//202401/image-20230308145533748_1706236177.png)

5. 通过手机号和邮箱获取用户id

6. 给多个用户批量发消息

7. 获取与上传图片或文件资源

#### 云之家

`目前云之家只能创建群组机器人，在群内发送文本消息，无法根据模板内的模板类型匹配对应的发送格式`

所需字段

- Webhook地址

获取方式

1. 在群聊中创建自定义机器人
2. 选择“通知型机器人”
3. 输入名称及描述得到该机器人的Webhook地址

![](/media//202401/image-20230308150619756_1706236202.png)

#### 邮件

```
邮件默认开启账户密码验证
默认开启SSL加密
大部分邮箱服务商需要生成专属密码
```

所需字段

- SMTP发件服务器主机： 如smtp.qq.com
- 端口号 不加密的SMTP端口号一般是25 通过SSL加密的端口号一般是465
- SSL加密：需要根据邮箱提供商选择是否进行SSL加密
- 发件账户 1231233@qq.com
- 密码 xxxxxx

### 通过手机号获取ID

此处接口已经写好，后续需要接入个人中心进行手机号绑定管理

目前可调用 企业微信 钉钉 飞书 三个平台，云之家是群组机器人无需获取第三方UserId

接口地址：`http://127.0.0.1:8094/orbit/workflow/msgThirdParty/queryUserId`

调用方法：`POST`

所需参数：

| 参数名称   | 参数描述         | 是否必须 | 参数类型 |
| ---------- | ---------------- | -------- | -------- |
| phone      | 需要绑定的手机号 | 是       | String   |
| lightAppId | 绑定所用的轻应用 | 是       | String   |

返回参数

| 参数名称    | 参数描述     |      |
| ----------- | ------------ | ---- |
| success     | 查询成功数目 |      |
| successList | 查询成功列表 |      |
| fail        | 查询失败数目 |      |
| failList    | 查询失败列表 |      |

调用示例：

```json
{
    "phone": "15999576525",
    "lightAppId":"301581300622426112"
}
```

返回体示例：

```json
{
    "code": 200,
    "message": "success",
    "data": {
        "2": {
            "fail": 0,
            "successList": {
                "15999576525": "XuJingLing"
            },
            "success": 1,
            "failList": {}
        },
        "3": {
            "fail": 1,
            "successList": {},
            "success": 0,
            "failList": {
                "15999576525": null
            }
        },
        "4": {
            "fail": 0,
            "successList": {
                "15999576525": "67ff87a7"
            },
            "success": 1,
            "failList": {}
        },
        "5": {
            "fail": 0,
            "successList": {},
            "success": 0,
            "failList": {}
        }
    }
}
```

## 模板管理

### 模板分类

#### 全文模板

以文本的形式发送到各平台，发送之前如果平台支持markdown文本格式，会先转换一次markdown格式再向平台发送。

#### 链接模板

用户点击消息卡片即可跳转到对应的消息详情页面，需要`msg_url`字段不为空

#### 报表模板

将报表文件发送到各平台，需要`content_attachment`字段不为空

#### 其他模板

目前其他模板就是以全文模板形式发送到各个平台

#### 平台效果

- 钉钉（从左到右，依次是图文模板、链接模板、全文模板和报表模板）

- 企业微信（从左到右，依次是图文模板、链接模板、全文模板和报表模板）

- 飞书（从左到右，依次是图文模板、链接模板、全文模板和报表模板）

- 注：飞书不支持群发文件，因此此处的报表模板实际上是复用链接模板

### 模板填充

待更新