Programmable Voice

  1. Home
  2. Docs
  3. Programmable Voice
  4. Release Notes
  5. Voice Elements Client (Developer) – Release Notes

Voice Elements Client (Developer) – Release Notes


Voice Elements Developer 8.6.4.0

Released June 24, 2019

    • Add Gate to allow clients to control incoming message requests
    • Allow client to get last SIP response
    • Correct reported issue with sips schema
    • Add proxy registration support
    • Changes to support Npcap and Win10Pcap
    • Fix issue with playing wave files that have LIST Chunks
    • Better handling of SIP redirect
    • Note: This version requires HmpElements Version 10.2.3.0 (Included with release)
  • HmpElements Updates Available for VoiceElements Developer Version 8.6.4.0
    • HMPElements Version 10.2.3.7
      • Call Progress Updates
    • HMPElements Version 10.2.3.8 (Cumulative, includes 10.2.3.7)
      • Registration Groups for Failover Added To Configuration Options
    • HMPElements Version 10.2.3.9 (Cumulative, includes 10.2.3.8)
      • Updates for TLS1.2 for both DTLS and WebSockets
      • Note:  This update requires .NET 4.6.1

Voice Elements Developer 8.6.3.0

Released November 15, 2018

    • SMS Support
    • Enhance Failover Support for Cloud Customers
    • Fix Issue related to NOTIFY messages
    • Add RegistrationResetToTagOnRenewal Setting

Voice Elements Developer 8.6.2.0

Released July 27, 2018

    • Amazon Lex Support

Voice Elements Developer 8.6.1.0

Released June 21, 2018

    • Adds Destination Group Support (Allows for failover to multiple endpoints when dialing)
    • Adds SMS Support for sending and receiving secure SMS messages

Voice Elements Developer 8.5.1.0

Released June 12, 2017

    • Version Change required by schema change in VoiceElements Server and HMPElements Server
    • Update code signatures

Voice Elements Developer 8.4.1.2

Released May 11, 2017

    • Added new DestinationGroup Class. Allows application to setup multiple outbound carriers for calls. If the primary fails, a backup carrier will automatically be used
    • Improved logging when services fail to start.
    • Improved communication with the dashboard.

Voice Elements Developer 8.4.1.1

Released Jan 16, 2017

    • SetMonitor Stream – Re-streams the current voice resource’s input to an external IP and PORT.
public void SetMonitorStream(string ipAddress, int port, string streamMode)
    • Add PingCheckTimeoutMs to config file. Allows user to control when the connection from the application to the server is considered broken. Default is 7500ms.
    • A secure connection is now the default between the application and the server. To keep your connection from being encrypted set “SecureConnection” to false in the config file.
    • Channel Reclamation and Locking Improved

Voice Elements Developer 8.3.16.822

Released August 2016

    • Record to byte[]
    • Enhance Fax Error Codes

Voice Elements Developer 8.3.15.1215

Released December 2015

    • Changes to Include RequestLine on Certain SIP calls
    • SendSipNotifyRequest
public SipStatusCode SendSipNotifyRequest(ref string sessionId, ref string dialogId, HmpUri destinationUri, HmpUri sourceUri, 
string[] inputHeaders, string[] inputSdp, out string[] outputHeaders, out string[] outputSdp, TransportProtocol transportProtocol, 
string overrideRequestLine, string overrrideDestination)
    • Improvements to Object Disposal
    • Fix Reconnection Issues in Single Client Mode
    • Add Streaming State Events
    • Add User Supplied Sip Headers for REFER
    • Various minor bug fixes

Voice Elements Developer 8.3.15.220

Released February 2015

    • TCP/TLS Support
    • Secure RTP
    • Trim Audio
public void TrimAudio(string inputWaveFile, string outputWaveFile, float vadDbTrigger, int vadDebouncerMs, int leadInTimeMs, int trailOutTimeMs)
    • Record and Follow Conversation
public TerminationCode RecordAndFollowConversation(string filename, RoutableResource resource1)
    • DialComplete Events for Blind Dials
    • Allow user to Override Destination of Sip Call
    • Cumulative Update of Proxy and IceCast Code Branches
    • Various minor bug fixes

