網易七魚 Android SDK 是一個 Android 端客服系統訪客解決方案,既包含了客服聊天邏輯管理,也提供了聊天界面,開發者可方便的將客服功能集成到自己的 App 中。
網易七魚Android SDK使用方法
只需簡單 3 步,即可將客服功能加入你的 App:
添加 SDK 到項目中。
Android Studio: 在工程 build.gradle 文件中添加依賴即可。
// 最新版本可參考 Download 徽章后對應的數值
compile 'com.qiyukf.unicorn:unicorn:+'
Eclipse: 先下載 SDK,然后解壓縮,將得到的 unicorn 文件夾作為庫工程模塊導入到你的工程中,并添加模塊依賴。然后將 assets 文件夾的內容拷貝你的主工程的 assets 目錄中,將 AndroidManifest 文件中的內容拷貝到你的主工程的 manifest 文件中,并將 manifest 中的 ${applicationId} 替換為你的包名。
在你的 Application 類的 onCreate 函數中,加入以下初始化代碼:
public class YourApplication extends Application {
public void onCreate() {
// ... your codes
// appKey 可以在七魚管理系統->設置->App 接入 頁面找到
Unicorn.init(this, "appKey", options(), new UnicornImageLoader());
// ... your codes
}
// 如果返回值為null,則全部使用默認參數。
private YSFOptions options() {
YSFOptions options = new YSFOptions();
options.statusBarNotificationConfig = new StatusBarNotificationConfig();
return options;}
上面代碼中,UnicornImageLoader 可根據你 App 中圖片加載模塊做自定義實現,以免 SDK 中引入第三方圖片管理庫后造成與 App 的沖突或者浪費。在 demo 中,實現了依賴于 UniversalImageLoader 的 UILImageLoader。其代碼以及依賴于 fresco、Glide、Picasso 的實現代碼可參考 圖片加載 一節。
在你的 App 的合適頁面添加客服入口按鈕,并在響應函數中加入如下代碼:
String title = "聊天窗口的標題";/**
* 設置訪客來源,標識訪客是從哪個頁面發起咨詢的,用于客服了解用戶是從什么頁面進入。
* 三個參數分別為:來源頁面的url,來源頁面標題,來源頁面額外信息(保留字段,暫時無用)。
* 設置來源后,在客服會話界面的"用戶資料"欄的頁面項,可以看到這里設置的值。
*/ConsultSource source = new ConsultSource(sourceUrl, sourceTitle, "custom information string");/**
* 請注意: 調用該接口前,應先檢查Unicorn.isServiceAvailable(),
* 如果返回為false,該接口不會有任何動作
*
* @param context 上下文
* @param title 聊天窗口的標題
* @param source 咨詢的發起來源,包括發起咨詢的url,title,描述信息等
*/Unicorn.openServiceActivity(context, title, source);
在打開的頁面中,用戶就可以咨詢客服了。
由于開發環境的不同,很多情況下會出現集成報錯或者配置無效的問題。我們官網提供了demo源碼,開發者可以參考源碼;更多的時候是需要開發者自己本地調試代碼,可以通過斷點跟蹤等基本且有效的方法來定位和排查問題。
- PC官方版
- 安卓官方手機版
- IOS官方手機版