开通测试环境

七鱼目前并未提供对外的测试环境，但是企业可以通过注册免费试用账号实现测试目的。免费试用七鱼注册地址：注册地址试用版本为最高版本，已开通所有功能模块（但是个别功能使用会受限，例如管理员模式下修改员工个人头像、app端使用SDK接入测试等，完整功能测试需要付费或咨询销售专员处理），试用期限为7天。

web纯链接方式

Web纯连接方式，此方式是七鱼提供一个可直接咨询客服的URL，企业可以将此URL放置在自身应用中需要接入七鱼的地方（例如微信公众号文章的某个咨询客服超链；或者是企业官网的咨询客服按钮点击后可直接跳此URL）。

Web纯连接方式的接入成本最低，只需要企业自身前端将链接加入需要跳转的地方即可，但是此方式也牺牲了一些高级功能，例如传递用户信息、使用商品卡片等。

链接获取方式：登录七鱼后台，进入“应用-在线系统-设置-会话流程-会话分配-高级自定义分配（WEB端）- Web端自定义链接分配”，路径见下图：

此处链接还可以指定分流客服或者客服组以及设置是否优先启用机器人。

web-js方式

七鱼提供web端JS，可由对接企业前端开发人员通过集成开发实现七鱼访客端的接入。

详细开发指南：点击查看

对于需要在PC端和移动端（PC端和移动端的识别由七鱼实现，并使用不同代码逻辑。而且不同端的适配工作也由七鱼实现，开发者无需关心）网站集成七鱼的企业，七鱼提供的web端JS-SDK，方便开发者开发集成。开发者可以先运行下七鱼提供的demo，结合文档跟容易直观理解实现方法。demo内含有多个html文件，开发者可以将其挂载在自己的web项目下并访问并发起会话。

Demo下载地址：Demo下载

最简集成开发步骤：

1、注册并登录七鱼后台，进入【管理后台-> 应用->在线系统-> 设置->在线接入->网站->接入代码】

在此界面可看到以下截图信息

推荐使用服务异步加载方式，可规避因开发引用七鱼错误而导致七鱼加载异常时直接导致整个前端页面无法加载问题。

代码段中” j.src =’https://qiyukf.com/script/************.js’”为七鱼JS地址，对于每个登录后台，“************”内容都是唯一不变的。

2、在需要展示客服咨询入口的前端页面上，添加此段七鱼JS引用代码。添加位置必须是放在body内（若放置在header中将无效）。

如上，简单添加完成后，访问此页面就可以在页面右下键看到七鱼默认提供的客服咨询按钮，点击即可正常发起咨询。

七鱼提供现成的访客端聊天窗口，并且限定窗口整体UI框架，目前没有开放前端UI的自定义能力，所以开发者没办法修改客服聊天窗口UI展示。不过在七鱼后台可以通过配置来调整窗口的主题色等。配置功能路径请见下图：

微信授权方式

七鱼提供微信授权方式接入微信公众号和小程序，可由微信公众号或小程序超管在七鱼后台按照提示操作授权来实现微信原生聊天窗口的七鱼对接。

公众号授权

公众号授权接入（目前仅支持微信服务号和订阅号）

微信公众号授权接入的操作路径请见下图：

点击后将自动跳转至微信页面，需要公众号超管扫码授权。

授权成功后，访客可直接在自身手机微信中定位到公众号并进入公众号聊天窗口（微信原生窗口）。在窗口内发送消息就能正常和客服进行IM交流。

小程序授权

小程序需要前端开发实现一个客服咨询入口的按钮，详细代码段如下：

<button
  type="primary"
  size="40"
  session-from="nickName={{userInfo.nickName}}|avatarUrl={{userInfo.avatarUrl}}"
  open-type="contact"
>联系客服</button>

此处使用的是微信小程序提供的button组件open-type必须为”contact”。集成完毕后就已经完成了开发侧工作，之后就是提交发布了。若原先已经有小程序了且也有此按钮只是接了其他客服系统，那按钮可以复用，直接修改下session-from内容后重新发布就行。

小程序授权接入，具体路径请见下图：

点击确定后将跳转至微信授权扫码界面，需要小程序超管扫码授权。

点击确定后将跳转至微信授权扫码界面，需要小程序超管扫码授权。授权完成后即可在小程序内点击前端添加的“联系客服”按钮，进入微信原生的聊天窗口，在此窗口内发送消息就能正常和客服进行IM交流。

小程序SDK方式

七鱼提供微信小程序SDK，可由对接企业前端开发人员通过集成开发实现七鱼访客端的接入。详细开发指南可查看：查看详情

接入说明：

在微信小程序后台 – 设置 – 第三方设置 – 插件管理中申请使用七鱼小程序sdk插件，七鱼提供的微信小程序插件名称为 QIYUSDK。七鱼对外提供名字为chat的页面插件，请确保在配置企业appKey后再跳转到chat页面申请客服。

接入代码示例

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

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

初始化企业appKey配置企业的appKey采用接口插件对外接口的形式，使用requirePlugin引用插件后调用 _$configAppKey(appKey) 方法。#_$configAppKey(appKey)该接口接受一个appkey参数，支持Promise化使用。

