Toshiba TSPI Description Application Bulleti V2.15

Computer Telephony Integration

Application Bulletin

AB50-0003
April 1, 1997

Purpose

The following technical material is used for software engineers and programmers developing
third party TAPI applications with Toshiba telephone systems.

Introduction

Microsoft® Windows® Telephony is a component of Windows Open Services Architecture.
This architecture provides for the operation of telephony services when connected to many
different telephone swit ches. Therefore, an a pplication ne eds to kno w only the def inition of t he
API and not its implementation.

The telephony model supplies a DLL component, called TAPI.DLL. This component resides
between the Telephony API called by appl icat ions an d the Telephony SPI implement ed for t he
specific switch to which the PC is connected. The software applications call TAPI functions
that are managed by TAPI.DLL and routed to the Service Provider Interface (e.g., Toshiba’s
DKT SPI) for execution. The relationship between these components is shown in Figure 1.

4170109

TSPI Description V2.15

Microsoft Windows PC

Strata DKT

RS-232 Link

RPCI to COM Port

2046

Figure 1 The Telephony API Model and the Strata DK

Toshiba America Information Systems, Inc.

9740 Irvine Bl vd., Ir vin e, CA 92618-1697 [phone]

TAPI

Service
Provider

Telecommunication Systems Division

TAPI

Application # 1

TAPI

DLL

(Windows)

TAPI

Application # 2

1 of 18

AB50-0003

TSPI Description V2.15

The Telephone Applications Programming Interface (TAPI) was a joint development of
Microsoft and Intel
types of telephone systems. The standard allows software developers to create applications
without having to worry about how the telephone network interface functions. This interface
provides thre e levels of service: Basic, Supplementary, and Extended .Levels of Service

Levels of Service

Basic

Basic Services are centered around Plain Old Telephony Service (POTS) including a set of re­defined call states and information messages which pass events to the application. Features of
POTS include answering calls, making calls, numbering plans to support dialing, and the
ability to translate numbers based upon type and location of the user.

Supplementary

Supplementary Services provide additional features commonly found in most PBX’s. These
include call features such as Call Transferring, Forwarding, Conferencing, Hold, Park, and
Pickup. Additional services are defined for interfacing Media Services such as providing
interfaces for fax, modems, voice response, and tone detection/generation. Release 2.0 of the
TAPI specification includes third party call control services for Automatic Call Distribution
(ACD) and future Asynchronous Transfer Mode (ATM).

®

to provide a standard method of connecting Windows based PCs to all

al

i

Extended

Extended Services provide a method to access features and services beyond the Basic or
Supplementary Services. TAPI provides for the passing of messages directly between the
telephone system and the application. TAPI only passes these messages directly to either end
and does not take action or make interpretations of them. The application, therefore, is
responsible for the complete interaction of the feature or service provided.

Interfaces

ary an

The Windows Open Syste m Architecture pr ovides two interfaces for Telephony Devices. The
TAPI interface provides for the control of calls using a well defined interface and the audio
connection is handled in what Microsoft calls a Media Stream. To allow for a standard
interface for playing and recording messages, interfacing fax, modem or other devices uses a
separate application interface. The WAV API is a common interface that can provide these
services in an open manner that can be controlled using the TAPI interface.

Strata DK’s TSPI Model

rel

P

For the application’s developer, the Microsoft standard provides for two device classes: the
line device and the phone devic e. Any physical telephonic device recognized by TAPI fits into
one of these two classes, and can be treated in a consistent and reliable manner. Strata DK
TSPI only supports the line device class. The phone class is for telephone devices controlled
by the applicati on.

min

i

d Confident

2 of 18

Strata DK I&M April 1997

TSPI Description V2.15

Line Device Model

The Strata DK TSPI models its interface as a single-line device with multiple addresses, each
having no more than one call appearance. The specific capabilities of the line device and each
of the addresses are explained under the function description for lineGetDevCaps and
lineGetAddressCaps.

Phone Device Model

At present, the DKT TSPI does not support the phone device model.

The DKT TSPI Call State Flow

