概述
您可以在apicloud里使用逸创云客服的集成功能: http://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及更高版本