Voice Elements Developer 8.3.14.522

Released May 2014

    • Allow user to specify Fixed Talkers for Conferencing
    • Various minor bug fixes

Voice Elements Developer 8.3.14.429

Released April 2014

  • Proxy Support
  • Various minor bug fixes

Voice Elements Developer 8.3.14.321

Released March 2014

  • IceCast Support
  • Various minor bug fixes

Voice Elements Developer 8.3.14.212

Released February 2014

  • Fast Busy Support
  • Various minor bug fixes

Voice Elements Developer 8.3.13.612

Released June 2013

  • WebRTC Support
  • Various minor bug fixes

Voice Elements Developer 8.3.13.228

Released February 2013

* Added CallProgress Events
* Added AllowTifConversionToRotate Setting to Config
* Fixed TIFConversion to handle odd size pages
* Enhanced StopDial Functioning
* Added PlayAsync Method
:: ”public void PlayAsync(string filename, PlayType playType)”
* Enhanced Streaming of Cached File on the Server
* Fix DNIS lookup during Transfer Application
* Additional Method Documentation
* Logging Class Enhancements
* Fix to Allow Offset Memory Plays
* Add Code Signing Certificates
* Kill SpeechRecognition Fix
* Allow for unlimited Additional Voice Resources
* Update CacheMode.ClientUser and CacheMode.ClientNamed
* Conference Updates (FEG, ECTail, AGCLevels)
* Update Record Conversation
* Automatic Gain Control for Conferencing
* Throw Customer Exception on Beep/Fax Detection
* Add UnregisterDNIS()
* Correct PlayTone Method Definition
* Various minor bug fixes


Voice Elements Developer 8.3.12.111

Released January 2011

* Updates to SIP REFER
* Removed Need for a Developer License
* Moved Codebase to Visual Studio 2010
* Various minor bug fixes


Voice Elements Developer 8.3.0.1125

Released July 2010

* Send Sip Options Request
:: ”public int SendSipOptionsRequest(HmpUri destinationUri, HmpUri sourceUri, string acceptHeaderValue, out string[] headers, out string[] sdp)”
* Add Beep Detection
:: ”public void BeepDetectionStart()”
:: ”public void BeepDetectionStop()”
:: ”public void BeepDetectionRestart()”

* Add Transfer Application Function
* Add Config Section for Mapped Network Drives
* Add Call Progress Templates
* Add RemoteCallControlAddress to SipChannel Class
* Allow Thread Pool Manipulation from Config
* Enhance Inter-digit Processing options
* Allow client to connect to redundant VEServers
* Increase Speed of DTMF handling
* Addressed Stability Issues on High Density Systems
* Various minor bug fixes


Voice Elements Developer 2.1.721

Released July 2010

* Append Vap Segments
:: ”public void WaveAppendFromVap(FileInformation baseFile, FileInformation vapFile, int[] vapIndicies)”

* Enhancements to TIF converter resolutions
* PDFToTIF
:: ”public void PdfToTif(string inputFile, string outputFile)”

* Additional Documentation for Various Methods
* Client To Server Stability Enhancements
* Wave File Processing Improvements
* Set Monitor Status and Data
:: ”public void SetMonitorStatus(string status)”
:: ”public void SetMonitorData(string key, string value, bool clearFlag)”

* Various minor bug fixes


Voice Elements Developer 2.1.7

Released September 2009

