etTransfer Sample Program

TeleTools

The etTransfer sample program demonstrates how to perform a supervised transfer ( also known as a consultation transfer).  

The user dials the primary call and establishes a connection with the called party.  The user then dials the consultation call.  This causes the primary call to be placed on hold.  The user may then Swap Hold, Complete Transfer or Three Way Call.

Click here for more information about Supervised Transfer.

Requirements
Using This Sample Program
Download this Sample Program 
How this Sample Program Works
Source Code
Release Notes

Development Environment Technical Information
Telephony Hardware Technical Information

 

Requirements

  • A telephony device that supports supervised (consultation) transfer.

  • A properly configured TSP set with the codes / sequences to do a transfer on that device. Click the links below for help on some devices:

     Configuring a Dialogic Card PBX Strings
     Configuring a Hi-Phone PBX Parameters

Using This Sample Program

  1. Once the program is started select TAPI line device with the drop down list box. 

  2. Activate the device by clicking the Active check box.
    If the device does not support the supervised transfer feature a dialog box will be displayed with an error.

  3. Enter a phone number in the edit box adjacent to the Dial button then click the button to create the primary call.

  4. Wait for the primary call to be connected (the called party answers).

  5. Enter a phone number in the edit box adjacent to the TransferDial button then click the button to create the consultation call.

  6. Wait for the consultation call to be connected (the called party answers).

  7. Complete the supervised (consultation) transfer call by clicking the Complete button.  This connects the two called parties and disconnects the user from the call.

To create a three way call click the ThreeWay button instead of the Complete button.

Some telephony devices require you to create a three way call in order to create a conference.  You will notice that the TeleTools etLine control will indicate that a conference has been created in those situations.

Once the primary call is on hold and the consultation call is connected you may click the SwapHold button.  This will cause the consultation call to be placed on hold and the primary call the be taken off hold.  Most telephony devices require the primary call to be on hold before completing the transfer or creating a three way call.  Some telephony devices do not support this feature. Read the device documentation to determine their capability. Also see the “etLine.Transfer Methods” topic in the ExceleTel TeleTools help file.

For demonstration purposes, this sample program requires the primary call to be dialed.  A typical application could perform the transfer for either an outbound or an inbound call.  Most telephony devices (and their associated TAPI TSP) do not care if the primary call was inbound or outbound.

 

Download this Sample Program

For Use With TeleTools v3.7

File

Purpose

EXE

Ready to run!

Borland C++ 4,5,6

Source code and wave files

Borland Delphi 5,6,7

Source code and wave files

Visual Basic 5,6

Source code and wave files

Visual Basic .NET

Source code and wave files

Visual C++ 6

Source code and wave files

Visual Fox Pro 6

Source code and wave files

Tell us what you need?

Click here and tell us what you need!

How this Sample Program Works

When the program starts the Form_Load event handler routine fires.  The etLine control is enabled which allows the list of devices to be used to fill the Device combo box.  The etLine.TeleScope.Visible property is set to True causing the etLine TeleScope to be displayed.

When the user selects a device from the list box the etLine.Device.Active property is set to False and the Active check box is unchecked.

When the Active check box is checked the etLine1.AddressCapabilitiesCallFeatures property is checked to see if the selected device supports supervised transfers.  This is done by checking the bit flag at the position defined by the constant LINECALLFEATURE_SETUPTRANSFER.  If the device does not support this feature then an error dialog box is displayed.  Finally the etLine.Device.Active property is set to True, activating the TAPI line device.

Pressing the Dial button causes the etLine.Call.PhoneNumber property to be filled with the phone number in the edit box adjacent to the button.  If the associated Address edit box has a numeric value other than zero then the etLine.Call.Paramaters.Defaults property is set to False and the etLine1.Call.Parameters.AddressID is set.  This is useful with telephony devices that support multiple addresses for the selected line device. Finally the etLine.Call.Dial method is called.

Pressing the TransferDial button causes the etLine.Transfer.PhoneNumber property to be filled with the phone number in the edit box adjacent to the button.  If the associated Address edit box has a numeric value other than zero then the etLine.Transfer.Paramaters.Defaults property is set to False and the etLine1.Transfer.Parameters.AddressID is set.  This is useful with telephony devices that support multiple addresses for the selected line device. Finally the etLine.Transfer.Dial method is called.

Clicking the SwapHold button causes the etLine1.Transfer.SwapHold method to be called.

Clicking the SwapHold button causes the etLine1.TransferComplete method to be called.

Clicking the SwapHold button causes the etLine1.TransferThreeWay method to be called.

Control

Description

CheckBoxActive

Used to activate the TAPI Line device.

ComboBoxDevice

Used to select the TAPI line device.

ButtonDial

Dials the phone number entered in the TextCallPhoneNumber text box. Used to create the primary call.

ButtonTransferDial

Dials the phone number entered in the TextTransferPhoneNumber text box. Used to create the consultation call.

EditCallPhoneNumber

Holds the phone number for the primary call.

EditTransferPhoneNumber

Holds the phone number for the consulation call

EditCallParameterAddress

Used to set the etLine.Call.Parameter.AddressID property. Typical value is 0 for a one line, one channel device.

EditTransferParameterAddress

Used to set the etLine.Transfer.Parameter.AddressID property. Typical value is 0 for a one line, one channel device.

etLine1

The etLine control

ButtonTransferSwapHold

Swaps the active call with the call on consultation hold.

ButtonTransferComplete

Completes a consultation transfer started with the etLine.Transfer.Dial method.

ButtonTransferThreeWay

Completes a consultation transfer started with the etLine.Transfer.Dial method, to create a three way call.

 

Event Handler Routine

Description

CheckActive_Click

The “Active” checkbox is used to turn the selected line device on, when checked, or off, when not checked. If the control is checked, then the line device is activated by setting the property etLine1.Device.Active = TRUE; if not checked, then the line device is deactivated by setting the property etLine1.Device.Active = FALSE.

ComboDevice_Click

The etLine1.Device.Active property is checked to see if the current device is active. If so, then CheckBoxActive is set to false causing the device to be deactivated. The etLine1.Device.ID is set to the index value of the device chosen in the combo box. If no errors occurred, then the properties etLine1.Privilege.Monitor and etLine1.Privilege.Owner are set to true.

CommandDial_Click

The etLine1.Call.PhoneNumber property is set to the value in the EditCallPhoneNumber control then the etLine1.Call.Dial method is then called.

CommandThreeWay_Click

The etLine1.Transfer.ThreeWay method is called.

CommandTransferComplete_Click

The etLine1.Transfer.Complete method is called.

CommandTransferDial_Click

The etLine1.Transfer.PhoneNumber property is set to the value in the EditTransferPhoneNumber control then the etLine1.Transfer.Dial method is then called.

CommandTransferSwapHold_Click

The etLine1.Transfer.SwapHold method is called.

etLine1_OnDisconnected

The etLine1.Call.Hangup method is called to hang up the call for which the event fired.

Form_Load

It fills the combo box with available TAPI line devices and initializes the line device and the combo box to the first device available.

 

Release Notes

April 9, 2003

Published