Welcome to voipbin’s documentation!

• Introduction
  • Channels
    • Programmable voice
      • Account Notifications
      • Call Tracking
      • Programmable calling
      • Global conferencing
      • Interactive voice response(IVR)
    • Messaging
      • Programmable Messaging API
      • Conversations API
    • Video
  • Applications
    • Flow
    • Agent
    • Campaign
    • Conference
    • Conversation
    • Trunk
    • Queue
    • Webhook
• Quickstart
  • Signup
    • Sign up to VoIPBin
    • What Happens Next
  • Authentication
    • Generate Token
    • Generate Accesskey
    • Using Your Token or Accesskey
    • Example to retrieve a list of access keys
  • Call
    • Make your first voice call with manual actions
    • Make your first voice call with existed flow
  • Queue
    • Create your first queue
• Common
  • Overview
  • Address
    • Address
      • Example
    • Type
• RESTful API(Application Programming Interface)
• SDK(Software Development Kit)
  • Ovewview
    • Acesskey
    • Support Languages
• Architecture
  • Overview
    • Core Components
    • Communication Channels
    • Integration Services
    • Key Architectural Considerations
  • RTC(Real-Time Communication)
    • VoIP
    • Kamailio
    • Asterisk
    • RTPEngine
    • Conference
      • Conference Flow
      • 1:1 Calls as a Special Case of Conferencing
    • SIP Session Recovery
      • How It Works
      • Detailed Steps
      • Asterisk Patch for Recovery
• Accesskey
  • Accesskey API Overview
    • API Usage
      • Example Request
      • Description of Parameters
    • Authentication
    • Lifecycles and Expiry
    • Notes
  • Struct
    • Accesskey
  • Tutorial
    • Create, Retrieve, and Manage Accesskeys
• Flow
  • Overview
    • How the flow works
    • Unified flow
    • Non-linear action execution
    • Flow fork
    • Actions
    • Flow execution
      • Incoming/Outgoing Calls
      • Received Messages
      • Outbound Campaigns
      • API
    • Flow Actions and Interrupt Actions
      • Standard Flow Actions
      • Interrupt Actions
      • How Interrupt Actions Work
      • Integration and Best Practices
  • Flow
    • Flow
    • Type
  • Action
    • Action
    • Type
    • Agent Call
      • Parameters
      • Example
    • AMD
      • Parameters
      • Machine handle
      • Example
    • Answer
      • Parameters
      • Example
    • Beep
      • Parameters
      • Example
    • Branch
      • Parameters
      • Example
    • Call
      • Parameters
      • Example
    • Chatbot Talk
      • Parameters
    • Confbridge Join
      • Parameters
    • Condition Call Digits
      • Parameters
      • Example
    • Condition Call Status
      • Parameters
      • Example
    • Condition Datetime
      • Parameters
      • Example
    • Condition Variable
      • Parameters
      • Example
    • Conference Join
      • Parameters
      • Example
    • Connect
      • Parameters
      • Example
    • Conversation send
      • Parameters
      • Example
    • Digits Receive
      • Parameters
      • Example
    • Digits Send
      • Parameters
      • Example
    • Echo
      • Parameters
      • Example
    • External Media Start
      • Parameters
    • External Media Stop
      • Parameters
    • Fetch
      • Parameters
      • Example
    • Fetch Flow
      • Parameters
      • Example
    • Goto
      • Parameters
      • Example
    • Hangup
      • Parameters
      • Example
    • Hangup Relay
      • Parameters
      • Example
    • Message send
      • Parameters
    • Play
      • Parameters
      • Example
    • Queue Join
      • Parameters
      • Example
    • Recording Start
      • Parameters
      • Example
    • Recording Stop
      • Parameters
      • Example
    • Sleep
      • Parameters
    • Stream Echo
      • Parameters
      • Example
    • Talk
      • Parameters
      • Digits handle
      • Example
    • Transcribe recording
      • Parameters
      • Example
    • Transcribe start
      • Parameters
      • Example
    • Transcribe stop
      • Parameters
      • Example
    • Variable Set
      • Parameters
      • Example
    • Webhook send
      • Parameters
      • Example
  • Actvieflow
    • Activeflow
      • Example
    • Reference type
  • Tutorial basic
    • Get list of flows
    • Get detail of specified flow
    • Create a flow
    • Update the flow
    • Delete the flow
  • Tutorial scenario
    • Simple voicemail
    • Simple branch
    • Simple message send
    • Simple message send and make a new outbound call
• Activeflow
  • Overview
    • Execution
    • Status and Control interface
    • Activeflow Lifecycle
    • Executed Actions
  • Activeflow
    • Activeflow
      • Example
    • Status
    • Reference type
  • Tutorial
    • Get activeflow list
    • Stop activeflow
