NIM SDK 支持 APNs 离线推送功能。

当您的程序在后台被挂起、被系统/用户杀死，或网络异常，NIM SDK 与云信服务端的长连接会因为超时而断开，此时云信服务端会通过 APNs 通道为目标用户发送离线推送的消息。

如果您需要通过云信向 App 发送离线推送，需要先向云信提供 APNs 信息（App ID、证书等），授权云信服务端与 APNs 通信，从而实现离线推送功能。

技术原理

云信 IM 实现离线推送的技术原理如下：

前提条件

在实现“离线推送”功能之前，请确保：

• 开发环境满足如下要求：
  • Xcode 13
  • iOS 9.0.0 及以上版本
• 已注册云信 IM 账号，获取 accid 和 token。

实现流程

步骤 1：集成 APNs 推送服务

请参考集成 APNs 推送服务，实现云信服务端与 APNs 通信。

步骤 2：集成 NIM SDK

请参考集成 SDK 将 NIM SDK 集成至您的项目。

步骤 3：初始化 NIM SDK

1. 在项目文件中引入头文件 NIMSDK.h。

   #import <NIMSDK/NIMSDK.h>
   

2. 调用 registerWithOption: 初始化 NIM SDK。在初始化参数 NIMSDKOption 中传入推送证书名称（对应云信控制台配置的推送证书）。

   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
       ...
       // 推荐在程序启动的时候初始化 NIM SDK   
       NSString *appKey        = @"your app key";
       NIMSDKOption *option    = [NIMSDKOption optionWithAppKey:appKey];
       option.apnsCername      = @"your APNs cer name";
       [[NIMSDK sharedSDK] registerWithOption:option];
       ...
   }
   

   推送证书名称，不超过 32 个字符，否则登录时会报 500 错误。

步骤 4：上传 devicetoken 至云信服务端

通过调用updateApnsToken: 将提前获取到的 deviceToken 上传至云信服务端用于后续的 APNs 推送。

- (void)registerPushService
{
    if (@available(iOS 11.0, *))
    {
        UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
        [center requestAuthorizationWithOptions:(UNAuthorizationOptionBadge | UNAuthorizationOptionSound | UNAuthorizationOptionAlert) completionHandler:^(BOOL granted, NSError * _Nullable error) {
            if (!granted)
            {
                dispatch_async_main_safe(^{
                    [[UIApplication sharedApplication].keyWindow makeToast:@"请开启推送功能否则无法收到推送通知" duration:2.0 position:CSToastPositionCenter];
                })
            }
        }];
    }
    else
    {
        UIUserNotificationType types = UIUserNotificationTypeBadge | UIUserNotificationTypeSound | UIUserNotificationTypeAlert;
        UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:types
                                                                                 categories:nil];
        [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
    }
    
    [[UIApplication sharedApplication] registerForRemoteNotifications];
      
    // 注册push权限，用于显示本地推送
    [[UIApplication sharedApplication] registerUserNotificationSettings:[UIUserNotificationSettings settingsForTypes:(UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge) categories:nil]];
}

...

- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
    // 上传devicetoken至云信服务端。
    [[NIMSDK sharedSDK] updateApnsToken:deviceToken];
}

如需设置自定义推送文案（customContentKey），需要提前在控制台开通自定义推送文案功能，并提前添加好自定义的推送文案。具体如何实现，请参见推送文案。

步骤 5：测试离线推送

消息发送方：

发送消息或自定义系统通知给接收方（离线），具体的收发流程可参见消息收发和自定义系统通知。

这里以发送文本消息为例，通过调用 sendMessage:toSession:completion: 实现。发送的消息默认需要推送，如需设置推送文案，推送角标，推送文案前缀等，请参见配置消息的推送属性。

// 构造出具体会话：P2P单聊，对方账号为user
NIMSession *session = [NIMSession session:@"user" type:NIMSessionTypeP2P];
// 构造出具体消息
NIMMessage *message = [[NIMMessage alloc] init];
message.text        = @"hello";   //消息内容
message.apnsContent = @"发来了一条消息";  //推送文案
// 错误反馈对象
NSError *error = nil;
// 发送消息
[[NIMSDK sharedSDK].chatManager sendMessage:message toSession:session error:&error];

消息接收方：

接收方将会在登录后接收到离线推送。

• 离线推送支持配置免打扰时间，具体请参见设置推送全局免打扰。
• 离线推送支持配置多端推送策略，即支持推送至同一账号的多个客户端，具体请参见设置多端推送策略。

推送相关文档

• 推送问题排查
• 推送 payload 配置

常见问题

触发离线推送的条件

Q：触发推送的条件是什么？

A：iOS 切换到后台，或者用户主动杀死 App，触发推送条件。因此，要测试 iOS 推送问题，请登录后杀死 App，或将其切换到后台。

不会触发推送的场景

Q：哪些场景下不会触发推送？

A: IM 账号未登录/已登出/被踢下线，不会触发推送。App 在前台，不会触发推送。用户登录 IM 账号，并且未主动登出或者没有被踢下线，可能触发推送。

推送报错

Q：推送为什么会出现报错信息：query token with exception must not refer to a null object？

A：可能没有在 Application 主进程里面注册推送，请检查推送 SDK 的初始化时机，也可以参考 Demo 示例代码。

个别用户推送异常

Q：对于同一个消息，其他用户的推送正常，为什么个别用户推送异常？

A：请确认以下三点：

• 发送者和接收者两者是否是好友关系，控制台是否有设置非好友关系允许发送消息。
• 双方是否有拉黑情况。
• 接收方是否有设置发送免打扰，如果是强制推送的情况下可忽略。