Rest APIs
Documentation ↗GitHub ↗Help Center ↗Dashboard ↗
Start typing to search…

Constraints, Rate limits and Errors

Constraints, Rate limits and Errors:

Properties and Constraints:

API Keys: Properties and Constraints

ItemProperty or ConstraintNotes
API Keys100 characters (UTF8mb4 Characters)This covers all the languages and even emojis. (One emoji uses two characters).
Maximum number of APIs keys that can be created for an app25

Users and Groups: Properties and Constraints

ItemProperty or ConstraintNotes
Character limits for UIDs and GUIDs100 characters
Maximum users in a group (v3)100000
Maximum groups a user can be a part of2000
Maximum number of friends for a user1000
Maximum tokens for a userNo limits
Maximum Number of Bot users that can be created25
Maximum number of groupsNo limits
Maximum number of unread messages per userNo limits
Maximum number of users that can be created for an appNo limits
User and Group ID100 characters, alpha-dash (a-z, 0-9 with -and _) without spaces .CometChat forces the UID to all lowercase.
User and Group name100 characters, UTF8mb4 setThis covers all the languages and even emojis.
User and Group avatarMust be a URL, limit of 3000 charactersCometChat doesn't save the image on its servers.. There is no limit on the image resolution. It depends on the implementation.
User profileMust be a URL, limit of 3000 charactersSame as above
User and Group metadataThe API limit for the POST request length is 10 KB. Hence, the user's metadata information must fit in the same limit and must not exceed 5 KB.
User and Group tagA user can have up to 25 tags with 100 characters per tag. The tags can be in any language. The character set must be UTF8mb4
Group passwordString up to 100 characters
Group description255 characters, UTF8mb4 set
Maximum active presence subscriptionsThe presence subscription will be active until 1000 users are online for a single app. if more than 1000 users go online, the presence notification starting from the 1001st user will not be sent to other users.Note, this is the higher limit applicable across subscription for friends, users with certain roles and all users
Typing indicators for groupsTyping indicator will be sent for a group of up to 1000 online users.
Unread message counts for groupsFor a group with more than 300 members, the conversations and unread message counts are not updated.
Delivery and read receipts for groupsDelivery and read receipts will be sent for a group of up to 300 online users.

Roles: Properties and Constraints

ItemProperty or ConstraintNotes
Maximum number of Roles that can be createdMaximum 25
Role UID100 characters, alpha-dash (a-z, 0-9 with -and _) without spacesCometChat forces the UID to lowercase.
Role name100 characters, UTF8mb4This covers all the languages and even emojis.
Role description255 characters, UTF8mb4 set, any language.
MetadataNo limit

Messages: Properties and Constraints

Calling: Properties and Constraints

ItemProperty or ConstraintNotes
Maximum users in a call50
Default frame rate for video calls30 FPS
Resolution for video callsMaximum - 720p, Minimum - 180pThis depends on the layout selected and the bandwidth available at the user's end
Media encryption usedSRTP
Audio codec usedOPUS
Video codec usedH.264

Rate Limits:

Groups

  1. GUID must be less than 100 characters & must be alpha-numeric-dash.
  2. Groups (with all features) can be as large as 300 members.
  3. Groups (without delivery & read receipts & typing indicators) can be as large as 50,000 members and can have up to 10,000 concurrent members.

Users

  1. UID must be less than 100 characters & must be alpha-numeric-dash.
  2. A user can have up to 500 friends.
  3. Presence subscription for all users is limited to 1000 users.

Messages

  1. Messages must be less than 65Kb.

Voice & Video Calling

  1. Up to 4 users can participate in a single voice or video call.

API

  1. API calls for core operations are rate limited to 10000 requests per min. Core operations include user connection, create/delete user, create/join group cumulatively.
  2. API calls for standard operations are rate limited to 20000 requests per min. Standard operations include all other operations cumulatively.

Bots

  1. UID must be less than 50 characters.

Webhooks:

ItemProperty or ConstraintNotes
Webhook URLValid URL, maximum 255 characters
Webhook ID50 characters, UTF8mb4 set, alphanumeric (without spaces)
Webhook authentication username50 characters, alphanumeric (without spaces)
Webhook authentication password100 characters, alphanumeric (without spaces)

Errors: