接入说明

在微信小程序后台 - 设置 - 第三方设置 - 插件管理中申请使用七鱼小程序 SDK 插件，七鱼提供的微信小程序插件名称为 QIYUSDK，详细使用插件的方式请参考微信小程序插件的使用方式，微信使用插件文档。

七鱼对外提供名字为 chat 的页面插件，请确保在配置企业 appKey 和 appId 后再跳转到 chat 页面申请客服，接入请下载

代码示例

步骤一：引入插件代码包：使用插件前，使用者要在 app.json 中声明需要使用的插件

{
  "plugins": {
    "myPlugin": {
      "version": "2.12.0", // 推荐使用最新版
      "provider": "wxae5e29812005203f"
    }
  }
}

步骤二：插件初始化

const myPluginInterface = requirePlugin('myPlugin');
const appKey = ''; // 申请企业的appKey
const appId = ''; // 由七鱼后台-微信小程序接入绑定后自动生成,请确认 appId 在您的绑定列表中
myPluginInterface._$configAppKey(appKey);
myPluginInterface._$configAppId(appId); // 版本 >= 2.2.0

// 注意：1.x 版本、2.1.3 版本，请使用 __configAppId
// myPluginInterface.__configAppId(appId);

步骤三：配置客服跳转按钮

<navigator url="plugin://myPlugin/chat">
  联系客服
</navigator>

设置 appKey

_$configAppKey

接口描述

配置企业的 appKey 采用插件对外接口的形式。

参数说明

_$configAppKey(appKey:string):Promise<void>

名称	类型	必填	说明
appKey	string	是	企业appKey的查看方法见[注1]

代码示例

const myPluginInterface = requirePlugin('myPlugin');
myPluginInterface._$configAppKey('3858be3c20ceb629857573688888888'); // 申请企业的appKey

设置 appId

_$configAppId

版本要求 >= 2.2.0

注意：1.x 版本、2.1.3 版本，请使用 __configAppId

接口描述

配置小程序的 appId 采用插件对外接口的形式。

参数说明

_$configAppId(appId:string):void

名称	类型	必填	说明
appId	string	是	企业appId的查看方法见【注4】

代码示例

const myPluginInterface = requirePlugin('myPlugin');
myPluginInterface._$configAppId('uk1HD88888'); // 申请企业的appKey

【注1】企业appKey的查看方法： 七鱼管理后台 — 在线系统 — 在线接入

【注2】此方法为必须调用，请确保在跳转到插件的聊天界面之前配置了正确的 appKey

【注3】在对接之前请确定在 七鱼管理后台 — 在线系统 — 微信小程序接入 界面绑定您的微信小程序，否则可能会出现连接不到客服的情况

【注4】企业 appId 的查看方法：七鱼管理后台 — 在线系统 — 微信小程序接入

接入说明

代码示例

设置 appKey

设置 appId

目录