文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>云联络中心>SDK 开发指南>集成在线会话用户端 SDK>iOS

iOS

最近更新时间：2025-12-11 16:38:51

我的收藏

本页目录：

介绍

智能客服用户端 iOS UIKit。使用此 UIKit，您可以在一天内将智能客服的能力集成到您的 iOS 项目。极简接入，用智能客服为您的产品增收提效，提升用户满意度和付费转化。

效果展示









快速集成

环境与版本

iOS 版本: iOS 13 以上。
支持模拟器调试及真机运行。

CocoaPods 集成

方式1：拉取远程 CocoaPods 集成

在 Xcode 工程中，通过 CocoaPods 集成 TencentCloudAIDeskCustomer。
在 Podfile 中，添加如下示例代码：
target 'MyApp' do  
    pod 'TencentCloudAIDeskCustomer'
end

方式2：DevelopPods 源码集成（有源码修改时推荐）

从代码仓库下载 TencentCloudAIDeskCustomer-iOS 、TDeskCustomerServicePlugin、TDeskChat、TDeskCommon、TDeskCore ，然后将文件拖入您的工程目录 TDesk 下。
target 'MyApp' do  
    pod 'TencentCloudAIDeskCustomer', :path => "../TDesk/TencentCloudAIDeskCustomer-iOS"
    pod 'TDeskCustomerServicePlugin', :path => "../TDesk/TDeskCustomerServicePlugin"
    pod 'TDeskChat', :path => "../TDesk/TDeskChat"
    pod 'TDeskCommon', :path => "../TDesk/TDeskCommon"
    pod 'TDeskCore', :path => "../TDesk/TDeskCore"
end

带昵称和头像登录

调用 initWithProfile 方法登录智能客服。此接口支持同时设置用户的昵称和头像，可与业务侧账号体系打通。如果您希望人工客服在工作台接待用户咨询时，能看到用户的昵称、头像等信息以提升沟通效率，请在登录时设置 nickName 和 avatar 参数。效果如下图所示：

#import "TencentCloudAIDeskCustomer/TencentCloudCustomerManager.h"

int SDKAppID = 0; // Your SDKAppID，即开通了智能客服 Desk 的应用 ID
NSString *userID = @""; // Your userID，可复用您 app 的账号体系，或随机生成
NSString *userSig = @""; // Your userSig，接入阶段可控制台生成，生产阶段请务必由服务端生成
// 用户昵称。设置后，用户端转人工成功时，人工客服在工作台可见。您可将用户手机号，用户来源等信息写入昵称，长度限制500字节
NSString *nickName = @"";
// 用户头像。设置后，用户端转人工成功时，人工客服在工作台可见
NSString *avatar = @"";

[[TencentCloudCustomerManager sharedManager]
    initWithProfile:SDKAppID
    userID:userID 
    userSig:userSig 
    nickName:nickName 
    avatar:avatar
    completion:^(NSError *error) {
        if (error) {
            NSLog(@"login failed. error:%@", error);
        }
    }];
SDKAppID 信息，可在 即时通信 IM 控制台 单击应用管理 > 创建新应用，并选择客服服务 Desk > 智能客服， 开通智能客服 后获取。


userID 信息，可本地生成一个随机的字符串，例如 test-1234。
userSig 信息，可单击 即时通信 IM 控制台 > UserSig生成校验，填写创建的 userID，即可生成 userSig。


打开客服聊天页，发起您的第一条客服咨询

在您项目的 ViewController 里调用 pushCustomerServiceChatFromController 方法，跳转至客服聊天页面。
#import <TencentCloudAIDeskCustomer/TencentCloudCustomerManager.h>

[[TencentCloudCustomerManager sharedManager] pushCustomerServiceChatFromController:self];

高级用法

设置显示人工服务按钮

// 设置为 true 后，只有没再人工服务前就会显示“人工服务”按钮，在人工服务后会自动隐藏。
// 设置为 false 后，永远不显示“人工服务”按钮
[[TencentCloudCustomerManager sharedManager] setShowHumanService:YES];

设置显示服务评价按钮

// 设置为 true 后，进入人工服务状态就会显示“服务评价”按钮，在人工服务前会自动隐藏。
// 设置为 false 后，永远不显示“服务评价”按钮
[[TencentCloudCustomerManager sharedManager] setShowServiceRating:YES];

设置显示结束会话按钮

// 设置为 true 后，进入人工服务状态就会显示“结束会话”按钮，在人工服务前会自动隐藏。
// 设置为 false 后，永远不显示”结束会话“按钮
[[TencentCloudCustomerManager sharedManager] setShowEndHumanService:YES];

设置聊天窗口头像和昵称的显隐

// 设置聊天窗口显示头像。YES-显示头像，NO-隐藏头像（默认值为NO）
[[TencentCloudCustomerManager sharedManager] setShowAvatar:YES];

// 设置聊天窗口显示昵称。YES-显示昵称，NO-隐藏昵称（默认值为NO）
[[TencentCloudCustomerManager sharedManager] setShowNickName:YES];

设置机器人的头像和昵称

