This module contains structures and operations for CTI (remote call control) on TAPI or Bluetooth phone lines in the server.
A client program has access to all lines owned by the logged in user and to additional lines it has dedicated access.
It is possible to monitor all actions on these lines and to call operations to initiate new calls, set forwards, change states and so on.
In order to use the operations described in this document you have to make sure:
Additional prerequisites for a operation on the PBX and or the TAPI driver may be necessary.
Description of the Line-Call-Model
The remote call control and monitoring of the server is based on a line-call-model. This means, that users, lines and calls are organized in a tree like hierarchy.
Each node in this tree contains configuration data and dynamic data, which can be accessed and observed.
The Nodes are:
Some operations return an empty result object if they are executed successfully. So in this cases, the business logic should wait for result/error before do additional actions.
Phone numbers are normally used and provided in a so called supercanonic notation containing a full qualified number including country, city, main and extension number: +49815136856177
For operations affecting multiple calls be sure to check that all calls affected have the corresponding feature set. To merge two calls both calls have to have the feature eCFEATUREMERGECALLS set.
Example: Monitoring lines
Example: Call data transfer
Phone number formats
The whole system tries to use supercanonic numbers (+country city main and extension number / +49815136856177) whereever possible.
As long as the number is used in supercanonic notation all components can format the number as required (for dialing, for display, etc.)
You likely wonÂ´t need to format numbers as the system always provides supercanonic numbers.
Event from the server if a line changed its status or has been added or removed.
Event from the server if a line changed its DnD status.
Event from the server if a line changed its remote office state.
Event from the server that a monitoring point was closed due to a configuration change
Event from the server that a monitoring point has changed position from the configurative view
Event from the server if a line changed its forwardings.
Event from the server if a call changed its state.
Event from the server with the result of an asynchronous make call operation on the server.
Event from the server if there is a conference established on a line.
Event from the server if a conference is closed/destroyed.
Event from the server when a new participant was added to a conference.
Event from the server when a conference participant was removed.
Event from the server when call features have changed.
Event from the server when the project settings or the location of a line has changed.