回调配置

回调配置说明

回调是每刻提供的调用外部接口的功能，在【设置】->【回调管理】页面进行回调配置。

关键参数说明

配置参数说明

特殊说明

1. 加密秘钥：每刻在推送数据的时候，会通过加密方式生成签名，并放在请求头中。加签的秘钥暂时不支持修改，管理员可以点击每刻报销的“设置-安全设置-系统安全策略-账号管理”中获取到key和secret
2. 重试间隔：1s 5s 10s 30s 1m 2m 3m 4m 5m 6m 7m 8m 9m 10m 20m 30m 1h 2h

接口地址

企业在回调配置中自定义配置的回调地址

请求类型

企业在回调配置中自定义的请求类型

请求参数说明

特殊地，加签审批场景的场景事件（eventScenario）为APPROVAL，任务类型（taskActionType）为PROCESSING。

{
    "calloutParams": {
        "coverUser": "190013",
        "coverUserName": "张三",
        "eventTime": 1584444522722,
        "formCode": "MK_gxb191214601",
        "formDataCode": "BX18042824ZA8SG0",  
        "formName": "报销单打印",
        "formType": "REIMBURSE",
        "procInsId": "procInsId",
        "taskId": "taskId",
        "submitter": "190013",
        "submitterName": "张三",
        "eventScenario": "APPROVAL",
        "taskActionType": "COMPLETED",
        "taskAssignee": [
            "190013"
        ],
        "taskOwner": [
            "190013"
        ],
        "formSubType": "个人报销单",
        "formSubTypeBizCode": "BIZ123456",
        "taskName": "部门领导审批",
        "reason": "通过",
        "nominalOperator": "190013",
        "operatedByAdmin": false,
        "abnormal": false,
        "attachmentAll": [
            {
                "url": "https://...链接有效期7天",
                "fileName": "01.ng"
            },
            {
                "url": "https://...链接有效期7天",
                "fileName": "02.ng"
            }
        ],
        "taskAssigneeInfo": [
            {
                "taskAssigneeName": "林朝阳",
                "taskAssigneeId": "lzy665566"
            }
        ],
        "content": " 催办理由",
        "attachments": [
            {
                "url": "https://...链接有效期7天",
                "fileName": "1.txt"
            }
        ]
    }
}

返回参数说明

{
    "success":true,
  "errorMsg": "成功"
}

如果返回的结果是success为true，那么每刻会认为消息已经推送成功；其他情况，每刻认为消息推送失败，会再次推送。

回调类型归类

1. 流程开始类型的回调，taskAssignee 表示要处理这个待办的用户

2. 流程操作类型的回调，taskAssingee 表示实际操作的用户，taskOwner 表示任务之前的所有者

评论消息回调

因评论消息在流程的任何一节点都可以进行评论，这里规范评论消息的参数说明

请求参数说明：

{
    "formType": "PRECONSUME",
    "formDataCode": "PC200805UZVR5KW",
    "formCode": "MK20081302",
    "submitNum": "",
    "submitName": "James",
    "eventScenario": "Comment_Event",
  "formName": "报销单打印",
  "formSubTypeName":"1111",
  "formSubTypeBizCode":"BIZ159357",
  "taskName":"部门领导审批",
  "eventTime":15236554126,
  "procInsId": "procInsId",
  "taskId":"taskId",
    "content": " @James 申请单哦",
    "attachments": [{
        "url": "https://...链接有效期7天",
        "fileName": "1.txt"
    }],
    "receiveEmployeeIds": [
        ""
    ]
}

还款通知回调

回调场景：发送催还款通知

请求参数说明：

{
    "calloutParams": {
        "formType":"LOAN",
    "formSubTypeName":"linchaoyang的借款单2",
    "formDataCode":"LF2012251OQXQOLC",
    "formCode":"MK201210901",
    "settledTime":1608890226000,
    "taskActionType":"REPAYMENT_MESSAGE",
    "loanEmployeeName":"林朝阳",
    "formSubTypeBizCode":"FT2012251OOK92BK",
    "deductionAmount":30.00000,
    "owedAmount":70.00000,
    "loanEmployeeNo":"lzy665566",
    "formName":"abc",
    "eventTime":1609378797546,
    "approvedAmount":100.00000,
    "repaymentTime":1608890160013,
    "pendingAmount":10.00000
    }
}

行程调整通知

当行程作废的时候回发送该通知

请求参数说明

travelRoute: | 序号 | 字段名 | 类型 | 是否必须 | 说明 | | ---- | -------------- | ------- | -------- | ---------------- | | 1 | travelRouteCode | String | 是 | 行程唯一标志 | | 2 | userCode | String | 是 | 用户工号 | | 3 | startDate | Date | 是 | 开始时间 | | 4 | endDate | Date | 是 | 结束时间 | | 5 | departure | String | 是 | 出发地 | | 6 | destionation | String[]| 是 | 目的地 | | 7 | relationUsers | String[]| 否 | 关联人的员工号 |

{
    "calloutParams":{
        "operateAt":1610173858467,
        "formCode":"MK21010601",
        "formDataCode":"PC2101091D01AJ28",
        "formSubTypeName":"出差申请",
        "formName":"北京-上海出差申请",
        "formType":"PRECONSUME",
        "applicantEmployeeName":"张三",
        "applicantEmployeeId":"MK001",
          "changeType":"ABANDON",
        "submittedAt":1610173351882,
        "travelRoutes":[
            {
                "travelRouteCode":"TRC2101091D0QLMO0",
                "empId":"MK001",
                "startDate":1610173676075,
                "endDate":1610173677846,
                "departure":"北京市区",
                "destination":[
                    "上海市区"
                ],
                "relationUsers":[

                ]
            }
        ]
    }
}

单据作废回调

回调场景：作废单据是触发回调

配置：在回调管理中配置回调类型为“单据作废通知”对应的回调接口

请求参数说明：

和关键参数说明一致

修订记录

2020-06-02 返回参数由使用Code=ACK判断，改为success=true判断是否调用成功
2020-09-17 eventScenario 场景事件新增签收 SIGN

2020-12-31 taskActionType 任务类型新增还款通知 REPAYMENT_MESSAGE 并增加还款回调参数说明

2021-04-01 单据流程变更通知回调，增加审批流程中全部附件的参数；催办增加催办理由和附件信息参数

2021-04-27 新增回调类型归类

2021-05-30 新增SUBMIT类型回调，即每次提交动作都会发送提交类型回调消息，用于驳回到提单人清除待办

2021-08-17 新增单据作废回调类型

2021-08-24 SUBMIT类型回调参数中新增isFirstSubmission字段，判断是否为第一次提交

2021-12-23 新增合同变更回调