iOS icon AIHelp iOS SDK Integration Guide


I. Download iOS SDK


Click the button "Clone or download" in the top right corner to download iOS SDK and then unzip the file.

II. Import ElvaChatServiceSDK into project


Copy the ElvaChatServiceSDK folder to your main directory.

III. Project Settings


  1. Add framework to Link Binary with Libraries: webkit.framework (if using showElvaOP).
  2. Add -ObjC to Build Settings-Other Linker Flags.

IV. Interface Call Instructions


You must use init in your App's Initialization Code, otherwise you can not use AIHelps’ service properly.

[ECServiceSdk init:appSecret
              Domain:domain
              appId:appId];

About Parameters:

Parameters Description
AppSecret Your unique Developer API Key
Domain Your AIHelp Domain Name. For Example: foo.AIHELP.NET
AppId A unique ID Assigned to your App.

Coding Example:

//  Must be called during application/game initialization, otherwise you can't use AIHelp properly.

[ECServiceSdk init:@"YOUR_API_KEY"
              Domain:@"YOUR_DOMAIN_NAME"
              AppId:@"YOUR_APP_ID"];

V. Start Using AIHelp


1. API Summary:

Method Purpose Prerequisites
showElva Launch AI Conversation Interface
showElvaOP Launch Operation Interface Need to configure Operation Sections
showFAQs Show all FAQs by Sections Need to Configure FAQs
showFAQSection Show FAQ Section
showSingleFAQ Show Single FAQ Need to Configure FAQ
showConversation Launch Manual Conversation Interface Need to setUserName and setUserId
setName Set Your App's Name for AIHelp SDK to Display Use it After Initialization
setUserId Set Unique User ID
setUserName Set User In-App Name
setServerId Set Unique Server ID
setSDKLanguage Set SDK Language

2. Launch the AI Conversation Interface, Use showElva :

[ECServiceSdk showElva:playerName
              PlayerUid:playerUid
              ServerId:serverId
              PlayerParseId:playerParseId
              PlayershowConversationFlag:showConversationFlag];

or

[ECServiceSdk showElva:playerName
              PlayerUid:playerUid
              ServerId:serverId
              PlayerParseId:playerParseId
              PlayershowConversationFlag:showConversationFlag
              Config:config];

Coding Example:

//  Presenting AI Help Converation with your customers

NSMutableDictionary *config = [NSMutableDictionary dictionary];
NSMutableDictionary *customData = [NSMutableDictionary dictionary];
[customData setObject:@"vip,pay1" forKey:@"elva-tags"];
[customData setObject:@"1.0.0" forKey:@"VersionCode"];

[config setObject:customData forKey:@"elva-custom-metadata"];
[ECServiceSdk showElva:@"USER_NAME"
              PlayerUid:@"USER_ID"
              ServerId:@"123"
              PlayerParseId:@""
              PlayershowConversationFlag:@"1"
              Config:config];

/*config example content:
  {
    elva-custom-metadata ={
      hs-tags ='军队, 充值',
      VersionCode = '3'
  }
}

*/

About Parameters:

  • playerName: In-App User Name
  • playerUid: In-App Unique User ID
  • serverId: The Server ID
  • playerParseId: Can be empty string, can NOT be NULL.
  • showConversationFlag: Should be "0" or "1". If set at "1", the manual conversation entry will be displayed in the upper right hand side of the AI conversation interface.
  • config: Optional parameters for custom Dictionary information. You can pass specific Tag information using vector elva-tags, see the above coding example. Please note you also need to configure the same tag information in the Web console so that each conversation can be correctly tagged.

AIHelp showElva English iOS

Best Practice:

  1. Use this method to launch your APP's customer service. Configure specific welcome texts and AI story lines in the AIHelp Web Console to better the customer support experience.
  2. Enable Manual Conversation Entry to allow users’ to chat with your human support team with the parameter "showConversationFlag" setting to "1", you may use this method for any user or as a privilege for some users only.

3. Launch The Operation Interface, use showElvaOP :

The operation module is useful when you want to present updates, news, articles or any background information about your APP/Game to users.

[ECServiceSdk showElvaOP:playerName
              PlayerUid:playerUid
              ServerId:serverId
              PlayerParseId:playerParseId
              PlayershowConversationFlag:showConversationFlag
              Config:config];

or

