Skip to content

Commit f7fa064

Browse files
committed
docs: add API documentation
1 parent 8a6fb5c commit f7fa064

5 files changed

Lines changed: 781 additions & 75 deletions

File tree

README.md

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,6 @@ RustPBX is a high-performance, secure software-defined PBX (Private Branch Excha
3030
- **Call Management**: List, monitor, and control active calls
3131
- **LLM Proxy**: Built-in proxy for AI language model services
3232

33-
## 📊 Architecture
34-
35-
### SIP Workflow
36-
![Sip](./docs/sip.png)
37-
38-
The SIP workflow demonstrates how external applications can initiate calls through RustPBX, leveraging the full SIP protocol stack for reliable voice communications.
39-
40-
### WebRTC Workflow
41-
![Webrtc](./docs/webrtc.png)
42-
43-
The WebRTC workflow shows how web applications can establish direct peer-to-peer connections via RustPBX, enabling modern browser-based voice applications.
44-
4533
## 🛠 Quick Start
4634

4735
### Prerequisites
@@ -180,30 +168,19 @@ Key configuration options in `config.toml`:
180168

181169
See `https://github.com/restsend/rustpbxgo`
182170

183-
## 🎯 Use Cases
171+
### API Documentation
184172

185-
### AI Customer Service
186-
Build intelligent customer service systems with automated speech recognition, natural language processing, and synthetic voice responses.
187-
188-
### Voice Assistant Applications
189-
Create voice-controlled applications with real-time speech processing and AI-powered conversation handling.
173+
#### SIP Workflow
174+
![Sip](./docs/sip.png)
190175

191-
### WebRTC Contact Centers
192-
Deploy browser-based contact center solutions with advanced call routing and AI assistance.
176+
The SIP workflow demonstrates how external applications can initiate calls through RustPBX, leveraging the full SIP protocol stack for reliable voice communications.
193177

194-
### Telephony Integration
195-
Integrate traditional SIP phones and systems with modern AI voice processing capabilities.
178+
#### WebRTC Workflow
179+
![Webrtc](./docs/webrtc.png)
196180

197-
## 📋 Core Components
181+
The WebRTC workflow shows how web applications can establish direct peer-to-peer connections via RustPBX, enabling modern browser-based voice applications.
198182

199-
- **SIP Proxy Server** (`proxy/`): Full-featured SIP server with modular architecture
200-
- **User Agent** (`useragent/`): SIP user agent for outbound calls
201-
- **Media Engine** (`media/`): Audio processing pipeline with codec support
202-
- **Voice Synthesis** (`synthesis/`): TTS engines for multiple providers
203-
- **Speech Recognition** (`transcription/`): ASR engines with streaming support
204-
- **LLM Integration** (`llm/`): Language model proxy and integration
205-
- **Call Recording** (`callrecord/`): Call recording and storage management
206-
- **RESTful API** (`handler/`): HTTP API and WebSocket endpoints
183+
For detailed API documentation, see [API Documentation](./api.md).
207184

208185
## 🔧 Configuration Features
209186

docs/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,8 @@ AppServer invite a call via RustPBX
99

1010
![WebRTC](./webrtc.png)
1111

12-
App make a webrtc connection via RustPBX
12+
App make a webrtc connection via RustPBX
13+
14+
# API Documentation
15+
16+
For detailed API documentation, see [API Documentation](./api.md).

0 commit comments

Comments
 (0)