公告

接入sdk编译报错误请升级Xcode到最新版本或者选择“sdk_xcode10”分支下载导入！！！

SDK下载地址

https://github.com/udesk/udesk_mchat_ios

一、集成SDK

兼容性

类别	兼容范围
系统	支持iOS 8.0及以上系统
架构	armv7、arm64、i386、x86_64
开发环境	建议使用最新版本Xcode进行开发
Cocoapods	不支持

通过Pod导入SDK

pod 'MChatSDK', :git => 'https://github.com/udesk/udesk_mchat_ios'

手动导入SDK

把Udesk SDK 文件夹中的 UdeskMChatSDK.framework 、 UdeskMChatUIKit文件夹拷贝到新创建的工程路径下面，然后在工程目录结构中，右键选择 Add Files to “工程名” 。或者将这两个个文件拖入 Xcode 工程目录结构中。

1.1 引入依赖库

libxml2.tbd
libresolv.tbd

1.2 注意事项

多商户SDK使用了以下第三方框架，如果你们APP中也使用了则需要把我们SDK里的第三方框架删除。（框架路径：UdeskMChat/UdeskMChatUIKit/Tools/Vendor）
如果你使用的是xcode8 请在你项目的Info.plist文件里添加使用相册、相机、麦克风、保存图片到相册的权限

<key>NSCameraUsageDescription</key>

<string>App需要访问您的相机</string>

<key>NSMicrophoneUsageDescription</key>

<string>App需要访问您的麦克风</string>

<key>NSPhotoLibraryAddUsageDescription</key>

<string>App需要为您添加图片</string>

<key>NSPhotoLibraryUsageDescription</key>

<string>App需要访问您的相册</string>

二、快速使用

引入 ‘ #import <UdeskMChatSDK/UdeskMChatSDK.h>’

在AppDelegate、或者登陆成功之后里初始化SDK

签名生成规则：

出于安全的考虑，建议租户将 key 保存在自己的服务器端，App 端通过租户提供的接口获取经过 SHA1 计算后的加密字符串(sign)和时间戳(timestamp),时间戳精确到秒，然后传给 SDK。密码的有效期为时间戳 +/- 5分钟 SHA1("租户uuid+租户key+时间戳")加密字符粗的格式

数据名称	说明
uuid	Udesk后台提供
secret	Udesk后台提供
timestamp	获取精确到秒的时间戳

sign = SHA1("uuid+secret+timestamp")

//初始化sdk（UUID、timestamp、sign 都是必传字段！！！）
UMCSystem *system = [UMCSystem new];
system.UUID = @"a04d138d-98fb-4b9d-b2a7-478b7c0c1ce9";
system.timestamp = @"timestamp";
system.sign = @"sign";
            
UMCCustomer *customer = [UMCCustomer new];
customer.euid = @"euid"; //必填字段！！！
customer.name = @"name"; //必填字段！！！

//非必填字段
customer.cellphone = @"13888888888";
customer.email = @"test@udesk.cn";
customer.org = @"org";
customer.tags = @"测试1,测试2";
customer.customerDescription = @"用户描述";
customer.customField = @{
  @"TextField_34012":@"测试",
  @"SelectField_533":@[@(1)],
};
            
[UMCManager initWithSystem:system customer:customer completion:^(NSError *error) {
    NSLog(@"%@",error);
}];

参数名称	类型	是否必填	说明
UUID	NSString	是	贵公司注册Udesk多商户系统，后台分配的ID
timestamp、sign	NSString	是	时间戳、签名，由你们后端返回
euid	NSString	是	用户的唯一标识，用来识别身份,是你们生成传入给我们的。传入的字符请使用字母 / 数字等常见字符集。就如同身份证一样，不允许出现一个身份证号对应多个人，或者一个人有多个身份证号；其次如果给顾客设置了邮箱和手机号码，也要保证不同顾客对应的手机号和邮箱不一样，如出现相同的，则不会创建新顾客
name	NSString	是	用户昵称
email	NSString	否	用户邮箱，需要严格按照邮箱规则。没有则不填！不可以为空！不可以为固定值！不可以随便填！
cellphone	NSString	否	用户号码，需要严格按照号码规则。没有则不填！不可以为空！不可以为固定值！不可以随便填！
org	NSString	否	公司名称
tags	NSString	否	用户标签，用逗号分隔如："帅气,漂亮"
customerDescription	NSString	否	用户描述
customField	NSDictionary	否	用户自定义字段

UUID可以在管理后台 -> 平台信息获得
fieldKey是Udesk生成的，可以在 “管理后台” -> “管理中心” -> “管理” -> “客户字段” 获得
fieldValue有两种类型，1.文字字段：字符串类型；2.选择字段：数组类型（数组元素为选项的下标）

在合适的地方添加商户列表View

UMCMerchantsView *merchats = [[UMCMerchantsView alloc] initWithFrame:CGRectMake(0, 0, self.view.frame.size.width, self.view.frame.size.height) sdkConfig:[self getConfig]];
[self.view addSubview:merchats];