The Toshiba TAPI Service Provider V2.15 has been released with th e f ol lowing call state flow
as illustrated in the diagram below:

AB50-0003

al

i

I-Ring

I-Use

Deallocate Call
Handle

Idle

Figure 2 Call State Flow

C-Ring
C-Hold

Allocate Call
Handle

min

i

Dial Tone

Busy

Offering

BusyLED

OFF

I-Use

d Confident

LED OFF

ary an

Ringback

I-Use

Hold

Busy

ConnectedStart

I-Hold
E-Hold

2045

rel

P

Strata DK I&M April 1997

3 of 18

AB50-0003

Table 2-1 Call State Descriptions

TSPI Description V2.15

ALL O

C

ALL STATE

Idle Steady Off Idle Idle
Transferred Calls (1Hz) Green T-Ring
Incoming Call 1 (10Hz), 1 Off Green I-Ring I-Ring
Hold Recall 1 (2Hz), 1 (10Hz) Green H-Recall H-Recall
I-Hold (4Hz) Green I-Hold I-Hold
Transf er Ho ld (10Hz) Green T-Hold T-Hold
Exclusive Hold (10Hz) Green E-Hold E-Hold
Current Lin e In-Use* I-Use Rate Green I-Use I-Use
Common Hold 3/4 On, 1/8 Off Red C-Hold
Common Hold (1Hz) Red C-Hold C-Ring, T-Hold
Incoming Line Ring (1Hz) Red L-Ring
Common Ring (2Hz) Red C-Ring
Busy Steady On Red Busy Busy

LED F

C

LASH

OLOR

DK16E & DK424 R3

S

YSTEMS

i

THER

al

d Confident

*I-Use rate is generated in the phone. The cycle consists of 2 seconds on followed by 1/8
second off, 1/8 second on, 1/8 second off state.

System Messages

An application receives information in two ways: solicited and unsolicited. Solicited
information is req uest ed by the application through a function call such as lineGetDevCaps or
lineGetAddressCaps. Unsolicited information arrives in the form of messages. Often, the two
mechanisms are used together, as when an application receives a LINE_CALLSTATE
message, after which it checks the infor mation contai ned in th e LINECALLINFO s truct ure b y
calling lineGetCallInfo.

Strata DKT TSPI supports the following messages providing unsolicited information:

ary an

min

LINE_CALLSTATE

LINE_LINEDEVSTATE

rel

P

i

Sent to an application to notify it about changes in a call’s state.

Sent to the application to notify it about changes in the line status. This message indicates
which status item has changed.

4 of 18

Strata DK I&M April 1997

TSPI Description V2.15

LINE_ADDRESSSTATE

The Service Provider follows with this callback message giving changes to the state of any
address.

LINE_CALLINFO

A callback message that notifies of additional information about the call.

AB50-0003

LINE_REPLY

Messages generated for all asynchronous requests. Toshiba DKT TSPI always uses
lineMakeCall in this asynchronous manner.

LINE_NEWCALL

A message to notify the application of a new call event arriving.

Startup and Shutdown of TAPI

lineInitialize

An application re gis ters a TAPI connection b y callin g this functio n. This fun ction is not passe d
through to the TSPI but handled by TAPI.DLL. One of the main purposes is to establish a
pointer to the application’s callback function to allow unsolicited messages to be registered.
Two pieces of information is retur ned to the appli cation: an appl icat ion ha ndle a nd the number
of available line devices. Strata DK TSPI supports multiple line devices.

d Confident

lineShutdown

When the application is done, this command releases the resources and the TAPI environment
is disconnected.

al

i

lineNegotiateAPIVersion

This function is used to negotiate the API version number to used. The application provides
the range of versions it is compatible with and TAPI.DLL in turn negotiates with the TSPI to
determine which version range it supports.

lineOpen

This function opens the specified device ID for the purpose of monitoring or control by the
application. Opening the line returns the handle for the device. The application can then use
this handle to answer inbound calls, make outbound cal l s, or moni tor ca ll activities on the l i ne
for logging purposes. The application should query the capabilities of the line, (using
lineGetDevCaps) before opening the line device. Upon opening the line, a serial port will be
allocated and initialized.

