Feature Configuration

Login and Message

Log in to the IM console, navigate to the target application to access the application management page, and select Chat > Configuration > Login and Message on the left sidebar. You can manage login and message related settings according to your business needs.

Login settings

1. On the Login and Message page, click Edit in the upper-right corner of the Login Settings area.



2. In the pop-up dialog box, select a multi-device login policy and set the maximum number of concurrent online web instances.
Note
If you select multi-device login for the Premium edition, up to 10 concurrent online web clients are supported, and up to 3 online devices are supported for each of the Android, iPhone, iPad, Windows, macOS, and Linux platforms.



3. Click Confirm.

Historical message storage period settings

Historical messages are stored for seven days by default. Extending the storage period is a value-added service. For more information on billing, see Pricing. You can modify the storage period once every month.
1. On the Login and Message page, click Edit in the upper-right corner of the Historical Message Storage Period Settings area.
2. In the pop-up dialog box, extend the storage period of historical messages.
3. Click Confirm and the configuration will take effect immediately.

Message recall settings

1. On the Login and Message page, click Edit in the upper-right corner of the Message Recall Settings area.



2. In the pop-up dialog box, set the time limit for message recall.



3. Click Confirm.

Multi-client synchronization settings

You can enable or disable Sync Conversation Deletion Across Clients in the Multi-client Synchronization Settings area on the Login and Message page.
Enabled: If multiple clients are online concurrently, deleting a conversation from one client will be synced to other clients (that is, the conversation will also be deleted from other clients).
Disabled: If multiple clients are online concurrently, deleting a conversation from one client will not be synced to other clients. The feature of syncing conversation deletion across clients is disabled by default.
Note
The feature of syncing conversation deletion across clients is available only to native SDK v5.1.1 and web SDK v2.14.0 or later. If you are using an earlier SDK version, you need to upgrade your SDK before you can use the feature.




User status query and status change notification settings

You can enable the feature of user status query and status change notification in the Set user status query and status change notification area on the Login and Message page.
Note
The feature of user status query and status change notification is disabled by default. When it is disabled, the error code 72001 will be reported for user status query, subscription, or unsubscription on clients. The feature can be enabled on native SDK v6.3 or later and is available only to Premium edition users. You can click here to upgrade.




Message extension settings

You can enable message extension in the Set message extension area on the Login and Message page.
Note
Message extension allows you to configure keys and values for messages to implement features such as polling, group notices, and surveys. For more information, see here. Message extension is available only to Premium edition users and is supported only on native SDK Enhanced edition v6.7.3184 or later. If you are using an earlier version, upgrade your SDK.




All/Tag users push sttings

You can enable the feature of pushing to all users in the All/Tag users push sttings area.
Note
All/Tag Users Push is an excellent tool for application user operations. It not only supports sending specific content to all users, but also can send personalized content to specific user groups based on tags and attributes, such as member events, and regional notifications. This helps effectively attract, convert, and activate users. For more information, see Pushing to All Users.




Configuration of conversations to pull

In the Configuration of conversations to pull area on the Login and Message page, you can configure the number of conversations to be pulled from the cloud. The default number is 100, and you can change the number to up to 500.
Note
The feature of configuring the number of conversations to pull is available only to Premium edition users. If you are not an Premium edition user, you need to upgrade your package before you can use the feature.
The feature of configuring the number of conversations to pull is available only to native SDK v5.1.1 and web SDK v2.0 or later. If you are using an earlier SDK version, you need to upgrade your SDK before you can use the feature.




Blocklist check

You can enable or disable Show "Sent successfully" After Sending Messages in the Blocklist check area on the Login and Message page.
Enabled: If you are in the recipient’s blocklist, you will see Sent successfully after sending a one-to-one message and the recipient will not receive the message. This is the default setting.
Disabled: If you are in the recipient’s blocklist, you will see Failed to send after sending a one-to-one message.




Relationship check

You can enable or disable Check Relationship for One-to-One Messages in the Relationship Check area on the Login and Message page.
Enabled: Check relationships before a one-to-one chat starts and only allow sending one-to-one messages to friends. When a user sends a one-to-one message to a stranger, the SDK will return error code 20009.
Disabled: Do not check relationships before a one-to-one chat starts and allow users to send and receive one-to-one messages to and from friends and strangers. This is the default setting.




Friends and Relationship Chain

Setting verification method for adding friends and custom friend fields.

Verification method for adding friends

1. Log in to the Chat console and navigate to the target application to access the application management page.
2. On the left sidebar, choose Chat > Configuration > Friends and Relationship, and click Edit in the upper-right corner of the Default Verification for Adding Friends area.


