Click or drag to resize

IPhoneCall Interface

Interface for softphone calls.

Namespace: Ozeki.VoIP
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 10.4.13.0
Syntax
public interface IPhoneCall : ICall, 
	IBaseCall, IOzBaseCall, IOzPhoneCall

The IPhoneCall type exposes the following members.

Properties
 NameDescription
Public propertyCallID Gets the unique identifier of the call.
(Inherited from IOzBaseCall)
Public propertyCallState Gets the state of the call.
(Inherited from IOzBaseCall)
Public propertyCallType Gets information about the type of the call. (i.e.: Audio, Video, AudioVideo)
(Inherited from ICall)
Public propertyCustomProperties Gets a collection that can be used for storing custom values for the call.
(Inherited from ICall)
Public propertyDialInfo Gets basic information about the call such as caller ID or dialed number.
(Inherited from IBaseCall)
Public propertyIsAnswered Gets a boolean value indicating whether the call has been answered.
(Inherited from IOzBaseCall)
Public propertyIsIncoming Gets if the call is an incoming call.
(Inherited from IOzBaseCall)
Public propertyMedia Gets the media manager that handles the media.
(Inherited from IOzPhoneCall)
Public propertyOtherParty Gets information about the remote party.
(Inherited from ICall)
Public propertyOwner Gets the owner of the call.
(Inherited from IBaseCall)
Public propertyPhoneLine Gets the correspondent phone line.
Public propertyReasonOfState Gets the textual context of the call state.
(Inherited from IOzBaseCall)
Public propertyTransferInfo Gets information about the call transfer.
(Inherited from ICall)
Top
Methods
 NameDescription
Public methodAnswer Answers the incoming call.
(Inherited from IOzPhoneCall)
Public methodAnswer(CallType) Answers the incoming call with the specified media types.
(Inherited from IOzPhoneCall)
Public methodAttendedTransfer 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)
Public methodBlindTransfer 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)
Public methodForward Forwards the incoming call to another phone.
(Inherited from IOzPhoneCall)
Public methodHangUp 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)
Public methodHold Puts the call on hold. If the call is already on local hold, it has no effect.
(Inherited from IOzPhoneCall)
Public methodModifyCallType Modifies the media used during the call.
(Inherited from ICall)
Public methodReject Rejects the incoming call.
(Inherited from IOzPhoneCall)
Public methodReject(String) Rejects the incoming call.
(Inherited from IOzPhoneCall)
Public methodRespond(ResponseCodes) Sends a response to the caller with the specified status code.
(Inherited from ICall)
Public methodRespond(ResponseCodes, String) Sends a response to the caller with the specified status code.
(Inherited from ICall)
Public methodRingWithEarlyMedia 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)
Public methodRingWithEarlyMedia(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)
Public methodSendInfo Sends INFO request to the other party.
(Inherited from ICall)
Public methodSendInstantMessage(String) Sends MESSAGE request to the other party.
(Inherited from ICall)
Public methodSendInstantMessage(String, MimeType) Sends MESSAGE request to the other party.
(Inherited from ICall)
Public methodSendInstantMessage(String, String) Sends MESSAGE request to the other party.
(Inherited from ICall)
Public methodStart Starts the outgoing call.
(Inherited from IOzPhoneCall)
Public methodStartDTMFSignal(DtmfNamedEvents) Starts sending the given DTMF signal continously until the StopDTMFSignal method called. The signalling mode will be detected automatically.
(Inherited from ICall)
Public methodStartDTMFSignal(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)
Public methodStopDTMFSignal Stops the DTMF signalling.
(Inherited from ICall)
Public methodToggleHold 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)
Public methodUnhold Takes the call off from hold. If the call is in progress, it has no effect.
(Inherited from IOzPhoneCall)
Top
Events
 NameDescription
Public eventCallStateChanged Occurs when the state of the call has changed.
(Inherited from IOzBaseCall)
Public eventCallTypeChanged Occurs when the call type changed.
(Inherited from ICall)
Public eventDtmfReceived Occurs when the other party stopped the DTMF signalling.
(Inherited from IOzPhoneCall)
Public eventDtmfStarted Occurs when the other party started the DTMF signalling.
(Inherited from IOzPhoneCall)
Public eventForwarding Occurs when the call is being forwarded to a different set of destinations.
(Inherited from IOzBaseCall)
Public eventInfoDataReceived Occurs when the other party sent data in a SIP INFO request.
(Inherited from ICall)
Public eventInfoResponseReceived Occurs when response received to a sent SIP INFO request.
(Inherited from ICall)
Public eventInstantMessageReceived Occurs when an the other party sent an instant message.
(Inherited from ICall)
Public eventInstantMessageResponseReceived Occurs when a delivery response arrived to a sent message.
(Inherited from ICall)
Public eventRedirected Occurs when the call has redirected.
(Inherited from IOzBaseCall)
Public eventTransferStateChanged Occurs when the transfer state changed.
(Inherited from ICall)
Top
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