API Version: Development

IPCortex.PBX

This is the top level container for PBX API methods and objects.

IPCortex.PBX.lines

An ordered list (Array) of Device objects relevant to the current logged in user.

IPCortex.PBX.owned

An ordered list (Array) of Device objects 'owned' by the current user. This list will be most relevant to click-to-dial applications.

IPCortex.PBX.queues

An ordered list (Array) of all Queue objects seen by the API.

IPCortex.PBX.devices

An ordered list (Array) of all Device objects seen by the API. This will include IAX2 trunks, SIP trunks, SIP handsets and Park orbits.

IPCortex.PBX.mailboxes

An ordered list (Array) of all Mailbox objects seen by the API.

IPCortex.PBX.extensions

An ordered list (Array) of all Extension objects seen by the API.

IPCortex.PBX.contacts

An ordered list (Array) of all Contact objects (Note, this is NOT the same as Address entries) seen by the API.

IPCortex.PBX.phones

An ordered list (Array) of all Phone objects recognised by the API. A Phone object collects Device objects (lines) into a handset.

IPCortex.PBX.rooms

An unordered list (Array) of all 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.

IPCortex.PBX.allRooms

An unordered list (Array) of all 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