[ECServiceSdk showElvaOP:playerName
              PlayerUid:playerUid
              ServerId:serverId
              PlayerParseId:playerParseId
              PlayershowConversationFlag:showConversationFlag
              Config:config
              defaultTabIndex:defaultTabIndex];

Coding Example:

//  Presenting Operation Info to your customers

NSMutableDictionary *config = [NSMutableDictionary dictionary];
NSMutableDictionary *customData = [NSMutableDictionary dictionary];
[customData setObject:@"vip,pay1" forKey:@"elva-tags"];
[customData setObject:@"1.0.0" forKey:@"VersionCode"];

[config setObject:customData forKey:@"elva-custom-metadata"];
[ECServiceSdk showElvaOP:@"USER_NAME"
              PlayerUid:@"USER_ID"
              ServerId:@"123"
              PlayerParseId:@""
              PlayershowConversationFlag:@"1"
              Config:config];

About Parameters:

  • playerName: User Name in Game/APP
  • playerUid: Unique User ID
  • serverId: The Server ID
  • playerParseId: Can be empty string, can NOT be NULL.
  • showConversationFlag: Should be "0" or "1". If set at "1", the manual conversation entry will be shown in the top right-hand corner of the AI conversation interface.
  • config: Custom Dictionary information. You can pass specific Tag information using vector elva-tags, see the above coding example. Please note that you also need to configure the same tag information in the Web console so that each conversation can be correctly tagged.
  • defaultTabIndex: Optional. The index of the first tab will be shown when entering the operation interface. Default value of the left-most tab, if you would like to show the AI conversation interface(the right-most) should be set to 999.

AIHelp showElvaOP

Best Practice:

  1. Use this API to present news, announcements, articles or any useful information to users/players. Configure and publish the information in AIHelp web console.

4. Display FAQs, use showFAQs:

[ECServiceSdk showFAQs];

or

[ECServiceSdk showFAQs:config];

Coding Example:

// Presenting FAQs to your customers

NSMutableDictionary *config = [NSMutableDictionary dictionary];
NSMutableDictionary *customData = [NSMutableDictionary dictionary];
[customData setObject:@"vip,pay1" forKey:@"elva-tags"];
[customData setObject:@"1.0.0" forKey:@"VersionCode"];
[config setObject:customData forKey:@"elva-custom-metadata"];
[ECServiceSdk showFAQs:config];

About Parameters:

  • config: Custom Dictionary information. You can pass specific Tag information using vector elva-tags, see above coding example. Please note that you also need to configure the same tag information in the Web console to make each conversation be correctly tagged.

AIHelp showFAQs English iOS

Best Practice:

  1. Use this method to show FAQs about your APP/Game properly. Configure FAQs in AIHelp Web Console. Each FAQ can be categroized into a section. If the FAQs are great in number, you can also add Parent Sections to categorize sections to make things clear and organized.

5. Show A Specific FAQ, use showSingleFAQ :

[ECServiceSdk showSingleFAQ:faqId];

or

[ECServiceSdk showSingleFAQ:faqId Config:config];

Coding Example

// Presenting FAQs to your customers

NSMutableDictionary *config = [NSMutableDictionary dictionary];
NSMutableDictionary *customData = [NSMutableDictionary dictionary];
[customData setObject:@"vip,pay1" forKey:@"elva-tags"];
[customData setObject:@"1.0.0" forKey:@"VersionCode"];
[config setObject:customData forKey:@"elva-custom-metadata"];
[ECServiceSdk showSingleFAQ:@"20" Config:config];

About Parameters:

  • faqId: The PublishID of the FAQ item, you can check it at AIHelp Web Console: Find the FAQ in the FAQ menu and copy its PublishID.
  • config: Custom Dictionary information. You can pass specific Tag information using vector elva-tags, see the above coding example. Please note that you also need to configure the same tag information in the Web console to make each conversation be correctly tagged.

AIHelp showSingleFAQ English iOS

Best Practice:

  1. Use this method when you want to show a specific FAQ in a proper location of your APP/Game.

6. Set Your App's Name for AIHelp SDK to Display, use setName :

[ECServiceSdk setName:game_name];

Coding Example:

[ECServiceSdk setName:@"Your Game"];

About Parameters:

  • game_name: APP/Game Name

Best Practice:

  1. Use this method after the SDK initialization. The App's name will be displayed in the title bar of the customer service interface.

7. Set the Unique User ID, use setUserId :

[ECServiceSdk setUserId:playerUid];

Coding Example:

