KF5SDK帮助开发者快速完成开发，提供给开发者创建工单、查看工单列表、回复工单、查看和搜索知识库文档、消息通知推送、即时IM等功能。目前支持iOS9.0及以上系统(需要xcode10.0及以上)。KF5SDK2.0版现已经支持bitcode和国际化。
为了更好的与企业的业务紧密结合，KF5SDK开源了SDK的UI界面，开发者可以根据自己的需求开发不同风格的页面，也可以使用KF5SDK提供的默认界面快速集成客服功能。
帮助中心允许用户在您的APP查看和搜索您云客服平台上的知识库文档。
用户可以在您的APP上反馈问题，反馈的问题您可以在云客服平台上处理，用户可在APP上查看反馈结果，并可与您进行交流。
用户可以通过APP与客服人员实时交流，实时发送和接收文字消息、语音消息、图片、附件，并为此提供了灵活的接口。
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
target 'TargetName' do
pod 'KF5SDK', '~>2.11.3'
endgithub "KF5SDK/KF5SDK-iOS2.0" ~>2.11.3
1、先下载KF5SDK的官方demo。将KF5SDK下的文件拖拽到自己的工程中。
2、添加系统库支持，添加 JavaScriptCore.framework， JavaScriptCore.framework， libsqlite3.tbd到自己的工程。
Privacy - Camera Usage Description：是否允许该应用使用你的相机？
Privacy - Microphone Usage Description：是否允许该应用使用你的麦克风?
Privacy - Photo Library Usage Description：是否允许该应用访问你的媒体资料库？
在使用SDK相关功能模块前，需要先设置KF5平台域名和appid，并调用KFUserManager的初始化用户的方法获取到userToken(用户唯一标示)，下面为使用邮箱初始化用户的方法：
// 初始化配置信息
[KFUserManager initializeWithHostName:kHostName appId:kAppId];
// 如果userToken为空，则需要初始化用户
if ([KFUserManager shareUserManager].user.userToken.length == 0) {
[[KFUserManager shareUserManager]initializeWithEmail:@"[email protected]" completion:^(KFUser * _Nullable user, NSError * _Nullable error) {
}];
}注意：
1、[KFUserManager initializeWithHostName:kHostName appId:kAppId]中khostName为您平台的http地址，如：https://tianxiang.kf5.com, kAppId为您为用户创建的唯一标示（在您的KF5后台创建移动SDK APP应用，APP应用里的传输密钥即为appId）。此方法可放在AppDelegate里初始化。
2、最好在使用SDK相关功能前调用，比如设置界面，不建议在AppDelegate中调用此方法，因为当前服务器对每个平台平均的创建用户量有一定的限制。KF5SDK是专用于普通用户的，因此初始化用户时应该使用不同的邮箱或手机号,否则App中的每个用户看到的所有信息全部相同。
引入#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];
工单自定义字段需要在创建工单前设置,对应方法为KFCreateTicketViewController中的setCustomFields方法,格式为@[@{@"name":@"field_123",@"value":@"手机端"},@{@"name":@"field_321",@"value":@"iOS"}]。
注：工单部分有工单列表、工单内容、创建工单、工单详细信息，分别对应控制器为
KFTicketListViewController、KFTicketViewController、KFCreateTicketViewController、KFDetailMessageViewController。更详细的信息请见相关类的头文件。
引入#import "KF5SDKChat.h"
调用方法如下：
[self.navigationController pushViewController:[[KFChatViewController alloc]initWithMetadata:@[@{@"name":@"系统",@"value":@"IOS"},@{@"name":@"应用名称",@"value":@"云客服"}]] animated:YES]; 用户自定义信息需要在初始化KFChatViewController时设置,在initWithMetadata:中设置metadata,格式为@[@{@"name":@"系统",@"value":@"IOS"},@{@"name":@"应用名称",@"value":@"云客服"}]。
注：聊天部分有聊天控制器，对应控制器为
KFChatViewController。更详细的信息请见相关类的头文件。
KFConfig为全局初始化方法，用于初始化KF5平台地址和应用的APPID，需要在使用SDK前初始化，建议放在AppDelegate里。
KFHttpTool为核心网络请求，里面涉及用户的管理、文档请求、工单请求。
KFChatManager为核心IM请求，里面涉及到IM的所有请求，并封装了数据库方法，开发者可非常方便的集成IM功能。
KFMessage为IM消息模型。
KFAgent为客服模型。
KFLogger为日志打印类，当有错误信息时，会输入日志。开启方式如下：
#ifdef DEBUG
[KFLogger enable:YES];
#else
[KFLogger enable:NO];
#endif云客服移动SDK 通知普通用户工单被客服公开回复，或即时交谈的离线消息。
目前集成推送通知的唯一方法是使用一个回调的API，在使用该API前，您必须保证您的应用开启了远程推送服务。
在这里，你需要做三件事：
1、 在你的账号里配置您的移动SDK应用程序启动推送通知
2、 设置回调URL支持我们的回调
3、 在您的应用程序处理用户的唯一标示和推送请求
当有消息发送时，云客服SDK将通知您设置的回调URL。之后，您的服务必须处理发送推送通知到最终用户的设备。 当我们想要发送一个通知给最终用户,我们会发送一个流请求的URI设置应用程序配置。示例请求:
<回调URL>
Content-Type: application/json
Accept: application/json
{
// 用户的信息 object
"user":{
// 被推送的user_id inter
"user_id":123
},
// 设备的列表 array
"device":[{
// 设备的唯一标示 string
"device_token":"1234567890",
// 设备的类型 string
"type":"IOS"
}],
// 推送通知信息 object
"notification": {
// 工单的id
"ticket_id":"123",
// 类型
"type":"ticket"
}
}同样，在聊天中发送离线消息中，向设置的回调URL发送的数据示例:
<回调URL>
Content-Type: application/json
Accept: application/json
{
// 用户的信息 object
"user":{
// 被推送的user_id inter
"user_id":123
},
// 设备的列表 array
"device":[{
// 设备的唯一标示 string
"device_token":"1234567890",
// 设备的类型 string
"type":"IOS"
}],
// 推送通知信息 object
"notification": {
// 聊天消息
"message":"hello",
// 类型
"type":"im"
}
}给您的应用程序注册通知
通过 [[KFUserManager shareUserManager] saveDeviceToken:@"xxxxxx" completion:^(NSDictionary * _Nullable result, NSError * _Nullable error) {}];发送最终用户的唯一标示，即可完成推送设置。
建议：最好在用户退出登录或不需要推送的时候，通过[[KFUserManager shareUserManager] deleteDeviceToken:@"xxxxxx" completion:^(NSDictionary * _Nullable result, NSError * _Nullable error) {}];将用户的唯一标示删除。
#import "KFUserManager.h"
/**
保存deviceToken
@param deviceToken 用户deviceToken,不能为空
@warning 必须初始化完成后,才能使用
*/
- (void)saveDeviceToken:(nonnull NSString *)deviceToken completion:(nullable void (^)(NSDictionary * _Nullable result, NSError * _Nullable error))completion;
/**
删除deviceToken
@param deviceToken 用户deviceToken,不能为空
@warning 必须初始化完成后,才能使用
*/
- (void)deleteDeviceToken:(nonnull NSString *)deviceToken completion:(nullable void (^)(NSDictionary * _Nullable result, NSError * _Nullable error))completion;1、KF5SDK分为两个部分,KF5SDKCore.framework和UI两个部分,具体的使用方式可以参考demo,也可以具体看类的.h文件,里面提供详细的注释供参考。
2、所有的UI样式被封装在KFHelper中，开发者可根据需求直接修改View的属性或修改KFHelper中的样式。
3、KF5SDK/UI部分使用的第三方库如果和您的有冲突，删除UI中相应的第三方库即可。
4、如果在KFChatViewController和KFTicketViewController界面出现弹出键盘时,视图和导航栏都往上移动且工具栏与键盘之间留有空隙,则请检查您是否集成了类似IQKeyboardManager的第三方库,如果有,只需要在KFChatViewController和KFTicketViewController中禁止掉IQKeyboardManager即可!
修复IM对话关闭后,表情键盘没有切换会文字键盘的问题
更新KF5SDK.podspec设置
修复文档中心点击搜索框可能会崩溃的问题
删除UIWebView,并替换成WKWebView
新增IM支持机器人热门问题和自定义问题,新增IM机器人支持接收图片消息
新增IM支持视频消息
更新问题分配方式,问题分配需在KF5后台重新配置
新增工单催单接口
修复IM去留言点击事件错误的问题
支持工单和文档的相对路径
调整文件结构,支持Cocoapods,支持Carthage
新增支持客服撤回操作
优化录音操作体验,优化代码
修复有可能与Masonry冲突的问题,优化代码
新增支持IM机器人选择机器人题库分类和文档知识库分类
添加支持IM排队超时提醒
新增IM聊天消息对img标签的支持,新增文档内容支持附件,优化性能
新增IM问题分配功能,适配iPhoneX
新增IM卡片消息展示功能,适配工单和IM满意度三种级别可选,优化IM的体验
修复IM可能丢消息的问题
新增IM同步客服头像功能,修复刷新bug
修复IM输入框在某些状态下布局出错的问题
新增支持IM服务时间,优化代码,修复部分bug
新增机器人关闭状态先发送消息后排队的设置,修复部分bug
优化体验,修复部分bug
新增SDK支持IM分词匹配功能,优化代码
SDKIM新增消息类型,修复工单内容不显示的bug
新增SDK支持IM超时应答功能,修复部分bug
新增SDK支持用户的受理客服功能,优化代码
修复IM满意度评价可能出错的bug,添加自定义国际化支持,修复工单批量上传图片可能会漏掉的bug,优化代码
新增工单满意度评价功能,修复部分bug
修复聊天创建cell使用标识不正确的问题
iOS SDK2.0beta版更新