Limitations
This page introduces the usage limits of Chat, including limits to the user, the message, the group, the chatroom and the call limit of the server APIs.
User attributes
The user attributes UserInfo include the user avatar, nickname, email address, and so on. The total length of the user information for one user must be 2 KB or less, and the total length for all users under an app must be within 10 GB or less.
Message length
The length limits of the different types of messages are as follows:
Message type | Length limit | Related API |
---|---|---|
Text message | 5 KB | createTxtSendMessage |
Image message | 10 MB | |
Voice message | 10 MB | |
Video message | 10 MB | |
File message | 10 MB | |
Transparent transmission message | 5 KB | createSendMessage |
Customized extended message | The size of the extended message must not exceed that of the original message. | createSendMessage |
Customized message | 5 KB | createSendMessage |
Group-related limitations
Group attributes
When a group createGroup is created, the length limits of the group information are as follows:
-
Group name: 128 characters or less
-
Group description: 512 characters or less
-
Group extension information: 1024 characters or less
Group member attributes
-
Key: Of string type, 16 bytes or less, only supports English uppercase and lowercase letters, numbers, and underscores
-
Value: 512 bytes or less
-
The total size of key-value pairs of a chat group members: 4KB or less
Chatroom-related limitations
PCU per chatroom
The limit of Peak Concurrent Users per chatroom is 10,000. To extend this limit, contact support@agora.io.
Chatroom attributes
When a chatroom createChatRoom is created, the length limits of the chatroom information are as follows:
-
Chatroom name: 128 characters or less
-
Chatroom description: 512 characters or less
Each chat room can have up to 100 custom attributes, and the total size of chat room custom attributes of each app cannot exceed 10 GB. The custom chat room attributes are of a key-value pair structure. A single key cannot exceed 128 characters and a room attribute value cannot exceed 4096 characters. Attribute keys support the following character sets:
- 26 lowercase English letters a-z;
- 26 uppercase English letters A-Z;
- 10 numbers 0 -9;
- "_", "-", ".".
Multiple messages forwarding limitations
- The forwarding multiple messages capability is available only in client APIs and not RESTful APIs.
- End users can only forward up to 300 messages at a time.
- The content of the forwarded messages can't be searched.
- When forwarding multiple messages in a combined form, the title and preview of the combined message is displayed. The content of the message preview can't exceed 5KB.
- Applications developed with Chat SDK versions prior to
1.2.x
will not support display of forwarded messages.
Sent message modification limitations
This feature has the following limitations:
- For a group chat, regular group members can only edit message sent by themselves, but the group owner and admins can also edit messages sent by regular group members. The message sender remains unchanged regardless of the message edit operator.
- Supported message types: text only.
- Supported use case: One-on-one chat group. Does not support Chatroom.
- End users can recall and modify messages that were sent up to 7 days ago.
- Agora supports editing the same message up to 10 times.
Storage limitations
- The Agora Chat server stores up to 100 conversations per end user.
RESTful API Call limit of server-side
The RESTful API call frequency limit of each method varies. For details about each method, see Chat RESTful API Reference.
If the provided call frequency limit cannot meet your business requirements, contact support@agora.io.
Presence limitations
The presence status of each user can be subscribed by up to 3000 users.
Contact limitations
Each user can have a block list that can contain a maximum of 500 users.