min

i

rel

lineSetStatusMessages

P

This operation allows an application to specify which notification messages the service
provider s hould genera te for events relat ed t o t he s tatus chang es for the s pec if ie d li ne or an y of
its addresses.

Strata DK I&M April 1997

ary an

5 of 18

AB50-0003

lineGetStatusMessages

This function queries the TSPI for current status messages.

lineClose

This function closes the specified open line device after aborting all outstanding calls and
asynchronous operations on the device.

Receiving Information

lineGetDevCaps

This function queries a specified line device to determine its telephony capabilities. It is
important for an application to call this function before opening the line device. This allows
the application to determine which of possibly several line devices to use. Returns the
supplementary and extended capabilities of a given line device as a data structure of type
lineDevCaps:

TSPI Description V2.15

al

i

F

IELD NAME

dwProviderInfoSize
dwProviderInfoOffset

dwSwitchInfoSize
dwSwitchInfoOffset

dwPermanentLineID This field will contain the permanent device ID, as found

dwLineNameSize
dwLineNameOffset

dwStringFormat STRINGFORMAT_ASCII
dwAddressModes LINEADDRESSMODE_ADDRESSID
dwNumAddresses This field reports the number of addresses found for this

dwBearerModes LINEBEARERMODE_VOICE

min

dwMaxRate 0

i

dwMediaModes LINEMEDIAMODE_INTERACTIVEVOICE
dwGenerateToneModes

dwGenerateToneMaxNumFre

rel

q

ary an

The memory area referenced by these fields will contain
the NULL-terminated string describing the service
provider. The Strata DK service provider is “Toshiba DKT
TSPI”.

This memory area is not used by the Toshiba DKT TSPI.

in TELEPHON.INI.
This memory area contains the name of the device as

defined in Setup of the driver installed.

device. This is defined in Setup of the driver installed.

Not supported by Toshiba DKT TSPI.

d Confident

S

ETTING

P

6 of 18

dwGenerateDigitModes LINEDIGITMODE_DTMF
dwMonitorToneMaxNunFreq

dwMonitorToneMaxNumEntr
ies

Not supported by Toshiba DKT TSPI.

Strata DK I&M April 1997

TSPI Description V2.15

AB50-0003

F

IELD NAME

dwMonitorDigitModes Not supported by Toshiba DKT TSPI.
dwGatherDigitsMinTimeout

dwGatherDigitsMaxTimeout
dwMedCtlDigitMaxListSize

dwMedCtlMediaMaxList
dwMedCtlToneMaxListSize
dwMedCtlCallStateMaxListS
ize

dwDevCapFlags 0
dwMaxNumActiveCalls 1
dwAnswerMode LINEANSWERSTATE_DROP
dwRingModes 0
dwLineStates LINEDEVSTATE_OTHER |

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

LINEDEVSTATE_CONNECTED |
LINEDEVSTATE_DISCONNECTED |

LINEDEVSTATE_OPEN |
LINEDEVSTATE_CLOSE |

LINEDEVSTATE_NUMCALLS |

S

ETTING

al

i

dwUUIAcceptSize
dwUUIAnswerSize
dwUUIMakeCallSize
dwUUIDropSize
dwUUISendUserUserInfoSiz
e
dwUUICallInfoSize

MinDialParams
MaxDialParams
DefaultDialParams

dwNumTerminals Not supported by Toshiba DKT TSPI.
dwTerminalCapsSize

dwTerminalCapsOffset

min

dwTerminalTextEntrySize

i

dwTerminalTextOffset
dwDevSpecificSize

dwDevSpecificOffset

rel

lineGetAddressCaps

P

This function queries the specified address on the specific line device to determine its
telephony capabilities. The Toshiba DKT TSPI returns two sets of values depending whether

LINEDEVSTATE_REINIT |
LINEDEVSTATE_TRANSLATECHANGE

d Confident

Not supported by Toshiba DKT TSPI.

ary an

These will indicate the dia l sp eed, duration, and dial pause
duration set b y the p hone syst em and are not ch angeabl e at
the device level.

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

