Enable and configure Chat

Before using Chat, you need to enable and configure Chat at Agora Console.

Before enabling Chat, make sure that you have the following:

• A valid Agora account.
• An Agora project that uses APP ID + Token as its authentication.
• A Chat pricing plan. For how to subscribe to a plan, see Subscribe to the pricing plan.

1. Log in to the Agora Console.

2. In the left navigation bar, click Project Management and click Config for the project that you want to use.

3. In the Features section of the Edit Project page, click Enable next to Chat to enable Chat.

   

   If this is the first project you enable Chat for, select and subscribe a chat package:

   

4. Select a data center closest to where most of your end users are located.

   

   Once Chat is enabled, you are redirected to the Chat config page.

5. Enable the advanced Chat features based on your business requirements.

   

For details about these advanced features, see the following:

• Message Callback
• Message Thread
• Reaction
• Offline Message Push (Advanced)
• Presence
• Translation
• Moderation

Agora Console assigns the following information to each project that enables Chat:

• Data Center: Agora provides several data centers for the service in different regions, including Beijing1 (China), Beijing VIP (China), Singapore, Frankfurt (Germany), and Virginia (USA). After the plan is changed, the data center remains unchanged.
• AppKey: The unique identifier that Chat assigns to each app. The rule is ${OrgName}#{AppName}.
• OrgName: The unique identifier that Chat assigns to each enterprise (organization).
• AppName: The name that Chat assigns to each app. Each app under the same enterprise (organization) must have a unique App Name.
• API request url: The domain of the WebSocket and RESTful API request that Agora assigns to each project.

Follow these steps to get the project information:

1. Find the project that has enabled Chat on the Project management page at Agora Console, and click Config.
2. On the project edit page, find Chat and click Config.
3. On the project config page, get the values of Data Center, AppKey, OrgName, AppName, WebSocketAddress, and REST API.

1. Log in to the Agora Console.

2. In the left navigation bar, click Package.

3. On the Subscribe tab, you can change your Chat plan by clicking Subscribe on other plans.

   

   Note:

   • The plan change take effect immediately.
   • Agora doesn't recommend plan downgrading, as it could impact capacity of your applications and availability of certain features.

1. Log in to Agora Console.

2. In the left navigation bar, click Project Management and click Config for the project that you want to use.

3. In the Features section of the Edit Project page, click Enable/Configure next to Chat.

4. On the Application Information page, disable Chat Service Status section. Note: When you disable Chat, the Chat-related data are still stored in the Chat data center, and you are still charged for the plan activation fee.

   q

Before unsubscribing Chat, ensure all the projects that enable Chat are disabled.

1. Log in to the Agora Console.

2. In the left navigation bar, click Package.

3. On the Subscribe tab, scroll down to the bottom and click Unsubscribe.

   

   Note:

   • When you unsubscribe Chat, all Chat-related data are purged.
   • When you unsubscribe Chat, you are still billed with a pro-rated monthly fee and the usage occurred during that month.

After enabling and configuring Chat Service, the Chat-related features in Agora Analytics are enabled by default to help you keep track the usage trends and quality details. For more information, see Data Insights and Data Metrics.