Welcome to voipbin’s documentation!

• Glossary
  • Terms
  • Requirement levels indicator
• 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
    • Domain
    • Queue
    • Webhook
• API
• Flow
  • Overview
    • How the flow works
    • Non-linear action execution
    • Flow fork
    • Actions
  • 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
    • Confbridge Join
      • Parameters
    • Condition Call Digits
      • Parameters
      • Example
    • Condition Call Status
      • 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
    • 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
      • 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
• Call
  • Overview
    • Protocol
    • PSTN/Phone number format
    • Extension number format
    • Incoming call
    • Outgoing call
  • Call
    • Call
      • Example
    • Type
    • Status
    • Direction
    • Hangup by
    • Hangup reason
  • 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
• Message
  • Overview
  • Message
    • Message
    • Target
    • Type
    • Direction
  • Tutorial
    • Send a message
    • Get list of messages
• Agent
  • Overview
    • Call to agent
  • Struct
    • Agent
    • Ring method
    • Status
  • Tutorial
    • Create a new agent
    • Update agent’s status
    • Update agent’s addresses
• Conference
  • Overview
  • Conference
    • Conference
    • Type
    • Status
  • Tutorial
    • Install channel: line
      • Example
    • Get list of conferences
      • Example
    • Get detail of conference
      • Example
    • Create a new conference
      • Example
• Conversation
  • Overview
    • Unified conversation
  • 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
• Domain
  • Overview
  • Domain
    • Domain
  • Tutorial
    • Get list of domains
    • Get detail of specified domain
    • Create a domain
    • Update the domain
    • Delete the domain
• Extension
  • Overview
  • 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
    • Waiting actions
    • Agent searching
  • Queue
    • Queue
    • Routing Method
  • Queuecall
    • Queuecall
      • Example
    • Reference type
    • Status
  • Tutorial
    • Create a new queue
    • Get list of queues
• Recording
  • Overview
  • Recording
    • Recording
    • Type
    • Status
    • Format
  • Tutorial
    • Get list of recordings
    • Get detail of recording
    • Simple recordingfile download
• Tag
  • Overview
  • 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
  • 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
    • Types 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
• Variable
  • Overview
    • Variable use
  • Variable
    • Call
      • Source address
      • Destination address
      • Others
    • Queue
      • Queue info
      • Queuecall info
• Common
  • Overview
  • Address
    • Address
    • Type

Indices and tables

• Index

• Module Index

• Search Page