Udesk移動應用 SDK for iOS 開發文件
方法/步驟
SDK 工作流程
Udesk-SDK的工作流程如下圖所示。
Udesk SDK 匯入
1. 下載Udesk SDK ，匯入SDK包到你的工程。
2. 匯入以下框架到你的工程
3. 點選你的工程targets －> Build Settings 搜尋 Other Linker Flags 加入 -lxml2 -ObjC
快速啟用SDK
使用Udesk提供的UI，可以免去UI部分的開發，更快的嵌入應用。使用Udesk SDK 提供的UI，必須執行 初始化函式、建立使用者函式和調出檢視函式三個步驟，其餘介面為可選項。
1.註冊udesk 替換key和domain
[[Udesk shareUdeskSDK] installForApiKey:@"您公司金鑰" domainName:@“您公司域名"];
2.建立使用者並傳入使用者資訊
NSDictionary *parameters = @{
@"user": @{
@"nick_name": @"小明",
@"cellphone":@"18888888888",
@"weixin_id":@"xiaoming888",
@"weibo_name”:@"xmwb888",
@"qq":@"8888888",
@"email":@"[email protected]",
@"description":@"使用者描述",
}
};
[[Udesk shareUdeskSDK] createCustomer :parameters];
3.推出檢視
[[Udesk shareUdeskSDK] showFAQs:self withOptions:nil];
至此，你已經為你的 APP 新增Udesk提供的客服服務。而Udesk SDK 還提供其他強大的功能，可以幫助提高服務效率，提升使用者使用體驗。接下來為你詳細介紹如何使用其他功能。
介面說明：
初始化SDK
注意：所有操作都必須在初始化SDK後才能正常執行！
將 SDK 檔案新增到工程，在AppDelegate中引用 Udesk.h 檔案，然後在application: willFinishLaunchingWithOptions:函式中初始化 SDK 。
註冊udesk 替換key和domain
[[Udesk shareUdeskSDK] installForApiKey:@"您公司金鑰" domainName:@“您公司域名”];
獲取祕鑰（管理員登入）
新增使用者資訊和使用者自定義欄位
注意：若要在SDK中使用 使用者自定義欄位 需先在網頁端設定新增使用者自定義字欄位。
使用者欄位包含了一名聯絡人的所用資料。目前Udesk完全支援自定義使用者欄位，您可以選擇輸入型欄位和選擇型欄位。如果是選擇型欄位，需要提供多個自定義的選項供您的客戶進行選擇。如果是輸入型欄位，使用者會看到一個文字輸入框，在其中輸入資料。
呼叫使用者自定義欄位函式：
[[Udesk shareUdeskSDK] getUserFields:^(NSDictionary *fieldsDict) {
NSLog(@"fieldsDict:%@",fieldsDict);
}];
返回資訊：
fieldsDict:{
message = success;
status = 0;
"user_fields" = (
{
comment = “測試測試”; ———————————-欄位描述
"content_type" = droplist;———————————-欄位型別
"field_label" = "測試"; ———————————-使用者名稱
"field_name" = “SelectField_109"; ———————————-欄位名
options = ( ———————————-下拉列表選項
{
0 = "測試使用者自定義欄位";
}
);
permission = 0; ———————————客戶不可見
requirment = 1; ———————————客戶可見，但不可修改
};
}
使用：
//2.建立使用者並傳入使用者資訊和使用者自定義欄位
NSDictionary *parameters = @{
@"user": @{
@"nick_name": @"hehe",
@"cellphone":@"333312313",
@"weixin_id":@"xs28888",
@"weibo_name":@"xuch27777",
@"qq":@"234661166",
@"email":@"[email protected]",
@"description":@"好",
@"customer_field":@{@"SelectField_109":@"0"}
}
};
[[Udesk shareUdeskSDK] createCustomer :parameters];
注意：引數都是非必需，你還可以這樣寫：
NSDictionary *parameters = @{
@"user": @{ }
};
獲取歷史訊息
[[Udesk shareUdeskSDK] getAllMessageAndServeEvents:^(NSArray *allMessages) {
NSLog(@"dataList:%@",allMessages);
}];
清除歷史訊息
[[Udesk shareUdeskSDK] clearBreadCrumbs];
顯示客服線上狀態和名字
[[Udesk shareUdeskSDK] showAgentOnlineStatus:YES showAgentName:YES];
顯示諮詢物件和店鋪名字
諮詢物件：
NSDictionary *commodityDict = @{
@"commodity_url":@"http://www.udesk.cn", //必須
@"commodity_title":@"測試標題測試標題測試標題測試標題測試標題測試標題測試標題測試標題",//必須
@"commodity_imageUrl":@";,
@"commodity_detail":@"測試子標題測試子標題測試子標題"
};
[[Udesk shareUdeskSDK] commodityParameters:commodityDict];
店鋪名字：
將店鋪名字寫成字典 傳入呼叫檢視的三個API的optionsDictionary引數裡。
示例：
NSDictionary *dic = @{@"shopName":@"廉城電器"};
[[Udesk shareUdeskSDK] showFAQs:self withOptions:dic];
調出檢視
Udesk提供的檢視，完成了一整套Udesk中的介面。讓開發者免去 UI 開發工作。我們提供三個藉口：
//顯示獨立的幫助中心
[[Udesk shareUdeskSDK] showFAQSection:self withOptions:nil];
//顯示獨立的IM介面
[[Udesk shareUdeskSDK] showConversation:self withOptions:nil];
//顯示幫助中心和IM的集合
[[Udesk shareUdeskSDK] showFAQs:self withOptions:nil];
UI自定義
Udesk提供自定的UI 可以讓Udesk-SDK與你的APP風格融為一體。
注意：需要在彈出檢視之前修改引數
通過配置文件修改
Udesk-SDK關鍵字修改
您還可以設定sdk預設的關鍵字，通過修改sdk包裡的Localizable.strings檔案。
注意：若要修改sdk關鍵字，請修改右側的關鍵字 比如 "常見問題" = "問題";
