Unread Message Count

When the customer service replies user's message, user can receive a notification of unread messages, even if the AIHelp page is not currently displayed.

You can implement this function either by every-5-minutes' polling or by third-party push.

TIP

This feature is disabled by default, please contact us before your integration.

By Polling

WARNING

By default, AIHelp uses a randomly generated deviceId as userId to poll for the count of unread messages.

So, until you sync the correct userId to AIHelp, the unread message count may be inaccurate.

API

startUnreadMessageCountPolling

Call this method to start a polling job for the count of unread messages. Please ensure that you are calling this method after the initialization is finished.

void AIHelp_onInitializationCallback() {
    // Sync userId info to AIHelp via updateUserInfo API
    [AIHelpSupportSDK updateUserInfo:[[[AIHelpUserConfigBuilder alloc] init] build]];

    // Start polling
    [AIHelpSupportSDK startUnreadMessageCountPolling:unreadMessageNumCallBack];
}

The count of unread messages is pulled every 5 minutes within the function, the result will be returned to the caller in the following conditions:

1. When user with ongoing tickets receives a new message, accumulated number of unread messages will be returned;
2. When users open AIHelp session, a returning with number 0 indicates they have read all messages.

Definition

onUnreadMessageCountCallback

• Type: (void(*)(int unreadCount))
• Details: Required. Callback for unread message count.

By Third-Party Push

Now we take APNs as an example to illustrate how the in-app notification works.

1、register APNs：

#import <UserNotifications/UserNotifications.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    if (@available(iOS 10.0, *)) {
        [[UNUserNotificationCenter currentNotificationCenter] requestAuthorizationWithOptions:UNAuthorizationOptionBadge | UNAuthorizationOptionSound | UNAuthorizationOptionAlert completionHandler:^(BOOL granted, NSError * _Nullable error) {
            if (granted) {
                // The user has allowed push permissions
            }
        }];
    } else {
        UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:UIUserNotificationTypeAlert | UIUserNotificationTypeBadge | UIUserNotificationTypeSound categories:nil];
        [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
    }
}

2、call the following method to inform AIHelp of the player's push token and push platform：

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
   if ([[[UIDevice currentDevice] systemVersion] floatValue] >= 13) {
       if (![deviceToken isKindOfClass:[NSData class]]) {
           return;
       }
       const unsigned *tokenBytes = (const unsigned *)[deviceToken bytes];
       NSString *strToken = [NSString stringWithFormat:@"%08x%08x%08x%08x%08x%08x%08x%08x",
                             ntohl(tokenBytes[0]), ntohl(tokenBytes[1]), ntohl(tokenBytes[2]),
                             ntohl(tokenBytes[3]), ntohl(tokenBytes[4]), ntohl(tokenBytes[5]),
                             ntohl(tokenBytes[6]), ntohl(tokenBytes[7])];
       token = strToken;
   } else {
       token = [NSString stringWithFormat:@"%@", deviceToken];
       token = [token stringByReplacingOccurrencesOfString:@"<" withString:@""];
       token = [token stringByReplacingOccurrencesOfString:@">" withString:@""];
       token = [token stringByReplacingOccurrencesOfString:@" " withString:@""];
   } 
   AIHelpUserConfigBuilder *userConfigBuider = [[AIHelpUserConfigBuilder alloc] init];
   userConfigBuider.userId = @"userId";
   [AIHelpSupportSDK updateUserInfo:userConfigBuider.build];
   [AIHelpSupportSDK setPushToken:token pushPlatform:AIHelpTokenPlatformAPNS];
}

3、alert your users when you receive a new message from AIHelp:

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    NSDictionary *data = userInfo[@"data"];
    if (data && [data[@"elva"] isEqualToString:@"yes"]) {
        // alert your users that he/she has received a new message
    }
}

4、AIHelp push data format is as follows：

{
    "to":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
    "notification":{
        "body":"This is your new message content",
        "title":"customer service sends you a message.",
        "sound":"Enabled",
        "priority":"high",
        "uid":"..."
    },
    "data":{
        "body":"This is your new message content",
        "title":"customer service sends you a message.",
        "uid":"...",
        "elva":"yes",
        "entry_tag":"..."
    }
}