VoIPBin Documentation
Welcome to VoIPBIN’s documentation!
Note
AI Implementation Hint
For API integration, start with the Quickstart guide. For the full machine-readable API spec, use GET https://api.voipbin.net/openapi.json (OpenAPI 3.0 JSON). For interactive API reference, see ReDoc.
Getting Started
Core Concepts
- Flow
- Overview
- How the flow works
- Understanding Flow Execution
- Action Execution Patterns
- Branching and Decision Making
- The Variable System
- Unified flow
- Non-linear action execution
- Flow fork
- Actions
- Flow execution
- Flow Lifecycle
- Flow Actions and Interrupt Actions
- The on complete flow id
- Execution limits
- Behavior on termination
- Example
- Error Handling in Flows
- Flow
- Action
- Action
- Type
- Agent Call
- AMD
- Answer
- Beep
- Branch
- Call
- Chatbot Talk
- Confbridge Join
- Condition Call Digits
- Condition Call Status
- Condition Datetime
- Condition Variable
- Conference Join
- Connect
- Conversation send
- Digits Receive
- Digits Send
- Echo
- External Media Start
- External Media Stop
- Fetch
- Fetch Flow
- Goto
- Hangup
- Hangup Relay
- Message send
- Play
- Queue Join
- Recording Start
- Recording Stop
- Sleep
- Stream Echo
- Talk
- Transcribe recording
- Transcribe start
- Transcribe stop
- Variable Set
- Webhook send
- Tutorial basic
- Tutorial scenario
- Flow Execution Internals
- Flow Manager Architecture
- Activeflow Lifecycle
- Execution Loop Detail
- Action Execution Results
- Inter-Service Communication During Execution
- Variable System Internals
- Flow Forking and Stack Management
- Event-Driven Execution
- Safety Mechanisms
- Concurrent Execution Handling
- RabbitMQ Message Patterns
- Database Schema
- Advanced Flow Patterns
- Multi-Level IVR with Sub-Menus
- Business Hours Routing
- Dynamic Flow with External Data
- AI-Powered Conversational Flow
- Call Recording with Consent
- Callback Request Pattern
- Survey After Call
- Failover and Redundancy
- Language Selection
- Parallel Call Attempts (Ring All)
- Real-Time Transcription with Keyword Detection
- Flow Debugging and Troubleshooting
- Flow Best Practices
- Overview
- Activeflow
- Variable
- Webhook
- Overview
- Webhook
- activeflow_created
- activeflow_updated
- activeflow_deleted
- call_created
- call_ringing
- call_answered
- call_updated
- call_hungup
- queue_created
- queue_updated
- queue_deleted
- queuecall_created
- queuecall_entering
- queuecall_kicking
- queuecall_serviced
- queuecall_done
- queuecall_abandoned
- agent_created
- agent_updated
- agent_deleted
- agent_status_updated
- Tutorial
- Common
Voice & Real-Time
- Call
- Overview
- Protocol
- PSTN/Phone Number Format
- Extension Number Format
- Call Lifecycle
- What Happens At Each Stage
- Understanding Hangup Reasons
- Media Control Operations
- Call Chaining
- Timestamps Explained
- Route Failover
- Incoming call
- Execution of Call Flow for incoming call
- Outgoing call
- Execution of Call Flow for outgoing call
- Error handling and Termination
- Call concept
- Related Documentation
- Transfer
- Groupcall
- Struct Call
- Struct Groupcall
- Tutorial
- Simple outbound call with TTS
- Simple outbound call with an existing flow
- Simple outbound call with media file play
- Simple outbound call with TTS and connect
- Simple outbound call with talk and digits_send
- Simple outbound call with Branch
- Get call list
- Get specific call
- Make a groupcall
- Troubleshooting
- Internal Call Sequences
- Advanced Call Scenarios
- Call Media and Codecs
- Call Troubleshooting
- Overview
- Conference
- Queue
- Overview
- The purpose of call queueing
- How Queue Routing Works
- Queuecall Lifecycle
- Agent Searching
- Agent Status Transitions
- Multi-Queue Agent Scenarios
- Flow Execution
- Timeout Handling
- Queue Metrics and Tracking
- When No Agents Are Available
- Conference Bridge Architecture
- Common Queue Scenarios
- Best Practices
- Related Documentation
- Queue
- Queuecall
- Tutorial
- Overview
- Recording
- Transcribe
- Overview
- Tutorial
- Start Transcription with Flow Action
- Start Transcription via API (Manual)
- Get Transcription Results
- Understanding Transcription Direction
- Real-Time Transcription with WebSocket
- Receive Transcripts via Webhook
- Supported Languages
- Common Use Cases
- Best Practices
- Transcription Lifecycle
- Troubleshooting
- Transcribe
- Transcription
- Speech Webhook Message
- Mediastream
Messaging
AI & Automation
- AI
- AI Voice Agent Integration
- Team
- Campaign
- Outdial
- Outplan
Resources & Management
- Number
- Agent
- Contact
- Overview
- Structures
- Tutorial
- Create a contact
- Get a list of contacts
- Get a specific contact
- Update a contact
- Delete a contact
- Lookup a contact by phone number
- Lookup a contact by email
- Add a phone number
- Update a phone number
- Remove a phone number
- Add an email address
- Update an email address
- Remove an email address
- Add a tag
- Remove a tag
- Customer
- Billing Account
- Storage
- Tag
- Provider
- Route
- Extension
- Trunk
Architecture (Deep Dive)
- Architecture
- Overview
- Backend Microservices
- Microservices Organization
- Service Characteristics
- API Gateway - bin-api-manager
- Special Service Architectures
- Service Independence
- Service Communication Patterns
- Service Discovery and Configuration
- Health Monitoring
- Error Handling and Resilience
- Deployment Architecture
- Monitoring and Observability
- Best Practices
- Inter-Service Communication
- Data Architecture
- Data Flow Diagrams
- Real-Time Communication (RTC)
- System Request Flows
- Request Flow Overview
- Flow 1: Create Call (Simple)
- Flow 2: Get Call with Caching
- Flow 3: Call with Event Broadcasting
- Flow 4: Complex Multi-Service Flow
- Flow 5: Real-Time Event Notification
- Flow 6: Error Handling Flow
- Performance Optimization
- Best Practices for Developers
- Debugging Request Flows
- Summary
- Call Flow Sequences
- Deployment Architecture
- Security Architecture
- Websocket
Reference
- Glossary
- Terms
- Accesskey
- Action
- Activeflow
- Agent
- Branch
- Call Leg
- Campaign
- Conference
- DID (Direct Inward Dialing)
- DTMF (Dual-Tone Multi-Frequency)
- E.164
- Flow
- Flow Fork
- Interrupt Action
- IVR (Interactive Voice Response)
- Media Server
- PSTN (Public Switched Telephone Network)
- Queue
- RTP (Real-time Transport Protocol)
- SIP (Session Initiation Protocol)
- SIP Trunk
- STT (Speech-to-Text)
- TTS (Text-to-Speech)
- Variable
- Webhook
- WebRTC (Web Real-Time Communication)
- Timestamp
- Requirement levels indicator
- Terms
Help & Support