CometChat Pro Documentation

You'll find comprehensive guides and documentation to help you start working with CometChat as quickly as possible. Let's jump right in!

Key Concepts

Learn the most important concepts of CometChat, so that it's easier to integrate.

CometChat Dashboard

The CometChat Dashboard enables you to create new apps (projects) and manage your existing apps.

How many apps to create?

Ideally, you should create two apps- one for development and one for production. And you should use a single app irrespective of the number of platforms.

Do not create separate apps for every platform; if you do, your users on different platforms will not be able to communicate with each other!

  • For every app, a unique App ID is generated. This App ID will be required when integrating CometChat within your app.
  • Along with the App ID, you will need to create an API Key (from the Dashboard) which can be used for user authentication.

API Keys

You can generate two types of API Keys from the dashboard.

Recommended Use

Auth Only

The API keys with authOnly scope can be used for direct login. It cannot be used to call any other APIs.

In your client side code

Full Access

The API keys with fullAccess scope can be used to call any API.

In your server side code


A user is anyone who uses CometChat.


  • Each user is uniquely identified using UID.
  • The UID is typically the primary ID of the user from your database.

Auth Token

  • A single user can have multiple auth tokens. The auth tokens should be per user per device per session.
  • It should be generated by API call ideally, via server to server call. The auth token should then be given to CometChat for login.
  • An Auth Token will be automatically destroyed on log out. So it's important to generate a new auth token every time a user logs in to your app.


To allow a user to use CometChat, the user must log in to CometChat.

CometChat does not handle user management. You must handle user registration and login at your end. Once the user is logged into your app/site, you can log in the user to CometChat programmatically. So the user does not ever directly login to CometChat.

CometChat does not handle friends management. If you want to associate friends with your users, you must handle friends management in your app. Once two users are friends (i.e. they have accepted each other as friends), then you can associate them as friends in CometChat.

Typical Workflow

Your App
Your Server

User registers in your app

You store the user information in your database (e.g. ID, name, email, phone, location etc. in users table)

You add the user to CometChat (only ID & name) using the API

User logs in to your app

You verify the credentials, login the user and retrieve the user ID

You log in the user to CometChat using the same user ID programmatically

User sends a friend request

You display the request to the potential friend

No action required

User accepts a friend request

You display the users as friends

You add both the users as friends using the API

User Roles

A role is a category for a group of similar users. For example, you may want to group your premium users using the role "Premium". You then use this to filter users or enable/disable features by writing conditional code.

User List

  • The User List can be used to build the Contacts or Who's Online view in your app.
  • The list of users can be different based on the logged-in user.


A group can be used for multiple users to communicate with each other on a particular topic/interest.


  • Each group is uniquely identified using GUID.
  • The GUID is typically the primary ID of the group from your database. If you do not store group information in your database, you can generate a random string for use as GUID.


CometChat supports three different types of groups:



All users

Any user can choose to join


All users

Any user with a valid password can choose to join


Only users part of the group

Invited users will be auto-joined


Once a participant joins a group, they become a member of the group. Members are part of the group indefinitely i.e. they will keep receiving messages, calls & notifications. To stop, the participant must either be kicked, banned or intentionally leave the group.

CometChat supports three different types of member scopes in a group:



Group creator is assigned Admin scope

  • Change scope of Group Members to admin, moderator or participant.
  • Can add members to a group.
  • Kick & Ban Participants/Moderators/Admins
  • Send & Receive Messages & Calls
  • Update group
  • Delete group



  • Change scope of moderator or participant.
  • Update group
  • Kick & Ban Participants
  • Send & Receive Messages & Calls


Any other user is assigned Participant scope

  • Send & Receive Messages & Calls


CometChat supports three types of messages:



By default, every message is considered as a text message.

Along with the text message, custom metadata can be sent in JSON format. For example, you can send custom metadata to identify the original message the current message is in response to (i.e. to implement reply feature).


Any media message like files, audio & video.

Along with the media message, custom metadata can be sent in JSON format. For example, you can add metadata to send a caption along with the media message.


Any custom message like location coordinates.


  • Real-time user information (presence) is available for first 1000 users (when retrieving all users) or first 1000 friends per user (when retrieving friends).
  • Groups are limited to 300 members per group.

Updated a day ago

Key Concepts

Learn the most important concepts of CometChat, so that it's easier to integrate.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.