<br> [**點此進入芝麻小客服官網**](https://xiaokefu.com.cn/?source=kanyun_t_mia ) <br> >本功能支持小程序、小游戲及云客服H5、PC插件 支持傳入的參數包括： 其中來源將顯示在對話框頂部：（消息來自：XXX）  其余傳入的數據，包括自定義客戶字段，都將顯示在接待界面客戶資料區內； ``` 城市：city 省會：province 微信：weixin 電話：mobile 數字 年齡：age 數字 性別：sex 1或2 1是男 2是女 來源：source 備注：note 昵稱：nickName 頭像地址：avatarUrl 用戶ID：openid 你可以通過這個id來指定唯一用戶（只支持大小寫字母、數字、下劃線及中劃線，且長度不能超過78個字符） 聯合ID：unionid 主要用于對接頁面等場景 標簽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 ``` 另外，如果有些參數（比如手機號等涉及用戶隱私的數據），不適合明文傳參，可以通過以下方法將參數加密后傳遞（僅H5云客服支持）： 1、將參數以json格式組裝，示例如下： ~~~ {"nickName":"咸魚","source":"咸魚測試","note":"note","mobile":"12345231234","avatarurl":"https://wechatapi.xiaokefu.com.cn/static/avatar/137.png"} ~~~ 2、將組裝好的json按RSA算法加密 **加密公鑰如下：** ~~~ -----BEGIN PUBLIC KEY----- MIIEIjANBgkqhkiG9w0BAQEFAAOCBA8AMIIECgKCBAEA5QPmUXQbm9mOjwQNvFQg yqFLyElBsGUR98lXAFa3sgHnUMkYDa8+ca1QNoF8sNzhT3Ed1YzvGvsXr74x42rS 3QDNkg4ZHOkH+Hv5e1BFeKkc3sAeQQ4OqEGsyAZlFFS0etwhlpjRGMqaBSbRIa9M WfGL8sVp4j+k2m7NbHDVYT9PvxgQHXNxiDnWLV14fzAZ4xPRGQ2F/oZp0EpBdAtG 5VeEm2hfYHy4LQslJsfdacgzjA1d7Y82ixojmX988LvMo5huWY/AQUdqTEKPp2u3 LKW59d39LyS+vLhsAVYWUu3rNa/Nto4zmNrlWElk+JjO75FG2vv84l5AmZEsnIwZ 0BaEqKXztxjNIAPbY+nVyfqcZFDKnbBUhybGy8feHJNHtotDAlX1YJT7N5jWp2T3 qDRqun8KdLpo+NuCDMEb9gynqdUYtWg6XesNA9WU0/g5s7gVwwa329OtMysSIEui xZGCxl44oT02WvWLhYRq6g2D4Yl9OwsBKyXLvMsiN4krHnoRkrSQdtYglpWayLrd U1cYD4lmB5HAkc40wiSauD/si+/XB12clMFmjLR5272/xHSJ02ECcBooVB6zCXrF YYpwUWzxnnmavZFaSnKcFEqWxxmcQWW2j9Y/MClhX4rxzrFDfxK+ZoK1N8ERxjbJ EeE+eqXR9+lKb3hsDrDwl5M9JeeBxtHZ040pQI5d02ZuCofTcjUZF5AIuujrmhkk 6DzgTd3i86D2IRcioUSpsz+gGFITPvvJ3oM9+W/PBBqLDDmz89VLGrxgGTDBkihh /LlvqbxAV4r3CivrissAcEdQ+Qm4RIjEGmy5xgE+ZD0SDAwBjF9OVOBJEilDu2uy 1FOOS+N4vi2EFLwVTrVVSD3mZQnNfaJNENytZG1xmhg5KQNRX48iYMG1K3ocID9t aYFPg6zG7dQQoYRa57EJ1TTdvaim0aw6bs9GUs54gQU9/h7ets01YFGHFESle7If FGCqiey+fUXGW8zXZDU+YdrXYMSvDVRcs4uttH7BQjlXpKG99phMoznPRT4etDB3 /pW45vxV4h4QoFMq8UPwZpBoox56XhRXY8CeakpIRERB3TaxkK+VJvEMj5PfGf/O tZ1AvBIxqEK4LNR7ZCLEoLnkzNbQNOeWAAvneU/yN+X2v6fw4t8iOcGRbvtCWhbn kOtAxrkmN1J/4ffssbrTGUciWAinfjI/HAgiB4e36RKOpJah8ypAMhhJFGqLadOC fxhRD4xSH09zhFMqn2k5knW1WPCIaz1n5ERWe3FpZUHr6KTOsu2PMaeWYcTXJVpE pSkMxwf43ckdhMoEQ8YEPsn2Zledy9P+tjtr4n7QE2Izd+Qew1FNIRnLVgAMdf7V DwIDAQAB -----END PUBLIC KEY----- ~~~ **加密后示例數據如下：** ~~~ no9WiTz6E1eEZMaykwUhyweUQzWZqZnMAZ0twdzFl/A1VL+U0hcuCJbAhpwrRdoyY9gdlbeJMmrHZE658p8jm5TH3iUAiW2++LJaE486RJ3VwZKIRZz11AstNlwpDgN/lpfHaWguVD+6OqrM9V5tDnqbiKrkKtt/hI7YjbSNMVlSRfEVEFjYLhtV2G8l+7ej8rdFk/gaSvb7jvQttPYDkXcD1i7K/Fa5EYleP5pFYNuxL3b52yl2JeZFzwoTzfPs87Vl19ikLmTLJIFOCq0u/Bgwa8OP066jCKrek6uwCPiuo/HBfaWGbYRFXqBLbch9gM4Cs0DJiHM3ia60mZ1icLbZUvVbwc7qFb8JnwjhGoKC7KjYa679HaipLql9mmCOFYV1OaGjcE68RszBMV50TgB/HzPu/BOcbKa2DW+NBl4L7YrAKVdF//nbL5v5xB4/p4+ih+dAZn2TWF0RWwjahpRn8Ebd8y/Zw1i/YonnmeH3hj7zXXGs3/tHY3Y4P8R+9yTpgNP+/mXkW190nLOZ4LLGm37DEhlbLS7xVKYKnxrqMPN/PlEcem34Fe4AYLNL1Ihjm7Kc39Na6Feuwsr8v4UP3zobcqrgIzq00Xh09Uxyk61zMnLj1iRQVQOaTi7RoT93F1SwlS6vkh2thLSCXPsXN5YbMN4/vQDvmKl0BObzacVyBBxkPOKvpca+HFcMSNCWZ1L4sT+aZGxenRjeGu6RQzfAxRKAhigX1Zd02b9rUr77272qCrZOI83Q/VVw0p/vlYbh6Us3UMQ/Xm7b++t/qKmNj9pC8zMIkJQBEiPdvLgK8GXh9BQ0uUmMRofozddbNbyUfXkXHV6Mln5CRtZ1Hi4mR3HeT7g+GLW2eiOd6XR9Z3UOg8GcvYa4Ld1PqGdpMS7gjC553f0AB4eVONcW92kGs2ihFzk3tW0s86l3mltTzyTD60OngmhiG2wGiUQC4/0a32jVJzJE2uj/Ry/y9Dj6qivpo+/DjquKOEtfolomEdruoimBE/wg8HhOdr/5Umo89OKk8qb+7JYWeLLb8iBXJ90HCxtQO70diwCmvZXhCSwrsZ1AoqQOBT8kcIIAvvLGRS7ZPx+bPBlxBK56WUY/G4N2xvmWOoePGmlBnBm0IYTP7FTNuMsY1o/gwTyufPcWVz4AKdL0MEpq2tL9qqhlNLbeRaTTgMvYiTB3V2UlCLOQ8NnU7i7eJUVOSsTu7bWcn34rRH+Xp5r4HCnasfMtJkCD924zP8QCEIULi6im+7Zugz0mXqgz6OOXVUZ8rFkSwdn8nbIeZ1sLDAcivfQN93CRYz/kbbjFNXr4Wm1EQAgmyaOABVuUBejG44MlAiZvBe6/o+JU3zj71g== ~~~ 3、將加密后的數據，先進行base64_encode，然后urlencode。示例數據如下： ~~~ no9WiTz6E1eEZMaykwUhyweUQzWZqZnMAZ0twdzFl%2FA1VL%2BU0hcuCJbAhpwrRdoyY9gdlbeJMmrHZE658p8jm5TH3iUAiW2%2B%2BLJaE486RJ3VwZKIRZz11AstNlwpDgN%2FlpfHaWguVD%2B6OqrM9V5tDnqbiKrkKtt%2FhI7YjbSNMVlSRfEVEFjYLhtV2G8l%2B7ej8rdFk%2FgaSvb7jvQttPYDkXcD1i7K%2FFa5EYleP5pFYNuxL3b52yl2JeZFzwoTzfPs87Vl19ikLmTLJIFOCq0u%2FBgwa8OP066jCKrek6uwCPiuo%2FHBfaWGbYRFXqBLbch9gM4Cs0DJiHM3ia60mZ1icLbZUvVbwc7qFb8JnwjhGoKC7KjYa679HaipLql9mmCOFYV1OaGjcE68RszBMV50TgB%2FHzPu%2FBOcbKa2DW%2BNBl4L7YrAKVdF%2F%2FnbL5v5xB4%2Fp4%2Bih%2BdAZn2TWF0RWwjahpRn8Ebd8y%2FZw1i%2FYonnmeH3hj7zXXGs3%2FtHY3Y4P8R%2B9yTpgNP%2B%2FmXkW190nLOZ4LLGm37DEhlbLS7xVKYKnxrqMPN%2FPlEcem34Fe4AYLNL1Ihjm7Kc39Na6Feuwsr8v4UP3zobcqrgIzq00Xh09Uxyk61zMnLj1iRQVQOaTi7RoT93F1SwlS6vkh2thLSCXPsXN5YbMN4%2FvQDvmKl0BObzacVyBBxkPOKvpca%2BHFcMSNCWZ1L4sT%2BaZGxenRjeGu6RQzfAxRKAhigX1Zd02b9rUr77272qCrZOI83Q%2FVVw0p%2FvlYbh6Us3UMQ%2FXm7b%2B%2Bt%2FqKmNj9pC8zMIkJQBEiPdvLgK8GXh9BQ0uUmMRofozddbNbyUfXkXHV6Mln5CRtZ1Hi4mR3HeT7g%2BGLW2eiOd6XR9Z3UOg8GcvYa4Ld1PqGdpMS7gjC553f0AB4eVONcW92kGs2ihFzk3tW0s86l3mltTzyTD60OngmhiG2wGiUQC4%2F0a32jVJzJE2uj%2FRy%2Fy9Dj6qivpo%2B%2FDjquKOEtfolomEdruoimBE%2Fwg8HhOdr%2F5Umo89OKk8qb%2B7JYWeLLb8iBXJ90HCxtQO70diwCmvZXhCSwrsZ1AoqQOBT8kcIIAvvLGRS7ZPx%2BbPBlxBK56WUY%2FG4N2xvmWOoePGmlBnBm0IYTP7FTNuMsY1o%2FgwTyufPcWVz4AKdL0MEpq2tL9qqhlNLbeRaTTgMvYiTB3V2UlCLOQ8NnU7i7eJUVOSsTu7bWcn34rRH%2BXp5r4HCnasfMtJkCD924zP8QCEIULi6im%2B7Zugz0mXqgz6OOXVUZ8rFkSwdn8nbIeZ1sLDAcivfQN93CRYz%2FkbbjFNXr4Wm1EQAgmyaOABVuUBejG44MlAiZvBe6%2Fo%2BJU3zj71g%3D%3D ~~~ 4、在H5云客服的鏈接中拼接**固定參數zhima_params**,將加密好的數據作為參數zhima_params的值，示例如下： ~~~ https://xiaokefu.com.cn/api/mobileweb#/home?channel_id=78&channel_key=7810ic&wechatapp_id=14804&zhima_params=no9WiTz6E1eEZMaykwUhyweUQzWZqZnMAZ0twdzFl%2FA1VL%2BU0hcuCJbAhpwrRdoyY9gdlbeJMmrHZE658p8jm5TH3iUAiW2%2B%2BLJaE486RJ3VwZKIRZz11AstNlwpDgN%2FlpfHaWguVD%2B6OqrM9V5tDnqbiKrkKtt%2FhI7YjbSNMVlSRfEVEFjYLhtV2G8l%2B7ej8rdFk%2FgaSvb7jvQttPYDkXcD1i7K%2FFa5EYleP5pFYNuxL3b52yl2JeZFzwoTzfPs87Vl19ikLmTLJIFOCq0u%2FBgwa8OP066jCKrek6uwCPiuo%2FHBfaWGbYRFXqBLbch9gM4Cs0DJiHM3ia60mZ1icLbZUvVbwc7qFb8JnwjhGoKC7KjYa679HaipLql9mmCOFYV1OaGjcE68RszBMV50TgB%2FHzPu%2FBOcbKa2DW%2BNBl4L7YrAKVdF%2F%2FnbL5v5xB4%2Fp4%2Bih%2BdAZn2TWF0RWwjahpRn8Ebd8y%2FZw1i%2FYonnmeH3hj7zXXGs3%2FtHY3Y4P8R%2B9yTpgNP%2B%2FmXkW190nLOZ4LLGm37DEhlbLS7xVKYKnxrqMPN%2FPlEcem34Fe4AYLNL1Ihjm7Kc39Na6Feuwsr8v4UP3zobcqrgIzq00Xh09Uxyk61zMnLj1iRQVQOaTi7RoT93F1SwlS6vkh2thLSCXPsXN5YbMN4%2FvQDvmKl0BObzacVyBBxkPOKvpca%2BHFcMSNCWZ1L4sT%2BaZGxenRjeGu6RQzfAxRKAhigX1Zd02b9rUr77272qCrZOI83Q%2FVVw0p%2FvlYbh6Us3UMQ%2FXm7b%2B%2Bt%2FqKmNj9pC8zMIkJQBEiPdvLgK8GXh9BQ0uUmMRofozddbNbyUfXkXHV6Mln5CRtZ1Hi4mR3HeT7g%2BGLW2eiOd6XR9Z3UOg8GcvYa4Ld1PqGdpMS7gjC553f0AB4eVONcW92kGs2ihFzk3tW0s86l3mltTzyTD60OngmhiG2wGiUQC4%2F0a32jVJzJE2uj%2FRy%2Fy9Dj6qivpo%2B%2FDjquKOEtfolomEdruoimBE%2Fwg8HhOdr%2F5Umo89OKk8qb%2B7JYWeLLb8iBXJ90HCxtQO70diwCmvZXhCSwrsZ1AoqQOBT8kcIIAvvLGRS7ZPx%2BbPBlxBK56WUY%2FG4N2xvmWOoePGmlBnBm0IYTP7FTNuMsY1o%2FgwTyufPcWVz4AKdL0MEpq2tL9qqhlNLbeRaTTgMvYiTB3V2UlCLOQ8NnU7i7eJUVOSsTu7bWcn34rRH%2BXp5r4HCnasfMtJkCD924zP8QCEIULi6im%2B7Zugz0mXqgz6OOXVUZ8rFkSwdn8nbIeZ1sLDAcivfQN93CRYz%2FkbbjFNXr4Wm1EQAgmyaOABVuUBejG44MlAiZvBe6%2Fo%2BJU3zj71g%3D%3D ~~~ **使用H5云客服傳參加密，請務必注意以下幾點：** > 1、拼接后的json數據，最長不得超過1000個**字節**。如果長度超過1000個字節，可以考慮將部分無需加密的參數，直接以明文形式傳遞。 > 2、openid參數，不能放在加密參數中，必須以明文傳遞 > 3、注意對url的參數進行urlencode,防止解碼失敗 > 4、支持明文傳參和加密兩種方式混合使用，但是鏈接中有zhima_params,重復參數會優先取加密的參數。 ### **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`判斷是否初始化完成 -------- ### **自定義客戶字段** 如果小客服提供的客戶字段不能滿足需求，可以使用自定義客戶字段功能 功能位置：后臺--自定義客戶字段  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> -------- ### **查看自己傳遞的參數** 在傳遞參數后，可以進入網頁端后臺--客服消息界面內查看傳遞的參數： 步驟：從傳遞參數的客服入口內咨詢，進入客服消息界面找到咨詢者，在右側資料區底部查看參數：  ------ 常見問題： 1：小程序傳遞過來的參數無效？ * 請確認從含有參數的入口點擊了客服按鈕進入； * 請確認完全按照我們傳遞參數的格式，單引號雙引號不能變； * 請確認沒有開啟云函數的消息推送功能，其中不包含打開客服事件； 2：小程序傳遞過來的參數為空？ 請確認傳遞過來的變量有值。 3：VUE的uniapp開發的小程序，編譯無法通過？ session-from?是個json?，我們的文檔時針對原生小程序寫的，‘{{??}}’這個語法是原生微信小程序里的，uniapp使用的時VUE的語法，綁定值的方式和原生小程序的語法稍微有寫區別。  </h> </h> <br> <br> <br> <br><br> [**點此進入芝麻小客服官網**](https://xiaokefu.com.cn/?source=kanyun_b_mia ) 您有問題需要咨詢的話，可以掃描下方二維碼： </h>  </h> </h>