IPCortex.PBX
This is the top level container for PBX API methods and objects.
An ordered list (Array) of
Device objects relevant to the current logged in user.
An ordered list (Array) of
Device objects 'owned' by the current user. This list will be most relevant to click-to-dial applications.
An ordered list (Array) of all
Queue objects seen by the API.
An ordered list (Array) of all
Device objects seen by the API. This will include IAX2 trunks, SIP trunks, SIP handsets and Park orbits.
An ordered list (Array) of all
Mailbox objects seen by the API.
An ordered list (Array) of all
Extension objects seen by the API.
An ordered list (Array) of all
Contact objects (Note, this is
NOT the same as
Address entries) seen by the API.
An ordered list (Array) of all
Phone objects recognised by the API. A Phone object collects
Device objects (lines) into a handset.
An unordered list (Array) of all live
Room objects recognised by the API. This prepresents all rooms open with the currently logged in user. There is a pseudo 'online' room created by the system, and this is intentionally excluded from the list.
An unordered list (Array) of all live
Room objects recognised by the API. If the logged in user has the rights as an API chat admin, then this list will include additionally visible rooms, otherwise it will be the same as
IPCortex.PBX.rooms
A Promise
resolving to an Object
containing a key-value list of roomID and roomName data for all archive
multi-rooms accessible which the current user is-or-has participated in. This will include live archive multi-rooms, and also and previously joined but left archive multi-rooms. These rooms can then be reconnected to using IPCortex.PBX.joinRoom
A Promise
resolving to an Object
containing a key-value list of roomID and roomName data for all public
chat rooms accessible in the current user's company. Joining a public room can be done by using either IPCortex.PBX.joinRoom
or by trying to create a public room with the identical name.
NULL
or an Object
. At present the object contains a single attribute {system: true}
. It does not represent whether any specific company or extension will be recorded, just the system licence. 6.4.21+. In future it is intended that further call recording data will be represented.