- (UMCSDKConfig *)getConfig {
    
    UMCSDKConfig *config = [UMCSDKConfig sharedConfig];
    
    UMCSDKStyle *styly = [UMCSDKStyle defaultStyle];
    config.sdkStyle = styly;
    
    return config;
}

进入聊天页

UMCSDKManager *sdkManager = [[UMCSDKManager alloc] initWithMerchantId:@"商户ID"];
sdkManager.sdkConfig = [UMCSDKConfig sharedConfig];
[sdkManager pushUdeskInViewController:self completion:nil];

三、自定义配置

3.1 咨询对象

客户通过某个商品详情页点击咨询按钮直接和客服进行会话

UMCSDKManager *sdkManager = [[UMCSDKManager alloc] initWithMerchantId:@"商户ID"];
sdkManager.sdkConfig = [self getConfig];
[sdkManager pushUdeskInViewController:self completion:nil];
            
- (UMCSDKConfig *)getConfig {
    
    UMCSDKConfig *config = [UMCSDKConfig sharedConfig];
    
#warning 这里写死了单个商品的咨询对象，实际开发中可根据需求自定义
    UMCProduct *product = [[UMCProduct alloc] init];
    product.title = @"iPhone X";
    product.image = @"https://g-search3.alicdn.com/img/bao/uploaded/i4/i3/1917047079/TB1IfFybl_85uJjSZPfXXcp0FXa_!!0-item_pic.jpg_460x460Q90.jpg";
    product.url = @"http://www.apple.com/cn";
    
    UMCProductExtras *extras = [[UMCProductExtras alloc] init];
    extras.title = @"标题";
    extras.content = @"¥9999";
    
    product.extras = @[extras];
    
    config.product = product;
    
    UMCSDKStyle *styly = [UMCSDKStyle defaultStyle];
    config.sdkStyle = styly;
    
    return config;
}

3.2 商品消息

UMCSDKManager *sdkManager = [[UMCSDKManager alloc] initWithMerchantId:@"商户ID"];
sdkManager.sdkConfig = [self getConfig];
[sdkManager pushUdeskInViewController:self completion:nil];
            
- (UMCSDKConfig *)getConfig {
    
    UMCSDKConfig *config = [UMCSDKConfig sharedConfig];
    
    UMCCustomButtonConfig *customButton = [[UMCCustomButtonConfig alloc] initWithTitle:@"自定义按钮" clickBlock:^(UMCCustomButtonConfig *customButton, UMCIMViewController *viewController){
        
        //点击自定义按钮回调
        //示例里直接在回调里发送了商品消息，开发者可以根据自己需求进行修改
        [viewController sendGoodsMessageWithModel:[self getGoodsModel]];
    }];
    
    config.showCustomButtons = YES;
    config.customButtons = @[customButton];
    
    UMCSDKStyle *styly = [UMCSDKStyle defaultStyle];
    config.sdkStyle = styly;
    
    return config;
}

- (UMCGoodsModel *)getGoodsModel {
    
    UMCGoodsModel *goodsModel = [[UMCGoodsModel alloc] init];
    goodsModel.goodsId = @"12";
    goodsModel.name = @"Apple iPhone X (A1903) 64GB 深空灰色 移动联通4G手机";
    goodsModel.url = @"https://item.jd.com/6748052.html";
    goodsModel.imgUrl = @"http://img12.360buyimg.com/n1/s450x450_jfs/t10675/253/1344769770/66891/92d54ca4/59df2e7fN86c99a27.jpg";
    
    UMCGoodsParamModel *paramModel1 = [UMCGoodsParamModel new];
    paramModel1.text = @"￥6999.00";
    paramModel1.color = @"#FF0000";
    paramModel1.fold = @(1);
    paramModel1.udBreak = @(1);
    paramModel1.size = @(14);
    
    UMCGoodsParamModel *paramModel2 = [UMCGoodsParamModel new];
    paramModel2.text = @"满1999元另加30元";
    paramModel2.color = @"#c2fcc3";
    paramModel2.fold = @(1);
    paramModel2.size = @(12);
    
    UMCGoodsParamModel *paramModel3 = [UMCGoodsParamModel new];
    paramModel3.text = @"但是我会先提价100";
    paramModel3.color = @"#ffffff";
    paramModel3.fold = @(1);
    paramModel3.size = @(20);
    
    goodsModel.params = @[paramModel1,paramModel2,paramModel3];
    
    return goodsModel;
}

3.3 自定义按钮

//按钮位于输入框上方
UMCCustomButtonConfig *buttonConfig1 = [[UMCCustomButtonConfig alloc] initWithTitle:@"自定义按钮1" clickBlock:^(UMCCustomButtonConfig *customButton, UMCIMViewController *viewController) {
		//do something
	  //UdeskChatViewController 有可以发送消息的方法。
}];
buttonConfig1.type = UMCCustomButtonTypeInInputTop;

//按钮位于更多
UMCCustomButtonConfig *buttonConfig2 = [[UMCCustomButtonConfig alloc] initWithTitle:@"自定义按钮2" clickBlock:^(UMCCustomButtonConfig *customButton, UMCIMViewController *viewController) {
		//do something
	  //UdeskChatViewController 有可以发送消息的方法。
}];
buttonConfig2.type = UMCCustomButtonTypeInMoreView;

