TapiCall Class

TapiCall Class

Provides information about a call and methods for call flow processing.

Inheritance Hierarchy

SystemObject
Traysoft.AddTapiTapiCall

Namespace: Traysoft.AddTapi
Assembly: Traysoft.AddTapi (in Traysoft.AddTapi.dll) Version: 6.0.0.1110

Syntax

C++

Copy

public class TapiCall

Public Class TapiCall

public ref class TapiCall

The TapiCall type exposes the following members.

Properties

	Name	Description
	Address	Gets a TapiAddress that received the call.
	CallData	Gets the application-settable call data.
	CallDuration	Gets the duration of the call.
	CalledID	Gets the called party's ID (phone number), if available.
	CalledIDName	Gets the called party's name, if available.
	CallerID	Gets the caller's ID (phone number), if available.
	CallerIDName	Gets the caller's name, if available.
	CallID	Gets a numeric identifier (sequence number) of the call.
	ConnectedID	Gets the connected party's ID (phone number), if available.
	ConnectedIDName	Gets the connected party's name, if available.
	ConnectedMode	Gets the substate or mode of the connected call.
	DeviceSpecificInfo	Gets device specific information about the call.
	DeviceSpecificStatus	Gets device specific information about the status of the call.
	Direction	Gets a direction of the call (incoming or outgoing).
	DisconnectMode	Gets the disconnect mode (reason) for the disconnected call.
	Display	Gets the telephony system-specific call display information, if available.
	DisplayableAddress	Gets the displayable address (phone number) for logging purposes, if available.
	Guid	Gets the globally unique identifier (GUID) of the call.
	Line	Gets a TapiLine that the call is associated with.
	Origin	Gets the origin of the call.
	Privilege	Gets access rights or privileges an application may have to the corresponding call.
	Reason	Gets the reason for the call.
	RedirectingID	Gets the redirecting party's ID (phone number), if available.
	RedirectingIDName	Gets the redirecting party's name, if available.
	RedirectionID	Gets the redirection party's ID (phone number), if available.
	RedirectionIDName	Gets the redirection party's name, if available.
	RelatedCallID	Gets a numeric identifier (sequence number) of the related call.
	State	Gets the state of the call.
	Tag	Gets or sets the object that contains supplemental data about the call.
	Trunk	Gets the number of the trunk over which the call is routed.

Top

Methods

	Name	Description
	Accept	Accepts offered call.
	AddToConference	Adds the consultation call to the existing conference.
	Answer	Answers incoming call.
	CompleteTransfer	Completes the transfer of the call to the party connected in the consultation call.
	Dial(String)	Dials the specified number on the existing call.
	Dial(String, Boolean)	Dials the specified number on the existing call.
	Disconnect	Disconnects the call.
	GatherDigits	Gathers one or more DTMF digits on the call.
	GenerateDigits	Initiates the generation of the specified digits on the call.
	GetCommHandle	Obtains a handle of the open communication port associated with the call.
	Hold	Places the call on hold.
	Park	Performs directed or nondirected park.
	Play(String)	Plays a wave file. Pending speak and play requests are not purged.
	Play(String, Boolean)	Plays a wave file.
	PrepareAddToConference	Prepares the conference call for the addition of another party.
	Redirect	Redirects the call to the specified destination number.
	RemoveFromConference	Removes the call from the conference.
	SetupTransfer	Initiates a transfer of the call. It establishes a consultation call, on which the destination of the transfer can be dialed.
	Speak(String)	Speaks the contents of a text string using text synthesis. Pending speak and play requests are not purged.
	Speak(String, Boolean)	Speaks the contents of a text string using text synthesis.
	StartRecording	Starts recording of call audio.
	StopPlayback	Stops currently playing wave file or text-to-speech.
	StopRecording	Stops recording of call audio.
	SwapHold	Swaps the active call with the specified call on consultation hold.
	Transfer	Performs a blind or single-step transfer of the call.
	Unhold	Retrieves the held call.
	WaitForDigit	Waits until either a DTMF digit has been detected or the specified time interval has elapsed.
	WaitForSilence	Waits until either a period of silence has been detected or the specified time interval has elapsed.
	WaitUntilDone	Waits until either all pending speak and play requests have completed or the specified time interval has elapsed.

Top

Remarks

AddTapi.NET creates a TapiCall object for each incoming or outgoing call. TapiCall object contains information about a call such as the caller's number, and provides methods to play wave files, speak text and obtain digits pressed by a remote party.

TapiCall objects are provided to the application in TapiCallHandler callback, and in IncomingCall, CallConnected and CallDisconnected events. In addition, Dial(String, Boolean) method returns TapiCall object created for the outgoing call.

Examples

The following code shows how to obtain TapiCall object in the IncomingCall event handler.

C++

Copy

TapiApp.Initialize("MyApp");
TapiApp.IncomingCall += OnIncomingCall;
...

void OnIncomingCall(object sender, TapiEventArgs args)
{
    TapiCall call = args.Call;
    // Display caller's number to the user
    Console.WriteLine("Incoming call from {0}", call.CallerID);
}

TapiApp.Initialize("MyApp")
AddHandler TapiApp.IncomingCall, AddressOf OnIncomingCall
...

Private Sub OnIncomingCall(ByVal sender As Object, ByVal args As TapiEventArgs)
    Dim objCall As TapiCall
    objCall = args.Call
    ' Display caller's number to the user
    Console.WriteLine("Incoming call from {0}", objCall.CallerID)
End Sub

Reference

Traysoft.AddTapi Namespace

Traysoft.AddTapiTapiCallHandler

TapiLineOpen(Boolean, TapiCallHandler)

TapiLineDial(String, Boolean)