消息推送到第三方平台的接口定义
应用场景
客户如有自己的OA系统或第三方OA系统，需要在每刻配置外部接口，在发生消息通知的时候，每刻系统会推送到该接口。
接口限制
该接口只支持旗舰版
请求类型
POST
接口配置说明
管理员进入设置页面，在"消息管理"页面点击"消息属性设置"按钮进入配置页面。
然后点击"修改接口地址"按钮进入如下图页面。配置地址后，需要点击"接口校验"按钮。只有校验通过的地址才能点击"确定"按钮。点击"
确定"后即自动保存。
请求参数
参数说明
| 参数名称 |
类型 |
是否必填 |
参数说明 |
| msgId |
String(50) |
是 |
消息编号 |
| entCode |
String(50) |
是 |
企业编号 |
| receiveEntities |
List<ReceiveEntity> |
是 |
接受人员工工号列表 |
| formType |
String(50) |
否 |
单据类型 |
| formNo |
String(50) |
否 |
单据号 |
| procId |
String(50) |
否 |
流程实例编号 |
| taskId |
String(50) |
否 |
任务实例编号 |
| submitter |
String(50) |
否 |
消息发送人 |
| submitterJobNum |
String(50) |
否 |
消息发送员工工号 |
| msgType |
String(50) |
是 |
消息类型 |
| msg |
Message |
否 |
消息内容 |
ReceiveEntity 说明
| 参数名称 |
类型 |
是否必填 |
参数说明 |
| url |
String(50) |
否 |
接收人跳转连接 |
| pcUrl |
String(50) |
否 |
接收人跳转连接 |
| receiveJobNum |
String(50) |
是 |
接收人员工编号 |
Message 说明
| 参数名称 |
类型 |
是否必填 |
参数说明 |
| title |
String(500) |
是 |
标题 |
| body |
String(2000) |
是 |
消息体 |
msgType说明
msgType为枚举类型，分别为：
| 值 |
说明 |
| approval |
审批通知 |
| reject |
驳回通知 |
| cc |
抄送通知 |
| urge |
催办通知 |
| completed |
单据完成通知 |
| settling |
出纳通知 |
| forward |
转交提醒通知 |
| bill_collection |
票据催收通知 |
| process_node_notice |
流程节点通知 |
| expenses_notice |
账本费用通知 |
formType为枚举类型，分别为：
| 值 |
说明 |
| REIMBURSE |
报销单 |
| PRECONSUME |
申请单 |
| CONTRACT |
合同 |
| LOAN |
借款单 |
| REPAYMENT |
还款单 |
| INSTALLMENT |
分期付款单 |
参数样例
{
"msgId": "MSG_21319539899765827",
"entCode": "EC34VFIKCJ0VU9",
"receiveEntities": {
"submitter": "AAA",
"submitterJobNum": "wew"
},
"formType": "PRECONSUME",
"formNo": "MK19529898444802",
"procId": "9e4ac334-e599-11ed-ad99-e2c5a906e8ef",
"taskId": "9e4da97f-e599-11ed-ad99-e2c5a906e8ef",
"msgType": "approve",
"msg": {
"title": "您有【Sar 申请单】需要审批",
"body": "承担人：***\n事由：test\n金额：233.0\n单据号：MK23040012"
},
"jumpUrl": "receiptAction=approve&formType=preconsume&procTaskId=9e4da97f-e599-11ed-ad99-e2c5a906e8ef&formDataCode=PC21319529898444802"
}
响应参数
参数说明
| 参数名称 |
类型 |
是否必填 |
参数说明 |
| success |
boolean |
是 |
是否成功， true ｜ false |
| errorMsg |
String |
否 |
错误信息 |
参数样例
- 正常响应参数示例
{
"success": true,
"errorMsg": null
}
- 错误响应参数示例
{
"success": false,
"errorMsg": "单号不存在****"
}
修改记录
2023-04-28 新增