Strata DK I&M April 1997

7 of 18

AB50-0003

TSPI Description V2.15

the line type def ined in Setup of the dri ve r was set for Prim e Line / Intercom or an y of the other
types listed. This function fills the data structure of type LineAddressCaps:

F

IELD NAME

dwLineDeviceID The device ID of the line with which the address is

associated.

dwAddressSize
dwAddressOffset

dwDevSpecificSize
dwDevSpecificOffset

dwAddressSharing LINEADDRESSSHARING_PRIVATE
dwAddressStates LINEADDRESSSTATE_OTHER |

dwCallInfoStates LINECALLINFOSTATE_OTHER |

dwCallerIDFlags LINECALLPARTYID_UNAVAIL

A NULL-terminated string reflecting the name of the key
on the station. This is defined during Setup of the driver.

Not supported by Toshiba DKT TSPI.

LINEADDRESSSTATE_INUSEZERO |
LINEADDRESSSTATE_INUSEONE |
LINEADDRESSSTATE_NUMCALLS |
LINEADDRESSSTATE_FORWARD (PDN or INT only)

LINECALLINFOSTATE_APPSPECIFIC |
LINECALLINFOSTATE_NUMOWNERINCR |
LINECALLINFOSTATE_NUMOWNERDECR |
LINECALLINFOSTATE_NUMMONITORS |
LINECALLINFOSTATE_DIALPARAMS

d Confident

S

ETTING

i

al

rel

P

dwCalledIDFlags LINECALLPARTYID_UNAVAIL
dwConnectedIDFlags LINECALLPARTYID_UNAVAIL
dwRedirectionIDFlags LINECALLPARTYID_UNAVAIL
dwRedirectingIDFlags LINECALLPARTYID_UNAVAIL
dwCallStates LINECALLSTATE_IDLE |

LINECALLSTATE_OFFERING |

ary an

min

i

dwDialToneModes LINEDIALTONEMODE_UNAVAIL
dwBusyModes LINEBUSYMODES_UNAVAIL
dwSpecialInfo LINESPECIALINFO_UNAVAIL
dwDisconnectModes LINEDISCONNECTMODE_UNKNOWN

LINECALLSTATE_DIALTONE |
LINECALLSTATE_RINGBACK |
LINECALLSTATE_BUSY |
LINECALLSTATE_CONNECTED |
LINECALLSTATE_PROCEEDING |
LINECALLSTATE_ONHOLD |
LINECALLSTATE_CONFERENCED |
LINECALLSTATE_ONHOLDPENDCONF |
LINECALLSTATE_ONHOLDPENDTRANSFER |
LINECALLSTATE_UNKNOWN

8 of 18

Strata DK I&M April 1997

TSPI Description V2.15

AB50-0003

F

IELD NAME

dwMaxNumActiveCalls 1
dwMaxNumOnHoldCalls 1
dwMaxNumOnHoldPending

Calls
dwMaxNumConference 4
dwMaxNumTransConf 1
dwAddrCapFlags LINEADDRCAPFLAGS_BLOCKIDDEFAULT |

dwCallFeatures LINECALLFEATURE_ADDTOCONF |

1

LINEADDRCAPFLAGS_DIALED |
LINEADDRCAPFLAGS_ORIGOFFHOOK |
LINEADDRCAPFLAGS_AUTORECONNECT |
LINEADDRCAPFLAGS_PARTIALDIAL |
LINEADDRCAPFLAGS_PICKUPCALLWAIT

LINECALLFEATURE_ANSWER |
LINECALLFEATURE_BLINDTRANSFER (R3 only) |
LINECALLFEATURE_COMPLETETRANSF |
LINECALLFEATURE_DIAL |
LINECALLFEATURE_DROP |
LINECALLFEATURE_HOLD |
LINECALLFEATURE_PARK |
LINECALLFEATURE_PREPARETOADDCONF |
LINECALLFEATURE_SETUPCONF |
LINECALLFEATURE_SETUPTRANSFER
LINECALLFEATURE_UNHOLD

d Confident

S

ETTING

al

i

