Configuring Push Notification Attributes for Messages

You can provide the RCMessagePushConfig configuration when sending messages to customize the push behavior for individual messages. For example:

Customize the push notification title and content
Customize the notification bar icon
Add additional information for remote push notifications
Bypass the recipient client's settings to forcibly display notification content in the push notification
Other personalized configurations supported by APNs, HarmonyOS, or Android push channels

Compared to the pushContent and pushData parameters in the message-sending input, the configurations in MessagePushConfig have higher priority. When sending a message, if RCMessagePushConfig is configured, the configurations in RCMessagePushConfig will be used first.

RCTextMessage *txtMsg = [RCTextMessage messageWithContent:@"Test text message"];

RCMessage *message = [[RCMessage alloc]
  initWithType:ConversationType_PRIVATE
  targetId:@"targetId"
  direction:MessageDirection_SEND
  content:txtMsg];

RCMessagePushConfig *pushConfig = [[RCMessagePushConfig alloc] init];
pushConfig.disablePushTitle = NO;
pushConfig.pushTitle = @"Notification Title";
pushConfig.pushContent = @"Notification Content";
pushConfig.pushData = @"Notification's pushData";
pushConfig.templateId = @"templateId";
pushConfig.iosConfig.threadId = @"iOS notification grouping ID";
pushConfig.iosConfig.apnsCollapseId = @"iOS notification override ID";
pushConfig.iosConfig.richMediaUri = @"iOS custom notification bar icon URL";
pushConfig.androidConfig.notificationId = @"Android notification ID";
pushConfig.androidConfig.channelIdMi = @"Xiaomi channel ID";
pushConfig.androidConfig.channelIdHW = @"Huawei channel ID";
pushConfig.androidConfig.categoryHW = @"Huawei Category";
pushConfig.androidConfig.channelIdOPPO = @"OPPO channel ID";
pushConfig.androidConfig.typeVivo = @"vivo classification";
pushConfig.androidConfig.categoryVivo = @"vivo Category";
pushConfig.hmosConfig.imageUrl = "HarmonyOS notification bar icon URL";
pushConfig.hmosConfig.category = "HarmonyOS push message category";
pushConfig.forceShowDetailContent = YES;
message.messagePushConfig = pushConfig;

/// Call global UIKit or IMLib message-sending method

Push Notification Attributes Explanation

RCMessagePushConfig provides the following parameters:

Parameter	Type	Description
disablePushTitle	BOOL	Whether to disable the notification title. This attribute is only effective for iOS platform users. Android third-party push platforms require a notification title, so this is not supported.
pushTitle	NSString	Push notification title. The title specified here has the highest priority. If not set, refer to the default Push Notification Title and Push Notification Content for built-in message types in User Content Message Format.
pushContent	NSString	Push notification content. The content specified here has the highest priority. If not set, refer to the default Push Notification Title and Push Notification Content for built-in message types in User Content Message Format.
pushData	NSString	Additional information for remote push notifications. If not provided, the `pushData` from the sent message will be used.
forceShowDetailContent	BOOL	Whether to forcibly display notification details. When the target user has set not to show message details via RCPushProfile's `updateShowPushContentStatus` method, this parameter can be used to forcibly display the push details for this message.
templateId	NSString	Push notification template ID. Once set, the push notification will match the language content in the template based on the language environment set by the target user via the SDK RCPushProfile's `setPushLauguageCode`. If no match is found, the default content will be used. The template content is set in the "Console - Custom Push Copywriting" section. For specific operations, refer to Configuring and Using Custom Multilingual Push Templates.
iOSConfig	RCiOSConfig	iOS platform-specific configurations. See RCiOSConfig Attribute Explanation for details.
androidConfig	RCAndroidConfig	Android platform-specific configurations. See RCAndroidConfig Attribute Explanation for details.
hmosConfig	RCHarmonyOSConfig	HarmonyOS platform-specific configurations. See RCHarmonyOSConfig Attribute Explanation for details.

RCiOSConfig Attribute Explanation

Parameter	Type	Description
threadId	NSString	iOS platform notification bar grouping ID. Notifications with the same `threadId` will be grouped together (supported from iOS10).
apnsCollapseId	NSString	iOS platform notification override ID. When `apnsCollapseId` is the same, new notifications will override old ones, with a maximum of 64 bytes (supported from iOS10).
richMediaUri	NSString	iOS custom notification bar icon URL. The app needs to parse `richMediaUri` and implement the display. Image requirements: 120 * 120px, in png or jpg format. Supported from SDK version 5.2.4.
interruptionLevel	NSString	Applicable to iOS 15 and later systems. Values can be `passive`, `active` (default), `time-sensitive`, or `critical`. For details, refer to the corresponding APNs interruption-level field. In iOS 15 and later, system features like "Scheduled Summary" and "Focus Mode" may cause important push notifications (e.g., balance changes) to be unnoticed by users. Consider setting this field. Supported from SDK version 5.6.7.

RCAndroidConfig Attribute Explanation

