Use Limits

Last updated: 2021-01-13 10:54:48

    Service Feature Limits

    Feature Limit Item Limit Description
    One-to-one/group message Content length The maximum length for a single one-to-one/group message is 8,000 bytes. If this limit is exceeded, the message will fail to be sent.
    Sending frequency One-to-one messages: no limit
    Group messages: 40 messages/second for each group (this limit applies to all group types, and the frequency limits on different groups are independent)
    Receiving frequency Android/iOS/Mac/Windows/iPad: no limit for one-to-one messages or group messages
    Web: no more than 1,000 messages/second (total of one-to-one messages and group messages)
    Size of a single file The SDK supports a maximum file size of 100 MB for any single file to be sent.
    Message history storage period Historical message storage is available for one-to-one messages and non–audio-video group messages. You can log in to the IM console to modify the relevant configuration. The default configurations for different service packages are as follows:
    • Trial Edition: 7 days, with no extension supported
    • Pro Edition: 7 days, with extension supported
    • Ultimate Edition: 30 days, with extension supported
    The extension of the historical message storage period is a value-added service. For the specific costs, see Value-added Service Pricing.
    System message Quantity and storage period A maximum of 100 system messages can be stored for up to 7 days.
    UserID Naming rules The maximum length of a user account is limited to 32 bytes. English letters or numbers are supported. Special characters are not allowed.
    User profile Custom field The keywords of custom fields must consist of English letters with a length no longer than 8 bytes. The length of the values of custom fields cannot exceed 500 bytes.
    UserSig Validity period User password. The signatures generated by the default API of the IM backend SDK expire after 180 days.
    Conversation management Number of recent contacts Up to 100 recent contacts can be saved for an ordinary user.
    User relationship chain Friends and friend groups
  • A single user can have up to 3,000 friends.
  • The maximum number of pending friend requests supported is 100.
  • The maximum number of friend groups supported is 32.
  • The maximum length of a friend group name is 30 bytes.
  • The maximum length of friend remarks is 96 bytes.
  • Blocklist A single user can blocklist a maximum of 1,000 users.
    Group Number of groups This refers to the total number of groups of all group types that simultaneously exist in a single SDKAppID, excluding deleted groups. If the upper limit has been reached, you can delete unneeded groups and then create new ones. The upper limits for different service packages are as follows:
  • Trial Edition: 100
  • Pro Edition or Ultimate Edition: no upper limit

  • The maximum daily net increase of groups is 10,000, and the free peak group count is 100,000/month. If the peak group count exceeds the free quota, extra fees will be generated. For more information on the costs, see Fees for Usage Exceeding the Free Quota.
    Number of group members Audio-video group (AvChatRoom): no upper limit on the number of group members.
    For non–audio-video groups, the default configurations for different service packages are as follows:
    • Trial Edition: 20 members/group
    • Pro Edition: 200 members/group, which can be extended to 2,000 members/group
    • Ultimate Edition: 2,000 members/group, which can be extended to 6,000 members/group
    • Extending the upper limit on the number of group members is a paid value-added service. For the specific costs, seeValue-added Service Pricing.
    Number of groups a user can join This refers to the total number of groups of all group types that a user can join. The limits for different service packages are as follows:
  • Trial Edition: 50 groups/user
  • Pro Edition: 500 groups/user, which can be extended to 1,000 groups/user
  • Ultimate Edition: can be extended to 3,000 groups/user
  • Extending the upper limit on the number of groups that a user can join is a paid value-added service. For the specific costs, see Value-added Service Pricing.
    Group profile
  • The maximum length of the group name is 30 bytes.
  • The maximum length of the group introduction is 240 bytes.
  • The maximum length of the group announcement is 300 bytes.
  • The maximum length of the group profile photo URL is 100 bytes.
  • The maximum length of the group name card is 50 bytes.
  • Custom group ID The custom group ID must be printable ASCII characters (0x20-0x7e) with maximum length limited to 48 bytes. It cannot begin with @TGS# so as to avoid confusion with the default group IDs assigned by IM.
    Group custom field Groups support up to 20 custom fields:
  • The Key field is String type, with a maximum length of 16 bytes. Its name can contain only uppercase and lowercase letters, numbers, and underscores.
  • The Value field is a user-defined buffer and can be binary data. The maximum Value length for groups is 512 bytes.
  • Group member custom field Group Member supports up to 5 custom fields:
  • The Key field is String type, with a maximum length of 16 bytes. Its name can contain only uppercase and lowercase letters, numbers, and underscores.
  • The Value field is a user-defined buffer and can be binary data. The maximum Value length for Group Member is 64 bytes.
  • Note:

    This document lists only the RESTful APIs that have use limits. For a complete list of APIs, see RESTful APIs.

    General limits

    Limit Item Limit Description
    Call frequency

    Account management

    API Limit Description
    Importing multiple accounts Up to 100 user names can be imported at a time, and this API does not support directly importing nickname and profile photo information of accounts.
    Querying online status of accounts A single request can query the status of up to 500 users.

    One-to-one message

    API Limit Description
    Sending one-to-one messages in batches A single request can send one-to-one messages to up to 500 users.

    Relationship chain management

    API Limit Description
    Importing friends A single request can import up to 1,000 friends.

    Group management

    API Limit Description
    Adding group members A maximum of 100 members can be added at a time.
    Deleting group members A single request can delete up to 500 members.
    Querying a user’s identity in the group A single request can query up to 500 accounts.
    Batch muting and unmuting A single request can mute/unmute up to 500 accounts.
    Sending ordinary messages in a group The default sending frequency of a single group is limited to 40 messages/second.
    If two messages sent within 5 minutes from the same sender have the same random value (Random parameter), the later message will be discarded as a duplicate message.
    Importing group messages A maximum of 20 messages can be imported by a single request. Messages must be imported in ascending order by timestamp. The timestamps of imported messages must be earlier than the current time and later than the group creation time. Otherwise, the import fails.
    Importing group members Audio-video groups (AVChatRoom) do not support importing members.
    Up to 300 members can be imported in one request. However, different group types have different group member limits. For more information, see Group Features.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help