工单接口对接详细说明

工单流程调用企业接口、第三方条件和接口调用节点的接入说明。

接口对接

该接口用于工单对接，七鱼系统通过该接口向第三方系统获取信息。例如用户信息，包括访客VIP级别，访客UID，访客CRM信息等，通过参数eventType进行区分不同场景下的调用。

对接URL配置在七鱼系统中：系统管理》扩展与集成》CRM信息对接》工单对接接口URL

参数eventType类型说明：

参数值	参数说明
1	邮件工单通过邮件收件人地址+发件人地址获取访客CRM信息
2	流程管理-条件节点中的第三方条件
3	画布流程-接口调用节点

七鱼服务器向第三方接口请求信息时，采用密钥安全认证机制，保证第三方系统的信息安全。

数据校验

接口鉴权参考通用说明 - 数据校验

调用说明

本接口只支持POST请求；

本接口请求Content-Type类型为：application/json;charset=utf-8;

本接口返回类型为JSON，同时进行UTF-8编码。

curl请求样例如下

eventType=1对接事件

说明：邮件工单通过邮件收件人地址+发件人地址，获取访客用户信息，包括访客VIP级别、访客UID、crm信息

curl -X POST \
  '[http://www.xxx.com/api/ticket/crm/info?checksum=f570a5eb049eb803b086e45829b07e48&time=1511832531](http://www.xxx.com/api/ticket/crm/info?checksum=f570a5eb049eb803b086e45829b07e48&time=1511832531)' \
  -H 'content-type: application/json;charset=utf-8' \
  -d '{
    "eventType": 1,
    "sender": "some@163.com",  //发件人邮件地址
    "receiver": "other@163.com"  //收件人邮件地址
  }'

eventType=2对接事件

说明：流程管理-条件节点中的第三方条件

curl -X POST \
  '[http://www.xxx.com/api/ticket/crm/info?checksum=f570a5eb049eb803b086e45829b07e48&time=1511832531](http://www.xxx.com/api/ticket/crm/info?checksum=f570a5eb049eb803b086e45829b07e48&time=1511832531)' \
  -H 'content-type: application/json;charset=utf-8' \
  -d '{
    "eventType": 2,
    "ticketId": 123123,  //工单id
    "foreignId": "",  //用户uid
    "processName": "流程名称", //流程名称
    "nodeName": "节点名称"  //节点名称
    "nodeName": "节点名称"  //节点名称
    "processId":1,        //流程id
    "nodeExecRecordId":456, //节点执行记录id
    "conditionLineName":"条件组名称",   //条件组名称
    "conditionLineId":789             //条件组id
  }'

eventType=3对接事件

说明：流程管理-接口调用节点

请求参数具体根据接口调用节点中的选择参数确定

curl -X POST \
  '[http://www.xxx.com/api/ticket/crm/info?checksum=f570a5eb049eb803b086e45829b07e48&time=1511832531](http://www.xxx.com/api/ticket/crm/info?checksum=f570a5eb049eb803b086e45829b07e48&time=1511832531)' \
  -H 'content-type: application/json;charset=utf-8' \
  -d '{
    "eventType": 3,
    "id": 123123,  //工单id
    "foreignID": "",  //用户uid
    "processName": "流程名称", //流程名称
    "processNodeName": "节点名称"  //节点名称
  }'

响应样例如下

本接口返回的数据中，code返回200代表成功

本接口返回的数据中，message可用于code非200，即响应错误时的说明

本接口返回的数据中，result代表返回的数据内容，只有在code返回200时才生效

eventType=1对接响应

说明：eventType为1下的返回数据如下，其中data为String类型，data中字段具体说明参考CRM对接-crm轻量对接-参数说明(opens new window)

{
  "code": 200,
  "result": {
    "uid": "testUid",
    "viplevel": 3,
    "data": "[
{ \"key\":\"real_name\", \"value\":\"testname122601\" },
{ \"key\":\"mobile_phone\", \"hidden\":true, \"value\":\"14800000000\" },
{ \"key\":\"email\", \"value\":\"14800000000@163.com\" },
{ \"index\":0, \"key\":\"account\", \"label\":\"账号\", \"value\":\"zhangsan\" , \"href\":\"[http://example.domain/user/zhangsan](http://example.domain/user/zhangsan)\" },
{ \"index\":1, \"key\":\"sex\", \"label\":\"性别\", \"value\":\"先生\" },
{ \"index\":5, \"key\":\"reg_date\", \"label\":\"注册日期\", \"value\":\"2015-11-16\" },
{ \"index\":6, \"key\":\"last_login\", \"label\":\"上次登录时间\", \"value\":\"2015-12-22 15:38:54\" },
{ \"index\":7, \"key\": \"tags\", \"label\": \"标签\", \"value\": \"ceshi,测试一下\" },
{ \"index\":8, \"key\": \"leaderId\", \"value\": \"1001\" }
] ",
},
"message": "返回说明"
}

eventType=2对接响应

说明：流程管理-条件节点中的第三方条件的响应

result为true代表满足

result为false代表不满足

注意：如果请求中的interfaceType=1 即等待回调结果，那么整个过程分两步

第一步：提供一个通知

本次请求用于提供给业务侧一个通知，条件节点会一直等待，直到业务侧返回结果；

业务侧响应本次请求时，code要为200 和result要为true ，否则视为条件不满足处理，流程会继续往下执行；

第二步：等待回调结果

业务侧过了一段时间处理完成后，需要调用工单回调接口，用于获取条件节点结果是满足还是不满足，此时条件节点才根据具体结果继续往下执行，即满足会往满足分支流程执行；不满足会往不满足分支流程执行

{
  "code": 200,
  "result": true,
  "message": "返回说明"
}

eventType=3对接响应

说明：流程管理-接口调用节点

code为200代表满足

code非200代表不满足

不需要result

{
    "code":200,
    "message":"",
}

工单接口对接详细说明

目录