VoMS™1.0 (Voice Message Services) User's Guide Copyright © SoftTree Technologies, Inc. 2005 All rights reserved Contents Table of Contents Table of Contents ............................................................................................................................ 3 About this guide............................................................................................................................... 6 INTENDED AUDIENCE..................................................................................................................................... 6 CONVENTIONS USED IN THIS DOCUMENT ......................................................................................................... 6 ABBREVIATIONS AND PRODUCT REFERENCE TERMS.......................................................................................... 7 TRADEMARKS .............................................................................................................................................. 7 CHAPTER 1, How VoMS works..................................................................................................... 8 MESSAGE PROCESSING WORKFLOW ............................................................................................................... 8 Components ........................................................................................................................................ 8 Workflow.............................................................................................................................................. 9 SUPPORTED VOICE MESSAGING METHODS AND FORMATS.................................................................................10 CHAPTER 2, Sending voice messages ....................................................................................... 11 OVERVIEW .................................................................................................................................................11 MESSAGE SENDING METHODS.......................................................................................................................11 CREATING PRE-RECORDED SOUND MESSAGES AND MESSAGE SEGMENTS ..........................................................12 CREATING DYNAMICALLY SYNTHESIZED VOICE MESSAGES AND MESSAGE SEGMENTS ..........................................12 CHAPTER 3, VoMS Client API.....................................................................................................14 OVERVIEW OF VOMS CLIENT API METHODS .................................................................................................14 Instantiating VoMS client ....................................................................................................................14 Connecting to VoMS server................................................................................................................14 Querying connection status ................................................................................................................14 Sending messages .............................................................................................................................14 Obtaining last message ID .................................................................................................................15 Querying client processing status.......................................................................................................15 Querying message processing status.................................................................................................15 Validating WAV file consistency .........................................................................................................16 Disconnecting from VoMS server .......................................................................................................16 COM INTERFACE........................................................................................................................................16 About COM Interface..........................................................................................................................16 Using COM API in Your Program .......................................................................................................16 A Quick Example: Visual Basic application ........................................................................................17 Instantiating VoMS client ....................................................................................................................18 Destroying VoMS client ......................................................................................................................19 CloseSession......................................................................................................................................21 GetLastMessageID.............................................................................................................................22 - 3 - Contents GetLastError.......................................................................................................................................23 GetMessageStatus .............................................................................................................................24 GetStatus ...........................................................................................................................................25 IsConnected .......................................................................................................................................26 OpenSession......................................................................................................................................27 SendMessage.....................................................................................................................................29 ValidateWavFile..................................................................................................................................31 DLL INTERFACE..........................................................................................................................................32 About DLL Interface............................................................................................................................32 Using DLL API in Your Program.........................................................................................................32 A Quick Example: Visual Basic application ........................................................................................32 Instantiating VoMS client ....................................................................................................................34 Destroying VoMS client ......................................................................................................................35 VOMS_CheckWavFileFormat.............................................................................................................37 VOMS_Connect..................................................................................................................................38 VOMS_Disconnect .............................................................................................................................40 VOMS_GetLastError ..........................................................................................................................41 VOMS_GetStatus ...............................................................................................................................43 VOMS_IsConnected...........................................................................................................................44 VOMS_SendMessage ........................................................................................................................45 CHAPTER 4, VoMS Command Line Interface............................................................................. 47 CHAPTER 5, Sample Programs and Code Examples................................................................. 49 VISUAL BASIC .............................................................................................................................................49 DELPHI ......................................................................................................................................................49 C/C++.......................................................................................................................................................49 POWERBUILDER .........................................................................................................................................49 VBSCRIPT..................................................................................................................................................49 JAVASCRIPT ...............................................................................................................................................50 PERL .........................................................................................................................................................50 CHAPTER 6, Installation and Uninstallation ................................................................................ 51 SERVER INSTALLATION ................................................................................................................................51 CLIENT INSTALLATION..................................................................................................................................52