Getting Started
Reference
Samples
Resources
API Version: 6.3.20
Getting Started
Javascript API
Loading the API
Authentication
Fetching PBX data
Lite Javascript API
REST API
Request format
REST authentication
Reference
Classes
IPCortex.Types.Address
IPCortex.Types.Contact
IPCortex.Types.Extension
IPCortex.Types.Phone
IPCortex.Types.Device
IPCortex.Types.Call
IPCortex.Types.History
IPCortex.Types.Mailbox
IPCortex.Types.Queue
IPCortex.Types.Room
IPCortex.Types.Av
IPCortex.Types.File
IPCortex.Types.Cmd
Methods
Authentication Methods
IPCortex.PBX.Auth.login
IPCortex.PBX.Auth.logout
IPCortex.PBX.Auth.exit
IPCortex.PBX.Auth.getSubID
IPCortex.PBX.Auth.setHost
IPCortex.PBX.Auth.setWSHost
IPCortex.PBX.Auth.rtcReset
IPCortex.PBX.Auth.selCompany
PBX Data methods
IPCortex.PBX.startFeed
IPCortex.PBX.pauseFeed
IPCortex.PBX.stopPoll
IPCortex.PBX.stopFeed
IPCortex.PBX.setIdle
IPCortex.PBX.fetchData
IPCortex.PBX.enableTags
IPCortex.PBX.disableTags
IPCortex.PBX.restRequest
IPCortex.PBX.getLines
IPCortex.PBX.getAddressbook
IPCortex.PBX.getTimeDelta
IPCortex.PBX.setIce
PBX Chat methods
IPCortex.PBX.enableChat
IPCortex.PBX.disableChat
IPCortex.PBX.setStatus
IPCortex.PBX.chatInvite
IPCortex.PBX.createRoom
IPCortex.PBX.enableFeature
IPCortex.PBX.disableFeature
PBX History methods
IPCortex.PBX.enableHistory
IPCortex.PBX.disableHistory
IPCortex.PBX.saveHistory
Error Helper
IPCortex.PBX.Auth.errtype
IPCortex.PBX.Auth.errstr
IPCortex.PBX.Auth.Error
Add-on features
Feature: AV
Feature: File
Feature: Command
Properties
IPCortex
IPCortex.name
IPCortex.version
IPCortex.PBX
IPCortex.PBX.lines
IPCortex.PBX.owned
IPCortex.PBX.queues
IPCortex.PBX.devices
IPCortex.PBX.mailboxes
IPCortex.PBX.extensions
IPCortex.PBX.contacts
IPCortex.PBX.phones
IPCortex.PBX.rooms
IPCortex.PBX.allRooms
IPCortex.PBX.Auth
IPCortex.PBX.Auth.id
IPCortex.PBX.Auth.uname
IPCortex.PBX.Auth.name
IPCortex.PBX.Auth.company
REST API
Requests
Requests
Authentication
Authenticating
Authentication Tokens
Users
User
External User
User Links
Dialplan
Company
DDI numbers
Call Barring
Extensions
Handsets
Nightmode
Opt in-out
Call-data
Billable others
Call Reports
Call Data
Recording
Recording
Handsets
Handset Provisioning
Call-Control
Call control
keevio
keevio commands
Permissions
command 'dial'
command 'create'
command 'start'
Samples
Contacts
Accessing Contacts
Addressbook
Calling
Dial Number
Call handling
Chat
Chat Echo Bot
Chat Echo Bot in Node.js
Chat Client
Video
Video Echo Bot
Video Client
Resources
NodeJS
simpleCTI
MasqueradeJS
React / Redux
Reference
Reference
Select a reference subsection
Class
Description
Classes
JS Classes Reference section
Methods
JS Methods Reference section
Properties
JS Properties Reference section
REST API
REST API Reference section
