Enable and Configure Agora Chat Service

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

Prerequisites

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

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

Enable the Agora Chat service

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 the service.

Once the Chat service is enabled, you are redirected to the Chat config page. You can then enable the below advanced features of Chat 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

Get the information of the Agora Chat project

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

• 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 the Agora Chat service assigns to each app. The rule is ${OrgName}#{AppName}.
• OrgName: The unique identifier that the Agora Chat service assigns to each enterprise (organization).
• AppName: The name that the Agora Chat service 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 the Chat service 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.

Next steps

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.