跳到主要内容
版本:1.2.0

消息模块

概述

基础的消息模块,各推送方式均基于这个模块进行扩展和管理。

可以建立多种类型的消息推送渠道和方式,消息推送以任务的形式进行管理。(可视化配置页可自行扩展)

数据库表

任务表

名称含义
_id任务id,系统自动生成
name任务名
type推送任务类型
pushAddress推送地址
triggerHook触发时机
surveys绑定的问卷id,为空则通用
ownerId任务创建者id

任务Log表

名称含义
_id推送记录id,系统自动生成
request推送的body数据
response响应的数据
statushttp状态码

API

创建推送任务

POST /api/messagePushingTasks

Request

名称含义类型是否必填默认值
name任务名称StringY
type任务类型StringY
pushAddress推送地址http | ...Y
triggerHook触发时机response_inserted | ...Y
surveys问卷IDsString[]N[]

Response

名称含义类型
taskId任务IDString

示例

{
code: 200,
data: {
taskId: ...,
}
}

扩展

通信类型

1、类型定义

enums\messagePushing.tsMESSAGE_PUSHING_TYPE 定义扩展的类型。

2、通信逻辑

utils 里扩展通信逻辑实现,如 utils/httpRequest.ts

触点事件

1、类型定义

enums\messagePushing.tsMESSAGE_PUSHING_HOOK 定义扩展的类型。

2、事件逻辑

在message模块实现逻辑,如 runResponseDataPush 供外部模块调用。