rel

P

dwRemoveFromConfCaps LINEREMOVEFROMCONF_NONE
dwRemoveFromConfState Not supported by Toshiba DKT TSPI.
dwTransfer Modes LINETRANSFERMODE_TRANSFER |

LINETRANSFERMODE_CONFERENCE

dwParkModes LINEPARKMODE_NONDIRECTED

ary an

F

IELD NAME

dwForwardModes LINEFORWARDMODE_UNCOND |

min

i

dwMaxForwardEntr ies
dwMaxSpecificEn tr ies

dwMinFwdNumRings
dwMaxFwdNumRings

dwMaxCallCompletions
dwCallCompletionConds
dwCallCompletionModes

LINEFORWARDMODE_BUSY |
LINEFORWARDMODE_NOANSW |
LINEFORWARDMODE_BUSYNA

1
1

3
3

Not supported by Toshiba DKT TSPI.

S

ETTING

Strata DK I&M April 1997

9 of 18

AB50-0003

TSPI Description V2.15

F

IELD NAME

dwNumCompletionMessages
dwCompletionMsgTextEntry
Size
dwCompletionMsgTextSize
dwCompletionMsgTextOffset

lineGetAddressStatus

This functi on queries the specified address for its current status. The current status is returned
using the data structure lineAddressStatus:

F

IELD NAME

dwNumInUse 1 if there is a call associated with the address, 0 otherwise.
dwNumActiveCalls 1 if there is a call in any state other than ONHOLD at the

dwNumOnHoldCalls 1 if there is a call holding at the address, 0 otherwise.
dwNumOnHoldPendingCalls 1 if there is a call in either the ONHOLDPENDINGCONF

S

ETTING

Not supported by Toshiba DKT TSPI.

S

ETTING

address, 0 otherwise.

state or the ONHOLDTENDTRANSFER state, 0
otherwise.

al

i

dwAddressFeatures If there is no c all associated with the given address, this

lineGetCallInfo

This function returns detailed information about the specified call. The information is returned
in a data structure of the type LineCallInfo:

dwLineDeviceID The number of the line device being addressed.
dwAddressID The address ID for the call associated.
dwBearerMode LINEBEARERMODE_VOICE
dwRate 0

i

dwMediaMode LINEMEDIAMODE_INTERACTIVEVOICE
dwAppSpecific Retains the value passed in lineSetAppSpecific.
dwCallID Not supported by Toshiba DKT TSPI.

rel

dwRelatedCallID Not supported by Toshiba DKT TSPI.

F

IELD NAME

ary an

min

field will contain the value
LINEADDRFEATURE_MAKECALL. Otherwise, it will
be 0.

d Confident

S

ETTING

P

10 of 18

dwCallParamFla gs If this ca ll was initiated with lineMakeCall, this field will

be the same as the dwCallP aramFla gs f ield pass ed into th at
function via the LINECALLPARAMS structure.
Otherwise, it will be 0.

Strata DK I&M April 1997

TSPI Description V2.15

AB50-0003

F

IELD NAME

dwCallStates
dwMonitorDigitModes

dwMonitorMediaModes
DialParams
dwOrigin
dwReason
dwCompletionID Not supported by Toshiba DKT TSPI.
dwNumOwners 1
dwNumMonitors 0
dwCountryCode
dwTrunk Always xffffffff (Unknown)
dwCallerID Fl ags
dwCallerID Si ze

dwCallerIDOffset

dwCalledIDFlags
dwCalledIDSize

dwCalledIDOffset
dwConnectedIDFlags Not supported by Toshiba DKT TSPI
dwConnectedIDSize

dwConnectedIDOffset
dwRedirectionIDFlags Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

Provides Cal ler ID name and n umber when pro vided b y the
public network. Internal calls give caller ID number if
LCD Name is off and Caller ID name if the LCD name
feature is on.

The DNIS/DID number received and Strata DK
alphanumeric tag are provided.

d Confident

Not supported by Toshiba DKT TSPI

S

ETTING

al

i

rel

P

dwRedirectionIDSize
dwRedirectionIDOffset