UMCSDKConfig *config = [UMCSDKConfig sharedConfig];
config.showCustomButtons = YES;
config.customButtons = @[buttonConfig1,buttonConfig2];
    
UMCSDKStyle *style = [UMCSDKStyle defaultStyle];
config.sdkStyle = style;

//直接进入聊天页面
UMCSDKManager *sdkManager = [[UMCSDKManager alloc] initWithMerchantEuid:@"merchantEuid"];
sdkManager.sdkConfig = config;
[sdkManager pushUdeskInViewController:self completion:nil];

//进入到商户列表
//UMCMerchantsView *merchats = [[UMCMerchantsView alloc] initWithFrame:self.view.bounds sdkConfig:config];
//[self.view addSubview:merchats];

四、离线推送

//获取deviceToken(注意：如果是用的第三方推送，需要传第三方自己的ID)
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    [UMCManager registerDeviceToken:deviceToken];
}

//App 进入后台时，关闭Udesk推送
- (void)applicationDidEnterBackground:(UIApplication *)application {
  
    __block UIBackgroundTaskIdentifier background_task;
    //注册一个后台任务，告诉系统我们需要向系统借一些事件
    background_task = [application beginBackgroundTaskWithExpirationHandler:^ {
        
        //不管有没有完成，结束background_task任务
        [application endBackgroundTask: background_task];
        background_task = UIBackgroundTaskInvalid;
    }];
    
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        
        //根据需求 开启／关闭 通知
        [UMCManager startUdeskMChatPush];
    });
}

//App 进入前台时，开启Udesk推送
- (void)applicationWillEnterForeground:(UIApplication *)application {
		[UMCManager endUdeskMChatPush];
}

给客户服务器地址推送消息的格式：

{
   "category" : "auto",
   "content" : "",
   "content_type" : "image",
   "created_at" : "",
   "customer_name" : "",
   "customer_openid" : "",
   "device_token" : "",
   "direction" : "out",
   "event_name" : "",
   "extras" : "",
   "failed_at" : "",
   "id" : 1,
   "isAudioTranslate" : "",
   "menu_id" : "",
   "merchant_euid" : "asdssd",
   "merchant_id" : 1,
   "message_id" : "",
   "platform" : "",
   "recognition" : "",
   "send_status" : "",
   "sent_at" : "",
   "type" : "",
   "voice_url" : ""
}

五、接口说明

5.1 接受消息代理

//添加当前类为代理，
[[UMCDelegate shareInstance] addDelegate:self];
//实现接受消息方法
- (void)didReceiveMessage:(UMCMessage *)message {
  	NSLog(@"%@",message);
}

//移除代理
[[UMCDelegate shareInstance] removeDelegate:self];

5.2 未读消息回调

[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(msgUnreadCountHasChange:) name:UMC_UNREAD_MSG_HAS_CHANED_NOTIFICATION object:nil];

- (void)msgUnreadCountHasChange:(NSNotification *)notif {
    [UMCManager merchantsUnreadCountWithEuid:nil completion:^(NSInteger unreadCount) {
        
        UINavigationController *nav = self.tabBarController.viewControllers[1];
        nav.tabBarItem.badgeValue = [NSString stringWithFormat:@"%ld",unreadCount];
        if (unreadCount == 0) {
            nav.tabBarItem.badgeValue = nil;
        }
    }];
}

其他API参考UMCManager.h

六、更新记录

更新记录：

sdk v1.0.7版本更新功能:

1.优化留言功能

sdk v1.0.6版本更新功能:

1.适配iOS14

sdk v1.0.5版本更新功能:

1.支持导航菜单

2.支持更多客户信息

3.支持发送文件

sdk v1.0.4版本更新功能:

1.第三方框架私有化

2.支持推送

3.支持自定义按钮

4.多商户排队放弃和离线客户检测机制

sdk v1.0.3版本更新功能:

5.部分表情支持

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

公告

SDK下载地址

一、集成SDK

兼容性

通过Pod导入SDK

手动导入SDK

1.1 引入依赖库

1.2 注意事项

二、快速使用

签名生成规则：

三、自定义配置

3.1 咨询对象

3.2 商品消息

3.3 自定义按钮

四、离线推送

给客户服务器地址推送消息的格式：

五、接口说明

5.1 接受消息代理

5.2 未读消息回调

六、更新记录

更新记录：

Files

README.md

Latest commit

History

README.md

File metadata and controls

公告

SDK下载地址

一、集成SDK

兼容性

通过Pod导入SDK

手动导入SDK

1.1 引入依赖库

1.2 注意事项

二、快速使用

签名生成规则：

三、自定义配置

3.1 咨询对象

3.2 商品消息

3.3 自定义按钮

四、离线推送

给客户服务器地址推送消息的格式：

五、接口说明

5.1 接受消息代理

5.2 未读消息回调

六、更新记录

更新记录：