// 设置机器人头像。如果您未设置机器人头像，则 UIKit 展示客服号默认的头像。
[[TencentCloudCustomerManager sharedManager] setRobotAvatar:@"https://tccc-im-agent-avatar-1258344699.cos.ap-nanjing.myqcloud.com/robot_default_avatar_3.png"];

// 设置机器人昵称
[[TencentCloudCustomerManager sharedManager] setRobotNickName:@"your robot nickname"];

设置人工客服的头像和昵称

说明：
仅转人工成功后，与人工客服对话时有效。
客服成员或管理员可以在智能客服管理端 > 团队管理 > 成员界面，编辑成员的昵称和头像。
如果您的应用需要区分人工客服的头像和昵称，请设置enableUnifiedMemberProfile值为 NO。默认值为 YES，即展示统一的人工客服的头像和昵称。如果您未在代码中设置统一的人工客服头像和昵称，则 UIKit 会使用客服号的头像和昵称进行展示。
// 设置为 NO，则 UIKit 展示在智能客服管理端配置的人工客服的头像和昵称
[[TencentCloudCustomerManager sharedManager] setEnableUnifiedMemberProfile:NO];

// 设置为 YES（默认值），则 UIKit 展示设置的统一的客服头像和昵称
// 如果您未设置统一的客服头像，则展示客服号默认的头像
// 如果您未设置统一的客服昵称，则展示客服号默认的昵称
[[TencentCloudCustomerManager sharedManager] setEnableUnifiedMemberProfile:YES];
[[TencentCloudCustomerManager sharedManager] setMemberAvatar:@"https://tccc-im-agent-avatar-1258344699.cos.ap-nanjing.myqcloud.com/seat_default_avatar_2.png"];
[[TencentCloudCustomerManager sharedManager] setMemberNickName:@"your agent name"];

转指定人工客服或客服分组

如果您的应用需要在用户登录后自动转指定人工客服或客服分组，请参考以下代码实现。
转指定人工客服
转客服分组
// 监听客服会话启动的通知
[NSNotificationCenter.defaultCenter
    addObserver:self
    selector:@selector(onCustomerServiceChatDidStart)
    name:TUIKitNotification_CustomerServiceChatDidStart
    object:nil];

- (void)onCustomerServiceChatDidStart {
    // transfer to specific members
    NSArray *memberList = @[@"agent_account_1", @"agent_account_2"]; // 请替换为您应用的人工客服账号
    [[TencentCloudCustomerManager sharedManager]
        transferToHumanWithMemberList:memberList
        description:@"your description"];
}
// 监听客服会话启动的通知
[NSNotificationCenter.defaultCenter
    addObserver:self
    selector:@selector(onCustomerServiceChatDidStart)
    name:TUIKitNotification_CustomerServiceChatDidStart
    object:nil];

- (void)onCustomerServiceChatDidStart {
    int groupID = 0; // 请替换为您应用的客服分组 ID
    [[TencentCloudCustomerManager sharedManager]
        transferToHumanWithGroupID:groupID
        description:@"your description"];
}


触发指定任务流

如果您的应用需要在用户登录后自动触发指定任务流，请参考以下代码实现。
// 监听客服会话启动的通知
[NSNotificationCenter.defaultCenter
    addObserver:self
    selector:@selector(onCustomerServiceChatDidStart)
    name:TUIKitNotification_CustomerServiceChatDidStart
    object:nil];

- (void)onCustomerServiceChatDidStart {
    int taskFlowID = 0; // 请替换为您应用的任务流 ID
    [[TencentCloudCustomerManager sharedManager]
        transferToTaskFlow:taskFlowID
        description:@"your description"];
}

设置快捷用语

设置输入框上部快捷用语。
[[TencentCloudCustomerManager sharedManager] setQuickMessages:<#(NSArray<TUICustomerServicePluginMenuCellData *> *)#>];

设置底部快捷订单卡片

核心是数据 TUICustomerServicePluginProductInfo 类和 setProductInfo 方法, 用法请参见下方示例代码及注释。
TUICustomerServicePluginProductInfo *productInfo = [[TUICustomerServicePluginProductInfo alloc] init];
productInfo.title = @"腾讯云 - 高级版智能客服";
productInfo.desc = @"¥3000/月";
productInfo.picURL = @"https://qcloudimg.tencent-cloud.cn/image/document/cdbef3bc3e441e46503e1230ac6f65cf.png";
productInfo.linkURL = @"https://cloud.tencent.com/document/product/269/96056";
productInfo.clickAutoSend = NO; // 这里配置成 YES 就不需要配置 onSendClickListener, 即可自动发送
productInfo.customField = @{
        @"客服许可": @"3个",
        @"知识库语言数": @"不限制",
        @"多机器人": @"3个"
};
productInfo.onSendClickListener = ^(UIView *view) {
        // 这里可以在发送前, 修改要发送出去的信息
        productInfo.customField = @{
            @"客服许可": @"3个"
        };
        [TUICustomerServicePluginDataProvider sendProductMessage:productInfo];
        [[TencentCloudCustomerManager sharedManager] setProductInfo:nil]; // setProductInfo:nil 即可关闭快捷订单卡片
};
[[TencentCloudCustomerManager sharedManager] setProductInfo:productInfo]; // 调用 setProductInfo 即可展示订单卡片示例
中国站
目录