dwRedirectingIDFlags Not supported by Toshiba DKT TSPI.
dwRedirectingIDSize

dwRedirectingIDOffset
dwAppNameSize

dwAppNameOffset
dwDisplayableAddressSize

min

dwDisplayableAddressOffset

i

dwCalledPartySize
dwCalledPartyOffset

dwCommentSize
dwCommentOffset

dwDisplaySize
dwDisplayOffset

ary an

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

If the call being referenced is the active call on the line,
these fields wi ll contain the contents of the two line L CD
display currently bei ng shown.

Strata DK I&M April 1997

11 of 18

AB50-0003

TSPI Description V2.15

dwUserUserInfoSize
dwUserUserInfoOffset

dwHighLevelCompSize
dwHighLevelCompOffset

dwLowLevelCompSize
dwLowLevelCompOffset

dwChargingInfoSize
dwChargingInfoOffset

lineGetCallStatus

This function returns the current status of the specified call as a data structure of type
lineCallStatus:

dwCallState This field will reflect the actual state of the call.
dwCallStateMode This field will reflect the actual mode of the state listed

dwCallPrivilege This reflects the privilege granted to the call.

F

IELD NAME

F

IELD NAME

S

ETTING

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

S

ETTING

above.

al

i

dwCallFeatures This field will indicate all of the features allowable, given

dwDevSpecificSize
dwDevSpecificOffset

lineGetID

This function returns a device ID for the specified device class associated with the selected
line, address, or call. Toshiba DKT TSPI uses this function t o identify the real device ID when
the line device was opened using LINE_MAPPER as a device ID. This function call also be
used to obtain the device ID of the phone or media (e.g., mci, waveform, mci midi, wave, fax,
etc.) associated with a call, address or line. The result in returned in a data structure
VARSTRING pointed to by lpDeviceID:

F

IELD NAME

dwStringFormat STRINGFORMAT_BINARY

min

i

dwStringSize dwStringOffset4

lineGetLineDevStatus

rel

P

This operation queries the specified open line device for its current status. If successful it
returns the current status of the specified open line device using a data structure
LineDevStatus:

the current state of the call.
Not supported by Toshiba DKT TSPI.

d Confident

ary an

A DWORD containing the ID for the line device specified.

S

ETTING

12 of 18

Strata DK I&M April 1997

TSPI Description V2.15

AB50-0003

F

IELD NAME

dwNumOpens The number of instances t his appl icat ion open ed, normal ly

1.
dwOpenMediaModes LINEMEDIAMODE_INTERACTIVEVOICE
dwNumActiveCalls The number of calls ringing and/or connected.
dwNumOnHoldCalls The number of calls that are on hold.
dwNumOnHoldPendCalls The number of calls pending in the ONHOLDPENDCONF

or the ONHOLDPENDTRANSFER states.

dwLineFeatures LINEFEATURE_MAKECALL if no active calls exist,

otherwise 0.
dwNumCallCompletions
dwRingMode Always 0.
dwSignalLevel Not supported by Toshiba DKT TSPI.
dwBatteryLevel Not supported by Toshiba DKT TSPI.
dwRoamMode LINEROAMMODE_UNAVAIL
dwDevStatusFlags The current status of the device.
dwTerminalModesSize

dwTerminalModesOffset
dwDevSpecificSize

dwDevSpecificOffset

Not supported by Toshiba DKT TSPI.

Not supported by Toshiba DKT TSPI.

d Confident

S

ETTING

al

i

lineGetAddressID

This function is used to map a phon e number assig ned to a line de vi ce back to is dwAddr essID
in the range of 0 to the number of addresses minus 1 returned in the line’s device capabilities.
LineMakeCall allows the application to make a call by specifying a line handle an address on
the line. The address can be specified either as dwAddressID, as a phone number, or as a
device specific name or identifier.

min

i

rel

P

ary an

Strata DK I&M April 1997

13 of 18

AB50-0003

Basic Call Control

lineMakeCall

This function places a call on the specified line to the specified address. The application has
the option to specify an originating address on the specified line. The TSPI models the
addresses based upon the line type when Setup was used to define the driver.

