消息服务

1. 概况

消息途径分为邮件、短信、站内信、webhook4大类别。它包含了激发系统与用户交互的触发点类型，不同触发点在触发之后给用户反馈的消息模板，发送邮箱和短信的服务器配置信息。

消息服务用来选择某一个触发点对应选择的邮件模板、短信模板、站内信模板以及发送模式。用户可以根据需要，通过此功能，可以在忘记密码、添加/导入新用户、系统添加新功能、修改密码等过程中向不同成员发送邮件提醒。同时可以设置不同的邮件通知模式。

2. 消息服务列表

列表字段：

• 消息类型：由接收方的某些行为触发邮件发送的触发点类型。比如忘记密码、添加/导入新用户、项目停用、修改密码等。
• 说明：对触发类型的触发情景、适用场景的描述。
• 层级：发送设置生效的层级，包括平台层,组织层,项目层三个层级。
• 状态：消息类型的状态，分为启用,停用两种。启用状态下的消息类型会根据发送消息。
• 是否允许配置接收：设置是否允许用户自定义是否接收此类型的消息。

3. 修改发送设置

1. 进入平台管理，点击菜单“设置>通知>消息服务”，进入消息服务页面。

2. 选择你要修改发送设置的消息类型，点击操作栏的修改发送设置按钮，进入修改发送设置侧开页。

   发送设置：

   • 选择发送方式：您可以选择邮件、站内信、webhook、短信等4种发送方式。
   • 是否允许配置接收：设置是否允许用户自定义是否接收此类型的消息。
   • 重发次数：自动重发的次数，默认重发次数为3次。
   • 是否即时发送：选择触发该消息类型是否立刻发送。
   • 是否允许手动重发：邮件发送失败后，是否允许用户在消息日志面点击重发。
   • 是否为待办提醒：消息是否为待办。

3. 点击保存，保存修改。

3. 修改邮件模板

1. 点击点击操作栏的修改邮件模板按钮，打开修改邮件模板页面。

   必填字段：

   • 邮件主题：发送时邮件的主题。
   • 邮件内容：邮件的内容。 填写模板所需的文字和参数。模板中的参数变量通过${}进行替换，在发送时，将${}替换成对应的实际变量。 例如： 模板:`${username}`您好。 发送参数：`username=张三`。 发送信息：张三您好。 更多的变量信息，请查看变量说明

2. 点击保存，完成修改。

4. 修改站内信模板

1. 点击点击操作栏的修改站内信模板按钮，打开修改站内信模板页面。

   必填字段：

   • 站内信主题：发送时站内信的标题。
   • 站内信内容：站内信的内容。 填写模板所需的文字和参数。模板中的参数变量通过${}进行替换，在发送时，将${}替换成对应的实际变量。

   例如：
   模板:`${username}`您好。
   发送参数：`username=张三`。
   发送信息：张三您好。  
   

   • 更多的变量信息，请查看变量说明

2. 点击保存，完成修改模板。

5. 修改短信模板

1. 点击点击操作栏的修改短信模板按钮，打开修改短信模板页面。

   必填字段：

   • 短信内容：短信的内容。

2. 点击保存，完成修改模板。

6. 修改webhook模板

1. 点击点击操作栏的修改webhook模板按钮，打开修改webhook模板页面。

   必填字段：

   • webhook主题：发送时webhook的标题。
   • webhook容：webhook的内容。（仅支持text或者markdown文本格式） 填写模板所需的文字和参数。模板中的参数变量通过${}进行替换，在发送时，将${}替换成对应的实际变量。

   例如：
   模板:`${username}`您好。
   发送参数：`username=张三`。
   发送信息：张三您好。  
   

   • 更多的变量信息，请查看变量说明

2. 点击保存，完成修改模板。

6. 变量声明

以下是邮件、短信、站内信模板中可以使用的变量参数。

模板中的参数变量通过${}进行替换，在发送时，将${}替换成对应的实际变量。

例如：

邮件标题：验证邮件
邮件内容：
${userName}，您好！您正在进行邮箱验证，您本次请求的验证码为：${verifyCode}。
此验证码用于重置密码，XXX内有效。

7. 更多操作

• 使用Choerodon进行通知配置
• 查看消息发送日志
• 如何发送系统公告