| IPhoneCall Interface |
Interface for softphone calls.
Namespace: Ozeki.VoIP
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 1.8.12.0 (1.8.12)
SyntaxThe IPhoneCall type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Answer |
Answers the incoming call.
(Inherited from IOzPhoneCall.) |
| Answer(CallType) |
Answers the incoming call with the specified media types.
(Inherited from IOzPhoneCall.) |
| AttendedTransfer |
Transfers the call to another phone number.
An attended transfer is a transfer made after notifying the destination party of the transfer.
(Inherited from ICall.) |
| BlindTransfer |
Transfers the call to another phone number.
A blind transfer is defined as a transfer made without notifying the destination party before transferring the call.
(Inherited from IOzPhoneCall.) |
| Forward |
Forwards the incoming call to another phone.
(Inherited from IOzPhoneCall.) |
| HangUp |
Hangs up the call. If the outgoing call has not been answered yet, it will be cancelled.
If the incoming call has not been answered, it will be rejected.
(Inherited from IOzPhoneCall.) |
| Hold |
Puts the call on hold. If the call is already on local hold, it has no effect.
(Inherited from IOzPhoneCall.) |
| ModifyCallType |
Modifies the media used during the call.
(Inherited from ICall.) |
| Reject |
Rejects the incoming call.
(Inherited from IOzPhoneCall.) |
| Reject(String) |
Rejects the incoming call.
(Inherited from IOzPhoneCall.) |
| Respond(ResponseCodes) |
Sends a response to the caller with the specified status code.
(Inherited from ICall.) |
| Respond(ResponseCodes, String) |
Sends a response to the caller with the specified status code.
(Inherited from ICall.) |
| RingWithEarlyMedia |
Sends a provisional response with media description to the caller. When early media response is sent, the softphone can send media data to the other party while the phone is still ringing.
(Inherited from IOzPhoneCall.) |
| RingWithEarlyMedia(CallType) |
Sends a provisional response with media description to the caller. When early media response is sent, the softphone can send media data to the other party while the phone is still ringing.
(Inherited from IOzPhoneCall.) |
| SendInfo |
Sends INFO request to the other party.
(Inherited from ICall.) |
| SendInstantMessage(String) |
Sends MESSAGE request to the other party.
(Inherited from ICall.) |
| SendInstantMessage(String, MimeType) |
Sends MESSAGE request to the other party.
(Inherited from ICall.) |
| SendInstantMessage(String, String) |
Sends MESSAGE request to the other party.
(Inherited from ICall.) |
| Start |
Starts the outgoing call.
(Inherited from IOzPhoneCall.) |
| StartDTMFSignal(DtmfNamedEvents) |
Starts sending the given DTMF signal continously until the StopDTMFSignal method called. The signalling mode will be detected automatically.
(Inherited from ICall.) |
| StartDTMFSignal(DtmfNamedEvents, DtmfSignalingMode) |
Starts sending the given DTMF signal continously until the StopDTMFSignal method called. If the remote party does not support the specified method, no DTMF signal will be sent.
(Inherited from ICall.) |
| StopDTMFSignal |
Stops the DTMF signalling.
(Inherited from ICall.) |
| ToggleHold |
Puts the call on hold or takes the call off hold. (toggle)
If the call is in InCall state, puts it on hold.
If the call is in LocalHeld or InactiveHeld state, takes it off hold.
(Inherited from IOzPhoneCall.) |
| Unhold |
Takes the call off from hold. If the call is in progress, it has no effect.
(Inherited from IOzPhoneCall.) |
Properties| Name | Description | |
|---|---|---|
 | CallID |
Gets the unique identifier of the call.
(Inherited from IOzBaseCall.) |
| CallState |
Gets the state of the call.
(Inherited from IOzBaseCall.) |
| CallType |
Gets information about the type of the call. (i.e.: Audio, Video, AudioVideo)
(Inherited from ICall.) |
| CustomProperties |
Gets a collection that can be used for storing custom values for the call.
(Inherited from ICall.) |
| DialInfo |
Gets basic information about the call such as caller ID or dialed number.
(Inherited from IBaseCall.) |
| IsAnswered |
Gets a boolean value indicating whether the call has been answered.
(Inherited from IOzBaseCall.) |
| IsIncoming |
Gets if the call is an incoming call.
(Inherited from IOzBaseCall.) |
| Media |
Gets the media manager that handles the media.
(Inherited from IOzPhoneCall.) |
| OtherParty |
Gets information about the remote party.
(Inherited from ICall.) |
| Owner |
Gets the owner of the call.
(Inherited from IBaseCall.) |
| PhoneLine |
Gets the correspondent phone line.
|
| ReasonOfState |
Gets the textual context of the call state.
(Inherited from IOzBaseCall.) |
| TransferInfo |
Gets information about the call transfer.
(Inherited from ICall.) |
Events| Name | Description | |
|---|---|---|
 | CallStateChanged |
Occurs when the state of the call has changed.
(Inherited from IOzBaseCall.) |
| CallTypeChanged |
Occurs when the call type changed.
(Inherited from ICall.) |
| DtmfReceived |
Occurs when the other party stopped the DTMF signalling.
(Inherited from IOzPhoneCall.) |
| DtmfStarted |
Occurs when the other party started the DTMF signalling.
(Inherited from IOzPhoneCall.) |
| InfoDataReceived |
Occurs when the other party sent data in a SIP INFO request.
(Inherited from ICall.) |
| InfoResponseReceived |
Occurs when response received to a sent SIP INFO request.
(Inherited from ICall.) |
| InstantMessageReceived |
Occurs when an the other party sent an instant message.
(Inherited from ICall.) |
| InstantMessageResponseReceived |
Occurs when a delivery response arrived to a sent message.
(Inherited from ICall.) |
| TransferStateChanged |
Occurs when the transfer state changed.
(Inherited from ICall.) |
Remarks
The interface that represents the phone call. The phone call stores the phone line,
the number of the remote party, the information about that it is an incoming call or not.
The events that are defined in this interface inform the system about the
errors that result the end of the call, the state change of the call, the DTMF signals
arriving from the remote end and the media packages sent from the remote end.
The call control is also defined in this interface. If the call is an incoming call, you
can accept or reject it. The outgoing call can be started, ended, cancelled, held with the methods
that are also defined here. The sending capability of DTMF signals and media packets are
also defined in the IPhoneCall interface.
The call supports more media dtat format according to the codecs that are used during the call.
See Also