TSPI Description V2.15

If the line is busy when a call attempt is made, the currently active call will be disconnected.
If no destination address is provided, a new call will be created and the line will transition to

the LINECALLSTATE_DIALTONE state. The lineDial function can be used at this point to
dial the destination address.

LINECALLPARAMS (default)

F

IELD NAME

dwBearerMode LINEBEARERMODE_VOICE
dwMinRate

dwMaxRate
dwMediaMode LINEMEDIAMODE_INTERACTIVEVOICE
dwCallParamFlag s 0
dwAddressMode LINEADDRESSMODE_ADDRESSID
dwAddressID any available
DialParams 0, 0, 0, 0
dwOrigAddressSize

dwOrigAddressOffset
dwDisplayableAddressSize

dwDisplayableAddressOffset
dwCalledPartySize

dwCalledPartyOffset
dwCommentSize

dwCommentOffset
dwUserUserInfoSize

0 (3.1kHz )

0

d Confident

0

0

0

0

ary an

S

ETTING

al

i

P

lineDial

14 of 18

dwUserUserInfoOffset 0
dwHighLevelCompSize

dwHighLevelCompOffset

min

i

dwLowLevelCompSize
dwLowLevelCompOffset

dwDevSpecificSize
dwDevSpecificOffset

rel

This function dials the specified dialable number. Use this operation in all situations where
you need to send address information to the switch on an existing call; such as dialing the
address of the party to transfer a call, etc.

0

0

0

Strata DK I&M April 1997

TSPI Description V2.15

lineAnswer

This function accepts the specified OFFERED call. The optional user-to-user information is
ignored.

lineDrop

This function drops or disconnects the specified call, or abandons a call attempt in progress.
When this function returns, the call will be in the IDLE state. The o ptional user-to-user
information is ignored.

Because the DKT TSPI can drop calls only to which it is connect ed, this fe ature is allo wed for
calls in the CONNECTED stat e only. In addition, the service prov ider k eeps tra ck of wheth er a
given call is owned by a TAPI application, in order to avoid dropping calls initiated or
answered by other applica tions. The call is considere d o wned b y a TAPI application, it must be
either initiated, answered, or placed on hold by a TAPI application.

lineDeallocateCall

This function releases resources used to keep track of a given call. This function can only be
called while the state is idle.

AB50-0003

al

i

Holding Calls

lineHold

This function places the specified call on hard hold. This can used when in either
LINECALLSTATE_CONNECTED or LINECALLSTATE_PROCEEDING states. The
application can place a call on hold even if it did not originate or answer that call.

lineUnhold

This function retrieves the specified held call. This feature is only valid when the call is in the
LINECALLSTATE_ONHOLD state.

Transferring Calls

TAPI provides two mechanisms for call transfer: blind transfer or consultation transfer.

♦ In blind transfer, an existing call is transferred to a specified destination address in one

min

phase using lineBlindTransfer (Supported on DK280 R3 or DK16e and later systems).

i

♦ In a consultation transfer, the existing call is first prepared for transfer to another address

using lineSetupTransfer. This places the existing call on consultation hold, and identifies
the call as t he t ar ge t fo r the ne xt tr ansfer-completion request. This command al so al locat es

rel

P

a consultation call that can be used to establish the consultation call with the party to
which the call will be transferred.

The application can dial the extension of the destination party on the consultation call
using lineDial, or is can drop and deallocate the consultation call and instead activate an
existing held call (lineUnhold). Fi nally, the application comp letes the transfer of the call
on transfer hold t o the desti natio n part y b y using lineCompl eteTransfer. At thi s poin t, bot h
call appearances revert to the IDLE state.

d Confident

ary an

Strata DK I&M April 1997

15 of 18

AB50-0003

lineBlindTransfer

This function performs a single-step transfer of the specified call to the specified destination
address. The lpszDestAddress is interpreted in the same manner as lineMakeCall function.

lineSetupTransfer

This function initiates the transfer of the specified call. It establishes a consultation call,
lphdConsultCall, on which the party can be dialed that can become the destination of the
transfer. The original call transitions to the ONHOLDPENDTRANSFER state.

