下载文档

uexMeChat
更新时间:2016-05-10

1、简介

美洽客服插件
插件作者:来自美洽官方

1.2、 业务限制资源规格限制说明

美洽是一款实现手机用户与企业保持随时随刻沟通的客服工具。本模块封装了美洽的相关接口,(由美洽官方开发平台提供)。使用此模块之前需要先注册美洽获取appkey。网址:www.meiqia.com
通知:目前旧版系统已经停止注册,请使用新版 uexMeiqia,由美洽官方维护,反馈请留言或到AppCan社区

1.3、 UI展示

1.4、 相关下载:

插件测试用例与自定义插件下载:点击此处

1.5、 术语表


Path Types

协议头 Android对应路径 (其中”/sdcard/“等 同于”/storage/emulated/0/“) iOS对应路径
res:// widget/wgtRes/ widget/wgtRes
wgts:// /storage/emulated/0/widgetone/apps/ xxx(widgetAppId)/ /Documents/apps/xxx(widgetAppId)/
wgts:// /storage/emulated/0/widgetone/widgets/ /Documents/widgets/
file:///sdcard/ /storage/emulated/0/

2、API概览

2.1、 方法:

initMeChat 初始化美洽SDK

uexMeChat.initMeChat(appkey);
说明:
在加载完成一个页面时进行初始化,初始化成功后才能进行后续操作。
参数:

  1. Appkey: (String类型) 必选 在美洽平台上申请的appkey

登录美洽管理后台后,通过如下步骤获取appkey

平台支持:
Android2.2+
iOS6.0+
版本支持:
3.0.0+
示例:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <script type="text/javascript">
  5. window.uexOnload = function() {
  6. uexMeChat.initMeChat('54466e013baac96d64000001');
  7. }
  8. </script>
  9. </head>
  10. </html>

specifyAllocGroup 将这个用户指定分配到某个客服分组

uexMeChat.specifyAllocGroup(groupId);
说明:
将这个用户指定分配到某个客服分组
参数:

  1. groupId:(String类型) 必选客服分组的id

登录美洽管理后台,在「账户和设置」–>「入口设置」–>「自定义链接」中点击「指定分配客服」,选择你要分配的组,在如图所示位置就可以找到分组编号:

平台支持:
Android2.2+
iOS6.0+
版本支持:
3.0.0+
示例:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <script type="text/javascript">
  5. window.uexOnload = function() {
  6. uexMeChat.initMeChat('54466e013baac96d64000001');
  7. }
  8. function specifyAllocGroup(){
  9. uexMeChat.specifyAllocGroup(“100”);
  10. }
  11. </script>
  12. </head>
  13. <body>
  14. <input type=”button” value=”添加指定分组” onclick=”specifyAllocGroup();”>
  15. </body>
  16. </html>

specifyAllocAgent 将用户指定分配给某个客服

uexMeChat.specifyAllocAgent(agentId,isForce);
说明:
将用户指定分配给某个客服
参数:

  1. agentId:(String类型) 必选客服的id

登录美洽管理后台,在「客服」页点击你想查找的客服的名字,新页面的URL里就能找到客服ID,如图:

  1. isForce:(bool类型) 必选是否强制分配。

该客服不在线的情况下,如果不是强制分配,那么分配给其他客服;如果是强制分配,那么用户只能使用留言。
平台支持:
Android2.2+
iOS6.0+
版本支持:
3.0.0+
示例:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <script type="text/javascript">
  5. window.uexOnload = function() {
  6. uexMeChat.initMeChat('54466e013baac96d64000001');
  7. }
  8. function specifyAllocGroup(){
  9. uexMeChat.specifyAllocAgent(“1001”,true);
  10. }
  11. </script>
  12. </head>
  13. <body>
  14. <input type=”button” value=”添加指定客服” onclick=”specifyAllocAgent();”>
  15. </body>
  16. </html>

addUserInfo 添加用户信息和自定义信息

uexMeChat.addUserInfo(userInfoJson,otherInfoJson);
说明:
为了让客服能更准确帮助用户,可以在初始化SDK之后,调用上线接口前添加用户数据,但这并不是必须的,你可以跳过这个步骤。
用户信息添加后的效果:
自定义信息添加后的效果:
参数:

  1. userInfoJson:(String类型) 必选json格式的字符串,用户信息的键是美洽已经规定常量,值为任何字符串,详见下表: 各字段含义如下:
说明 备注
realName 真实姓名
sex 性别
birthday 生日
age 年龄
job 职业
avatar 头像URL
comment 备注
appUserId 用户识别符 设置后可实现消息漫游
appUserName 登录名
appNickName 昵称
tel 电话
email 邮箱
address 地址
QQ QQ
weibo 微博ID
weixin 微信号
  1. otherInfoJson:(String类型) 必选json格式的字符串,键值不受约束,可以为字符串。

平台支持:
Android2.2+
iOS6.0+
版本支持:
3.0.0+
示例:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <script type="text/javascript">
  5. window.uexOnload = function() {
  6. uexMeChat.initMeChat('54466e013baac96d64000001');
  7. }
  8. function addUserInfo(){
  9. var userInfo = '{"appNickName":"这是一个昵称","realName":"张三"}';
  10. var otherInfo = '{"这是键":"这是值","键和值":"都可以填写任何字符串"}';
  11. uexMeChat.addUserInfo(userInfo,otherInfo);
  12. }
  13. </script>
  14. </head>
  15. <body>
  16. <input type=”button” value=”添加用户信息” onclick=”addUserInfo();”>
  17. </body>
  18. </html>

show 显示客服界面

uexMeChat.insertItemAt(params);
说明:
显示客服界面。在initMeChat、specifyAllocGroup、specifyAllocAgent、addUserInfo之后执行。
平台支持:
Android2.2+
iOS6.0+
版本支持:
3.0.0+
示例:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <script type="text/javascript">
  5. window.uexOnload = function() {
  6. uexMeChat.initMeChat('54466e013baac96d64000001');
  7. }
  8. function show(){
  9. uexMeChat.show();
  10. }
  11. </script>
  12. </head>
  13. <body>
  14. <input type=”button” value=”打开客服” onclick=”show();”>
  15. </body>
  16. </html>