layout: docs_show title: 移动应用 SDK for iOS permalink: /docs/meiqia-ios-sdk/
在您阅读此文档之前,我们假定您已经具备基础的 iOS 应用开发经验并能理解相关基本概念。
如有疑问,欢迎加入美洽 SDK 开发 QQ 群:295646206
美洽 SDK 的工作流程如下图所示。
说明:
Demo中的文件 | 说明 |
---|---|
MeiQiaSDK.framework | 美洽 SDK 的框架。 |
MQChatViewController/ | 美洽提供的开源聊天界面 Library,更多详情请参考 github 。 |
MeiqiaSDKViewInterface | 美洽的 SDK 逻辑接口层 与 开源聊天 Library 的中间层,调用美洽 SDK 的接口,完成界面所需的功能。 |
框架中的文件 | 说明 |
---|---|
MQManager.h | 美洽 SDK 提供的逻辑 API,开发者可调用其中的逻辑接口,实现自定义在线客服界面 |
MCDefination.h | 美洽 SDK 所使用的枚举分类 |
MQAgent.h | 实体类:客服 |
MQMessage.h | 实体类:消息 |
将美洽 SDK 文件夹中的 MeiQiaSDK.framework
、 MQChatViewController/
和 MeiqiaSDKViewInterface/
文件夹(可选)复制到新创建的工程路径下,然后在工程目录结构中,右键选择 添加文件到 “工程名” 。或者将这两个文件直接拖入 XCode 工程目录结构中。
美洽 SDK 的实现依赖于一些系统框架,在开发应用时,您需要在工程中添加这些框架。开发者首先点击工程右边的工程名,然后在工程名右边依次选择 目标 -> 构建阶段 -> 链接二进制与库,展开 链接二进制与库 后点击下面的 + 添加以下依赖项
美洽开源了一套聊天界面 Library,帮助开发者快速创建聊天视图,并提供自定义接口以满足一定定制需求。
如前所述,使用美洽 SDK 必不可少的一步是初始化 SDK,完成初始化后便可操作 SDK 其他功能和接口,例如退出视图等。美洽提供的 UI 简化了开发流程,使得为 APP 添加客服功能最低仅需几行代码和一个 info.plist
配置:
//在AppDelegate.m增加如下 SDK 设置
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[MQManager initWithAppkey:@"开发者的美洽AppKey" completion:^(NSString *clientId, NSError *error) {
}];
return YES;
}
//App 进入后台时,关闭美洽服务
- (void)applicationDidEnterBackground:(UIApplication *)application {
[MQManager closeMeiqiaService];
}
//App 进入前台时,开启美洽服务
- (void)applicationWillEnterForeground:(UIApplication *)application {
[MQManager openMeiqiaService];
}
//在开发者需要调出聊天界面的位置,增加如下代码
MQChatViewManager *chatViewManager = [[MQChatViewManager alloc] init];
[chatViewManager pushMQChatViewControllerInViewController:self];
美洽的图片、语音等静态资源存放在 AWS S3 上,但 s3.amazonaws.com
使用了 SHA1 证书,不满足 iOS 9 的 ATS (App Transport Security) 要求。
因此为了让聊天界面正确显示图片和语音,开发者需要在 App 的 info.plist 中添加如下设置(右键点击info.plist
-> Open As
-> Source Code
)。
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
<key>NSExceptionDomains</key>
<dict>
<key>s3.cn-north-1.amazonaws.com.cn</key>
<dict>
<key>NSExceptionRequiresForwardSecrecy</key>
<false/>
</dict>
</dict>
</dict>
添加完成后,info.plist的显示效果如图:
关于 S3 证书问题,可参考 stackoverflow 上的一个 讨论。
至此,你已经为你的 APP 添加了美洽提供的客服服务。而美洽 SDK 还提供其他强大的功能,可以帮助提高服务效率,提升用户使用体验。接下来为你详细介绍如何使用其他功能。
本节介绍了如何使用美洽的开源聊天界面快速集成客服功能。
注意:
开发者在美洽工作台注册 App 后,可获取到一个可用的 AppKey。在 AppDelegate.m
的系统回调 didFinishLaunchingWithOptions
中调用初始化 SDK 接口:
[MQManager initWithAppkey:@"开发者注册的App的AppKey" completion:^(NSString *clientId, NSError *error) {
}];
如果您不知道 AppKey,请使用美洽管理员账号登录 美洽,在「设置」 -> 「SDK」 菜单中查看。如下图:
当 App 进入后台时,美洽推送给开发者服务端的消息数据中,会有 deviceToken 字段。
将以下代码添加到 AppDelegate.m
的系统回调 didRegisterForRemoteNotificationsWithDeviceToken
中:
[MQManager registerDeviceToken:deviceToken];
美洽推送消息给开发者服务端的数据格式,可参考 推送消息数据结构。
功能效果展示:
为了让客服能更准确帮助用户,开发者可上传不同用户的属性信息。例如下:
//创建自定义信息
NSDictionary* clientCustomizedAttrs = @{
@"name" : @"Kobe Bryant",
@"avatar" : @"http://meiqia.com/avatar.png",
@"身高" : @"1.98m",
@"体重" : @"93.0kg",
@"效力球队" : @"洛杉矶湖人队",
@"场上位置" : @"得分后卫",
@"球衣号码" : @"24号"
};
[MQManager setClientInfo:clientCustomizedAttrs completion:^(BOOL success) {
}];
以下是美洽定义好的字段,开发者可通过上述接口直接设置以下字段:
Key | 说明 |
---|---|
name | 真实姓名 |
avatar | 头像 URL |
tags | 标签,数组形式,且必须是企业中已经存在的标签 |
source | 顾客来源 |
comment | 备注 |
美洽默认会根据管理员设置的分配方式智能分配客服,但如果需要让来自 App 的顾客指定分配给某个客服或某组客服,需要在上线前添加以下代码:
如果您使用美洽提供的 UI,可对 UI 进行如下配置,进行指定分配:
MQChatViewManager *chatViewManager = [[MQChatViewManager alloc] init];
[chatViewManager setScheduledAgentToken:agentToken];
如果您自定义 UI,可以直接使用如下美洽 SDK 逻辑接口:
//分配到指定客服,或指定组里面的客服,指定客服优先级高,并可选择分配失败后的转接规则
[MQManager setScheduledAgentWithAgentId:agentId agentGroupId:agentGroupId scheduleRule:rule];
注意
美洽开源了一套 聊天界面 Library,完成了一整套 MQManager
中的接口。让开发者免去了 UI 开发工作。并在 MQChatViewController
类中添加了其他自定义选项和功能扩展。
你只需要在用户需要客服服务的时候,退出美洽 UI。例如下:
//当用户需要使用客服服务时,创建并退出视图
MQChatViewManager *chatViewManager = [[MQChatViewManager alloc] init];
[chatViewManager pushMQChatViewControllerInViewController:self];
注意,如果这样不对 MQChatViewManager
进行任何配置直接调出视图,实际是用美洽初始化 SDK 后的顾客进行上线。如果开发者需要指定顾客上线,请参考
MQServiceToViewInterface
文件是开源聊天界面调用美洽 SDK 接口的中间层,目的是剥离开源界面中的美洽业务逻辑。这样就能让该聊天界面用于非美洽项目中,开发者只需要实现 MQServiceToViewInterface
中的方法,即可将自己项目的业务逻辑和该聊天界面对接。
更多开源聊天界面 Library 详细介绍和使用方法,请转至 github。
下面介绍了开源 UI 中的美洽逻辑的配置,开发者可以根据需求对其进行配置,然后调用聊天视图。
如果开启消息同步,在聊天界面中下拉刷新将获取服务端的历史消息;
如果关闭消息同步,则是获取本机数据库中的历史消息;
由于顾客可能在多设备聊天,关闭消息同步后获取的历史消息可能少于服务端的历史消息。
MQChatViewManager *chatViewManager = [[MQChatViewManager alloc] init];
//开启同步消息
[chatViewManager enableSyncServerMessage:true];
[chatViewManager pushMQChatViewControllerInViewController:self];
上述已有介绍,请参考 指定分配客服和客服组。
设置开发者自定义 id 后,将会以该自定义 id 对应的顾客上线。
注意,如果美洽服务端没有找到该自定义 id 对应的顾客,则美洽将会自动关联该 id 与 SDK 当前的顾客。
MQChatViewManager *chatViewManager = [[MQChatViewManager alloc] init];
[chatViewManager setLoginCustomizedId:customizedId];
[chatViewManager pushMQChatViewControllerInViewController:self];
使用该接口,可让美洽绑定开发者的用户系统和美洽的顾客系统。
注意,如果开发者的自定义 id 是自增的,美洽建议开发者服务端保存美洽顾客 id,登录时设置 登录客服的顾客 id,否则很容易受到中间人攻击。
设置美洽顾客的 id 后,该 id 对应的顾客将会上线。
MQChatViewManager *chatViewManager = [[MQChatViewManager alloc] init];
[chatViewManager setLoginMQClientId:clientId];
[chatViewManager pushMQChatViewControllerInViewController:self];
注意,如果美洽服务端没有找到该顾客 id 对应的顾客,则会返回该顾客不存在
的错误。
开发者需要获取 clientId,可使用接口[MQManager getCurrentClientId]
。
请参考 美洽开源聊天界面的国际化说明。
开源聊天界面的更多配置,可参见 MQChatViewManager.h 文件。
本节主要介绍部分重要的接口。在MeiqiaSDK.framework
的MQManager.h
中,所有接口都有详细注释。
开发者可使用美洽提供的 API,自行定制聊天界面。使用以下接口前,别忘了 初始化 SDK。
美洽建议开发者在 AppDelegate.m
的系统回调 didFinishLaunchingWithOptions
中,调用初始化 SDK 接口。这是因为第一次初始化美洽 SDK,SDK 会向美洽服务端发送一个初始化顾客的请求,SDK 其他接口都必须是在初始化 SDK 成功后进行,所以 App 应尽早初始化 SDK 。
//建议在AppDelegate.m系统回调didFinishLaunchingWithOptions中增加
[MQManager initWithAppkey:@"开发者注册的App的AppKey" completion:^(NSString *clientId, NSError *error) {
}];
美洽需要获取每个设备的 deviceToken,才能在 App 进入后台以后,推送消息给开发者的服务端。消息数据中有 deviceToken 字段,开发者获取到后,可通知 APNS 推送给该设备。
在 AppDelegate.m中的系统回调 didRegisterForRemoteNotificationsWithDeviceToken
中,调用上传 deviceToken 接口:
[MQManager registerDeviceToken:deviceToken];
详细介绍请见 消息推送。
该接口上文已有介绍,请见 指定分配客服和客服组。
初始化 SDK 成功后,SDK 中有一个可使用的顾客 id,调用该接口即可让其上线,如下代码:
[MQManager setCurrentClientOnlineWithCompletion:^(MQClientOnlineResult result, MQAgent *agent, NSArray<MQMessage *> *messages) {
//可根据result来判断是否上线成功
} receiveMessageDelegate:self];
开发者可通过 获取当前顾客 id 接口,取得顾客 id,保存到开发者的服务端,以此来绑定美洽顾客和开发者用户系统。如果开发者保存了美洽的顾客 id,可调用如下接口让其上线。调用此接口后,当前可用的顾客即为开发者传的顾客 id。
[MQManager setClientOnlineWithClientId:clientId completion:^(MQClientOnlineResult result, MQAgent *agent, NSArray<MQMessage *> *messages) {
//可根据result来判断是否上线成功
} receiveMessageDelegate:self];
如果开发者不愿保存美洽顾客 id,来绑定自己的用户系统,也将用户 id 作为参数,进行顾客的上线,美洽将会为开发者绑定一个顾客,下次开发者直接调用如下接口,就能让这个绑定的顾客上线。
调用此接口后,当前可用的顾客即为该自定义 id 对应的顾客 id。
特别注意:传给美洽的自定义 id 不能为自增长的,否则非常容易受到中间人攻击,此情况的开发者建议保存美洽顾客 id。
[MQManager setClientOnlineWithCustomizedId:customizedId completion:^(MQClientOnlineResult result, MQAgent *agent, NSArray<MQMessage *> *messages) {
//可根据result来判断是否上线成功
} receiveMessageDelegate:self];
开发者可监听顾客上线成功的广播,在上线成功后,可上传该顾客的自定义信息等操作。广播的名字为 MQ_CLIENT_ONLINE_SUCCESS_NOTIFICATION
,定义在 MQDefinition.h 中。
开发者可通过此接口接口,取得顾客 id,保存到开发者的服务端,以此来绑定美洽顾客和开发者用户系统。
NSString *clientId = [MQManager getCurrentClientId];
如果开发者想初始化一个新的顾客,可调用此接口。
该顾客没有任何历史记录及用户信息。
开发者可选择将该 id 保存并与 App 的用户绑定。
[MQManager createClient:^(BOOL success, NSString *clientId) {
//开发者可保存该clientId
}];
NSString *clientId = [MQManager setClientOffline];
如果没有设置顾客离线,开发者设置的代理将收到即时消息,并收到新消息产生的广播。开发者可以监听此 notification,用于显示小红点未读标记。
如果设置了顾客离线,则客服发送的消息将会发送给开发者的服务端。
美洽建议
,顾客退出聊天界面时,不设置顾客离线,这样开发者仍能监听到收到消息的广播,以便提醒顾客有新消息。
开发人员可以在合适的位置监听收到消息的广播,以提醒用户有新消息。广播名为 MQ_RECEIVED_NEW_MESSAGES_NOTIFICATION
,定义在 MQDefinition.h 中。
开发人员可以通过获取广播中的 userInfo 来获取收到的消息数组,数组中是美洽消息 MQMessage 实体,例如:[notification.userInfo objectForKey:@"messages"]
注意,如果用户退出聊天界面,开发人员没有调用设置用户离线接口的话,之后该用户收到新消息,仍然能收到有新消息的广播
。
#pragma 在合适的地方监听有新消息的广播
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(didReceiveNewMQMessages:) name:MQ_RECEIVED_NEW_MESSAGES_NOTIFICATION object:nil];
#pragma 监听收到美洽聊天消息的广播
- (void)didReceiveNewMQMessages:(NSNotification *)notification {
//广播中的消息数组
NSArray *messages = [notification.userInfo objectForKey:@"messages"];
NSLog(@"监听到了收到客服消息的广播");
}
开发人员可以使用此接口获取当前正在接待用户的客服信息:
MQAgent *agent = [MQManager getCurrentAgent];
添加自定义信息的操作与上述相同,请参阅 添加自定义信息。
开发人员可以使用此接口获取服务端的历史消息:
[MQManager getServerHistoryMessagesWithUTCMsgDate:firstMessageDate messagesNumber:messageNumber success:^(NSArray<MQMessage *> *messagesArray) {
//显示获取到的消息等逻辑
} failure:^(NSError *error) {
//进行错误处理
}];
注意,服务端的历史消息是该用户在所有平台上产生的消息,包括网页端、Android SDK、iOS SDK、微博、微信,可在聊天界面的下拉刷新处调用。
由于使用 从服务端获取更多消息接口,会产生数据流量,开发人员也可以使用此接口来获取 iOS SDK 本地的历史消息。
[MQManager getDatabaseHistoryMessagesWithMsgDate:firstMessageDate messagesNumber:messageNumber result:^(NSArray<MQMessage *> *messagesArray) {
//显示获取到的消息等逻辑
}];
注意,由于没有同步服务端的消息,所以本地数据库的历史消息可能少于服务端的消息。
开发人员可能已经注意到了,前面提到的3个用户上线接口,都包含一个参数是设置接收消息的代理
,开发人员可以在这里设置接收消息的代理,让代理来接收消息。
设置代理后,实现 MQManagerDelegate
中的 didReceiveMQMessage:
方法,就可以通过这个代理函数接收消息。
开发人员可以通过调用此接口来发送文字消息
:
[MQManager sendTextMessageWithContent:content completion:^(MQMessage *sendedMessage) {
//消息发送成功后的处理
}];
开发人员可以通过调用此接口来发送图片消息
:
[MQManager sendImageMessageWithImage:image completion:^(MQMessage *sendedMessage) {
//消息发送成功后的处理
}];
开发人员可以通过调用此接口来发送语音消息
:
[MQManager sendAudioMessage:audioData completion:^(MQMessage *sendedMessage, NSError *error) {
//消息发送成功后的处理
}];
注意,调用发送消息接口后,回调中会返回一个消息实体,开发人员可以据此判断该条消息是发送成功还是发送失败。
如果您的开发项目也是 SDK,那么在了解常规 App 嵌入美洽 SDK 的基础上,还需要注意其他事项。
与 App 嵌入美洽 SDK 的步骤相同,需要 导入美洽 SDK -> 引入依赖库 -> 初始化 SDK -> 使用美洽 SDK。
如果开发人员使用了美洽提供的聊天界面,还需要公开素材包:
开发人员点击工程右边的工程名,然后在工程名右边依次选择 TARGETS -> BuiLd Phases -> Copy Files ,展开 Copy Files 后点击展开后下面的 + 来添加美洽素材包 MQChatViewAsset.bundle
。
在之后发布您的 SDK 时,将 MQChatViewAsset.bundle
一起打包即可。
当前仅支持一种推送方案,即美洽服务端将消息发送至开发者的服务端,开发者再将消息推送至 App,可见 SDK 工作流程。
未来美洽 iOS SDK 将会支持直接将消息推送至 App,即开发人员可以将 App 的推送证书上传至美洽,美洽将消息推送至苹果 APNS 服务器。目前正在紧张开发中。
推送消息将会发送至开发者的服务器。
设置服务器地址,请使用美洽管理员账号登录 美洽,在「设置」 -> 「SDK」中设置。
目前,美洽的推送是通过将推送消息发送至开发者提供的 URL 来实现的。
当 App 进入后台时,应通知美洽服务端,让其将之后的消息推送给开发者提供的服务器地址。
开发人员需要在 AppDelegate.m
的系统回调 applicationDidEnterBackground
中调用关闭美洽服务接口,如下代码:
- (void)applicationDidEnterBackground:(UIApplication *)application {
[MQManager closeMeiQiaService];
}
当 App 进入前台时,应通知美洽服务端,让其将之后的消息发送给 SDK,而不再推送给开发者提供的服务器地址。
开发人员需要在 AppDelegate.m
的系统回调 applicationWillEnterForeground
中调用开启美洽服务接口,如下代码:
- (void)applicationWillEnterForeground:(UIApplication *)application {
[MQManager openMeiQiaService];
}
当有消息需要推送时,美洽服务器会向开发人员设置的服务器地址发送推送消息,方法类型为 POST,数据格式为 JSON 。
发送请求的格式介绍:
request.header.authorization 为数据签名。
request.body 为消息数据,数据结构为:
Key | 说明 |
---|---|
messageId | 消息 id |
content | 消息内容 |
messageTime | 发送时间 |
fromName | 发送人姓名 |
deviceToken | 发送对象设备的 deviceToken,格式为字符串 |
clientId | 发送对象的客户 id |
customizedId | 开发者上传的自定义 ID |
contentType | 消息类型 - 文本/照片/音频 |
deviceOS | 设备系统 |
customizedData | 开发者上传的自定义属性 |
开发者可以根据请求中的签名,对推送消息进行数据验证。美洽提供了 Java、Python、Ruby、JavaScript、PHP
5种语言的计算签名的代码,具体请参阅 美洽 SDK 3.0 推送的数据结构签名算法。
当前 SDK 是为美洽 3.0 提供,如果你使用的是美洽 2.0「经典版」的 AppKey,请使用美洽 2.0「经典版」SDK
传送门:
如果没有配置NSExceptionDomains
,美洽 SDK 会返回 MQErrorCodePlistConfigurationError
,并且在控制台中打印:!!!美洽 SDK 错误:请开发者在 App 的 info.plist 中增加 NSExceptionDomains,具体操作方法请参阅「https://github.com/Meiqia/MeiqiaSDK-iOS#info.plist设置」
。如果出现上述情况,请 配置 NSExceptionDomains
注意,如果发现添加配置后,仍然打印配置错误,请开发者检查是否错误地将配置添加到了项目 Tests 的 info.plist 中。
如果上述情况都不存在,请检查引入美洽 SDK 的设备的网络是否通畅
美洽开源的聊天界面使用的是系统的 UINavgationController
,所以没有显示导航栏的原因可能有3种:
Push
方式弹出视图,那么可能是传入 viewController
没有基于 UINavigationController
。Push
方式弹出视图,那么可能是 UINavgationBar
被隐藏或者是透明的。Category
,对 UINavgationBar
做了修改,造成无法显示。其中 1、2 种情况,除了修改代码,还可以直接使用 present
方式弹出视图解决。
如果开发者的 App 最低支持系统是 7.0 以下,将会出现这种警告。
ld: 警告:目标文件(/Meiqia-SDK-Demo/MQChatViewController/Vendors/MLAudioRecorder/amr_en_de/lib/libopencore-amrnb.a(wrapper.o))构建用于更高版本的 iOS(7.0),而链接的是(6.0)
原因是美洽将 SDK 中使用的开源库 opencore-amr 针对支持 Bitcode 而重新编译了一次,但这并不影响 SDK 在 iOS 6 中的使用。如果你介意,并且不会使用 Bitcode,可以将美洽 SDK 中使用的 opencore-amr
替换为老版本:传送门
因为美洽静态库包含5个平台(armv7、armv7s、arm64、i386、x86_64)+ Bitcode。但这并不代表会严重影响编译后的宿主 App 大小,实际上,这只会增加宿主 App 100kb 左右大小。
请检查是否使用了第三方开源库 IQKeyboardManager,该开源库会与判断输入框的逻辑冲突。
解决方案:(感谢 RandyTechnology 提供该问题的原因和解决方案)
MQChatViewController
的 viewWillAppear
里加入 [[IQKeyboardManager sharedManager] setEnable:NO];
,作用是在当前页面禁用 IQKeyboardManagerMQChatViewController
的 viewWillDisappear
里加入 [[IQKeyboardManager sharedManager] setEnable:YES];
,作用是在离开当前页面之前重新启用 IQKeyboardManager使用了 TabBarController 的 App,视图结构各不相同,并且可能存在自定义 TabBar 的情况,所以美洽 SDK 无法判断并准确调整,需要开发者自行修改 App 或 SDK 代码。自 iOS 7 系统后,大多数情况下只需修改 TabBar 的 hidden
和 translucent
属性便可以正常使用。
请参阅 指定分配客服和客服组 中的配图。
请查看 如何监听监听收到消息的广播。
请查看指定的客服的服务顾客的上限是否被设置成了0,或服务顾客的数量是否已经超过服务上限。查看位置为:工作台 - 设置 - 客服与分组 - 点击某客服
由于「聊天界面」的项目中用到了几个开源库,如果开发者使用相同的库,会产生命名空间冲突的问题。遇到此类问题,开发者可以选择删除「聊天界面 - Vendors」中的相应第三方代码。
注意,美洽对几个第三方库进行了自定义修改,如果开发者删除了美洽中的 Vendors,聊天界面将会缺少我们自定义的效果,详细请移步 Github 美洽开源聊天界面。
v3.1.2 2016年02月22日
v3.1.1 2016年02月17日
v3.1.0 2016年01月28日
v3.0.9 2016年01月14日
v3.0.8 2016年01月13日
v3.0.7 2016年01月11日
v3.0.6 2016年01月6日
v3.0.5 2016年01月5日
v3.0.4 2015年12月31日
v3.0.2 2015年12月30日