kf5sdk

来自于：逸创云客服立即使用

initKF5 showHelpCenter showRequestCreation showRequestList showChatView setCustomFields setTopBarColor

概述

kf5提供给开发者发送工单、查看工单列表、查看知识库等功能。本模块封装了kf5的相关接口，使用此模块需先注册kf5来获取appid和hostName。注册kf5：登录kf5官网( www.kf5.com )注册kf5账号,进入控制面板 - 系统设置 - 支持渠道 - 移动APP SDK中添加一个APP以获取appid，hostName为你注册的域名，例如：kf5.kf5.com。

initKF5

初始化kf5

initKF5({params}, callback(ret, err))

params

hostName:

  • 类型：字符串
  • 描述：注册后的域名

appId:

  • 类型：字符串
  • 描述：注册kf5后，从后台添加APP后获取

email:

  • 类型：字符串
  • 描述：(手机和邮箱,必须传其一)用户的邮箱

phone:

  • 类型：字符串
  • 描述：(手机和邮箱,必须传其一)用户的手机号

verifyUserType:

  • 类型：整型
  • 描述：（可选项）用户信息验证方式,只能传1(验证邮箱)或2(验证手机号),只有当邮箱和手机号同时传入时才生效,默认为1(验证邮箱)
  • 默认值：1/2

appName:

  • 类型：字符串
  • 描述：（可选项）应用名称
  • 默认值：iOSAPP/AndroidAPP

deviceToken:

  • 类型：字符串
  • 描述：（可选项）应用推送的deviceToken

userName:

  • 类型：字符串
  • 描述：（可选项）用户的昵称

callback(ret, err)

err:

  • 类型：JSON 对象
  • 内部字段： 
{  
    message：""  //错误描述  
}

ret:

  • 类型：JSON 对象
  • 内部字段： 
{  
    message：""  //成功描述  
}

补充说明

使用此模块，必须先用initKF5进行初始化。手机和邮箱必须格式正确。

1.email和phone必须传其一,如果单独传入email或者phone,则verifyUserType无效;
2.如果email和phone都传入时以verifyPriorityType(用户信息验证方式)为主;

2.1 如果verifyUserType设置为1,则验证kf5系统中有没有该email,有则验证成功,并修改该用户的手机号(如果手机号已在系统中存在,将不会修改);
2.2 如果verifyUserType设置为2,则验证kf5系统中有没有该phone,有则验证成功;

2.2.1 如果该用户不存在email则添加该email(如果该email已在系统中存在,将不会添加);
2.2.1 如果该用户存在email,则email不能修改;

示例代码

var param = {  
    hostName : "xxx.kf5.com",  
    appId : "xxxxxxx",  
    email : "",  
    phone : "",
    verifyUserType : 1,
    appName : "",
    deviceToken : "",
    userName : "",
};  
var kf5 = api.require('kf5sdk');
kf5.initKF5(param, callback);

function callback(ret, err) {
    api.alert({
        msg: ret.message
    });
}

可用性

iOS系统(iOS8以上) Android系统(SDK10及以上)

可提供的2.7.1及更高版本

showHelpCenter

弹出kf5帮助文档页面

showHelpCenter({params})

params

type:

  • 类型：数字
  • 默认值：0
  • 描述：（可选项）显示帮助文档的方式，为0展示分区列表(默认)，为1直接展示分区列表，为2直接展示所有分类列表，为3直接展示所有文档列表

示例代码

var params = {
    type: 0
};
var kf5 = api.require('kf5sdk');
kf5.showHelpCenter({ params });

补充说明

使用此接口,必须先使用initKF5进行初始化。

可用性

iOS系统(iOS8以上) Android系统(SDK10及以上)

可提供的2.7.1及更高版本

showRequestCreation

弹出kf5反馈问题页面

showRequestCreation()

示例代码

var kf5 = api.require('kf5sdk');
kf5.showRequestCreation();

补充说明

使用此接口，必须先使用initKF5进行初始化。 使用此接口需添加相机、麦克风和照片的权限。

可用性

iOS系统(iOS8以上) Android系统(SDK10及以上)

可提供的2.7.1及更高版本

showRequestList

弹出kf5查看反馈页面

showRequestList()

示例代码

var kf5 = api.require('kf5sdk');
kf5.showRequestList();

补充说明

使用此接口，必须先使用initKF5进行初始化。

可用性

iOS系统(iOS8以上) Android系统(SDK10及以上)

可提供的2.7.1及更高版本

showChatView

弹出kf5即时交谈

showChatView({params})

params

metadata:

  • 类型：数组
  • 描述：(可选项)IM自定义信息

示例代码

var params = {
    metadata  : [
        {
            "name":"姓名",
            "value":"小明"
        },
        {
            "name":"性别",
            "value":"男"
        }
    ],
}; 
var kf5 = api.require('kf5sdk');  
kf5.showChatView(params);

补充说明

使用此接口，必须先使用initKF5进行初始化。 使用此接口需添加相机、麦克风和照片的权限。

可用性

iOS系统(iOS8以上) Android系统(SDK10及以上)

可提供的2.7.1及更高版本

setCustomFields

设置工单自定义字段

setCustomFields({params})

params

custom_fields:

  • 类型：数组
  • 描述：工单自定义字段数组,每次提交工单时,都会将自定义字段添加到工单中

示例代码

var params = {
                custom_fields : [{
                    "name" : "fields_123",
                    "value" : "iOS"
                }, {
                    "name" : "fields_321",
                    "value" : "测试应用"
                }]
            } 
var kf5 = api.require('kf5sdk');  
kf5.setCustomFields(params);

补充说明

使用此接口，需配合工单模块一起使用。工单自定义字段的key在kf5后台的设置工单自定义字段里获取。

可用性

iOS系统 Android系统(SDK10及以上)

可提供的2.7.1及更高版本

setTopBarColor

设置头部nav的颜色样式

setTopBarColor()

params

navColor:

  • 类型：字符串
  • 描述：（可选项）头部nav背景颜色
  • 默认值：#3E4245

textColor:

  • 类型：字符串
  • 描述：（可选项）头部nav TextView字体颜色
  • 默认值：#FFFFFF

centerTextSize:

  • 类型：整型
  • 描述：（可选项）头部Nav 中间Textview字体大小
  • 默认值：22

rightTextSize:

  • 类型：整型
  • 描述：（可选项）头部Nav 右侧TextView字体大小,iOS不可用
  • 默认值：20

centerTextVisible:

  • 类型：布尔型
  • 描述：（可选项）头部Nav中间TextView是否可见,iOS不可用
  • 默认值：true

rightTextVisible:

  • 类型：布尔型
  • 描述：（可选项）头部Nav右侧TextView是否可见
  • 默认值：true

示例代码

var params = {
    navColor: "#3E4245",
    textColor: "#FFFFFF",
    centerTextSize: 22,
    rightTextSize: 20,
    centerTextVisible: true,
    rightTextVisible: true,
};
var kf5 = api.require('kf5sdk');
kf5.setTopBarColor({ params });

补充说明

使用此接口，需配合其他接口一起使用。

可用性

iOS系统(iOS8以上) Android系统(SDK10及以上)

可提供的2.7.1及更高版本