更新记录

1.2.0（2024-11-19） 下载此版本

Android SDK 同步更新到 4.0.19 iOS SDK 同步更新到 3.9.19

1.1.9（2024-08-23） 下载此版本

Android SDK 同步更新到 4.0.15

1.1.8（2024-07-23） 下载此版本

Android SDK 同步更新到 4.0.14 ; 新增 Android 支持多语言设置；

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

MeiQia_For_DCloud

请您首先把文档全部仔细阅读完毕,再进行您的开发, 如还有疑问，欢迎加入 美洽 SDK 开发 QQ 群：515344099

AppKey 的获取方法

使用管理员权限账号登陆美洽，在 设置 --> SDK 页面中，选择 添加 App 配置 ，根据提示配置 App 信息，然后添加 APP 即可得到 appkey 用于配置。

插件接口总览

插件接口使用详解

设置 AppKey

添加插件的时候，需要将从美洽获取到的 appkey 填入配置中

项目中引用插件

// 务必先生成自定义基座，然后运行的时候使用自定义基座，否则会出现找不到插件的错误
const mqModule = uni.requireNativePlugin("MeiQia-ChatPlugin");

打开默认的美洽聊天页面

openMeiQiaChatView() {
    mqModule.initChatViewManger();
    mqModule.showMeiQiaChatView();
},

说明：美洽所有业务和配置方法都在initChatViewManger()，调用以后才能调用，最后使用showMeiQiaChatView()跳转到聊天页面。

配置聊天页面 UI 样式

configMeiQiaChatStyle() {
    mqModule.initChatViewManger();
    mqModule.configChatViewStyle({
      "navBarBackgroundColor": "#ffffff", // 设置导航栏的背景色；
      "navBarTitleTxtColor": "#ffffff", // 设置导航栏上的 title 的颜色；
      "enableShowClientAvatar": true, // 是否支持当前用户头像的显示
      //以下配置暂时只支持ios
      "incomingMsgTextColor": "#ffffff", // 设置客服发送过来的message的文字颜色；
      "incomingBubbleColor": "#ffffff", // 设置客服发送过来的message气泡颜色；
      "outgoingMsgTextColor": "#ffffff", // 设置用户发送出去的message的文字颜色
      "outgoingBubbleColor": "#ffffff", // 设置用户发送出去的message气泡颜色；
      "eventTextColor": "#ffffff", // 设置事件流的显示文字的颜色；
      "navTitleFont": 15, // 设置导航栏上的title的字体大小
      "backgroundColor": "#ffffff", // 聊天窗口背景色；
      "enableRoundAvatar": false, // 是否开启圆形头像；
      "enableIncomingAvatar": true, // 是否支持左边头像的显示
    });

    mqModule.showMeiQiaChatView();
  }

设置预发送文本消息

preSendTextMessage() {
    mqModule.initChatViewManger();
    mqModule.setPreSendTextMessage("预发送内容");
    mqModule.showMeiQiaChatView();
},

设置预发送商品卡片信息消息

preSendProductCardMessage() {
    mqModule.initChatViewManger();
    mqModule.setPreSendProductCardMessage({
    pictureUrl : "https://file.pisen.com.cn/QJW3C1000WEB/Product/201701/16305409655404.jpg", // 商品图片的链接
    title: "商品的标题",
    description:"商品描述的内容",
    productUrl:"https://meiqia.com", // 商品链接
    salesCount:50 // 商品销售量
    });

    mqModule.showMeiQiaChatView();
},

设置是否支持发送语音信息

enableSendVoiceMessage() {
    mqModule.initChatViewManger();
    mqModule.enableSendVoiceMessage(false); // 默认支持
    mqModule.showMeiQiaChatView();
},

说明：是否发送语音、图片，默认都是支持的。 接收/发送消息的声音，也是默认开启的。

是否支持相册选择图片可裁剪，只支持iOS

enablePhotoLibraryEdit() {
    mqModule.initChatViewManger();
    mqModule.enablePhotoLibraryEdit(false); // 默认支持
    mqModule.showMeiQiaChatView();
},

说明：这个方法是针对iOS的

设置指定分配的客服

configScheduledAgentId() {
    mqModule.initChatViewManger();
    mqModule.setScheduledAgentId("客服id");
    mqModule.showMeiQiaChatView();
},

设置指定分配的客服组

configScheduledAgentId() {
    mqModule.initChatViewManger();
    mqModule.setScheduledGroupId("客服组id");
    mqModule.showMeiQiaChatView();
},

说明：如果设置了分配给客服id，以分配给客服id为优先

设置指定分配的客服/客服组的转接规则

configScheduledAgentId() {
    mqModule.initChatViewManger();
    mqModule.setScheduledGroupId("客服组id");
    mqModule.setScheduledRule(1);  //不转接给任何人
    mqModule.showMeiQiaChatView();
},