• Call
  • Overview
    • Protocol
    • PSTN/Phone Number Format
    • Extension Number Format
    • Incoming call
    • Execution of Call Flow for incoming call
    • Outgoing call
    • Execution of Call Flow for outgoing call
    • Error handling and Termination
    • Call concept
      • Comparison: Traditional Call Concept vs Voipbin Call Concept
  • Transfer
    • Blind Transfer
    • Attended Transfer
  • Groupcall
    • Ringall
    • Linear
    • Nested groupcall
  • Struct Call
    • Call
      • Example
    • Type
    • Status
    • Direction
    • Hangup by
    • Hangup reason
  • Struct Groupcall
    • Groupcall
      • Example
    • Ring method
    • Answer method
  • Tutorial
    • Simple outbound call with TTS
    • 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
• Message
  • Overview
  • Message
    • Message
    • Target
    • Type
    • Direction
  • Tutorial
    • Send a message
    • Get list of messages
• Email
  • Overview
  • Email and Mailbox
  • Email Message
  • Email
    • Email
      • Example
    • Status
  • Attachment
    • Attachment
    • Type
  • Tutorial
    • Get list of emails
      • Example
• Agent
  • Overview
    • Call to agent
    • Permission
  • Struct
    • Agent
    • Ring method
    • Status
    • Permissio
  • Tutorial
    • Create a new agent
    • Update agent’s status
    • Update agent’s addresses
• Conference
  • Overview
  • Conference
    • Conference
      • Example
    • Type
    • Status
  • conferencecall
    • Conferencecall
      • Example
    • Reference type
    • Status
  • Tutorial
    • Install channel: line
      • Example
    • Get list of conferences
      • Example
    • Get detail of conference
      • Example
    • Create a new conference
      • Example
    • Kick the conferencecall from the conference
      • Example
• Mediastream
  • Overview
    • Available resources
    • Bi-directional streaming
    • Uni-directional streaming
    • Encapsulation Types
    • Codec
• Conversation
  • Overview
    • Unified conversation
    • Seperated conversation room
  • Conversation
    • Conversation
      • Example
    • Reference type
  • Message
    • Message
      • Example
    • Direction
  • Tutorial
    • Setup the conversation
    • Get list of conversations
      • Example
    • Get detail of conversation
      • Example
    • Send a message to the conversation
      • Example
    • Get list of conversation messages
      • Example
• Extension
  • Overview
    • Registration address
    • Registration
    • 407 Proxy Authentication Required
  • Extension
    • Extension
  • Tutorial
    • Get list of extensions
    • Get detail of specified extension
    • Create a extension
    • Update the extension
    • Delete the extension
• Number
  • Overview
    • Flow execution
  • Number
    • Number
      • example
    • Status
  • Tutorial
    • Get list of available-numbers
    • Get list of numbers
    • Get detail of number
    • Delete number
    • Create number
• Queue
  • Overview
    • The purpose of call queueing
    • Flow Execution
    • Agent searching
  • Queue
    • Queue
    • Routing Method
  • Queuecall
    • Queuecall
      • Example
    • Reference type
    • Status
  • Tutorial
    • Create a new queue
    • Get list of queues
• Recording
  • Overview
    • List Call Recording Metadata
    • Retrieve Detailed Information with the Single Call Recording Metadata API
    • Delete Call Recordings
    • Download Call Recording Audio Files
    • Asynchronously Export Call Recordings in Bulk
  • Recording
    • Recording
    • Type
    • Status
    • Format
  • Tutorial
    • Get list of recordings
    • Get detail of recording
    • Simple recordingfile download
• Tag
  • Overview
    • Key Features and Use Cases
  • Tag
    • Tag
  • Tutorial
    • Create a new tag
• Campaign
  • Overview
    • Resource
    • 5W1H
    • Dialing strategy
  • Campaign
    • Campaign
      • Example
    • Type
    • Status
    • Service level
    • End handle
  • Campaigncall
    • Campaigncall
      • Example
    • Reference type
    • Status
    • Result
  • Tutorial
    • Get list of campaigns
      • Example
    • Get detail of campaign
      • Example
    • Create a new campaign
      • Example
• Outdial
  • Overview
    • Outdial
    • Outdial target
  • Outdial
    • Outdial
      • example
  • Outdialtarget
    • Outdialtarget
      • Example
    • Status
  • Tutorial
    • Get list of outdials
    • Get a detail of outdial
    • Create a new outdial
    • Create a new outdialtarget
    • Get list of outdialtargets
