Skip to main content

Agora Call

This module enables audio and video calling functionality using the Agora platform for real-time communication.

Features​

  • Voice Calls: High-quality audio calls between users
  • Video Calls: Face-to-face video communication
  • Group Calls: Support for multi-participant calls (configurable limit)
  • Call Management: Initiate, join, leave, decline, and end calls
  • Call History: View history of past calls via API
  • Call Status Tracking: Track call and participant status in real-time
  • Configurable Quality: Choose video quality (480p, 720p, 1080p) and audio profiles
  • Cloud Recording: Optional call recording support

Requirements​

  • Open Core Business Suite (Base System)
  • OC Connect module (dependency)
  • Agora account with App ID and App Certificate

Installation​

Enable via Admin Panel​

  1. Log in as administrator
  2. Navigate to Settings > Addons
  3. Find Agora Call and click Enable
  4. Run migrations if prompted

Enable via Command Line​

php artisan module:enable AgoraCall
php artisan migrate

After enabling, configure Agora credentials in the module settings (see Configuration below).

Configuration​

Access the settings page at Settings > Addon Settings > Agora Call to configure:

Agora Credentials​

  • Agora App ID: Your App ID from the Agora Console
  • Agora App Certificate: Your App Certificate from the Agora Console

Call Settings​

  • Maximum Participants: Maximum number of participants in a group call (2-50, default: 10)
  • Enable Recording: Enable or disable cloud recording for calls
  • Auto End Call: Automatically end the call when all participants leave
  • Call Timeout: Maximum duration for a call in minutes (5-1440, default: 60)

Quality Settings​

  • Default Video Quality: Low (480p), Standard (720p), or High (1080p)
  • Audio Profile: Speech Standard, Music Standard, or Music High Quality

Usage​

Making Calls​

Calls are initiated from the OC Connect app:

  • Start a voice or video call from a chat conversation
  • Recipients receive a call notification
  • Accept or decline incoming calls

During a Call​

  • Join or leave an active call
  • Call status is tracked for all participants
  • Calls auto-end when all participants leave (if enabled)
  • Calls end automatically when the timeout is reached

Call History​

View past call records including call status and participants via the mobile app.

Agora Account Setup​

To use this module, you need to:

  1. Create an account at Agora.io
  2. Create a new project in the Agora Console
  3. Enable the Voice and Video Calling products
  4. Copy your App ID and App Certificate
  5. Enter the credentials in the module settings page

Technical Notes​

  • Agora provides global infrastructure for low-latency calls
  • Token-based authentication is used for secure call access
  • Call events (join, leave, decline, end) are tracked per participant
  • The module generates Agora tokens on the server side for security

Changelog: View version history

Last updated on