说明：指定分配客服/客服组，该客服/客服组不在线，如何转接的规则

setScheduledRule的value值： vaule == 1； //不转接给任何人 vaule == 2； //转接给组内的人 vaule == 3； //转接给企业其他随机一个人

不调用setScheduledRule方法，默认就是按照 vaule == 3的规则分配

使用开发者自定义的id上线

configLoginCustomizedId() {
    mqModule.initChatViewManger();
    mqModule.setLoginCustomizedId("顾客自定义id");
    mqModule.showMeiQiaChatView();
},

设置顾客的自定义信息

configClientInfo() {
    mqModule.initChatViewManger();
    mqModule.setClientInfo({
    clientInfo:{
        age:"22",
        weixin: "5545666",
        name: "美洽用户"
        },
    override: true});
    mqModule.showMeiQiaChatView();
},

说明：clientInfo: 顾客配置信息； override：是否强制更新，如果不设置此值为 true，设置只有第一次有效。

以下字段是美洽定义好的，开发者可通过上方提到的接口，直接对下方的字段进行设置：

如果还要添加更多的自定义字段，请到工作台的 设置页面 -> 顾客 -> 顾客管理 -> 顾客名片字段 -> 自定义字段 中添加想要的字段。

获取当前未读消息

getUnreadMessages() {
    testModule.getUnreadMessages((result) => {
        uni.showToast({
            title: '调用获取未读消息' + result,
            icon:'none'
        });
    });
}

返回未读消息的数组，数据结构大体是：

[{
    "id": "26136869504",
    "agent_id": "1525407",
    "content_type": "text",
    "conversation_id": "3682151000",
    "type": "message",
    "action": "message",
    "track_id": "2BF3IyEcxfbjuF9Pdo9NlkAtwGt",
    "created_on": "1656487957.360000",
    "message_user_name": "客服某某",
    "message_avatar": "https:/xxx.jpg",
    "from_type": "agent",
    "content": "23132"
}, {
    "id": "26136869068",
    "agent_id": "1525407",
    "content_type": "text",
    "conversation_id": "3682151000",
    "type": "message",
    "action": "message",
    "track_id": "2BF3IyEcxfbjuF9Pdo9NlkAtwGt",
    "created_on": "1656487955.565000",
    "message_user_name": "客服某某",
    "message_avatar": "https://xxx.jpg",
    "from_type": "agent",
    "content": "112323123"
}]

关闭对话页

dismiss() {
    testModule.dismiss();
}

监听对话中的链接点击

// ios 目前只支持商品卡片的点击回调
// 开发者自己处理 url 点击，注意：设置监听回调后,将不再跳转网页.如果需要跳转,开发者需要自行处理
setLinkTapCallback() {
    testModule.setLinkTapCallback((url) => {
        console.log('url = ' + url);
    });
}

使用美洽留言页面

openMeiQiaMessageForm() {
    mqModule.showMQMessageForm();
},

不用调用initChatViewManger，直接就可以跳转。

根据 customizedId 获取未读消息

getUnreadMessagesWithCustomizedId() {
    testModule.getUnreadMessagesWithCustomizedId("111111", (result) => {
        uni.showToast({
            title: '调用获取未读消息' + result,
            icon:'none'
        });
    });
}

结束当前对话

endCurrentConversation() {
    testModule.endCurrentConversation((result) => {
        console.log('结束对话 ==== ' + result);
        if (result) {
            console.log('结束成功');
        }else {
            console.log('结束失败');
        }
    });

切换appkey登录

switchAppkey() {
    testModule.switchAppkey('22222', (result) => {
        console.log('clientId：' + result);
        if (result.length > 0) {
            console.log('切换成功');
        }else { 
            console.log('切换失败');
        }
    });
}

设置当前语言

配置本地化语言(仅iOS支持)，目前支持：中文简体、中文繁体、英文、马来语、印尼语，日语、泰语、越南语、葡萄牙语、印地语、西班牙语、俄语，韩语，不支持的语言默认显示为英文 如："en" ，"zh-Hans"，"zh-Hant"，"ms"， "id", "ja"，"th"，"vi"，"pt"，"hi"， "es"，"ru"，"ko"（不调用此方法，则随系统语言变化）

setLocalizedLanguage() {
    testModule.setLocalizedLanguage('ms');
}

iOS离线推送说明

首先需要设置服务器地址，请使用美洽管理员帐号登录 美洽，在「设置」 -> 「SDK」中设置。

推送消息数据结构

当有消息需要推送时，美洽服务器会向开发者设置的服务器地址发送推送消息，方法类型为 POST，数据格式为 JSON 。

发送的请求格式介绍：

request.header.authorization 为数据签名。

request.body 为消息数据，数据结构为：

注意：开发者需要自己请求注册推送，让用户授权