User Extra Info

We provide some other extra user info for you to know better about your users.

API

You can pass some other user information such as app package name, device model to AIHelp through the userConfig property.

let userConfig = {
  applicationIdentifier: 'your_package_name', 
  applicationVersion: 'your_app_version',
  applicationName: 'your_app_name',
  totalMemory: 'user_device_total_memory',
  availableMemory: 'user_device_available_memory',
  deviceModel: 'user_device_model',
  totalSpacePhone: 'user_device_total_storage_space',
  freeSpacePhone: 'user_device_available_storage_space',
  osVersion: 'user_device_os_version',
  networkType: 'user_device_network_type',
  countryCode: 'user_country_code',
  carrier: 'user_current_operator',
};
AIHelpSupport.updateUserInfo(userConfig);

URL

Or, you could implement the same function by the URL scheme:

<script>
  let domain = "your_app_domain";
  let appId = "your_app_id";
  let entranceId = "your_entrance_id";
  (function () {
    let baseUrl = `https://${domain}/webchatv5/#/${appId}`;
    let params = `entranceId=${entranceId}&applicationIdentifier=${your_package_name}&applicationVersion=${your_app_version}&osVersion=${user_device_os_version}`;
    let url = `${baseUrl}?${params}`;
    window.open(url);
  })();
</script>

Definition

userConfig API

• Type: object
• Detail: Optional. Only works in API, to add more user information.

applicationIdentifier

• Type: string
• Detail: Optional. Application package name.

applicationVersion

• Type: string
• Detail: Optional. Application version.

applicationName

• Type: string
• Detail: Optional. Application name.

totalMemory

• Type: string
• Detail: Optional. Device total runtime memory, aka RAM.

availableMemory

• Type: string
• Detail: Optional. Device available runtime memory.

deviceModel

• Type: string
• Detail: Optional. Device model.

totalSpacePhone

• Type: string
• Detail: Optional. Device total storage space.

freeSpacePhone

• Type: string
• Detail: Optional. Device available storage space.

osVersion

• Type: string
• Detail: Optional. The operating system version.

networkType

• Type: string
• Detail: Optional. The network type, such as Wi-Fi or 5G.

countryCode

• Type: string
• Detail: Optional. Country code.

carrier

• Type: string
• Detail: Optional. The alphabetic name of current registered operator.