public interface ActiveConnection : IOMSnapshot,
IEquatable<Object>, IDisposable| AttachedData | Additional data attached by PBX |
| CallConnectionID | each connection has unique identifier in the call. |
| CallID |
Unique identifier of the call on PBX. All ActiveConnection
with the same CallID are participants of the same conversation. This ID is run-time identifier for TCX.PBXAPI |
| DialedNumber | Provides number which was dialed by the originator of an outbound connection. This property provides valid information only for outbound connections on external line. (DN property is an ExternalLine object) |
| DN | Connection is associated with this DN |
| ExternalParty | provides caller id or dialed number in case if DN is the ExternalLine |
| HasAttached |
Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot) |
| HistoryIDOfTheCall |
Each call has unique history ID. It is persistent unique ID of the call in call history database. (obsolete) v14 - call history database does not use this ID. Obsolete. |
| ID |
each object has unique ID.
It is the same as the value returned by GetHashCode. (legacy)
new object has ID=0. After successful call to save snapshot gets persistent ID.
(Inherited from IOMSnapshot) |
| InternalParty | Points to internal entity (DN) which is on other side of call. |
| IsInbound |
Specifies call direction Actual only during call setup and simple call scenario. Cannot provide correct information for calls which were transferred, diverded, parked etc. |
| IsOutbound |
Specifies call direction Actual only during call setup and simple call scenario. Cannot provide correct information for calls which were transferred, diverded, parked etc. |
| Item | returns value of specific Key in AttachedData. All string keys of the Active connection can be obtained by AttachedData property |
| LastChangeStatus | specifies the time when connection had changed its status to Status |
| OfferProvided |
Information which is provided for Ringing status.
When call is addressed to the specific device, CallManager gives inforamtion about SDP negotiation state. This information could be used by sip endpoints which are integrated with CallControl API. Allows to execute SIP pickup request with most optimal SDP negotiation: if OfferProvided is True - Pickup should be performed with request for offer if OfferProvided is False - Pickup should be performed with SDP offer |
| OnBehalfOf | the connection is made on behalf of this DN. |
| OriginatedBy | Originator of the connection. Initiator of the connection. specifies DN which creating the connection. RouteToAsync(ActiveConnection, RouteRequest) |
| OriginatedByConnection | Originator connection. it is the connection which initiating RouteToAsync(ActiveConnection, RouteRequest) |
| OtherCallParties | reports parties of this connection. |
| PartyConnectionID | id of party connection |
| RecordingState | Current state of the recording |
| ReferredBy | Initiator of Blind Transfer procedure. This property specifies CallConnectionID of the ActiveConnection which has initiated Blind Transfer Note: Initiator of Blind Transfer may leave the call before tranfer has finished. This value is valid only for ActiveConnection in Ringing state. |
| ReferredByDN | gives the reference to the DN which parforms blind transfer procedure |
| RouteTarget | special routing attribute. effectively, the connection is created as "routing to the DN" valid only for ActiveConnection on ROUTER RoutePoint |
| Status | specifies current status of connection. ConnectionStatus |
| Answer |
this method allows to answer the call ringing on the specific device.
server will try to apply following actions: |
| AttachConnectionData | Allows to attach data to the existing connection. The data will be available using AttachedData and indexer of ActiveConnection Ignores all keys which are not started with "public_" prefix. |
| AttachOnSave(IEnumerableIOMSnapshot) |
This method allows to add other object updates to the main object saving transaction
(Inherited from IOMSnapshot) |
| AttachOnSave(IOMSnapshot) |
This method allows to add other object updates to the saving transaction of main object
(Inherited from IOMSnapshot) |
| Bargein(RegistrarRecord, PBXConnectionBargeInMode) | barge in the device to the call of the connection. in case if mode is Whisper the ActiveConnection will hear the new participant. |
| Bargein(String, PBXConnectionBargeInMode) | Barge in to the call. Call manager will make a call to all devices attachec to specified DN. Answered connection will barge in to the call of the ActiveConnection |
| CancelRerouteRequest | Cancels specific route requested by Reroute(IEnumerableRouteRequest) Can be called at any time to ensure that route has been ended. |
| ChangeRecordingState | Recording control |
| Clone |
Makes fresh snapshot of the object without modifications
(Inherited from IOMSnapshot) |
| DeleteOnSave(IEnumerableIOMSnapshot) |
Allows to remove other objects as a part of the main object saving transaction.
(Inherited from IOMSnapshot) |
| DeleteOnSave(IOMSnapshot) |
Allows to remove other objects as a part of the main object saving transaction.
(Inherited from IOMSnapshot) |
| Divert(RegistrarRecord) | PickupCall(RegistrarRecord, ActiveConnection). Reroute the incoming call to specifc device |
| Divert(String, Boolean) | mirrored action of PickupCall(String, ActiveConnection). Reroute the connection to new destination |
| Drop |
Drop the connection This action is performed as emulation of the Reject/Drop action on the device. Request to drop call is coming from the server side. |
| GetHashCode |
Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot) |
| GetPartyConnection | Party Connection. As specified by CallManager |
| MoveTo | Reserved for future use. Move connection to specified device. If connection is established, it can be moved to another device. Routing rules will not be applied to the transfer operation. |
| ReplaceWith | Transfer operation. Replace the connection with new connection made with specified number |
| ReplaceWithPartyOf | Replaces the connection with the party of the other connection on the same device. It is last step of Attended transfer |
| Reroute | Request to replace the connection with one of the route build for specified targets. if one of the route will answer, this connection will be replaced with answered route. All other routes will be cancelled. All ActiveConnections created for the Reroute request will have attached key "requested-target-id". |
| ToString |
Brief description of object in term of Object model.
default implementation is ToString. Concrete implementation may be more verbose.
(Inherited from IOMSnapshot) |
| AnswerAsync |
request to answer of the call if device supports direct contol.
Currently supported only by uacsta devices.
(Defined by CallControlAPI) |
| AttachConnectionDataAsync |
Attaches data to ActiveConnection the participant connection. Attaches only subset of the keys which are started with "public_" (Defined by CallControlAPI) |
| BargeInCallbackAsync |
barge-in to the call of the specifid participant form the Extension (Defined by CallControlAPI) |
| BargeInCallbackAsync |
Barge in to the participant from the specific Extension device
(Defined by CallControlAPI) |
| ChangeRecordingStateAsync |
changing recording state on behalf of participant
(Defined by CallControlAPI) |
| Deserialize |
deserializes object and remenber repeatlist.
object can be saved
(Defined by SerializationExtension) |
| DivertAsync |
Diverts call to the specified destination
(Defined by CallControlAPI) |
| DivertAsync |
divert to number with voicemail flag. This is for backward compatibility.
(Defined by CallControlAPI) |
| DropAsync |
the request to terminate connection.
(Defined by CallControlAPI) |
| GetSerializableProperties |
Returns list of properties which are require serialization
(Defined by SerializationExtension) |
| OMDelete |
Apply update of the specific snapshot.
virtually any object may be updated even those which are not supporting IOMStorable interface.
(Defined by CollectionTransactionsHelper) |
| OMSave |
Apply update of the specific snapshot.
virtually any object may be updated even those which are not supporting IOMStorable interface.
(Defined by CollectionTransactionsHelper) |
| ReplaceWithAsync |
BlindTransfer to specific destination. It is most flexible version which allows to choose any type of destination.
Allows to bypass routing rules.
(Defined by CallControlAPI) |
| ReplaceWithAsync |
BlindTransfer to the specific device. Ignores all forwarding rules and tries to deliver call to specific device.
(Defined by CallControlAPI) |
| ReplaceWithAsync |
Blind transfer with route to number. Does not allow to bypass forwarding/routing rules.
(Defined by CallControlAPI) |
| ReplaceWithInitOnlyAsync |
Overload of ReplaceWithInitOnlyAsync(ActiveConnection, String, DN, CallControlAPIDivertReason) for DestinationStruct (Defined by CallControlAPI) |
| ReplaceWithInitOnlyAsync |
Init only request of ReplaceWithAsync(ActiveConnection, RegistrarRecord, DN, CallControlAPIDivertReason) (Defined by CallControlAPI) |
| ReplaceWithInitOnlyAsync |
Special version when the caller needs to initiate transfer without waiting for result
(Defined by CallControlAPI) |
| ReplaceWithPartyOfAsync |
Final step of Attended transfer procedure.
(Defined by CallControlAPI) |
| RouteToAsync |
the request to route call to specific endpoint.
the connection is assumed as Parent.
Routing request could create many "ringing" destinations, but only one may answer
The answering connection is replacing the parent connection.
If all destination have failed, task is completed with failed state and Parent connection left alive.
(Defined by CallControlAPI) |
| RouteToAsync |
Simplified vertion which receives DestinationStruct and Timeout
(Defined by CallControlAPI) |
| RouteToAsync |
Simplified vertion which receives Destination
(Defined by CallControlAPI) |
| SerializeObject |
Deserializer for IOMSnapshot
(Defined by SerializationExtension) |
| SerializeProperty |
returns false if there are no enough information at the moment and it should be repeated after after all objects will be restored.
Typical case is forward reference to the DN object.
(Defined by SerializationExtension) |
| TryDeserializeProperty |
returns false if there are no enough information at the moment and it should be repeated after after all objects will be restored.
Typical case is forward reference to the DN object.
(Defined by SerializationExtension) |