Click or drag to resize

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.4.0
Syntax
public class TelephonyServer : ClientObject

The TelephonyServer type exposes the following members.

Properties
  NameDescription
Public propertyAutoAssignVoiceResources
Specifies whether the server auomatically assigns Voice Resources to Channel Resource Objects when created. Default and recommeded is true.
Public propertyCacheMode
Defines which Sound File Cache Mode the client and server use to store and or stream audio between them.
Public propertyCacheName
The specific name of the cache to use on the server. This is valid only when using Sound File Cache Mode of "Client Named".
Public propertyDialMode
The Dial Mode to use when placing calls using the abstract Dialer class and QueueCall, or StartCall commands.
Public propertyEventableMessageRequestMethods
Public propertySmsBorderElementsPublicKeyXml
The RSA key that will allow you to send messages to the BorderElements server.
Public propertySmsMyPrivateKeyXml
Your RSA key that will allow you to recieve messages from the BorderElements server.
Public propertyStatic memberState
The Current State of the Telephony Server. This will tell you if it is running, stopped, etc.
Public propertyUrl
The URL of the Telephony Server to which this client is connected.
Public propertyUsername
The user name that was used to connect to the Telephony Server.
Public propertyVoices
An Array of valid Voices for use with TTS.
Top
Methods
  NameDescription
Public methodActiveTelephonyServerLogin
Returns the Telphony Server Login object of the currently connected telephony server. If there is no active connection this returns null.
Protected methodDispose
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).)
Public methodStatic memberExiting
Signals the Telephony Server that you are about to exit the application.
Public methodGetAllChannels
Gets all channels from the telephony server. This is only valid in Dedicated Mode and will not work in a cloud, telphony bank architecture.
Public methodGetAllVoiceResources
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.
Public methodGetChannel
Requests a Channel Resource from the Telephony Server to use for voice and calling functions.
Public methodGetChannel(Int32)
Gets an available Channel Resource using a 1 based port number scheme.
Public methodGetChannel(String)
Gets an available Channel Resource using the device name string.
Public methodGetChannel(Type)
Gets an available Channel Resource of a specific type (SipChannel, DigitalChannel, MsiChannel, T1Channel or AnalogChannel).
Public methodGetClientVersion
Returns the current version of the client Voice Elements software.
Public methodGetConference
Requests a Conference object from the Telephony Server.
Public methodGetServerInfo
Gets basic server information and returns it in a Server Info object.
Public methodGetServerVersion
Returns the current version of the client Voice Elements software.
Public methodGetVoiceResource
Requests a Voice Resource object from the Telephony Server for playing, recording and other voice functions.
Public methodIsFileCached
Checks to see if the specified file is cached on the server.
Public methodJpgToTif
Converts a Jpeg image file to a Tiff format image file that can be sent as a fax.
Public methodMessageResponse
Sends a reply to a pending request.
Public methodPdfToTif
Converts a Pdf image file to a Tiff format image file that can be sent as a fax.
Public methodRegisterDNIS
Public methodRegisterDNIS(String)
Public methodRegisterDNIS(String)
Public methodRegisterWebRtcUrl
Public methodRegisterWebRtcUrl(String)
Public methodRegisterWebRtcUrl(String)
Public methodSendSipNotifyRequest(String, String, HmpUri, HmpUri, String, String, String, String)
Send a NOTIFY request
Public methodSendSipNotifyRequest(String, String, HmpUri, HmpUri, String, String, String, String, TransportProtocol, String, String)
Send a NOTIFY request
Public methodSendSipOptionsRequest
Sends a SIP OPTIONS request to a remote UA and return its response.
Public methodSendSipSubscribeRequest
Send a SUBSCRIBE request
Public methodSessionStatsCommand(String)
Issues commands to the SessionStats engine.
Public methodSessionStatsCommand(String, Byte)
Issues commands to the SessionStats engine.
Public methodSetPingTimeoutInterval
Public methodSmsRequestUndeliveredMessages
Have the server send any undelivered messages that may have accumulated while you were offline. Use this after connecting to the Telephony Server and after you have subsribed to the SmsMessage event.
Public methodSmsSendMessage(String, String, String, String, Guid, String, String)
Allows you to send encrypted SMS messages to a BorderElements server for delivery.
Public methodSmsSendMessage(String, ListString, ListString, String, String, Guid, String, String)
Allows you to send encrypted SMS messages to a BorderElements server for delivery.
Public methodSmsSendMessage(String, String, String, String, String, Guid, String, String)
Allows you to send encrypted SMS messages to a BorderElements server for delivery.
Public methodTifToPdf(String, String)
Converts a a Tiff format image file into a Pdf file. (Requires a sepcial server component)
Public methodTifToPdf(String, String, String)
Converts a a Tiff format image file into a Pdf file. (Requires a sepcial server component)
Public methodTifToTif
Converts a Tiff and "cleans" it so it meets the special format requirements for Dialogic.
Public methodTrimAudio
Public methodCode exampleTtsToFile(String, String)
Converts the specified text string into speech and saves it as the designated file.
Public methodCode exampleTtsToFile(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.
Public methodUnregisterDNIS
Removes previously registered DNIS information.
Public methodUnregisterDNIS(String)
Removes previously registered DNIS information.
Public methodUnregisterDNIS(String)
Removes previously registered DNIS information.
Public methodUnregisterWebRtcUrl
Public methodUnregisterWebRtcUrl(String)
Public methodUnregisterWebRtcUrl(String)
Public methodWaveAppend
Appends a wave file. Both files must have the same format.
Public methodWaveAppendFromVap(String, String, Int32)
Appends Vap Segments from an indexed file to an exisiting wave file.
Public methodWaveAppendFromVap(String, String, String)
Appends VAP segments from an indexed file to an exisiting wave file.
Public methodWaveConcat
Concatenates Wave Files. All files must have the same format.
Public methodWaveGetComment
Gets a comment in the RIFF section of the wave file. Comments should be in the LIST:INFO:ICMT field.
Public methodWaveWriteComment
Writes the comment into the file.
Top
Events
  NameDescription
Public eventConnectionLost
This event fires when your connection to the Telephony Server is lost.
Public eventConnectionRestored
This event fires when your lost connection to the Telephony Server is restored.
Public eventMessageRequest
Fired when a pending Message Request needs a client response.
Public eventCode exampleNewCall
Fires when there is a new inbound call sent from the Voice Elements Server.
Public eventPortStateChange
This event fires when your lost connection to the Telephony Server is restored.
Public eventSessionStatsData
Fired when new Session Stats data is available.
Public eventSmsDeliveryReport
Fired when an SMS delivery report is received.
Public eventSmsMessage
Fired when an SMS message is received.
Top
See Also