基本用法 - 网易七鱼 API

第一步：配置支持同步的字段

登录七鱼客服系统超级管理员账号，在应用 -> 工单系统 -> 工单字段同步，配置字段同步任务。

第二步：字段同步的使用

编辑设置过的字段，触发字段同步功能。

同步地址：第三方应该提供一个 http或https 格式的 url 作为事件接收的地址，如: http://xxxx或https://xxxx。请求的Content-Type:application/json;charset=utf-8

为了方便做完整性校验，七鱼请求该 url 时，会在参数中增加 checksum 参数，其具体计算和校验规则参考通用说明-数据校验

接收参数：七鱼会以【POST】方式推送数据，且所有数据在请求体内，因此你需要看以下关于数据的说明。

参数名称	类型	说明
fieldId	Long	自定义字段ID
fieldName	String	自定义字段名称
fieldType	String	字段值类型（TEXT：文本；DATEBOX：时间选择器；CHECKBOX:多选框；CASCADE:级联选择框）
fieldValue	String	当前触发字段值

请求示例：当任务触发字段只有一个时：

{
	"worksheet":{
		"fieldId":1,//自定义字段ID
		"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匹配字段。