3. Select a verification method as needed and click Confirm.

Custom friend fields

Note
You can add up to 20 custom friend fields, which cannot be deleted and whose field name and type cannot be modified. Please set the fields properly as needed.
1. Log in to the Chat console, navigate to the target application to access the application management page.
2. On the left sidebar, choose Chat > Configuration > Friends and Relationship, and click Add in the upper-right corner of the Custom Friend Field area.



3. In the pop-up dialog box, enter a field name and select a field type.
Note
The field name must be all letters and cannot exceed eight characters.

Custom User Fields

Log in to the Chat console, navigate to the target application to access the application management page. and select Chat > Configuration > Custom User Field on the left sidebar. You can manage custom user fields according to your business needs.
Caution
You can add up to 20 custom user fields, which cannot be deleted and whose field name and type cannot be modified. Please set the fields properly as needed.

Adding a custom user field

1. On the Custom User Field page, click Add in the upper-right corner.
2. In the pop-up dialog box, enter a field name, select a field type, and set read/write permissions.
Note
The field name must be all letters and cannot exceed eight characters.
You need to enable at least one read permission and one write permission



3. Click Confirm.

Modifying the permissions of a custom user field

1. On the Custom User Field page, click Change Permissions in the row of the target field.
2. In the pop-up dialog box, change the read or write permission.
3. Click Confirm.


4. Click Confirm.

Group Configuration

Custom group member fields

Log in to the Chat console, navigate to the target application to access the application management page, and select Chat > Configuration > Group configuration on the left sidebar. You can manage custom group member fields according to your business needs.
Caution
You can add up to five custom group member fields, which cannot be deleted and whose group type and read/write permissions can be changed. Please set the fields properly as needed.

Adding a custom group member field

1. On the Custom Group Member Field page, click Add in the upper-right corner.
2. In the pop-up dialog box, enter a field name and set group types and read/write permissions.
Note
The field name can contain up to 16 characters, supporting letters, digits, and underscores (_). It cannot begin with a digit.
A custom group member field and a custom group field cannot have the same name.
Click Add Group Type to add one group type at a time. Duplicate group types are not allowed.
Click Delete in the row of the target group type to delete it. However, you must retain at least one group type.



3. Select I understand that after a custom group member field is added, only the read-write permissions of the added group type can be modified; the group type cannot be reselected or deleted; the field cannot be deleted.
4. Click Confirm.

Editing a custom group member field

1. On the Custom Group Member Field page, click Edit in the row of the target custom group member field.
2. In the pop-up dialog box, modify the read and write permissions of existing group types, or click Add Group Type to add a new one and set its parameters. Duplicate group types are not allowed.


3. Select I understand that after a custom group member field is added, only the read-write permissions of the added group type can be modified; the group type cannot be reselected or deleted; the field cannot be deleted.
4. Click Confirm.

Custom group fields

Log in to the Chat console, navigate to the target application to access the application management pag, and select Chat > Configuration > Group configuration on the left sidebar. You can manage custom group fields according to your business needs.
Caution
You can add up to 10 custom group fields. Once set, these fields cannot be deleted, and only the group types and the corresponding read and write permissions can be modified. Therefore, set these fields properly as needed.

Adding a custom group field

1. On the Custom Group Field page, click Add in the upper-right corner.
2. In the pop-up dialog box, enter a field name and set the group types and read/write permissions.
Note
The field name can contain up to 16 characters, supporting letters, digits, and underscores (_). It cannot begin with a digit.
A custom group field and a custom group member field cannot have the same name.
Click Add Group Type to add one group type at a time. Duplicate group types are not allowed.
Click Delete in the row of the target group type to delete it. However, you must retain at least one group type.


3. Select I understand that after a custom group member field is added, only the read-write permissions of the added group type can be modified; the group type cannot be reselected or deleted; the field cannot be deleted.
4. Click Confirm.

Editing a custom group field

1. On the Custom Group Field page, click Edit in the row of the target custom group field.
2. In the pop-up dialog box, modify the read/write permissions of existing group types, or click Add Group Type to add a new one and set its parameters. Duplicate group types are not allowed.


3. Select I understand that after a custom group member field is added, only the read-write permissions of the added group type can be modified; the group type cannot be reselected or deleted; the field cannot be deleted.
4. Click Confirm.

Group message configuration

Log in to the Chat console, navigate to the target application to access the application management pag, select Chat > Configuration > Group configuration on the left sidebar, select the Group Message Configuration Tab, and configure group messages as needed.

