# 统一消息推送
统一消息推送可以实现将七巧低代码发送至企业微信的消息卡片,同步推送到指定第三方服务(以下统称为消息接收方)。由消息接收方决定消息的展现方式。
通过接口URL向目标地址推送消息内容,实现跨平台的消息内容同步。
# 配置说明
名词 | 说明 |
---|---|
事件名称 | 自定义事件名称,用于区分不同推送事件。 |
appid | 由消息接收方指定给七巧低代码的唯一身份标识,用于区分其他的消息推送方。 |
appSecret | 由消息接收方指定给七巧低代码的凭证密钥,用于接口签名使用。 |
接口URL | 消息接收方接收推送请求的访问协议和地址。 |
主页URL | 消息接收方接收审批流程消息完成审批后默认跳转的链接地址。 |
推送信息 | 选择数据来源并将其推送至接口URL。 |
注: 消息推送事件,将生成唯一的flowId。当创建多个推送事件时,可通过flowId进行区分。
# 操作说明
第一步:登录七巧管理端,点击集成中心-API管理-统一消息发送
第二步:将对应参数填充入对应输入框内,并保存
第三步:保存完成后,当前企业下的所有推送信息将按照指定格式推送至指定URL内
# 时序图
# 推送示例
七巧向消息接收系统推送的内容示例。
# 创建流程类型
接口地址 /task/external/flow/create
接口方法 POST
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
flowName | 流程名称 | String | 是 | |
extraFields | 自定义拓展字段 | List | 否 | 用于待办列表展示使用 |
{
"flowName": "产品部报销单",
"extraFields": [
{
"fieldKey": "money",
"fieldName": "报销金额"
}
]
}
返回参数
参数名 | 中文描述 | 类型 | 说明 |
---|---|---|---|
msg | 对返回码的文本描述内容 | String | |
code | 返回码 | Int | |
data | flowId:流程唯一ID | String |
{
"msg": "执行成功",
"code": 0,
"data": {
"flowId": "1518403714601885697"
}
}
# 创建单据
接口地址 /task/external/createTask
接口方法 POST
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
workNum | 工单号 | String | 是 | 工单在七巧的唯一标识号 |
flowId | 流程ID | String | 是 | 流程生成的ID,可作为流程唯一标识 |
flowName | 流程名称 | String | 是 | 流程ID对应的流程名称 |
bizInstanceId | 业务流程实例id | String | 是 | 流程实例化的唯一标识号 |
bizNodeId | 业务节点id | String | 是 | 用于标识当前流程实例节点的唯一标识 |
bizTaskId | 单据ID | String | 是 | 用于标识当前单据的唯一标识,每条单据对应一个唯一标识 |
currentNode | 业务节点名称 | String | 否 | |
title | 工单标题 | String | 是 | |
taskType | 单据类型 | Number | 是 | 0:待办,1:待阅 |
handler | 当前处理人的用户ID | String | 是 | 企业微信ID |
handlerName | 当前处理人的用户姓名 | String | 是 | |
applicantName | 工单申请人姓名 | String | 是 | |
preHandlerName | 上一处理人姓名 | String | 否 | |
formUrl | 七巧提供工单处理页面的Url | String | 是 | |
priority | 优先级别 | Number | 是 | 0:低,1:中,2:高 |
createDate | 创建时间 | Number | 是 | 时间戳,单位毫秒 |
extraJson | 预留信息(json) | String | 否 | 扩展字段信息,json字符串形式 |
[{
"bizTaskId": "1553038444628619299",
"workNum": "B2888220700114",
"flowId": "1522872123143737345",
"flowName": "请假申请",
"bizInstanceId": "1553038444628619265",
"bizNodeId": "1553038444628619266",
"currentNode": "审批",
"title": "张三请假申请--提交申请",
"taskType": 0,
"businessType": 0,
"businessMode": "HR",
"handler": "wuzong",
"handlerName": "吴总",
"applicantName": "张三",
"preHandlerName": "李副总",
"formUrl": "http://www.baidu.com",
"createDate": 1650606662038,
"priority": 0,
"extraJson":"{\"age\":\"14\",\"name\":\"张三\"}"
}]
返回参数
参数名 | 中文描述 | 类型 | 说明 |
---|---|---|---|
msg | 对返回码的文本描述内容 | String | |
code | 返回码 | Int | |
data | 返回结果集 | String | |
-bizTaskAndTaskId | bizTaskId和待办单据Id键值对 | String | 需要业务系统进行保存,该参数为待办单据唯一id,生成规则为:appid_bizTaskId |
{
"msg": "执行成功",
"code": 0,
"data": {
"bizTaskAndTaskId":
{"1553038444628619299":"1517383508911906817_1553038444628619299"}
}
}
1 / 0