<br> [**点此进入芝麻小客服官网**](https://xiaokefu.com.cn/?source=kanyun_t_mia ) <br> >本功能支持小程序、小游戏及云客服H5、PC插件 支持传入的参数包括: 其中来源将显示在对话框顶部:(消息来自:XXX) ![](https://box.kancloud.cn/0d4f28a2cc3370b8cb5d3e026177122d_1184x274.png) 其余传入的数据,包括自定义客户字段,都将显示在接待界面客户资料区内; ``` 城市:city 省会:province 微信:weixin 电话:mobile 数字 年龄:age 数字 性别:sex 1或2 1是男 2是女 来源:source 备注:note 昵称:nickName 头像地址:avatarUrl 用户ID:openid 你可以通过这个id来指定唯一用户(只支持大小写字母、数字、下划线及中划线) 标签ID:tag_id ``` ### **小程序代码:** 小游戏使用方法类似,请参考[官方文档](https://developers.weixin.qq.com/minigame/dev/api/open-api/customer-message/wx.openCustomerServiceConversation.html) ``` <button type='default' session-from='{"source":"来源","city":"重庆","province":"重庆","weixin":"微信号","mobile":"13275261763","age":"22","sex":"1","note":"备注",“tag\_id”:“12312”}' open-type="contact" >传入参数演示</button> ``` **备注1:sesion-from最大字符串长度为1024,超过1024会被截取,导致json出错** **备注2:tag\_id 需要在芝麻小客服后台标签管理里面去获取对应的标签ID** ### **云客服H5代码:** 可以使用短连接传入参数,也可以使用长链接(短链接在浏览器内打开后的链接)传入参数; 假如你的长连接(就是渠道链接在浏览器中打开后的链接)为:https://xiaokefu.com.cn/api/mobileweb#/home?channel_id=78&channel_key=7810ic&wechatapp_id=14804 ,传参后为: ``` https://xiaokefu.com.cn/api/mobileweb#/home?channel_id=78&channel_key=7810ic&wechatapp_id=14804&city=1&province=1&weixin=1&mobile=13555555555&age=1&sex=1&source=1&note=1&nickName=昵称&avatarUrl=xxxx&openid=XXXXX ``` 短连接使用方法(不推荐):在短连接后,直接添加对应的参数; 假如你的短连接为:https://xiaokefu.com.cn/s/1012ivx ,传参后为: ``` https://xiaokefu.com.cn/s/1012ivx?city=1&province=1&weixin=1&mobile=13555555555&age=1&sex=1&source=1&note=1&openid=XXXXX ``` ### **PC插件代码:** PC插件需要再JS中调用方法ZM.setUserInfo()。出了支持默认字段,也支持自定义客户字段。不同情况下使用示例如下: 1、触发事件时设置 ~~~javascript function onClick(){ ZM.setUserInfo({ province: '湖北省', // 省会: city: '黄石市', // 城市 weixin: 'xxx666', // 微信 mobile: '159xxxxxxx8', // 电话 数字 age: '30', // 年龄 数字 sex: '1', // 性别:1是男 2是女 source: '微博推广', // 来源 note: '从微博引流过来的', // 备注 nickName: '哈哈9999', // 昵称 openid: '123412edefg345234', // 用户ID tag_id: '244406' }) } ~~~ 2、接入或者页面加载时设置 ~~~javascript document.addEventListener("ZMReady",function(event){ window.ZM.setUserInfo({ province: '湖北省', // 省会: city: '武汉市', // 城市 weixin: 'xxx123', // 微信 mobile: '159xxxxxxx8', // 电话 数字 age: '30', // 年龄 数字 sex: '1', // 性别:1是男 2是女 source: '官网', // 来源 note: '官网云客服咨询', // 备注 nickName: '官网客户', // 昵称 openid: '123412edefg341234', // 用户ID }) }) ~~~ 3、使用`window.ZM.loaded`判断是否初始化完成 -------- ### **自定义客户字段** 如果小客服提供的客户字段不能满足需求,可以使用自定义客户字段功能 功能位置:后台--自定义客户字段 ![](https://img.kancloud.cn/bb/4b/bb4b20361eec89de88c0078d55d26af8_1527x682.png) 1. 可以设置每个字段的显示隐藏 2. 可以增加、编辑、删除自定义字段;注意:自定义字段一旦增加,只能编辑名称,不能编辑类型、字段ID以及选项。 3. 可以调整显示的位置顺序; 4. 自定义字段可以传递,传递方式跟上面的方法一致。比如某自定义字段ID为:ziduan1、ziduan2;在小程序入口处的传递方式是 ``` <button type='default' session-from='{"ziduan1":"字段值1","ziduan2":"字段值2"}' open-type="contact" >传入参数演示</button> ``` H5、插件的传递方式跟原本的传递方式保持一致。 <video style="width: 100%; height: 100%; object-fit: fill" controls="controls" poster="https://box.kancloud.cn/67b3e862f9930f84f9b9629c8aa1dba5_1911x1072.jpg" > <source src="https://ossxkf.oss-cn-beijing.aliyuncs.com/zidingyiziduan.mp4" type="video/mp4" /> </video> -------- ### **查看自己传递的参数** 在传递参数后,可以进入网页端后台--客服消息界面内查看传递的参数: 步骤:从传递参数的客服入口内咨询,进入客服消息界面找到咨询者,在右侧资料区底部查看参数: ![](https://img.kancloud.cn/8f/57/8f574ed84b63cbd8fe3d47a62e6c2cac_1911x928.png) ------ 常见问题: 1:小程序传递过来的参数无效? * 请确认从含有参数的入口点击了客服按钮进入; * 请确认完全按照我们传递参数的格式,单引号双引号不能变; * 请确认没有开启云函数的消息推送功能,其中不包含打开客服事件; 2:小程序传递过来的参数为空? 请确认传递过来的变量有值。 3:VUE的uniapp开发的小程序,编译无法通过? session-from 是个json ,我们的文档时针对原生小程序写的,‘{{  }}’这个语法是原生微信小程序里的,uniapp使用的时VUE的语法,绑定值的方式和原生小程序的语法稍微有写区别。 ![](https://img.kancloud.cn/f4/d1/f4d181bdbf22212a92767bf18ec9ca47_1300x639.png) </h> </h> <br> <br> <br> <br><br> [**点此进入芝麻小客服官网**](https://xiaokefu.com.cn/?source=kanyun_b_mia ) 您有问题需要咨询的话,可以扫描下方二维码: </h> ![](https://img.kancloud.cn/04/a1/04a1fd65b5f5cfbc32ad431a32fabd2a_200x199.png) </h> </h>