* New Methods added to the Telephony Server:
: ”’1. TIF To TIF converter:”’ Converts a generic TIF file to a TIF file format that Dialogic can fax.
:: ”public void TifToTif(string inputFile, string outputFile)”
: ”’2. JPG To TIF converter:”’ Converts a JPG file to a TIF file format that Dialogic can fax.
:: ”public void JpgToTif(string inputFile, string outputFile)”
: ”’3. TIF To PDF converter:”’ Converts a TIF file to a PDF. (This requires a Special Server Component. Contact Sales for more information.)
:: ”public void TifToPdf(string inputFile, string outputFile)”
: ”’4. TTS To File Function:”’ Converts Text To Speech and saves the result as a file. The output is a WAV file and the codec is usually MULAW_8Khz_8Bit. This allows you to do TTS independent of an active call.
:: ”public void TtsToFile(string ttsText, string outputFile)”
: ”’5. AppendWave Function:”’ Appends two wave files. This method tacks a wave file (appendedFile) onto the end of an existing file (baseFile). Both files must have the same format.
:: ”public void WaveAppend(string baseFile, string appendedFile)”
: ”’6. ConcatWave Function:”’ Concatenates Multiple Wave Files. All the input files are appended together and placed in a new output file. All files must have the same format.
:: ”public void WaveConcat(string[] inputFiles, string outputFile)”
* New Properties, Overloads, and Methods added to the Voice Resource:
: ”’1. GetDigits:”’ Waits for DTMF digits to arrive on the voice resource.
:: ”public TerminationCode GetDigits(int maximumDigits, int maximumTime, string terminationDigits)”
:: ”public TerminationCode GetDigits(int maximumDigits, int maximumTime, string terminationDigits, int interDigitTimeout)”
:: ”public TerminationCode GetDigits(int maximumDigits, int maximumTime, string terminationDigits, int interDigitTimeout, bool clearDigitBuffer)”
: ”’2. Drop Time:”’ A new method added to the Channel Resource. The time at which the server should automatically drop the call. This value is UniversalTime.
:: ” public DateTime DropTime”
: ”’3. StartingOffset:”’ The starting position in the file from which the next play should begin. This property is reset after each invocation. This allows you to start playing a file at the specified byte offset.
:: ”public int StartingOffset {get; set;}”
: ”’4. Multiple Play Files:”’ Plays a sequence of files, provided each file plays to completion.
:: ” public TerminationCode Play(string[] filenames)”
: ”’5. TerminationCodeFlag:”’ The termination code enumeration is actually a set of flags and on occasion, you can get more than one flag back, IE both MaxDTMF and Digit can be returned as a bitmask. The function checks to see if the specified flag is set. Returns True if the TerminationCode has the requested flag set.
:: ” public bool TerminationCodeFlag(TerminationCode searchFlag)”
* Analog Channels are returned with their own unique voice resource.
* Additional bug fixes


Voice Elements Developer 2.1.6

Released August 2009

* Conferencing Support


Voice Elements Developer 2.1.5

Released July 2009

*Version 2.1.5 now includes classes that permit sending and receiving faxes.
* Faxing requires a newly created class called a “FaxResource”
* To obtain a fax resource from the server, use the channel resource that you will be faxing from:
:m_ChannelResource.GetFaxResource();
* The fax resource is then tied to the channel resource for the duration of the faxing session.
* Once a fax resource is obtained, you can send or recevie a fax via one of the methods of the FaxResource:
: m_ChannelResource.FaxResource.Send(“MyFile.tif”);
: m_ChannelResource.FaxResource.Receive(“MyFile.tif”);
* At the conclusion of the fax operation you should dispose of the FaxResource:
:m_ChannelResource.FaxResource.Dispose();

<!– The FaxResource has the following events, properties and methods: –>

<!–* Dispose() – Disposes the FaxResource –>


Voice Elements Developer 2.1.4

* ”’TelephonyServer.GetClientVersion()”’
: Returns the Version of the Client

* ”’TelephonyServer.GetServerVersion()”’
: Returns the Version of the Server you are currently connected to.

* ”’Msi Support”’
: Entire new Class that is derived from Channel Object

* ”’Voice Recognition”’
: Added new properties to the VoiceResource object:

VoiceRecognitionEnabled.........if set to true, the system will attempt voice recognition.
VoiceRecognitionGrammarFile.....the grammar file to use
VoiceRecognitionPermitBargeIn...if set to true barge-in will terminate the play
VoiceRecognitionReturnedWord....the returned word from the recognition engine
VoiceRecognitionScore...........the score given by the recognition engine (0-999)

Persistent Connection
The client will automatically reconnect if the connection is lost. You will need to code the ConnectionLost and ConnectionRestored events.

Was this article helpful to you? Yes No