Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
VoIPBin is an opensource CPaaS platform. Star us on GitHub
VoIPBin Documentation
Logo
VoIPBin Documentation

Getting Started

  • Introduction
  • Quickstart
  • SDK(Software Development Kit)
  • RESTful API(Application Programming Interface)
  • Error Reason Codes

Core Concepts

  • Flow
    • Overview
    • Flow
    • Action
    • Tutorial basic
    • Tutorial scenario
    • Flow Execution Internals
    • Advanced Flow Patterns
    • Flow Debugging and Troubleshooting
    • Flow Best Practices
    • Overview
    • Activeflow
    • Tutorial
  • Variable
    • Overview
    • Using Variables in Flows
    • Capturing and Setting Dynamic Values
    • Integration with Applications
    • Best Practices and Considerations
    • Troubleshooting
    • Variable
  • Webhook
    • Overview
    • Webhook
    • Tutorial
  • Direct Hash
  • Common
    • Overview
    • Address

Voice & Real-Time

  • Call
    • Overview
    • Transfer
    • Transfer Struct
    • Groupcall
    • Struct Call
    • Struct Groupcall
    • Tutorial
    • Internal Call Sequences
    • Advanced Call Scenarios
    • Call Media and Codecs
    • Call Troubleshooting
  • Conference
    • Overview
    • Conference
    • conferencecall
    • Tutorial
  • Queue
    • Overview
    • Queue
    • Queuecall
    • Tutorial
  • Recording
    • Overview
    • Recording
    • Tutorial
  • Transcribe
    • Overview
    • Tutorial
    • Transcribe
    • Transcription
    • Speech Webhook Message
    • Transcript
  • Speaking
    • Overview
    • Speaking
    • Tutorial
  • Mediastream
    • Overview
    • Streaming
    • Tutorial

Messaging

  • Message
    • Overview
    • Message
    • Tutorial
  • Email
    • Overview
    • Email
    • Attachment
    • Tutorial
  • Talk
    • Overview
    • Talk
    • Message
    • Participant
    • Tutorial
  • Conversation
    • Overview
    • Conversation
    • Message
    • Conversation Account
    • Tutorial

AI & Automation

  • AI
    • Overview
    • How it works
    • Tool Functions
    • Using the AI
    • AI Talk
    • Using AI in Conversations (SMS / LINE)
    • AI Summary
    • External AI Agent Integration
    • Common Scenarios
    • Best Practices
    • Troubleshooting
    • Related Documentation
    • AI
    • Tool Functions
    • AIcall
    • AI Message
    • AI Summary
    • Tutorial
  • AI Voice Agent Integration
    • Overview
    • Tutorial
  • RAG
    • Overview
    • How it works
    • Use Cases
    • Troubleshooting
    • Related Documentation
    • RAG
    • Tutorial
  • Team
    • Overview
    • How it works
    • Runtime Behavior
    • Use Cases
    • Troubleshooting
    • Related Documentation
    • Team
    • Tutorial
  • Campaign
    • Overview
    • Campaign
    • Campaigncall
    • Tutorial
  • Outdial
    • Overview
    • Outdial
    • Outdialtarget
    • Tutorial
  • Outplan
    • Overview
    • Outplan
    • Tutorial

Identity & Contacts

  • Accesskey
    • Accesskey API Overview
    • Struct
    • Tutorial
  • Agent
    • Overview
    • Struct
    • Tutorial
  • Contact
    • Overview
    • Structures
    • Tutorial
  • Customer
    • Overview
    • Customer
    • Tutorial

Numbers & PSTN

  • Number
    • Overview
    • Number
    • Available Number
    • Tutorial
  • Provider
    • Overview
    • Provider
    • Tutorial
  • ProviderCall
    • Overview
    • ProviderCall
    • Tutorial
  • Route
    • Overview
    • Route
    • Tutorial
  • Extension
    • Overview
    • Extension
    • Tutorial
  • Trunk
    • Overview
    • Trunking
    • Domain name
    • Trunk
  • OutboundConfig
    • OutboundConfig Overview
    • OutboundConfig Tutorial
    • OutboundConfig Struct

Billing & Operations

  • Billing Account
    • Overview
    • Tutorial
    • Struct
    • Billing
  • Storage
    • Overview
    • Account
    • File
  • Tag
    • Overview
    • Tag
    • Tutorial

Architecture (Deep Dive)

  • Architecture
    • Overview
    • Backend Microservices
    • Inter-Service Communication
    • Data Architecture
    • Data Flow Diagrams
    • Real-Time Communication (RTC)
    • System Request Flows
    • Call Flow Sequences
    • Deployment Architecture
    • Security Architecture
  • Websocket
    • Overview
    • Structures
    • Tutorial

Self-Hosting

  • Self-Hosting

Reference

  • Glossary

Help & Support

  • Support
Back to top
View this page
Edit this page

RouteΒΆ

Define call routing rules that control how inbound and outbound calls are directed to their destinations.

API Reference: Route endpoints

  • Overview
    • How Routes Work
    • Route Failover
    • Dynamic Routing Decisions
    • Route Configuration
    • Common Scenarios
    • Best Practices
    • Troubleshooting
    • Related Documentation
  • Route
    • Route
  • Tutorial
    • Prerequisites
Next
Overview
Previous
Tutorial
Copyright © 2026, VoIPBIN
Made with Sphinx and @pradyunsg's Furo