CTI32 Class Library

cti Methods

The methods of the cti class are listed below. For a complete list of cti class members, see the cti Members topic.

Public Static (Shared) Methods

AddStreamBuffer Add a to the buffer a stream coming off the internet
AddToConf Adds a participant to an established conference.
AllocateStream Allocate a handle for doing plaing a file from the internet as it is downloading.
AppendToWave Append a Wave file recorded by Dialogic to an existing Wave file of the same type
BlindTransfer Blind Transfer Implementation For Global Call
CallTime Returns the call length in seconds from the time of the Answer until now
CheckLicense Check whether we have a valid demo license.
ClearDigitBuffer Clears out the digit buffer.
CloseDCB Closes the DCB board or channel device you have previously opened with OpenDCB.
CloseGCPort Close a port opened with Global Call. (CTIOpenGCPort).
CloseISDNPort a single channel on a Dialogic board.
CloseStation Closes the MSI board or channel device you have previously opened with CTIOpenStation.
CloseT1Port Closes a single channel on a Dialogic board.
CloseVoicePort Close voice resource device
ClrCap Clear Call Analysis parameters.
ConfFlushDtmf Vendetta specific. Flush Vendetta conference DTMF digits from a user or the entire Vendetta buffer.
ConfGetDtmf Vendetta specific. Gets a single digit from the Vendetta DTMF buffer. You can specify a specific user or get a digit from anyone by passing -1 in dev.
ConfMusicOnHold Vendetta specific. Puts music into the conference from the Vendetta music on hold port in the back of the card. You can also turn off the music with this function
ConfMuteChannel Vendetta specific. Mutes / Un-mutes a person from the conference.
ConfSetVolume Vendetta specific. Sets the speakers transmit or receive volume to a specified level.
CustomRead Reads data from a custom stream
CustomSeek Positions the file pointer to the specified location. (CUSTOM)
CustomWrite Writes data to a stream
DChannelTrace Start a DChannel trace
DeallocateStream Free the allocated stream handle.
DelConf Tears down an established conference.
DelExtCon Tears down an established extended connection.
Dial Dials a phone number on a specified channel. Optionally, call progress can be enabled. Which channel device handle you call here can get a little tricky. For Analog and T-1, you should have already taken the phone off hook and routed to a voice resource. You should pass the voice resource chdev. For ISDN, you should NOT call the SetHook() function but simply call CTIDial(). You should pass the ISDN channel device. If you want this command to simply dial tones, pass the voice chdev even for ISDN.
DialE1 Special E1 version of CTIDial. Dials a phone number on a specified channel. Optionally, call progress can be enabled. Which channel device handle you call here can get a little tricky. For Analog and T-1, you should have already taken the phone off hook and routed to a voice resource. You should pass the voice resource chdev. For ISDN, you should NOT call the SetHook() function but simply call CTIDial(). You should pass the ISDN channel device. If you want this command to simply dial tones, pass the voice chdev even for ISDN.
DisableFaxResource Informs CTI32 to disable a fax port
EnableFaxResource Informs CTI32 to enable a fax port
EstConf Establishes a conference on an MSI Board with up to 4 participants. A conference can be up to 8 participants, but you must use the CTIAddToConf() function to add the other 4.
EstExtCon Adds a third party to an already established routed (bridged) call. The “extended connection” must be made to a MSI station device. The extended device (new person) can be either a MSI station or a DTI, or LSI device.
FaxCancel Cancels a fax running on a different thread.
FileClose Closes a file you have previously opened with CTIFileOpen.
FileOpen Opens a file in a compatible mode with Dialogic driver.
FileRead Reads data from a file into a buffer.
FileSeek Positions the file pointer to the specified location.
FileWrite Writes data to a file from a buffer.
FreeFaxResource Frees a fax resource.
GetAnalogCallerId For Analog lines: Get the Caller's ID (number). Note: You must enable this feature in the OpenVoicePort method using perfectcall=2 or 3. Exception is never thrown.
GetBytesPlayed Returns number of bytes played on the last Play() command.
GetCallNumber Gets a persistant call number
GetCapResult Gets a Cap parameter result.
GetComfortCSP Get the current setting for the Comfort noise for CSP
GetDigits Gets digits from a channel. You can specify how many digits, terminating digits, maximum time etc..
GetEosDelay Get the current setting for the EndOfSpeech Delay for CSP
GetFaxResource Gets a fax resource
GetFaxResult Get detailed results of a fax operation.
GetLastCauseCodes For PRI lines (or Global Call) – returns the last ISDN or GlobalCall cause values for the last DISCONNECT or ISDN Error event on the channel. This can be helpful in determining the reason for the call failure in the event of a CR_ERROR dialing return code.
GetLastCauseValue For PRI lines – returns the last ISDN cause value for the last DISCONNECT or ISDN Error event on the channel.
GetParmInt Gets the current board or channel parameter. (Dialogic).
GetSilenceOverloaded. Waits for X deciseconds of continuous silence before returning or until 30 seconds of non-silence elapses.
GetSipStats Get Data About Current SIP Session
GetStationHookState Get whether the MSI station is onhook or not
GetTimeSlot Returns the Dialogic timeslot for a given device.
HalfRoute This performs an SCbus route or unroute between a CTI controlled device and any given timeslot. Useful in interfacing to non-supported devices.
InitializeFax Initializes the Gammalink fax ports in the system. You should call this function once on program entry. You can initialize the entire range of fax ports all at the same time. For example, if you had a CP-12 / SC board, (contains 12 fax resources) you would pass 1,12 and all the fax ports would be initialized and ready to go.
ISDN_AcceptCall Issues an ISDN AcceptCall - handy for not actually answering the ISDN phone line
ISDN_DChan_State Gets the current state of the D-Channel on an ISDN board
ISDN_DNIS_ANI Get the Dialed number and the Caller's ID (number). If ANI or DNIS is not available returns non-zero. Exception is never thrown.
ISDN_DNIS_ANI_EX Get the Dialed number and the Caller's ID (number + name). If ANI or DNIS is not available returns non-zero. Exception is never thrown.
ISDN_Restart Sests a PRI channel out of service.
ISDN_SetChanState Sets the PRI channel in service or out of service
ISDN_Shutdown Shutdown any ISDN channels.
IsFaxPortReady Is the port ready after a cancel
IsHangUp Check to see if device is hung up
IsStreamDone Check to see if stream is done.
LastPlay Tick when the channel last did something.
MonitorConf Puts the conference on the SCBus so that any device can CTIHalfRoute() or listen only to the conference.
MonitorSilence Returns the number of milliseconds of silence detected on the voice resource over the specified interval of time.
OpenDCB Opens a channel or board on an DCB conference board.
OpenGCPort Open a channel using Global Call. This is primarily used for support for DM/V boards.
OpenISDNPort Opens a single channel on a Dialogic board DTI Interface. When you are using a T1 board, you must open the DTI interface (this function call) AND the voice resource port. For SCbus programming, you must the CTIRoute() them together. The function also can be used to open the board to set board-level parameters.
OpenStation Opens a channel or board on an MSI station adaptor.
OpenT1Port Opens a single channel on a Dialogic board DTI Interface. When you are using a T1 board, you must open the DTI interface (this function call) AND the voice resource port. For SCbus programming, you must the CTIRoute() them together. The function also can be used to open the board to set board-level parameters.
OpenVoicePort Opens a single channel on a Dialogic board. This call can also be used to open up a board level resource so that you can CTISetParm() various Dialogic board level parameters.
PbxCallInfo Gets the called/calling number from a PBX board
PbxDisplay Retrieves the current LCD/LED display data.
PlayOverloaded. Plays a prompt or message out the specified channel. The voice message can come from one of 4 sources. 1. Play an entire file from beginning to end. 2. Play specifed prompts from a single indexed voice file (VAP). 3. Play a message from memory. 4. Play prompts from a memory VAP (indexed voice file). 5. Play prompts from a file based VAP file with the index portion of the VAP loaded in memory. In addition to specifying the source of the file, you must specify the voice file format and speed. You must also specify the various ways the play may terminate.
PlayAndRecognizeWordOverloaded. Play a file and recognize a single word using the installed speech recognition engine. You must have a CSP enabled port in order to use this function
PlayCharsOverloaded. Play characters one after the other such as a airline confirmation number.
PlayDateOverloaded. This intelligently speaks a date that you pass.. For example, "19940121" would be spoken January twenty-first Nineteen Nighty Four. The VAP file name that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the "SYSTEM VAP FORMAT" appendix. The SYSTEM VAP file can either be on disk or in memory. If you wish for a certain segment of the date be skipped, replace the numbers with XX. For example, XXXX0121 would speak January Twenty-First. The date format must by in YYYYMMDD format.
PlayDateSpanishOverloaded. (Spanish) This intelligently speaks a date that you pass.. For example, "19940121" would be spoken January twenty-first Nineteen Nighty Four. The VAP file name that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the "SYSTEM VAP FORMAT" appendix. The SYSTEM VAP file can either be on disk or in memory. If you wish for a certain segment of the date be skipped, replace the numbers with XX. For example, XXXX0121 would speak January Twenty-First. The date format must by in YYYYMMDD format.
PlayError This plays a generic system error file. It is intended to tell the user that the system is broken and to call a customer service representative to notify them.
PlayNumberOverloaded. This intelligently speaks a string of numbers. For example, “1234” would be spoken One thousand two hundred thirty-four. The VAP file name that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the "SYSTEM VAP FORMAT" appendix. The SYSTEM VAP file can either be on disk or in memory.
PlayNumberSpanishOverloaded. (Spanish) This intelligently speaks a string of numbers. For example, “1234” would be spoken One thousand two hundred thirty-four. The VAP file name that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the "SYSTEM VAP FORMAT" appendix. The SYSTEM VAP file can either be on disk or in memory.
PlayOrdinalOverloaded. Plays 1st, 2nd, 101st (one hundred first) etc.
PlayStream Play a file from over a network. Play as it is downloading.
PlayTimeOverloaded. This intelligently speaks a time that you pass.. For example, 23:01 would be spoken Eleven oh-one PM.. The VAP file handle that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the SYSTEM VAP FORMAT appendix. The SYSTEM VAP file can either be on disk or in memory. Expects time format as HH:MM. (With a colon in the middle – exactly 5 characters)
PlayTimeSpanishOverloaded. (Spanish) This intelligently speaks a time that you pass.. For example, 23:01 would be spoken Eleven oh-one PM.. The VAP file handle that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the SYSTEM VAP FORMAT appendix. The SYSTEM VAP file can either be on disk or in memory. Expects time format as HH:MM. (With a colon in the middle – exactly 5 characters)
PlayTone Plays a customized tone out the voice resource.
PlayTTSOverloaded. This is the Text To Speech function. It plays the given string using the Microsoft SAPI engine. The Microsoft speech engine must be installed, or this routine will return a -1. See CTI32 Guide for instructions on how to download and install.
PlayTTSAndRecognizeWordOverloaded. Play a Text-To-Speech string and recognize a single word using the installed speech recognition engine. You must have a CSP enabled port in order to use this function
PlayTTSAndRecognizeWordWOverloaded. Play a Text-To-Speech string and recognize a single word using the installed speech recognition engine. You must have a CSP enabled port in order to use this function
PlayTTSWOverloaded. This is the Text To Speech function. It plays the given string using the Microsoft SAPI engine. The Microsoft speech engine must be installed, or this routine will return a -1. See CTI32 Guide for instructions on how to download and install.
ReceiveFax Receives a fax on a Gammalink CP-X board. Prior to calling this method, you should have routed the fax channel to a telephone resource.
RecordOverloaded. Records a prompt or message from the specified channel. The voice recording can go to one of 3 destinations. 1. Record to a specific file.. 2. Record into a specific prompt in an indexed voice file (VAP). 3. Record into memory buffer of a specified size. Recording into a memory (VAP) structure is not supported. In addition to specifying the destination of the file, you must specify the voice file format and speed. You must also specify the various ways the recording may terminate.
RecordConversationOverloaded. Records a prompt or message from the specified channel. The voice recording can go to one of 3 destinations. 1. Record to a specific file.. 2. Record into a specific prompt in an indexed voice file (VAP). 3. Record into memory buffer of a specified size. Recording into a memory (VAP) structure is not supported. In addition to specifying the destination of the file, you must specify the voice file format and speed. You must also specify the various ways the recording may terminate.
RemFromConf Removes a participant from an established conference.
RestartBChannel Try to re-start the B-channel on the specified channel
RestartBChannelChdev Try to re-start the B-channel based on the channel device handle
RingStation Rings an MSI station.
Route This performs an SCbus route or unroute between two SCbus channels.
SendEmail Sends out an e-mail over the internet.
SendFax Sends a fax. Prior to making this call, you should have routed the fax channel to a telephone resource. You should have dialed a phone number before calling this function.
SendStatsReport Send out the nightly stats report
SetCallBack Sets the method to call on a new call.
SetCap Sets a Cap parameter. The cap structure controls the behaivor of Call progress.
SetComfortCSP Set the wait time before the CSP comfort tone starts playing after the barge-in event. Also sets the file to play. ///
SetConfAttributes Prior to one of the conferencing calls, you may want to set a device’s channel attributes describing the party’s properties within the conference.
SetDialOption Sets outbound call options for PRI lines: Options are: T1 - USA, E1 - Europe, Avaya - Custom Avaya switch, SDN - ATT SDN
SetDigType Sets the type of tones to listen to in CTIGetDigits. This is used to set to DTMF or MF tones.
SetEndOfData Set when there are no more buffers to add to the stream
SetEosDelay Set the EndOfSpeech Delay for CSP
SetFaxCallBack Set the method to call on a Fax Page Break
SetFaxMode Sets the fax mode for the resource. Valid Only When FAX_API in CTI32.ini is set To Manual Mode (3) --- 0=V.17, 1=T.38
SetGCOption Set some options which will control the behavior of the Global Call interface.
SetGlobalTone Sets up a global tone detection template. This is helpful in detecting a fax machine tone.
SetHangupCallBack Sets the method to call on a hangup.
SetHook : Puts a channel on-hook or takes a channel off-hook.
SetParmInt Sets the current board or channel parameter. (Dialogic).
SetSpeed Sets the play speed of the voice file.
SetStatistic Sets the CTI32 Statistic
SetStdCspCallBack Sets or Resets the Delegate For the CSP Callback
SetStdUio Sets the callback for a chdev. For use with UIO streaming.
SetVolume Set the volume on a channel.
ShutdownFax Shuts down the Gammalink fax ports in the system. You should call this function once on program exit. You can shut down the entire range of fax ports all at the same time. For example, if you had a CP-12 / SC board, (contains 12 fax resources) you would pass 1,12 and all the fax ports would be shut down and ready to go.
SipHeadersAdd Adds a Sip header for the next Sip instruction.
SipHeadersClear Clears the pending Sip headers for the next Sip instruction.
SipRefer Execute Blind Sip Transfer
SipReinvite Issue SIP Reinvite
SoftPhoneDestroy Destroy the softphone
SoftPhoneInitialize Initialize the softphone
SoftPhoneStart Start the softphone
SoftPhoneStop Stop The Softphone
Start Starts the CTI System. This must be the first call into the CTI32 Library.
StartTrace Start a D-channel trace
StationVolume Adjusts or resets the volume on a given MSI station channel.
Stop Stop the CTI32 toolkit - Call this on shutdown.
StopChannel Stop a file from playing or recording.
StopDial Stop Dialing in progress.
StopTrace Stop the D-channel trace.
TBCT Two B-Channel transfer. Hooks two PRI channels together at the switch and drops the lines from the IVR.
UnmonitorConf Closes the monitor stream previously started with CTIMonitorConf().
Version Version of CTI32
WaitEvent Wait for a specific event
WaitForHangup Wait for a hangup event
WaitForOffhook Wait for an MSI station to go offhook. This may be important to indicate the station wants to make an outbound call.
WaitForRing Waits for a specified number of rings before returning. This works both for analog, T-1 lines, and ISDN. For T-1 or ISDN lines, the NumRings parameter is not used. Note: This function does NOT take the channel OFF HOOK. You must do that by calling CTISetHook.
WaitForWink Wait for a wink event
Wink Send a wink to the carrier
ZipAndSendLogs Zip up and send all log files for this machine.
ZiptoneStation Sends a tone to an operator on the specified MSI station.

Public Instance Methods

CreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component)Overloaded. Releases all resources used by the Component.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetType (inherited from Object) Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
ToString (inherited from Component) 

Protected Instance Methods

Dispose (inherited from Component)Overloaded. Releases the unmanaged resources used by the Component and optionally releases the managed resources.
Finalize Destructor
GetService (inherited from Component) Returns an object that represents a service provided by the Component or by its Container.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

cti Class | CTI32NetLib Namespace