Broadcast to Users Service Configuration

The IM Service provides the Broadcast to Users Service, allowing apps to send messages or push notifications to all or specified users within the application. This enables precise and timely delivery of event announcements and content updates to target users for operational needs.

Service Capabilities and Related APIs

Before using the following capabilities and APIs of the IM Service, the Broadcast to Users Service must be enabled.

Name	API
Send Broadcast to All Users with Message-bearing Notification	The /message/broadcast.json API is used for scenarios where App Users send system notification messages to all users. Essentially, it broadcasts a system conversation message to all users in the app, which is received by the client using a scheduled pull mechanism. The message can be received within 3 minutes after sending. This is a Message-bearing Notification?.
Send Broadcast to Online Users	The /message/online/broadcast.json API is used for scenarios where App Users send system notification messages to currently online users. Essentially, it broadcasts a system conversation message to all online users in the app, which is received by the client using a scheduled pull mechanism. The message can be received within 3 minutes after sending. This is a Message-bearing Notification?.
Send Broadcast to All Users with Push-only Notification	The /push.json API is used for scenarios where the App Server sends push notifications to all or specified users. Essentially, it directly pushes a notification to all users in the app via third-party or the IM Service's built-in push channels. This is a Push-only Notification?.
Send Notification to Tagged Users	The /push.json API is used for scenarios where the App Server sends push notifications and system conversation messages to users with specified tags. Essentially, it directly pushes a notification to all users in the app via third-party or the IM Service's built-in push channels. The sent data includes message type and content, making it a Message-bearing Notification?.
Send Notification by Application Package Name	The /push.json API is used for scenarios where the App Server sends push notifications and system conversation messages to users with specified application package names. Essentially, it directly pushes a notification to all users in the app via third-party or the IM Service's built-in push channels. The sent data includes message type and content, making it a Message-bearing Notification?.

Enabling the Service

• In the development environment, the Broadcast to Users Service is enabled by default and can be used for free.
• In the production environment, you can enable the Broadcast to Users Service under the Basic Services tab in the Chat pricing plans page on the Console. This service is available for Chat Premium Plan or Chat Ultimate Plan users. Specific features and fees are detailed on the billing documentation.

Enabling Cloud Storage Service

If you need the IM Service to store system conversation messages for an extended period, please enable the corresponding cloud storage service. Once enabled, clients can retrieve historical messages stored on the server via the API for fetching remote history messages.

Name	API	Server-Side Message Storage Service
Send Broadcast to All Users with Message-bearing Notification	/message/broadcast.json	By default, messages are not stored in the IM Service's historical message records. To enable storage, you can go to the RC Console, navigate to Configuration > Chat settings > Basic features > Others, and enable the Cloud Storage for Broadcast Message feature.
Send Broadcast to Online Users	/message/online/broadcast.json	Does not support storage in server-side historical message records.
Send Broadcast to All Users with Push-only Notification	/push.json	Only generates push notifications, not messages, and does not support server-side storage.
Send Notification to Tagged Users	/push.json	Only requires enabling the Cloud Storage for One-to-One and Group Messages service. You can enable this service under the Basic Services tab in the Chat pricing plans page on the Console.
Send Notification by Application Package Name	/push.json	Only requires enabling the Cloud Storage for One-to-One and Group Messages service. You can enable this service under the Basic Services tab in the Chat pricing plans page on the Console.