[ECServiceSdk setUserId:@"123ABC567DEF"];

About Parameters:

  • playerUid:Unique User ID

Best Practice:

  1. Normally you do not need to use this method if you have passed the user ID in another method.

8. Set User Name, use setUserName :

[ECServiceSdk setUserName:playerName];

Coding Example:

[ECServiceSdk setUserName:@"PLAYER_NAME"];

About Parameters:

  • playerName: User/Player Name

Best Practice:

  1. Use this method to set the user name, which will be shown in the web console's conversation page for the user. You can address the user with this name during the chat.
  2. Normally you don't need to use this method if you have passed user name in other method.

9. Set Unique Server ID, use setServerId :

[ECServiceSdk setServerId:serverId];

Coding Example:

[ECServiceSdk setServerId:@"SERVER_ID"];

About Parameters:

  • serverId: The Unique Server ID

Best Practice:

  1. Normally you do not need to use this method if you have passed the server ID in another method.

10. Launch Manual Chat Console, use showConversation (need to set UserName):

[ECServiceSdk showConversation:playerUid ServerId:serverId];

or

[ECServiceSdk showConversation:playerUid
              ServerId:serverId
              Config:config];

Coding Example:

[ECServiceSdk setUserName:@"PLAYER_NAME"];

NSMutableDictionary *config = [NSMutableDictionary dictionary];
NSMutableDictionary *customData = [NSMutableDictionary dictionary];
[customData setObject:@"vip,pay1" forKey:@"elva-tags"];
[customData setObject:@"1.0.0" forKey:@"VersionCode"];
[config setObject:customData forKey:@"elva-custom-metadata"];
[ECServiceSdk showConversation:@"PLAYER_ID"
              ServerId:@"123"
              Config:config];

About Parameters:

  • playerUid: Unique User ID
  • serverId: Unique Server ID
  • config: Custom Dictionary information. You can pass specific Tag information using vector elva-tags, see the above coding example. Please note that you also need to configure the same tag information in the Web console to make each conversation be correctly tagged.

Best Practice:

  1. Normally you do not need to use this method unless you intend to allow users to enter manual conversations without engaging with the AI chat. You may use this method as a privilege for some users.

AIHelp showConversation English iOS

11. Set the SDK Language, use setSDKLanguage :

Setting the SDK Language will change the FAQs, Operational information, AI Chat and SDK display language.

[ECServiceSdk setSDKLanguage:language];

Coding Example:

[ECServiceSdk setSDKLanguage:@"en"];

About Parameters:

  • language: Standard Language Alias. For example: en is for English, zh_CN is for Simplified Chinese. More language labels can be viewed at AIHelp Web Console:"Settings"-->"Language"->Alias.

AIHelp laguaage alias

Best Practice:

  1. Normally AIHelp will use the mobile's language configuration by default. If you intend to make a different language setting, you need to use this method right after the SDK initialization.
  2. If you allow users to change the APP language, then you need to use this method to make AIHelp the same lanague as your APP.

12. Set a Different Greeting Story Line.

If your APP provides multiple entries to AIHelp, and you intend to introduce different AI welcome texts and story lines to users from different entries, you can set config parameter in showElva or showElvaOP

NSMutableDictionary *welcomeText = [NSMutableDictionary dictionary];
[welcomeText setObject:@"usersay" forKey:@"anotherWelcomeText"];

Coding Example:

NSMutableDictionary *welcomeText = [NSMutableDictionary dictionary];

//  note:anotherWelcomeText is key, should be unchanged.
//  you need to change usersay according to the "User Say" in your new
//  story line
[welcomeText setObject:@"usersay" forKey:@"anotherWelcomeText"];
NSMutableDictionary *config = [NSMutableDictionary dictionary];
[config setObject:welcomeText forKey:@"elva-custom-metadata"];

[ECServiceSdk showElva:@"TEST_PLAYER_NAME"
              PlayerUid:@"TEST_UID_123"
              ServerId:@"TEST_SRV_ID_123"
              PlayerParseId:@""
              PlayershowConversationFlag:@"1"
              Config:config];

or

[ECServiceSdk showElvaOP:@"TEST_PLAYER_NAME"
              PlayerUid:@"TEST_UID_123"
              ServerId:@"TEST_SRV_ID_123"
              PlayerParseId:@""
              PlayershowConversationFlag:@"1"
              Config:config];

Best Practice:

  1. Introduce different story lines to users from different sources