工单开放能力详细说明

工单触发器、SLA、画布三方目标和通知接口的企业侧格式约束。

工单开放能力

调用说明

开放能力是指，在工单系统中将工单的部分能力开放，能让第三方介入到工单的流程中。目前支持触发器和SLA。

触发器开放能力

触发器-条件接口

说明：用于触发器中触发工单范围、触发器条件中的条件选项

请求方式：POST

请求字参数

参数	类型	参数说明
ticketId	Long	工单id
triggerName	String	触发器名称
triggerId	Long	触发器id

{
    "ticketId":123,
    "triggerName":"触发器名称",
    "triggerId":123
}

响应字段

参数	类型	参数说明
code	Long	响应码 200-代表成功；其他-代表失败
message	String	响应信息
result	Boolean	响应结果 true-满足条件;false-不满足条件

{
    "code":200,
    "message":"success",
    "result":true
}

触发器-第三方通知接口

说明：用于触发器中执行操作中的第三方通知

请求方式：POST

请求字段

参数	类型	参数说明
ticketId	Long	工单id
triggerName	String	触发器名称
triggerId	Long	触发器id

{
    "ticketId":123,
    "triggerName":"触发器名称",
    "triggerId":123
}

响应字段

(触发器对响应结果不关心，只负责触发；如果要返回结果，可以参考如下格式返回)

参数	类型	参数说明
code	Long	响应码 200-代表成功；其他-代表失败
message	String	响应信息
result	Boolean	响应结果 true-满足条件;false-不满足条件

{
    "code":200,
    "message":"success",
    "result":true
}

SLA开放能力

SLA-条件接口

说明：用于SLA服务目标中筛选条件中的条件选项

请求方式：POST

请求字段

参数	类型	参数说明
ticketId	Long	工单id
slaName	String	SLA名称
slaId	Long	SLA的id

{
  "ticketId":12313,
  "slaName":"sla名称",
  "slaId":123
}

响应字段

参数	类型	参数说明
code	Long	响应码 200-代表成功；其他-代表失败
message	String	响应信息
result	Boolean	响应结果 true-满足条件;false-不满足条件

{
    "code":200,
    "message":"success",
    "result":true
}

SLA-第三方服务目标接口

说明：用于SLA服务目标中选择第三方服务目标设置

请求方式：POST

请求字段

参数	类型	参数说明
ticketId	Long	工单id
slaName	String	SLA名称
slaId	Long	SLA的id

{
  "ticketId":123123,
  "slaName":"sla名称",
  "slaId":123
}

响应字段

参数	类型	是否必填	参数说明
code	Long	Y	响应码 200-代表成功；其他-代表失败
message	String	Y	响应信息
result	ObjectArray	Y	响应结果（对象数据）

result字段说明：

参数	类型	是否必填	参数说明
name	String	Y	sla目标节点名称
type	String	Y	sla目标节点类型
time	List	Y	提醒时间点
reminder	Object	Y	提醒数据

reminder字段说明：

参数	类型	是否必填	参数说明
actionSettings	ObjectArray	Y	提醒渠道
target	Object	Y	提醒对象

actionSettings字段说明：

参数	类型	是否必填	参数说明
action	Long	Y	1-邮件提醒；2-短信提醒；4-站内通知；5-第三方接口通知
value	String	N	第三方接口通知时才有值，比如第三方通知的接口地址

target字段说明：

参数	类型	是否必填	参数说明	备注
target	Boolean	N	受理人	这3个至少得有一个有值
creator	Boolean	N	发起人	这3个至少得有一个有值
custom	Boolean	N	自定义坐席	这3个至少得有一个有值
customTargets	LongArray	N	自定义坐席的id	设置为自定义时，customTargets传坐席id

{
  "code":200,
  "msg":"success",
  "result":[
    {
      "name":"目标1",
      "type":"create",
      "time":1690192205210,
      "reminder":{
        "actionSettings":[
          {
            "action":5,
            "value":"[http://abc.com](http://abc.com)"
          },{
            "action":1
          }
        ],
        "target": {
          "target": true,
          "creator": true,
          "custom": true,
          "customTargets": ["6281062"]
        }
      }
    },
    {
      "name":"目标2",
      "type":"apply",
      "time":1690192205210,
      "reminder":{
        "actionSettings":[
          {
            "action":4
          },{
            "action":1
          }
        ],
        "target": {
          "target": false,
          "creator": false,
          "custom": true,
          "customTargets": ["6281062"]
        }
      }
    }
  ]
}

SLA-第三方通知接口

说明：用于SLA中提醒节点中的第三方通知

请求方式：POST

请求字段

参数	类型	参数说明
ticketId	Long	工单id
slaName	String	SLA名称
slaId	Long	SLA的id
content	String	工单内容
title	String	工单标题
priority	Long	工单优先级 2-低；5-一般；8-紧急；10-非常紧急
name	String	SLA目标节点名称
responseTime	String	服务目标响应时间；例如n分钟，n小时，n天；只有在系统设置目标里才有这个字段返回；第三方服务目标不会有这个字段

{
  "ticketId":123,
  "slaName":"sla名称",
  "slaId":123,
  "content":"工单内容",
  "title":"工单标题",
  "priority":5,
  "name":"首次响应",
  "responseTime":"2分钟"
}

响应字段

(触发器对响应结果不关心，只负责触发；如果要返回结果，可以参考如下格式返回)

参数	类型	参数说明
code	Long	响应码 200-代表成功；其他-代表失败
message	String	响应信息
result	Boolean	响应结果 true-满足条件;false-不满足条件

{
    "code":200,
    "message":"success",
    "result":true
}

画布开放能力

画布-sla三方目标

说明：用于获取三方sla目标配置

请求方式：POST

响应字段说明：非200都视为失败，超时时间500ms

请求参数

参数	类型	参数说明
ticketId	Long	工单id
processName	String	流程名称
nodeName	String	节点名称

{
    "ticketId": 21746271632158,
    "processName": "test",
    "nodeName": "A"
}

响应参数

参数	类型	参数说明
name	Long	自定义名称
type	String	自定义类型
time	Long	提醒时间
reminder	Object	提醒对象action 1-邮件提醒 2-短信提醒 3-所有都提醒 4-站内通知 5-第三方接口通知

{
    "code": 200,
    "result": [
        {
            "name": "name1",
            "type": "defined",
            "time": 123,
            "reminder": {
                "actionSettings": [
                    {
                        "action": 1,
                        "value": ""
                    },
                    {
                        "action": 5,
                        "value": "http://example/notify"
                    }
                ],
                "target": {
                    "creator": true,
                    "target": false,
                    "custom": false,
                    "customTargets": [

                    ]
                }
            }
        }
    ]
}

画布-sla三方通知

说明：用于三方slax消息通知

请求方式：POST

响应字段说明：非200都视为失败，超时时间500ms

请求参数

参数	类型	参数说明
ticketId	Long	工单id
title	String	工单标题
priority	Integer	优先级
content	String	工单内容
processName	String	流程名称
nodeName	String	节点名称
name	String	sla目标name
slaNodeType	String	sla目标type

{
    "title": "aa-3",
    "priority": 5,
    "ticketId": 21746271632158,
    "content": "31",
    "processName": "test",
    "nodeName": "A"
    "name":"name1",
    "slaNodeType":"defined"
}

工单开放能力详细说明

目录