Development Guide
Content Moderation Overview
Instant Messaging (IM) supports content moderation for IM messages.
- The IM service has a built-in sensitive word mechanism. Note that this mechanism is only a basic protection feature and is limited to text content (with a default maximum of 50 sensitive words). It cannot replace professional content moderation services.
- RC's Content Moderation Service provides comprehensive support for IM content, including text, images, voice clips, and short videos, ensuring accurate identification of sensitive information.
- If you wish to implement your own moderation system or integrate with a third-party moderation service, you can use the Message Callback Service.
If a message is blocked due to being flagged as violating rules, the sender will not be notified by default. If your app wants to notify the sender that the message has been blocked, you can submit a ticket to enable the Blocked Message Status Callback to Sender feature and set up a listener on the client side (requires Android/iOS SDK version ≧ 5.1.4, Web ≧ 5.0.2). For details, see Message Block Notification Callback.
By default, messages sent in one-to-one chats that contain sensitive words or fail moderation will still be stored in the sender's server-side message history. Additionally, the user will receive a message compensation when logging in from other devices. If you do not want messages containing sensitive words or failing moderation to be saved in the sender's message history or trigger message compensation, you can enable the Do Not Save Sensitive Messages to Sender's History feature in the RC Console under Configuration > Chat settings > Basic features > Security.
Sensitive Word Mechanism
Note
- The client does not provide management interfaces for this feature, only callback interfaces to notify the sender when a message is flagged as undeliverable. For details, see Message Block Notification Callback.
- If you need to moderate text (with semantic detection), images, voice clips, or short videos, it is recommended to use RC's Content Moderation Service.
The Sensitive Word Mechanism is a basic protection feature that only supports identifying and filtering sensitive words in text message content. For messages that contain sensitive words, you can choose to block the message (preventing it from being delivered to the recipient) or replace the sensitive words according to specified rules before delivery.
Currently supported languages for sensitive word filtering include: Chinese, English, Japanese, German, Russian, Korean, and Arabic.
You can manage sensitive words for the development or production environment under your App Key through the following methods:
| Feature Description | Client API | RC Server API | Console |
|---|---|---|---|
| Add sensitive words, with support for setting replacement content | Not available | Add Sensitive Word | Sensitive Word Settings page |
| Remove sensitive words | Not available | Remove Sensitive Word | Sensitive Word Settings page |
| Batch remove sensitive words | Not available | Batch Remove Sensitive Word | Sensitive Word Settings page |
| Get the list of sensitive words, with support for retrieving replacement content | Not available | Get Sensitive Word List | Sensitive Word Settings page |
Default Behavior
- A maximum of 50 sensitive words can be set by default.
- This feature only applies to messages sent from the client SDK by default.
- By default, it only supports identifying sensitive words in official built-in text message types (message identifier
RC:TxtMsg). It supports one-to-one chats, group chats, chatrooms, and ultra group conversations. Modified text messages in ultra groups are also subject to sensitive word identification, blocking, or filtering by default.
Configuration Adjustments
- Chat Premium Plan or Chat Ultimate Plan users can adjust the maximum number of sensitive words in the Extended Services tab under the Chat pricing plans page in the console. Specific features and costs are subject to the Billing Documentation.
- If you want to filter sensitive words in messages sent via the server API, you can enable the Server API Message Filtering for Sensitive Words switch in the Basic Features Interface in the console.
- If you need to enable the sensitive word mechanism for custom message types, you can click Set Custom Messages on the Sensitive Word Settings page. Provide the
ObjectNameof the custom message type and the corresponding key in the content (Content) JSON structure to filter the value associated with that key for sensitive words.
IM Content Moderation Service
Note
The client does not provide management interfaces for this feature, only callback interfaces to notify the sender when a message is flagged as undeliverable. For details, see Message Block Notification Callback.
If you want comprehensive moderation of IM content, you can use RC's Content Moderation Service, which provides IM Moderation and RTC Moderation services.
IM Moderation is designed for instant messaging and offers the following capabilities:
- Moderate text content
- Moderate images
- Moderate voice clips
- Moderate short videos
- Moderate custom message types (requires a ticket submission)
- Moderate message modifications in ultra group conversations
- View moderation reports in the console
- Query IM moderation records in the console
- Callback for moderation results
You can enable the IM Moderation service on the IM & RTC Moderation page in the console and configure the callback address for moderation results. For details, see the server documentation Moderation Result Callback.
IM Content Moderation Pricing
The content moderation service is a paid service. The development environment can be used for free, but the production environment requires prepayment. For specific pricing details, see Pricing Standards · IM Moderation.
Message Callback Service
If you want to integrate your own moderation system or a third-party content moderation service, you can use the Message Callback Service.
The Message Callback Service (formerly Template Routing) provides a message filtering mechanism. You can synchronize specific messages to your designated server based on parameters such as sender ID, recipient ID, message type, and conversation type. In ultra group conversations, message content modifications and message extensions can also be synchronized to your designated server.
Once messages are synchronized to your server, you can use your own moderation system or integrate with a third-party moderation system. The RC server will decide whether to deliver the message, replace its content, or how to replace the content based on the response from your application server.
You can manage the status and routing rules of the Message Callback Service for the development or production environment under your App Key on the Message Callback Service page in the console.
For details on how to create routing rules and the specific callback parameters, see the Message Callback Service documentation.
Message Callback Service Pricing
Pricing is subject to the Billing Documentation.