Extension parameters

Extension parameters are delivered with the message body to the client for custom processing.

Extension parameters fall into three categories:

• System Extension Parameters

  These parameters are reserved by the system. Do not modify their values. System extension parameters include notifyType, action, silent, pushType, templateCode, channel, and taskId.

• System Extension Parameters with Specific Meanings

  These system-reserved parameters have specific meanings and can be configured. The following table describes each parameter.

  Key	Description
  sound	Custom ringtone. Set the value to the ringtone file path. This parameter takes effect only on Xiaomi and Apple devices.
  badge	Application icon badge number. Set the value to the desired badge count. This parameter is delivered with the message body to the client. On Android devices, you must implement the badge logic yourself. On Apple devices, the system handles badges automatically. After the message is pushed, the application icon displays the badge count specified in the parameter value.
  mutable-content	APNs custom push identifier. Including this parameter in a push enables iOS 10 UNNotificationServiceExtension support. If omitted, the push is treated as a standard notification. Set the value to 1.
  badge_add_num	Incremental badge count for Huawei channel push notifications.
  badge_class	The entry Activity class for the Huawei channel desktop icon.
  big_text	Big text style. The value must be 1; other values are invalid. This parameter takes effect only on Xiaomi and Huawei devices.

• User-Defined Extension Parameters

  All parameter keys other than the system and system-specific extension parameters are user-defined. User-defined extension parameters are delivered with the message body for custom processing on the client side.