Parameter	Type	Description
notificationId	NSString	Android platform Push unique identifier. Currently supported for Xiaomi and Huawei push platforms. By default, developers do not need to set this. When a message generates a push, the message's `messageUId` is used as the `notificationId`.
channelIdMi	NSString	Xiaomi channel ID. This message uses the specified push channel for Xiaomi. If the developer has integrated Xiaomi push and needs to specify `channelId`, they can obtain it from Android developers. `channelId` is created by the developer.
miLargeIconUrl	NSString	(This field is no longer valid as Xiaomi has discontinued support for this feature) Xiaomi notification-type push notification image URL. Image requirements: 120 * 120px, in png or jpg format. Supported from version 5.1.7. Compatible with MIUI domestic (MIUI 12 and above) and international versions.
channelIdHW	NSString	Huawei channel ID. This message uses the specified push channel for Huawei. If the developer has integrated Huawei push and needs to specify `channelId`, they can obtain it from Android developers. `channelId` is created by the developer.
hwImageUrl	NSString	Huawei push notification custom notification bar icon URL. If not set, the notification bar icon will not be displayed. The icon file must be smaller than 512 KB, with a recommended size of 40dp x 40dp and rounded corners of 8dp. Icons exceeding the recommended size may be compressed or partially displayed. Supported from version 5.1.7.
categoryHW	NSString	Huawei push channel message self-classification identifier. Default is empty. `category` must be in uppercase letters, e.g., `IM`. The app must complete Huawei Self-Classification Rights Application or Special Permission Application as per Huawei requirements for this field to be valid. See Huawei's official documentation Huawei Message Classification Standards. This field has higher priority than the Huawei push `Category` configured for the App Key in the Console. Supported from SDK version 5.4.0.
importanceHW	RCImportanceHw	Huawei push notification reminder level. `RCImportanceHwLow` indicates that the notification bar message is expected to be a silent reminder, with no sound or vibration when the message arrives. `RCImportanceHwNormal` indicates that the notification bar message is expected to be a strong reminder, with sound and vibration when the message arrives. The actual message reminder method on the device will be adjusted based on the `categoryHW` field value, or the `category` field value configured in the Console, or Huawei Smart Classification results. Supported from SDK version 5.1.3.
imageUrlHonor	NSString	Honor push notification custom notification bar icon URL. If not set, the notification bar icon will not be displayed. The icon file must be smaller than 512 KB, with a recommended size of 40dp x 40dp and rounded corners of 8dp. Icons exceeding the recommended size may be compressed or partially displayed. Supported from SDK version 5.6.7.
importanceHonor	RCimportanceHonor	Honor push Android notification message classification, which determines the device's notification behavior. `RCImportanceHonorLow` indicates marketing and informational messages. `RCImportanceHonorNormal` (default) indicates service and communication messages. Supported from SDK version 5.6.7.
typeVivo	NSString	VIVO push service message category. Possible values: `0` (operational messages) and `1` (system messages). This parameter corresponds to the `classification` field in VIVO push service. See VIVO Push Message Classification Explanation.
categoryVivo	NSString	VIVO push service message sub-category. For example, `IM` (instant messages). This parameter corresponds to the `category` field in VIVO push service. For detailed `category` values, see VIVO Push Message Classification Explanation. If a sub-category `categoryVivo` is specified, `typeVivo` (system or operational message) must also be specified. Ensure that the sub-category content complies with VIVO's official requirements for system or operational message scenarios. The `categoryVivo` field has higher priority than the VIVO push `Category` configured for the App Key in the Console. Supported from SDK version 5.4.2.
channelIdOPPO	NSString	OPPO channel ID. This message uses the specified push channel for OPPO. If the developer has integrated OPPO push and needs to specify `channelId`, they can obtain it from Android developers. `channelId` is created by the developer.
fcmCollapseKey	NSString	FCM push notification grouping ID. Supported from SDK version 5.1.3. Note: If using this field, ensure that the FCM push configuration in the Console is set to Notification Message Mode.
fcmImageUrl	NSString	FCM push notification bar icon URL. If not set, the notification bar icon will not be displayed. Supported from SDK version 5.1.3. Note: If using this field, ensure that the FCM push configuration in the Console uses Certificate authentication and is set to Notification Message Mode.
fcmChannelId	NSString	FCM channel ID. This message uses the specified push channel for FCM. If the developer has integrated FCM push and needs to specify `channelId`, they can obtain it from Android developers. `channelId` is created by the developer.

Channel IDs need to be created by Android developers as follows:

Push Channel	Configuration Instructions
Huawei	Create Channel ID via Android SDK API on the app side
Xiaomi	Create Channel ID on Xiaomi Open Platform or via Xiaomi server API
OPPO	Create Channel ID via Android SDK on the app side; register the Channel ID on the OPPO management platform to ensure consistency
vivo	Create Channel ID via server API

RCHarmonyOSConfig Attribute Explanation

Parameter	Type	Description
imageUrl	NSString	HarmonyOS notification bar icon URL. The notification bar icon supports png, jpg, jpeg, heif, gif, and bmp formats. The image's length * width must be less than 25000 pixels. If the image does not meet the requirements, the terminal cannot display the notification message.
category	NSString	HarmonyOS push message category. Default is empty. `category` must be in uppercase letters. For details, refer to the corresponding HarmonyOS category explanation.

IMLib

Global Chat UIKit

push notification

IMLib

Global Chat UIKit

Chat Server

Chat Server SDK

Push Notification Attributes Explanation​

Push Notification Attributes Explanation