Development Guide

SDK supports message block notification callback starting from version 5.1.4.

By default, the message sender cannot be aware of whether the message has been intercepted by RC's moderation service. If the app wishes to notify the message sender when a message is blocked due to triggering moderation rules, it can enable the Blocked Message Status Callback to Sender service.

RC's content moderation service (including message sensitive words, IM moderation service, and message callback service) may intercept messages in the following scenarios:

• The content of a text message triggers RC's built-in sensitive words, causing the message to be undelivered to the recipient.
• The content of a text message triggers custom sensitive words (blocked sensitive words) set by the user, causing the message to be undelivered to the recipient.

• The message triggers the moderation rules set by the IM Moderation service or the Message Callback Service, causing the message to be undelivered to the recipient.

Enabling the Service

You can enable the Blocked Message Status Callback to Sender service in the RC Console by navigating to Configuration > Chat settings > Basic features > Security.

Message Block Listener Explanation

When a sent message is intercepted, the SDK triggers the following method in the MessageBlockListener:

void onMessageBlock(BlockedMessageInfo info)

The BlockedMessageInfo contains information about the intercepted message. You can retrieve this information using the methods listed in the table below:

Method Name	Description
getConversationType()	Retrieves the conversation type of the intercepted message
getTargetId()	Retrieves the conversation ID of the intercepted message
getChannelId()	Retrieves the ultra group channel ID of the intercepted message. Requires Android SDK ≧ 5.2.4
getBlockMsgUId()	Retrieves the unique ID of the intercepted message
getType()	Retrieves the reason for the message being intercepted. See MessageBlockType Explanation below.
getExtra()	Retrieves additional information about the intercepted message. Requires Android SDK version ≧ 5.2.5 (Exception: Due to historical reasons, it is also available in the 5.2.3.x maintenance versions starting from 5.2.3.2).
getSourceType()	Retrieves the source type of the intercepted ultra group message. 0: The original message triggered the interception (default). 1: The message extension triggered the interception. 2: The modified message content triggered the interception. Supported in Android SDK 5.2.5 and later (only for ultra groups).
getSourceContent()	Retrieves the content JSON string of the intercepted ultra group message or extension. When the sourceType field is 1, it represents the extension content. When sourceType is 2, it represents the modified message content. See sourceContent Explanation below. Supported in Android SDK 5.2.5 and later (only for ultra groups).

• MessageBlockType Explanation

  public enum MessageBlockType {
  
      /**
       * Unknown type
       */
      UNKNOWN(0),
  
      /**
       * Global sensitive words: Triggered by RC's built-in global sensitive words
       */
      BLOCK_GLOBAL(1),
  
      /**
       * Custom sensitive words: Triggered by custom sensitive words set by the user in RC
       */
      BLOCK_CUSTOM(2),
  
      /**
       * Third-party moderation: Triggered by a third-party (Shumei) or the message callback service (original template routing service) deciding not to deliver the message
       */
      BLOCK_THIRD_PATY(3);
  }

• sourceContent Explanation

  • When sourceType is 0, sourceContent is empty.
  • When sourceType is 1, sourceContent is the message extension content, example {"mid":"xxx-xxx-xxx-xxx","put":{"key":"Sensitive Word"}}. mid is the ID of the notification message.
  • When sourceType is 2, sourceContent is the modified message content, example {"content":"Text containing sensitive information"}. The message content format for built-in message types is described in Message Type Overview.

Setting the Message Block Listener

Note

This interface is available in RongIMClient.

You can set the message block listener using the following method to monitor intercepted messages and the reasons for interception.

RongIMClient.getInstance().setMessageBlockListener(listener)