Pulling message history before group join

1. On the Pull message history before group join page, select a Group Type and click Edit.
2. In the Pull message history before group join pop-up window, select the required configuration items.
Note
It takes about ten minutes for the configuration to take effect.
Audio-video groups do not support this configuration.




Group system notification configuration

Log in to the Chat console, navigate to the target application to access the application management pag, select Feature Configuration > Group configuration > Group system notification configuration on the left sidebar, select the Group system notification configuration Tab, and configure group system notifications as needed.

Notification of group member change

1. On the Notification of group member change, select a Group Type and click Edit.
2. In the Notification of group member change pop-up window, select the required configuration items.
Note
It takes about ten minutes for the configuration to take effect.
Audio-video groups do not support configuring the notification of group member change.




Notification of group profile change

1. On the Notification of group profile change page, select a Group Type and click Edit.
2. In the Notification of group profile change pop-up window, select the required configuration items.
Note
It takes about ten minutes for the configuration to take effect.
Audio-video groups do not support configuring the notification of group profile change.




Notification of group member profile change

1. On the Notification of group member profile change page, select a Group Type and click Edit.
2. In the Notification of group member profile change pop-up window, select the required configuration items.
Note
It takes about ten minutes for the configuration to take effect.




Group feature configuration

Log in to the Chat console, navigate to the target application to access the application management pag, select Chat > Configuration > Group configuration on the left sidebar, select the Group feature configuration Tab, and configure the group feature as needed.




Community

A community is a large group that can hold up to 100,000 users. Once a community is created, it allows users to join or leave freely and supports historical message storage. The community feature is disabled by default. Enabling it allows you to create communities and use associated features.
If you need to use the topic feature, enable it after creating a community. Multiple topics can be created under the same community, and they share the same set of community member relationships. However, different topics have their own message sending and receiving independently and do not interfere with each other.
Note
The community feature is available only for native SDK v5.8.1668 enhanced edition or later and for web SDK v2.17.0 or later. If you are using an earlier SDK version, you need to upgrade your SDK before you can use the feature.
This feature is available only for Premium edition users. You can click here to upgrade.

List of online audio-video group members

The feature of "List of online audio-video group members" is disabled by default. You can enable it as needed.
Note
If the feature is enabled, the list of the 1,000 latest online members of an audio-video group will be stored and the list can be pulled on clients.
This feature is available only for native SDK v6.3 or later. If you are using an earlier SDK version, you need to upgrade your SDK before you can use the feature.
This feature is available only for Premium edition users. You can click here to upgrade.

Broadcast messaging of audio-video group

Broadcast messaging of audio-video group is disabled by default. You can enable it as needed.
Note
Broadcast messaging of audio-video group is disabled by default and can be enabled on native SDK v6.5 or later.
Enabling this feature allows you to set the call frequency of the broadcast messaging of audio-video group, which defaults to one message per second and can be set to up to five messages per second.
This feature is available only for Premium edition users. You can click here to upgrade.

Audio-video group member banning

Once this feature is enabled, audio-video group members can be banned as needed. A banned member cannot receive group messages or rejoin the group during the ban.
Note
This feature is available only for native SDK v6.6 and web SDK v2.22 or later. If you are using an earlier SDK version, you need to upgrade your SDK before you can use the feature.
This feature is available only for Premium edition users. You can click here to upgrade.


Message history for new members of an audio-video group

Message history for new members is an important feature to increase the user stickiness in audio-video groups. It enables users to know what was going on before they enter an audio-video group, so they can quickly fit into interactive discussions and feel more involved. This helps deliver an highly immersive live chat experience and increase users' length of stay in live rooms.
1. On the Login and Message page, click Edit in the upper-right corner of the Message History for New Members area.
2. In the pop-up dialog box, set the number of messages viewable to new members.
3. Click Confirm.

Read receipts for group messages

Group message read receipt is a must-have feature for efficient communication. As a powerful feedback tool, it allows viewing the numbers and details of members who have or have not read the sent messages. This helps teams create a more timely and efficient atmosphere of communication, especially in business and OA scenarios.
1. On the Login and Message page, click Edit in the upper-right corner of Read receipts for group messages.
2. In the pop-up Read receipts for group messages dialog box, set the group types that support message receipts.
3. Click Confirm.
Note
The group message read receipt feature is available only for Premium edition users. If you are not an Premium edition user, you need to upgrade before you can use the feature. The feature is supported by native SDK v6.1.2155 or later and is applicable to work groups (Work), public groups (Public), and meeting groups (Meeting) that support up to 200 members per group.