• Outplan
  • Overview
    • Key features
  • Outplan
    • Outplan
      • example
    • Try interval
    • Max try count
  • Tutorial
    • Get list of outplans
    • Get detail of outplan
    • Create a new outplan
    • Update outplan’s dial info
    • Delete outplan
    • Update outplan’s basic info
• Webhook
  • Overview
    • Notification Mechanism
    • Types of Webhooks
    • Custom Endpoints
    • Benefits of Webhooks
  • Webhook
    • activeflow_created
      • Example
    • activeflow_updated
      • Example
    • activeflow_deleted
      • Example
    • call_created
      • Example
    • call_ringing
      • Example
    • call_answered
      • Example
    • call_updated
      • Example
    • call_hungup
      • Example
    • queue_created
    • queue_updated
    • queue_deleted
    • queuecall_created
      • Example
    • queuecall_entering
      • Example
    • queuecall_kicking
      • Example
    • queuecall_serviced
      • Example
    • queuecall_done
      • Example
    • queuecall_abandoned
    • agent_created
    • agent_updated
    • agent_deleted
    • agent_status_updated
      • Example
• Customer
  • Overview
  • Customer
    • Customer
      • Example
  • Tutorial
    • Get list of customers
    • Get detail of customer
    • Create a new customer
    • Delete customer
• Chat
  • Overview
    • Chat and Chatroom
    • Chatmessage and Charoommessage
  • Chat
    • Chat
      • Example
    • Type
  • Chatroom
    • Chatroom
      • Example
    • Type
  • Chatmessage
    • Chatmessage
      • Example
    • Type
  • Chatroommessage
    • Chatroommessage
      • Example
    • Type
  • Tutorial
    • Get list of chats
      • Example
    • Get detail of chat
      • Example
    • Create a new chat
      • Example
    • Get list of chatrooms
      • Example
    • Send chatmessage
      • Example
• AI
  • Overview
  • How it works
    • Action component
    • TTS/STT + AI Engine
    • Voice Detection and Play Interruption:
    • Context Retention
    • Multilingual support
    • External AI Agent Integration
    • MCP Server
  • Using the AI
    • Initial Prompt
      • Example Prompt:
  • AI Talk
    • Key Features
    • Built-in ElevenLabs Voice IDs
    • Other ElevenLabs Voice ID Options
  • AI Summary
    • Supported Resources
    • Choosing Between Real-time and Non-Real-time Summaries
    • AI Summary Behavior
    • Ensuring Full Coverage
  • AI
    • AI
      • Example
    • Type
• Provider
  • Overview
  • Provider
    • Provider
      • example
    • Type
  • Tutorial
    • Get list of providers
    • Get detail of provider
    • Create a new provider
    • Update provider
    • Delete provider
• Route
  • Overview
    • Route Failover
    • Dynamic Routing Decisions
  • Route
    • Route
      • example
  • Tutorial
    • Get list of routes
    • Get detail of route
    • Create a new route
    • Update route
    • Delete route
• Variable
  • Overview
  • Using Variables in Flows
  • Capturing and Setting Dynamic Values
    • Automatically by the system
    • By actions within the flow
    • Manually via variable_set action
  • Integration with Applications
  • Best Practices and Considerations
  • Variable
    • Activeflow
    • Call
      • Source address
      • Destination address
      • Others
    • Message
      • Source address
      • Target destination address
      • Message
    • Queue
      • Queue info
      • Queuecall info
    • AI Call
    • AI Summary
    • Recording
    • Transcribe
• Websocket
  • Overview
    • Websocket endpoint
    • Topic Subscription/Unsubscription
      • Customer Level Topics
      • Agent Level Topics
    • Pattern Matching Subscription
    • Real-Time Event Updates
    • Benefits of WebSocket
  • Struct
    • Subscribe
      • Example
    • Unsubscribe
      • Example
• Trunk
  • Overview
  • Trunking
    • Server address
    • Authentication
      • Basic authentication
    • Call handle
      • Early media handle
      • Realy hangup cause
  • Domain name
• Billing Account
  • Overview
    • Balance add
    • Rate
  • Struct
    • Billing account
• Storage
  • Overview
    • File Management
    • Storage Account Management
    • Quota
  • Account
    • Account
      • example
  • File
    • File
      • example
    • Reference Type
• Transcribe
  • Overview
    • Real-Time capability
    • Transcription
    • Enable transcribe
      • Automatic Trigger in the Flow
      • Interrupt Trigger(Manual API Request)
    • Supported Languages
  • Transcribe
    • Transcribe
      • example
    • reference_type
    • status
  • Transcription
    • Transcription
      • example
    • direction
• Glossary
  • Terms
  • Requirement levels indicator

Indices and tables

• Index

• Module Index

• Search Page