您好，欢迎使用udesk字段推送功能。

基本用法

第一步：配置支持推送的字段

登陆Udesk客服系统管理员账号，在 管理中心 -> 管理 -> 字段推送，配置基本属性。

第二步：字段推送的使用

编辑设置过的字段，触发字段推送功能。

注意事项

URL协议

字段推送URL目前仅支持https协议的链接。

字段支持

工单自定义字段及客户字段。字段推送请求方式POST请求。

推送数据说明

Udesk系统会监听设置的字段值是否发生变化，文本框类型字段光标进入时记录初始值，失去焦点后对比前后值变化，如果值有变化，调用字段推送设置接口。下拉类型的自定义字段，值变化即触发字段推送功能。

也可以设置在呼叫中心弹屏和IM有新的会话时推送字段。

推送参数说明

自定义字段

参数名称	类型	值	说明
TextField_xxx	String	字符串	文本类型自定义字段
SelectField_xxx	Array	[{value: "0", text: "北京市"}, {value: "0", text: "海淀区"}]	数组嵌套json

客户字段

参数名称	类型	值	说明
nick_name	String	字符串	客户名称
cellphone	Array	[{content:'159xxxx'},{content:'159xxxx',id:'123'}]	电话数组，更改电话触发
email	String	'udesk@udesk.cn'	更改主邮箱或副邮箱触发
other_emails	Array	['udesk@udesk.cn','udesk2@udesk.cn']	更改主邮箱或副邮箱触发
description	String	字符串	描述
organization_id	String	字符串	公司id
tags	String	'标签,标签2'	逗号分割的标签名称
level	String	'normal','vip'	等级
organization	String	'xxxxx有限公司'	公司名称
lang	String		语言
owner_group_id	Number		负责组ID
owner_id	Number		负责人ID

工单字段

参数名称	类型	值	说明
subject	String		工单标题
content	String		工单内容
customer.open_api_token	String		客户token
customer.weixin_openid	String		微信open_id
customer.weibo_openid	String		微博open_id
customer.web_token	String		客户web_token
customer.sdk_token	String		客户sdk_token
customer.email	String		客户邮箱
customer.cellphone	Array		客户电话
assignee_id	Number		负责人id
agent_group_id	Number		负责组id
priority_id	Number		优先级
status_id	Number		状态
tags	String		标签

其他参数

下面这些参数需要特定的时机才有

参数名称	类型	何时出现	说明
phoneNumber	String	弹屏	呼入或者呼出的电话
web_token	String	IM新会话且是web端发起聊天
weixins	Array<String>	IM新会话且是微信发起聊天
weibos	Array<String>	IM新会话且是微博发起聊天
sdk_token	String	IM新会话且是sdk发起聊天
weixin_minis	Array<String>	IM新会话且是小程序发起聊天
conversation_id	Number	弹屏
im_sub_session_id	number	IM新会话，IM工作台客户编辑
wechat	Json	当前IM新会话且是微信公众号时推送信息	appid 公众号ID;客户openid
newweibo	Json	当前IM新会话且是微博时推送信息	appid 微博账号ID;客户ID
wechat_minis	Json	当前IM新会话且是微信小程序时推送信息	appid 小程序公众号ID;客户openid

发送值示例

    //ticket
    {
        ticket:{
            SelectField_xxx:[{value: "0", text: "北京市"}, {value: "0", text: "海淀区"}],
            id:1//如果不存在id则值为null,
            key:'xxxxxxx'
        }
    }
    //customer
    {
        customer:{
            cellphone:[{content:'159xxxx'},{content:'159xxxx',id:'123'}],
            id:1//如果不存在id则值为null,
            key:'xxxxxxx'
        },
        phoneNumber: 'xxxxxxx',  //仅在弹屏时
        web_token: 'xxxxxx' //IM新会话且是通过web端发起
        wechat: {
            appid: 'xxxxxx', // 公众号ID
            openid: 'xxxxxx' // 客户openid
        },
        newweibo: {
            appid: 'xxxxxx', // 微博ID
            openid: 'xxxxxx' // 客户ID
        },
        wechat_minis: {
            appid: 'xxxxxx', // 小程序公众号ID
            openid: 'xxxxxx' // 客户openid
        }
    }

接收参数说明

自定义字段

参数名称	类型	值	说明
TextField_xxx	String	字符串
SelectField_xxx	Array	['0','1']	选项id数组

工单字段

参数名称	类型	值	说明
subject	String	字符串	工单主题
content	Html	富文本	工单描述
customer_id	Num	数值	工单客户ID
priority_id	Num	数值	优先级ID
status_id	Num	数值	状态ID
tags	String	字符串	逗号分割的标签名称
agent_group_id	Num	数值	负责组ID
assignee_id	Num	数值	负责人ID，负责者和负责人需要关联

客户字段

参数名称	类型	值	说明
nick_name	String	字符串	客户名称
cellphones_attributes	Array	['159xxxx','159xxxx']	电话数组，更改电话触发
email	String	'udesk@udesk.cn'	更改主邮箱或副邮箱触发
other_emails	Array	['udesk@udesk.cn','udesk2@udesk.cn']	更改主邮箱或副邮箱触发
description	String	字符串	描述
organization_id	String	字符串	公司id
tags	String	'标签,标签2'	逗号分割的标签名称
lang	String	'zh-cn'	客户语言码
owner_group_id	Num	数值	负责组ID
owner_id	Num	数值	负责人ID
level	String	vip/normal	客户等级

返回值示例

    {
        code: 1000,  //成功
        error:''    //错误信息
        ticket:{
            SelectField_xxx:['0','1'],
            subject:'字段推送'
        }
    }
    {
        code: 1000,   //成功
        error:''     //错误信息
        customer:{
            SelectField_xxx:['0','1'],
            cellphones_attributes:['159xxxx','159xxxx']
        }
    }