参数	类型	必须	描述
appKey	String	是	企业appKey的查看方法见下方（appkey获取）

var myPluginInterface = requirePlugin('myPlugin');

var appId = '由七鱼后台-微信小程序接入绑定后自动生成,请确认appId在您的绑定列表中。';
myPluginInterface.__configAppId(appId);  // 不是微信的appId，是七鱼后台生成的appId
myPluginInterface._$configAppKey('3858be3c20ceb6298575736cf27xxxxxxxx'); // 申请企业的appKey

#_$configAppKeySync(appKey)

_$configAppKey的同步方法。

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

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

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

[注4] 请注意目前七鱼管理后台appId为自动生成，解绑后重新绑定会生成新的appId，对应的微信小程序插件配置的appId也需要更新。

其中初始化企业appkey和appId获取方式分别如下：

appkey获取：

此处获取的appkey为企业全局唯一接入key，所有接入方式使用的是同一个值。

appid获取方式如下：

跳转客服页面

七鱼提供一个名称为chat的插件页面

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

此方式接入成功后，访客点击小程序内“联系客服”按钮后会跳转至七鱼的聊天窗口实现与客服的沟通。

微博授权方式

七鱼提供新浪微博授权方式接入微博私信，可在七鱼后台按照提示操作授权来实现微博的七鱼对接。（目前仅只是授权接入企业微博蓝V认证号）具体路径详见下图：

点击“去绑定企业微博认证号”后，七鱼会给出操作提示界面，需要对接者根据提示完成授权配置。

安卓SDK方式

七鱼提供安卓SDK，可由对接企业移动端开发人员通过集成开发实现七鱼访客端的接入。详细开发指南可查看：安卓SDK开发指南

对于安卓SDK接入，七鱼提供了demo以及demo源码。接入前期，企业产品策划人员可以先在七鱼官网下载demo并体验。开发者也需要先下载demo源码并在本地运行，结合源码和开发指南，能更快速的帮助开发者了解和测试SDK现有能力。

Demo现在地址：Demo下载（此处直接超链至下载界面并聚焦下载文件）

Demo源码下载地址：Demo源码下载（此处直接超链至下载界面并聚焦下载文件）（下载密码：qiyukefudemo）

开发者可以在app内集成七鱼提供的SDK并调用对应开放方法实现七鱼会话界面的接入。会话界面由七鱼提供并且对于整体UI框架做了限定，不过七鱼也提供了相关方法可以让开发者尽可能的去自定义框架内的个别属性。

安卓 SDK 提供的接口名为 UICustomization，配置参数放在 YSFOptions 的 uiCustomization变量中，开发者可在初始化 SDK 或者在运行时任意时候修改配置，当需要与 SDK 提供的默认界面不一样表现的地方，就修改对应的项，否则不赋值即可，界面会保留默认表现。详细开发指南：查看详情

目前的UI自定义属性都已经在开发指南内给出，若企业需要修改的UI属性不在开发指南内，那说明七鱼并没有开发对应的自定义方法，或此属性不在七鱼控制范围内。例如，聊天窗口顶部导航栏，七鱼引用了系统导航栏，并且占用了导航按钮。若企业需要完全自定义导航栏，可以自己去实现导航栏并弃用七鱼占用的按钮，自定义实现按钮并在七鱼提供的接口能力中找到对应开放能力去响应按钮点击事件。

IOS SDK方式

七鱼提供IOS SDK，可由对接企业移动端开发人员通过集成开发实现七鱼访客端的接入。详细开发指南可查看：IOS SDK开发指南

对于IOS SDK接入，七鱼提供了demo以及demo源码。接入前期，企业产品策划人员可以先在七鱼官网下载demo并体验。开发者也需要先下载demo源码并在本地运行，结合源码和开发指南，能更快速的帮助开发者了解和测试SDK现有能力。

Demo现在地址：点击下载（此处直接超链至下载界面并聚焦下载文件）

Demo源码下载地址：点击下载（此处直接超链至下载界面并聚焦下载文件）（下载密码：qiyukefudemo）

iOS SDK 提供聊天界面部分样式自定义，通过[QYSDK sharedSDK]单例的customUIConfig方法获取QYCustomUIConfig自定义UI配置类，该类为单例模式。详细开发指南：查看详情

消息接口方式

七鱼提供服务端的对接方式，即企业通过调用七鱼开放能力接口实现访客的接入，并通过接收七鱼推送事件来实现客服消息的回复等操作。（此种方式，需要对接企业自己写一个访客端以及访客端到企业服务端的IM通讯，开发量非常大。）详细开发指南可查看：查看详情

此接入方式实际是企业开发者后端与七鱼对接，通过七鱼提供的API接口可实现开发者主动与七鱼后端的交互；通过七鱼后端给开发者接口推送消息/事件，可以实现七鱼后端与开发者的主动交互。至于访客前端以及其与开发者后端的IM通讯，都需要开发者自己去实现。

消息接口对接有大量的后端开发工作，建议开发者先通过开发指南熟悉现有API能力，并结合demo快速掌握对接实现方式。Demo下载地址：点击下载

此demo内包含消息接口调用方式的参考代码以及将微信消息转发到七鱼的快捷方式。

快速开始