You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-31Lines changed: 8 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,18 +30,6 @@ RustPBX is a high-performance, secure software-defined PBX (Private Branch Excha
30
30
-**Call Management**: List, monitor, and control active calls
31
31
-**LLM Proxy**: Built-in proxy for AI language model services
32
32
33
-
## 📊 Architecture
34
-
35
-
### SIP Workflow
36
-

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
-

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
-
45
33
## 🛠 Quick Start
46
34
47
35
### Prerequisites
@@ -180,30 +168,19 @@ Key configuration options in `config.toml`:
180
168
181
169
See `https://github.com/restsend/rustpbxgo`
182
170
183
-
##🎯 Use Cases
171
+
### API Documentation
184
172
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
+

190
175
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.
193
177
194
-
###Telephony Integration
195
-
Integrate traditional SIP phones and systems with modern AI voice processing capabilities.
178
+
#### WebRTC Workflow
179
+

196
180
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.
198
182
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).
0 commit comments