Phone
Requires ext.adapter v0.1.0 or later and adapter v0.1.0 or later. Full support requires ext.adapter v0.1.2 or later and adapter v0.1.0 or later.
Description
Marks an Object as a communication device capable of call-related Operations (e.g., dial, accept, …).
Operations
Dial
Operation to start a new call by dialing a phone number.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| targetnum | string | Call target number |
Call ≥ext.adapter 0.1.2
Operation to start a new call by directly calling a target device.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| url | string | Object URL of target device. |
Accept
Operation to accept a call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfo | callinfo | Identifies the call to accept |
Hangup
Operation to hang up a call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfo | callinfo | Identifies the call to hang up |
Hold
Operation to hold a call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfo | callinfo | Identifies the call to hold |
Resume
Operation to resume a previously held call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfo | callinfo | Identifies the call to resume |
BlindTransfer
Operation to transfer a connected or incoming call to another call number.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfo | callinfo | Identifies the call to blind transfer | |
| targetnum | string | Number to transfer to |
Transfer
Operation to transfer a call participant to a participant of another call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfos | callinfo[] | CallInfos of all calls to be merged |
Conference
Operation to start a conference with all given calls.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfos | callinfo[] | CallInfos of all calls to create a conference with. The maximum number of participants depends on the connected phone. |
SplitConference
Operation to split a running conference in single calls.
Park
Operation to park the connected call to a given park position.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| callinfo | callinfo | CallInfo of call to be parked | |
| pos | string | Parking position |
Take
Operation to take a parked call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| pos | string | Parking position |
Key
Operation to send a key on the currently connected call.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| key | string | Keypad key |
Objects
CallInfo
Generated by the application and passed as callinfo or callinfos parameter to identify the call(s) which the Operation is supposed to target.
The properties Pos and TotalPos are indices in an imaginary list of calls, starting at 1 and sorted by age; i.e. 1 is the oldest call, 2 is the second oldest and so on. A value of 0 is invalid. The list is deduced as follows:
- Collect a list of all local calls known to the application, ignoring any parked calls.
- Filter the list to only inlcude calls of the device (read: Object) the Operation is targeting.
- Within that list,
Totalposis the index of the intended call. - Filter the list to only include calls with the same type as the intended call.
- Within that list,
Posis the index of the intended call.
Example, assuming only one local device for simplicity: Three calls are made in succession. One going in followed by another going out and a last one going in. Their CallInfos would look like this:
First call: Type = In, Pos = 1, TotalPos = 1
Second call: Type = Out, Pos = 1, TotalPos = 2
Third call: Type = In, Pos = 2, TotalPos = 3
| Property | Type | Description |
|---|---|---|
| Type | string | Enum: In, Out |
| Pos | int | Call number relative to type (starting with 1) |
| TotalPos | int | Absolute number relative to all current Calls (starting with 1) |
| RemoteNum | string | (optional) External call number |