Skip to content

Vinix Dev Reference Maintenance

Type to start searching

Vinix Dev Reference

Introduction
Voice APIs
Voice APIs
- API Basics
  API Basics
- Authentication
  Authentication
- Account Management
  Account Management
- Billing
  Billing
  - Call Detail Records
  - Ledgers
- Media Management
  Media Management
  - Media
- Misc
  Misc
  - Comments
  - Lists
- PBX Features
  PBX Features
  - Blacklists
  - Callflows
  - Click To Call
  - Configuring Conferences
  - Contact list
  - Devices
  - Dialplans
  - Directories
  - Faxboxes
  - Faxes
  - Groups
  - Hotdesks
  - Menus
  - Metaflows
  - Mms
  - Phone Numbers API
  - Quickcall
  - Call Recordings
  - Sms
  - Temporal Rules
  - Temporal Rules Sets
  - Users
  - Voicemail
- Call Queues
  Call Queues
  - Agents
  - Queues
- Calling Cards
  Calling Cards
  - Cccps
- Status
  Status
  - About
  - Acls
  - Call Channels
  - Parked calls
  - Presence
  - Registrations
- Storage
  Storage
  - Storage
  - Backends
    Backends
    
    HTTP
Integrations
Integrations
- Pivot
  Pivot
  - Intro
  - API
  - The Request
  - The Response
    The Response
    
    Kazoo JSON
    
    Bridging
    
    Collect
    
    Conferencing
    
    DTMF
    
    Hang Ups
    
    Play
    
    Presence
    
    Recording
    
    Say
    
    TwiML Format
  - Functions (Serverless)
  - Presentations
    Presentations
    
    Infrastructure by Pastie.org
    
    Pivot
  - Known_Issues
    Known_Issues
    
    Issues
- Websockets
  Websockets
  - Blackhole - Real-time HTTP Websocket Events
  - Ping
  - Bindings
  - API
  - HAProxy configuration
  - Troubleshooting
  - Maintenance
  - Presentations
    Presentations
    
    Webhooks and Websockets
- Webhooks
  Webhooks
  - Webhooks *Event driven HTTP*
  - Administration
  - Disabler
  - API
  - Webhook Events
    Webhook Events
    
    Channel Event Webhooks
    
    Channel Parking Event Webhook
    
    Notification Event Webhooks
    
    Object Change Event Webhook
Internationalization
Internationalization
- Phone Numbers
  Phone Numbers
  - Overview
  - Example Number Manager Configurations
    Example Number Manager Configurations
    
    European Union
    
    Indonesia
  - Example Dialplan Configurations
    Example Dialplan Configurations
    
    Ireland
    
    Netherlands - Amsterdam
    
    Netherlands - Rotterdam
- System Prompts
Applications
Applications
- Callflows
  Callflows
  - Callflow PBX Functionality
  - Maintenance
  - Endpoints
    Endpoints
    
    Device
    
    User
    
    Group
    
    Ring Group
    
    Ring Group Toggle
    
    Page Group
    
    Dynamic lookup
  - Call Parking
  - Call Recording
    Call Recording
    
    Record Call
    
    Record Caller
  - Call Priorities
  - Custom SIP Headers
  - Incoming Fax Detection
  - Change Language
  - Caller ID
    Caller ID
    
    Dynamic Caller ID
    
    Lookup Caller ID
    
    Prepend Caller ID
    
    Privacy
    
    Match CID
    
    Set CID
    
    Check CID
  - Playing Media
    Playing Media
    
    Media/URL
    
    Audio Macros
    
    Text-to-speech (TTS)
  - Conference
  - Temporal Routes (Time of Day)
  - EDR Event
  - Branch on object setting
  - Preflows
  - Resources
  - Manual Presence
  - Directory Search
  - Eavesdrop
    Eavesdrop
    
    Action
    
    Feature Code
  - Do Not Disturb (DND)
  - Missed Call Alert
  - Setup Call Waiting
  - Voicemail
  - Hotdesk
  - Pivot
  - Functions
  - Group Pickup
    Group Pickup
    
    Action
    
    Feature Code
  - Faxbox
  - Callflow Branching
  - DTMF
    DTMF
    
    Collect DTMF
    
    Send DTMF
    
    Flush DTMF
  - Intercom
  - Set Call Variable(s)
    Set Call Variable(s)
    
    Set variable
    
    Set variables
  - Set Alert-Info
  - Intercept
    Intercept
    
    Action
    
    Feature Code
  - SIP Response
  - Variable Branch
  - Hangup
  - Answer
  - Noop
  - Wait for Hangup
  - Call Forwarding
  - Receive Fax
  - Dead Air
  - Menu (IVR)
  - Custom Webhook
  - Channel Move
  - Transfer
  - Sleep
  - After Bridge
  - Set
  - Branch BNumber
  - Camping
  - Custom notifications
  - Deprecated
    Deprecated
    
    Offnet
  - Skeleton Callflow Action
- CDR
  CDR
  - CDR - *Call Detail Records*
- Conference
  Conference
  - Conference App
  - Maintenance
- Crossbar
  Crossbar
  - Index
  - Skeleton Endpoint
- Fax
  Fax
- Konami
  Konami
  - Konami *In-Call Feature Codes*
  - Audio level
  - Break
  - Callflow
  - Hangup
  - Hold
  - Hold control
  - Intercept
  - Move
  - Play
  - Record call
  - Resume
  - Say
  - Sound touch
  - In-Call Attended Transfer
  - Tts
  - Maintenance
- Media Manager
  Media Manager
  - Media Manager
  - Maintenance
- Milliwatt
  Milliwatt
  - Milliwatt *Echo and tone for monitoring*
- Notify
  Notify
  - Notify
  - Maintenance
- Registrar
  Registrar
  - Registrar *The star registration application*
  - Maintenance Maintenance
    Table of contents
    
    SUP-able functions
- Reorder
  Reorder
  - Reorder *Misconfigured Number Replies*
- Stats
  Stats
  - Index
- Tasks
  Tasks
- Trunkstore
  Trunkstore
  - Trunkstore *Lightweight trunking services*
  - Maintenance

Table of contents

SUP-able functions

Maintenance

SUP-able functions

Function	Arguments	Description
`device_by_ip/1`	`(IP)`
`register_views/0`
`set_listeners/1`	`(Count)`

Previous Registrar *The star registration application*

Next Reorder *Misconfigured Number Replies*

Copyright © 2014 - 2020 Vinix, LLC

powered by MkDocs and Material for MkDocs