README.md

Active Call Documentation (English)

Welcome to the Active Call English documentation hub.

📚 Documentation Index

Getting Started

• Configuration Guide — Complete guide for configuring Active Call with different calling scenarios

Core Concepts

• API Documentation — Full WebSocket API reference (commands, events, REST endpoints)
• Playbook Tutorial — Learn how to build stateful voice agents with Playbook
• Playbook Advanced Features — Advanced Playbook capabilities
• Template Syntax Comparison — Template syntax explanation and comparison

Architecture & Integration

• A Decoupled Architecture for AI Voice Agent — System architecture overview
• VoiceAgent Integration with Telephony Networks — Technical implementation details

Carrier Integration

• Twilio Elastic SIP Trunking — Connect active-call to Twilio (TLS + SRTP)
• Telnyx SIP Trunking — Connect active-call to Telnyx

Advanced Features

• Emotion Resonance — Real-time emotional response system
• HTTP Tool Integration — External API integration via function calling
• Intent Clarification — Advanced intent detection and clarification
• Voice Emotion — Voice emotion analysis and synthesis
• Rolling Summary — Conversation context rolling summary
• Context Repair — Context repair and completion
• Tool Instructions — Tool usage instructions
• Context Management — Conversation context management

🚀 Quick Start by Scenario

Scenario 1: Browser-based Voice Chat (WebRTC)

→ See Configuration Guide - WebRTC Scenario (Note: Requires HTTPS or 127.0.0.1)

Scenario 2: Telephony Integration (SIP)

→ See Configuration Guide - SIP Scenario

Scenario 3: Custom Application Integration (WebSocket)

→ See Configuration Guide - WebSocket Scenario

Scenario 4: Inbound Call Handling (SIP Registration)

→ See Configuration Guide - SIP Inbound

📖 Additional Resources

• Example Playbooks — Ready-to-use playbook examples
• Example Code — Sample implementations and utilities
• 中文文档 — Chinese Documentation