IOS SDK (V2.x) 简介

iOS SDK V2.0 及以上版本:

  • 开源了 UI 界面,开发者可以根据自己的需求开发不同风格的页面
  • 支持 bitcode 和国际化

Download SDK and Folk us on GitHub

iOS SDK V1.5.6 及以前版本因存在较大的兼容性问题,请尽快进行升级!
逸创云客服官方将不再为 V1.5.6 版本以下的 SDK 版本进行兼容性维护,请立即升级至最新SDK版本!

概述

KF5SDK 帮助开发者快速完成开发,提供给开发者创建工单、查看工单列表、回复工单、查看和搜索知识库文档、消息通知推送、即时IM等功能。目前支持 iOS 7.0 及以上系统(需要 xCode 8.0 及以上)。KF5SDK 2.0 版现已经支持 bitcode 和国际化。

为了更好的与企业的业务紧密结合,KF5SDK 开源了 SDK 的 UI 界面,开发者可以根据自己的需求开发不同风格的页面,也可以使用 KF5SDK 提供的默认界面快速集成客服功能。

功能介绍

帮助中心

帮助中心允许用户在您的 APP 查看和搜索您云客服平台上的知识库文档

反馈问题/联系我们

用户可以在您的 APP 上反馈问题,反馈的问题您可以在云客服平台上处理,用户可在 APP 上查看反馈结果,并可与您进行交流

查看工单列表/查看反馈

用户可以查看反馈的问题,以及处理结果,并可以继续和您交流,您可以在您的云客服平台上针对问题进行回复

即时交谈

用户可以通过APP与客服人员实时交流,实时发送和接收文字消息、语音消息、图片、附件,并为此提供了灵活的接口。

集成方法

  1. 请先前往GITHUB下载KF5SDK的官方demo

  2. 将 KF5SDK 下的文件拖拽到自己的工程中

  3. 添加系统库支持,添加 JavaScriptCore.frameworklibsqlite3.tbd 到自己的工程
  4. 引入 #import <KF5SDK/KF5SDK.h>

    初始化配置信息:

    [[KFConfig shareConfig]initializeWithHostName:kHostName appId:kAppId];
    • khostName 为您平台的http地址,如:https://sample.kf5.com
    • kAppId 为您为用户创建的唯一标示 (在您的逸创云客服后台 创建移动SDK APP应用,APP 应用里的传输密钥即为appId)
    • 此方法可放在 AppDelegate 里初始化

    进入工程的 info.plist , 添加相应权限:

    • Privacy - Camera Usage Description:是否允许该应用使用你的相机?
    • Privacy - Microphone Usage Description:是否允许该应用使用你的麦克风?
    • Privacy - Photo Library Usage Description:是否允许该应用访问你的媒体资料库?

  5. 配置完基本信息,即可使用逸创云客服SDK,详细的SDK参数和用法请见下面的内容

使用方法

在使用 SDK 相关功能模块前,引入 #import "KFUserManager.h"并调用 KFUserManager 的初始化用户的方法获取到 userToken (用户唯一标示),下面为使用邮箱初始化用户的方法:

// 如果userToken为空,则需要初始化用户
if ([KFUserManager shareUserManager].user.userToken.length == 0) {
    [[KFUserManager shareUserManager]initializeWithEmail:@"123@qq.com" completion:^(KFUser * _Nullable user, NSError * _Nullable error) {
    }];
}

注:最好在使用 SDK 相关功能前调用,比如设置界面,不建议在 AppDelegate 中调用此方法,因为当前服务器对每个平台平均的创建用户量有一定的限制。 KF5SDK 是专用于普通用户的,因此初始化用户时应该使用不同的邮箱或手机号。

添加支持文档功能

引入 #import "KF5SDKDoc.h" 后,调用方法如下:

[self.navigationController pushViewController:[[KFCategorieListViewController alloc]init] animated:YES];

文档模块中控制器 (更详细的信息请见相关类的头文件):

  • 文档分区: KFCategorieListViewController
  • 文档分类: KFForumListViewController
  • 文档列表: KFPostListViewController
  • 文档内容: KFDocumentViewController

添加支持工单功能

引入 #import "KF5SDKTicket.h" 后,调用方法如下:

[self.navigationController pushViewController:[[KFTicketListViewController alloc]init] animated:YES];

工单模块中控制器 (更详细的信息请见相关类的头文件):

  • 工单列表: KFTicketListViewController
  • 工单内容: KFTicketViewController
  • 创建工单: KFCreateTicketViewController
  • 工单详情: KFDetailMessageViewController

添加支持即时通讯功能

引入 #import "KF5SDKChat.h" 后,调用方法如下:

[self.navigationController pushViewController:[[KFChatViewController alloc]
initWithMetadata:@[@{@"name":@"系统",@"value":@"IOS"}]] animated:YES];

聊天控制器为 KFChatViewController (更详细的信息请见相关类的头文件)

核心 Framework 详解

  1. KFConfig 为全局初始化方法,用于初始化逸创云客服平台地址和应用的 APPID,需要在使用 SDK 前初始化,建议放在 AppDelegate 里;
  2. KFHttpTool 为核心网络请求,里面涉及用户的管理、文档请求、工单请求;
  3. KFChatManager 为核心 IM 请求,里面涉及到 IM 的所有请求,并封装了数据库方法,开发者可非常方便的集成 IM 功能;
  4. KFMessage 为 IM 消息模型;
  5. KFAgent 为客服模型;
  6. KFLogger 为日志打印类,当有错误信息时,会输入日志。开启方式如下:
#ifdef DEBUG
[KFLogger enable:YES];
#else
[KFLogger enable:NO];
#endif

UI 样式设置

所有的 UI 样式被封装在 KFHelper 中,开发者可根据需求直接修改 View 的属性或修改 KFHelper 中的样式

第三方库冲突解决

KF5SDKUI 部分使用的第三方库如果和您使用的有冲突,删除 KF5SDKUI 中相应的第三方库即可