This module contains the 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.
Retrieve line information from the server.
Call this function to get the current status of a line.
Gets the current state of a line and attach for call and change notifies on this line.
Stops the call and state change events on a line.
Set or remove "Do not Disturb" feature on the a line.
Changes the state of the "Remote Office" feature on a line.
- PRIVATE - Set a password for a line.
- PRIVATE - Find lines in the server for a supercanonic number.
Initiates a new call on a line.
- PRIVATE - not implemented
Drop a call identified by its connection identifier.
Drop the cative call on a line.
Accept a call on a line.
Redirect an incoming call to another line.
Pickup a ringing call from another line on an own line.
Start recording of a call.
Stop recording of a call.
Add some data to the call which will be transferred to other clients.
Merge two calls on a line together.
Swap puts the active call on hold and retrieves the hold call
Set the call on hold, so another another call in the same line will be possible to make.
Set simple call forwards.
Remove a forward from a line.
Dial DTMF tones on an active call.
Set a automatic call back if the call was not accepted or busy.
Initiate a conference call with two already existing calls of a line.
- PRIVATE - Operation to initiate a conference with "american conference model.
- PRIVATE - Allows to set the active address on a phone line
- PRIVATE - (Re-)register a new line to the virtual line subsystem of the server.