OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse OpenIMSDK Guides
GUIDESOpenIMSDK Guides

OpenIMSDK guides organized by implementation stage, from product concepts and deployment to integration, extension, operations, and reliability.

Guides

Offline Push

Connect mobile offline push for a complete notification experience.

Copy

Offline push notifications

In mobile environments, when a user is offline or an application is terminated or moved to the background, the operating system may suspend the application process. This prevents the OpenIMClientSDK persistent connection from continuing to receive messages. To ensure users receive notifications promptly, integrate a third-party offline push notification service:

Server and client configuration

A complete OpenIMSDK offline push delivery pipeline requires configuration in both OpenIMServer and OpenIMClientSDK.

Server-side configuration

The following YAML snippet demonstrates how to enable GeTui or FCM and configure the required credentials:

# Use GeTui for offline push notifications. You can also select fcm or jpns.
# Obtain configuration values from your push notification provider.
enable:
  getui:
    pushUrl: https://restapi.getui.com/v2/$appId
    masterSecret:
    appKey:
    intent:
    channelID:
    channelName:
  fcm:
    # filePath takes precedence; authURL is used when filePath is empty.
    filePath:
    authURL: # Must begin with https or http

Client-side configuration

Each client platform also requires configuring push credentials, application bundle identifiers, and notification permissions. Refer to the corresponding OpenIMClientSDK demo projects for setup instructions: