七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入

使用流程

接入插件后,App 页面中按以下流程调用七鱼能力。

引入插件模块

在需要调用七鱼能力的页面或公共模块中引入原生插件:

const qiyuModule = uni.requireNativePlugin("Netease-QiyuModule");

初始化 SDK

App 启动后调用 initSdk 初始化七鱼 SDK。建议在 App 主入口或业务初始化完成后调用一次。

qiyuModule.initSdk({
  appKey: "your_app_key",
  appName: "your_app_name",
  // iOS 推送相关参数按需配置:
  // pkCerName: "your_pushkit_certificate_name",
  // showAPNSDetail: true,
  // templateId: 6676063
});

按业务场景调用 API

初始化完成后,可以按需调用七鱼 API,例如上报用户信息、打开客服界面、发送商品卡片等。

常见调用顺序:

  1. App 启动后调用 initSdk。
  2. 用户登录后调用 setUserInfo 上报用户身份。
  3. 用户点击客服入口时调用 openServiceActivity 打开客服页面。

示例:

qiyuModule.setUserInfo({
  userId: "user_001",
  data: JSON.stringify([
    { key: "name", value: "张三" }
  ])
}, (ret) => {
  if (ret.code === 200) {
    qiyuModule.openServiceActivity({
      title: "在线客服",
      source: {
        title: "App 客服入口"
      }
    });
  }
});

部分 API 需要区分 Android / iOS 平台传不同参数,因此 API 文档按平台分别说明。完整调用方式可以参考七鱼插件 Demo 工程中的 qiyu-module.nvue。

这篇文档有帮助吗?

目录