lineCompleteTransfer

This function completes the transfer of the specified call to the party, or enter a three-way
conference, connected in the consultation call.

Conferencing

A conference call must be gi n as re gu lar t wo -party ca ll. Addi tiona l part ies ca n be added , one a t
a time. Calling lineS etupConfer ence prepa res a gi v en cal l for the ad dition of another p arty, and
this action establishes the conference call. This operation takes the original two-party call as
input, allocates a conference call, connects the original call to the conference, and allocates a
consultation call whose handle is returned to the application.

TSPI Description V2.15

al

i

The application can then use lineDial on the consultation call to establish a connection to the
next party to be added. lineDrop can be used to abandon this call attempt. The third party is
added with the function lineAddToConference, which specifies both the conference call and
the consul tation call.

To add additional parties to an existing conference call, the application uses
linePrepareAddToConference. When calling this function, the application supplies the handle
of an existi ng conferen ce call. The function a lloca tes a consul tation c all that can later be added
to the conference cal l and retur ns a consulta tion ca ll handle t o the applic ation. This confere nce
call is then placed on conf er enc e hol d. Once the consultation call exi st s, it can be added to the
existing conference call with lineAddToConference.

Once a call becomes a member of the conference call, the member’s call state reverts to
CONFERENCED while the conference call’s state becomes CONNECTED. The call handle
to the conference call and all the added parties remain valid as individual calls.

lineSetupConference

This function sets up a conference call for the addition of the third party. The function
allocates a consultation call for connecting to the party that is to be added to the call and
returns a newly created conference call with call state of ONHOLDPENDCONF.

min

i

rel

d Confident

ary an

P

16 of 18

Strata DK I&M April 1997

TSPI Description V2.15

lineAddToConference

This function adds a consultation call, specified by hdConsultCall, to an existing conference
call, specified by hdConfCall.

linePrepareAddToConference

This function prepa res an e xi stin g conf erenc e call for the additi on of ano the r part y. It creates a
new, temporary consultation call which can subsequently be added to the conference with the
lineAddToConference function.

Call Pa rkin g

linePark

Parks a given call at another address.

lineUnpark

Retrieves a parked call.

AB50-0003

al

i

Call Forwarding

lineForward

Set or cancel call forwarding requests.

Call Pickup

linePickup

Pick up a cal l that is alerting at another station

Miscellaneous Functions

ary an

min

lineConfigDialog

rel

P

i

This function displays a configuration dialog for the DKT TSPI device. The configurable
options are the minimum number of digits necessary for an outside number and the access
code that should be used to obtain an outside line. These two parameters are used when a
complete destination address is supplied with lineMakeCall to determine whether the
destination is internal or external. Any changes made will take place immediately; the service
provider allows changes to be made while the line is open.

d Confident

Strata DK I&M April 1997

17 of 18

AB50-0003

lineSetAppSpecific

This operation sets the application-specific field of the specified call’s LINECALLINFO
structure. Its usa ge i s ent irely defined by the appl icat io n and is unint errupt ed by the Telephony
API or the service provider.

When this field is changed, the service provider sends a LINE_CALLINFO message with an
indication that the dwAppSpecific field has changed.

Commands and Messages Not Supported

lineSecureCall lineSetTerminal
lineSwapHold lineRemoveFromConference
lineSetCallParams lineSetMediaControl
lineMonitorMedia lineMonitorDigits
lineMonitorTone lineGatherDigits
lineGenerateDigits lineGenerateTone
lineAccept lineRedirect

TSPI Description V2.15

al

i

lineCompleteCall lineUncompleteCall
lineNegotiateExtVersion lineDevSpecific
lineDevSpecificFeature LINE_MONITORMEDIA
LINE_MONITORDIGITS LINE_MONITORTONE
LINE_CALLDEVSPECIFIC LINE_DEVSPECIFIC
LINE_CALLDEVSPECIFICFEATURELINE_DEVSPECIFICFEATURE

d Confident

ary an

min

i

P

18 of 18

rel

Strata DK I&M April 1997