653
逸創雲客服
APICLOUD集成文檔及參數說明
概述
您可以在apicloud裏使用逸創雲客服的集成功能: https://www.apicloud.com/dev
逸創雲客服提供給開發者發送工單、查看工單列表、查看知識庫等功能。本模塊封裝了相關接口,使用此模塊需先注冊逸創雲客服來獲取appid和hostName。注冊逸創雲客服:登錄逸創雲客服官網( www.kf5.com )開通平台賬號,進入控製麵板 - 係統設置 - 客服接入渠道 - 移動APP SDK中添加一個APP以獲取appid,hostName為你注冊的域名,例如:yourdomain.kf5.com。
initKF5
初始化
initKF5({params},callback(ret,err))
params
hostName:
類型:字符串
默認值:無
描述:注冊後的域名,不可為空
appId:
類型:字符串
默認值:無
描述:注冊kf5後,從後台添加APP後獲取,不可為空
email:
類型:字符串
默認值:無
描述:用戶的賬號,不能為空
password:
類型:字符串
默認值:無
描述:用戶密碼,可以為空。(該用戶有密碼時,必須填寫)
userName:
類型:字符串
默認值:無
描述:用戶的昵稱,可以為空
callback(ret,err)
err:
類型:JSON對象
內部字段:
{
message:"" //錯誤描述
}
ret:類型:JSON對象
內部字段:
{
message:"" //成功描述
}
補充說明
使用此模塊,必須先用initKF5進行初始化。email為用戶賬號,必須為email格式,如果你的kf5係統中沒有該用戶,則自動創建。password可不填。當為創建用戶時,不填寫password,則創建的用戶沒有密碼。
示例代碼
var param = { hostName : "", appId : "", email : "", userName : "", password : "" }; var kf5 = api.require('kf5'); kf5.initKF5(param,callback); function callback(ret,err){ api.alert({ msg: ret.message }); }
可用性
iOS係統 Android係統(SDK10及以上)
可提供的1.0.0及更高版本
showHelpCenter
彈出幫助文檔頁麵
showHelpCenter({params})
params
type:
類型:整型
默認值:0
描述:顯示幫助文檔的方式,為0展示分區列表(默認),為1直接展示所有分類列表,為2直接展示所有文檔列表,為3使用默 認,可以為空。
示例代碼
var params = { type: 2 }; var kf5 = api.require('kf5'); kf5.showHelpCenter(params);
補充說明
使用此模塊,必須先使用initKF5進行初始化。
可用性
iOS係統 Android係統(SDK10及以上)
可提供的1.0.0及更高版本
showRequestCreation
彈出反饋問題頁麵
showRequestCreation()
示例代碼
var kf5 = api.require('kf5'); kf5.showRequestCreation();
補充說明
使用此模塊,必須先使用initKF5進行初始化。
可用性
iOS係統 Android係統(SDK10及以上)
可提供的1.0.0及更高版本
showRequestList
彈出查看反饋頁麵
showRequestList()
示例代碼
var kf5 = api.require('kf5'); kf5.showRequestList();
補充說明
使用此模塊,必須先使用initKF5進行初始化。
可用性
iOS係統 Android係統(SDK10及以上)
可提供的1.0.0及更高版本
setTopBarColor
設置頭部nav的顏色樣式
setTopBarColor()
示例代碼
var params = { navColor : "", titleColor :"" }; var kf5 = api.require('kf5'); kf5.setTopBarColor(params);
補充說明
使用此模塊,需配合其他模塊一起使用。
可用性
iOS係統 Android係統(SDK10及以上)
可提供的1.0.0及更高版本
最後更新:2017-02-07 22:26:56