TelephonyServer Class


TelephonyServer Class

This is the primary class providing the available methods and properties exposed by the Voice Elements Telephony Server hosting the telephony resources.

Inheritance Hierarchy

SystemObject
ClientObject
VoiceElements.ClientTelephonyServer

Namespace: VoiceElements.Client
Assembly: VoiceElementsClient (in VoiceElementsClient.dll) Version: 8.6.1.1

Syntax

C++

Copy

public class TelephonyServer : ClientObject

Public Class TelephonyServer
	Inherits ClientObject

public ref class TelephonyServer : public ClientObject

type TelephonyServer =  
    class
        inherit ClientObject
    end

The TelephonyServer type exposes the following members.

Properties

	Name	Description
	AutoAssignVoiceResources	Specifies whether the server auomatically assigns Voice Resources to Channel Resource Objects when created. Default and recommeded is true.
	CacheMode	Defines which Sound File Cache Mode the client and server use to store and or stream audio between them.
	CacheName	The specific name of the cache to use on the server. This is valid only when using Sound File Cache Mode of "Client Named".
	DialMode	The Dial Mode to use when placing calls using the abstract Dialer class and QueueCall, or StartCall commands.
	State	The Current State of the Telephony Server. This will tell you if it is running, stopped, etc.
	Url	The URL of the Telephony Server to which this client is connected.
	Username	The user name that was used to connect to the Telephony Server.
	Voices	An Array of valid Voices for use with TTS.

Top

Methods

	Name	Description
	ActiveTelephonyServerLogin	Returns the Telphony Server Login object of the currently connected telephony server. If there is no active connection this returns null.
	Dispose	This method disposes of the telephony server object and all client objects. This should be used to guarantee a clean shutdown. (Overrides ClientObject.Dispose(Boolean).)
	Exiting	Signals the Telephony Server that you are about to exit the application.
	GetAllChannels	Gets all channels from the telephony server. This is only valid in Dedicated Mode and will not work in a cloud, telphony bank architecture.
	GetAllVoiceResources	Gets all Voice Resources from the telephony server. This is only valid in Dedicated Mode and will not work in a cloud, telphony bank architecture.
	GetChannel	Requests a Channel Resource from the Telephony Server to use for voice and calling functions.
	GetChannel(Int32)	Gets an available Channel Resource using a 1 based port number scheme.
	GetChannel(String)	Gets an available Channel Resource using the device name string.
	GetChannel(Type)	Gets an available Channel Resource of a specific type (SipChannel, DigitalChannel, MsiChannel, T1Channel or AnalogChannel).
	GetClientVersion	Returns the current version of the client Voice Elements software.
	GetConference	Requests a Conference object from the Telephony Server.
	GetServerInfo	Gets basic server information and returns it in a Server Info object.
	GetServerVersion	Returns the current version of the client Voice Elements software.
	GetVoiceResource	Requests a Voice Resource object from the Telephony Server for playing, recording and other voice functions.
	IsFileCached	Checks to see if the specified file is cached on the server.
	JpgToTif	Converts a Jpeg image file to a Tiff format image file that can be sent as a fax.
	MessageResponse	Sends a reply to a pending request.
	PdfToTif	Converts a Pdf image file to a Tiff format image file that can be sent as a fax.
	RegisterDNIS
	RegisterDNIS(String)
	RegisterDNIS(String)
	RegisterWebRtcUrl
	RegisterWebRtcUrl(String)
	RegisterWebRtcUrl(String)
	SendSipNotifyRequest(String, String, HmpUri, HmpUri, String, String, String, String)	Send a NOTIFY request
	SendSipNotifyRequest(String, String, HmpUri, HmpUri, String, String, String, String, TransportProtocol, String, String)	Send a NOTIFY request
	SendSipOptionsRequest	Sends a SIP OPTIONS request to a remote UA and return its response.
	SendSipSubscribeRequest	Send a SUBSCRIBE request
	SessionStatsCommand(String)	Issues commands to the SessionStats engine.
	SessionStatsCommand(String, Byte)	Issues commands to the SessionStats engine.
	SetPingTimeoutInterval
	TifToPdf(String, String)	Converts a a Tiff format image file into a Pdf file. (Requires a sepcial server component)
	TifToPdf(String, String, String)	Converts a a Tiff format image file into a Pdf file. (Requires a sepcial server component)
	TifToTif	Converts a Tiff and "cleans" it so it meets the special format requirements for Dialogic.
	TrimAudio
	TtsToFile(String, String)	Converts the specified text string into speech and saves it as the designated file.
	TtsToFile(String, String, String)	Converts the specified text string into speech and saves it as the designated file using the voice designated in the third parameter.
	UnregisterDNIS	Removes previously registered DNIS information.
	UnregisterDNIS(String)	Removes previously registered DNIS information.
	UnregisterDNIS(String)	Removes previously registered DNIS information.
	UnregisterWebRtcUrl
	UnregisterWebRtcUrl(String)
	UnregisterWebRtcUrl(String)
	WaveAppend	Appends a wave file. Both files must have the same format.
	WaveAppendFromVap(String, String, Int32)	Appends Vap Segments from an indexed file to an exisiting wave file.
	WaveAppendFromVap(String, String, String)	Appends VAP segments from an indexed file to an exisiting wave file.
	WaveConcat	Concatenates Wave Files. All files must have the same format.
	WaveGetComment	Gets a comment in the RIFF section of the wave file. Comments should be in the LIST:INFO:ICMT field.
	WaveWriteComment	Writes the comment into the file.

Top

Events

	Name	Description
	ConnectionLost	This event fires when your connection to the Telephony Server is lost.
	ConnectionRestored	This event fires when your lost connection to the Telephony Server is restored.
	MessageRequest	Fired when a pending Message Request needs a client response.
	NewCall	Fires when there is a new inbound call sent from the Voice Elements Server.
	PortStateChange	This event fires when your lost connection to the Telephony Server is restored.
	SessionStatsData

Top

Reference

VoiceElements.Client Namespace