工单自定义字段同步推送
工单触发字段变化后,七鱼向企业侧推送字段信息并接收企业返回字段值的格式说明。
基本用法
- 第一步:配置支持同步的字段。
- 第二步:配置字段同步地址并处理七鱼推送。
- 同步地址:第三方应该提供一个
http或https格式的 URL 作为事件接收地址,例如http://xxxx或https://xxxx。请求的Content-Type为application/json;charset=utf-8。 - 接收参数:七鱼会以
POST方式推送数据,所有数据均在请求体内。
| 参数名称 | 类型 | 说明 |
|---|---|---|
fieldId | Long | 自定义字段 ID |
fieldName | String | 自定义字段名称 |
fieldType | String | 字段值类型:TEXT 文本;DATEBOX 时间选择器;CHECKBOX 多选框;CASCADE 级联选择框 |
fieldValue | String | 当前触发字段值 |
示例
请求示例
当任务触发字段只有一个时:
{
"worksheet": {
"fieldId": 1,
"fieldName": "触发字段",
"fieldType": "TEXT",
"fieldValue": "fieldValue"
}
}或:
{
"worksheet": {
"fieldId": 1,
"fieldName": "触发字段",
"fieldType": "DATEBOX",
"fieldValue": "1606287144574"
}
}或:
{
"worksheet": {
"fieldId": 1,
"fieldName": "触发字段",
"fieldType": "CHECKBOX",
"fieldValue": "选项1;选项2"
}
}或:
{
"worksheet": {
"fieldId": 1,
"fieldName": "触发字段",
"fieldType": "CASCADE",
"fieldValue": "{\"id\":1030847,\"path\":\"1111/222/333\",\"idpath\":[1030845,1030846,1030847]}"
}
}当任务中配置有多个触发字段时,每当触发字段内容被修改,就会将所有触发条件进行参数拼接并触发任务。fieldValue 可能为空。请求参数格式如下:
{
"worksheet": [
{
"fieldName": "触发字段2",
"fieldType": "TEXT",
"fieldValue": "",
"fieldId": 48104
},
{
"fieldName": "触发字段1",
"fieldType": "TEXT",
"fieldValue": "触发内容1",
"fieldId": 46235
}
]
}返回示例
{
"code": 200,
"result": [
{
"fieldId": 2,
"fieldName": "fieldName1",
"fieldValue": "fieldValue1"
},
{
"fieldId": 3,
"fieldName": "多选内容",
"fieldValue": "选项1;选项2"
}
]
}响应码为 200 表示请求成功。fieldId 或 fieldName 至少返回其中一项,七鱼优先根据 fieldId 匹配字段。
这篇文档有帮助吗?
工单开放能力详细说明
工单触发器、SLA、画布三方目标和通知接口的企业侧格式约束。
创建工单
代访客创建工单,支持普通工单(OpenAPI 来源)和邮件工单(fromType=4)。 **参数与工单类型** - uid 与 userMobile 二选一。 - 普通工单的 staffId 必填:-1 代表访客自助提交,正数代表发起坐席,且该坐席必须有效并属于本企业。 - 邮件工单的 uid 和 userEmail 必填,不使用 staffId 和受理目标规则。 **受理目标规则** 1. 未使用自动流转模板时,优先使用接口传入的 targetStaffId、targetGroupId,未传的字段可由模板预设补充。 2. 若最终没有有效受理目标,staffId 为正数时会自动成为受理人,staffId=-1 时则创建失败。 3. 未指定模板(templateId=0)时,staffId=-1 必须传 targetStaffId、targetGroupId 中的至少一个;staffId 为真实坐席时两者可不传,默认由 staffId 受理。 4. 使用自动流转模板时,接口传入的 targetStaffId、targetGroupId 仍会先进行有效性校验,但在实际分配时会被模板流程覆盖。 5. 部分企业若将非自动流转模板的受理组和受理人同时配置为必填,则两者最终都必须有值;同时指定受理组和受理人时,受理人必须属于该组。 **幂等与附件** - uniqueId 最长 32 字符,重复提交时返回已创建的工单 ID。 - 附件最多 5 个、总大小不超过 50 MB;type=1 为 Base64 图片上传后生成 URL,type=2 为 URL 直接使用。