User's Manual
Table Of Contents
- Contents
- Figures
- Tables
- Revision History
- About This Publication
- 1. Product Description
- 2. Programming Models
- 3. Device Handling
- 4. Event Handling
- 5. Error Handling
- 6. Application Development Guidelines
- 7. Call Progress Analysis
- 7.1 Call Progress Analysis Overview
- 7.2 Call Progress and Call Analysis Terminology
- 7.3 Call Progress Analysis Components
- 7.4 Using Call Progress Analysis on DM3 Boards
- 7.5 Call Progress Analysis Tone Detection on DM3 Boards
- 7.6 Media Tone Detection on DM3 Boards
- 7.7 Default Call Progress Analysis Tone Definitions on DM3 Boards
- 7.8 Modifying Default Call Progress Analysis Tone Definitions on DM3 Boards
- 7.9 Call Progress Analysis Errors
- 7.10 Using Call Progress Analysis on Springware Boards
- 7.11 Call Progress Analysis Tone Detection on Springware Boards
- 7.12 Media Tone Detection on Springware Boards
- 7.13 Default Call Progress Analysis Tone Definitions on Springware Boards
- 7.14 Modifying Default Call Progress Analysis Tone Definitions on Springware Boards
- 7.15 SIT Frequency Detection (Springware Only)
- 7.15.1 Tri-Tone SIT Sequences
- 7.15.2 Setting Tri-Tone SIT Frequency Detection Parameters
- 7.15.3 Obtaining Tri-Tone SIT Frequency Information
- 7.15.4 Global Tone Detection Tone Memory Usage
- 7.15.5 Frequency Detection Errors
- 7.15.6 Setting Single Tone Frequency Detection Parameters
- 7.15.7 Obtaining Single Tone Frequency Information
- 7.16 Cadence Detection in Basic Call Progress Analysis (Springware Only)
- 8. Recording and Playback
- 8.1 Overview of Recording and Playback
- 8.2 Digital Recording and Playback
- 8.3 Play and Record Functions
- 8.4 Play and Record Convenience Functions
- 8.5 Voice Encoding Methods
- 8.6 G.726 Voice Coder
- 8.7 Transaction Record
- 8.8 Silence Compressed Record
- 8.9 Recording with the Voice Activity Detector
- 8.10 Streaming to Board
- 8.11 Pause and Resume Play
- 8.12 Echo Cancellation Resource
- 9. Speed and Volume Control
- 10. Send and Receive FSK Data
- 11. Caller ID
- 12. Cached Prompt Management
- 13. Global Tone Detection and Generation, and Cadenced Tone Generation
- 13.1 Global Tone Detection (GTD)
- 13.1.1 Overview of Global Tone Detection
- 13.1.2 Global Tone Detection on DM3 Boards versus Springware Boards
- 13.1.3 Defining Global Tone Detection Tones
- 13.1.4 Building Tone Templates
- 13.1.5 Working with Tone Templates
- 13.1.6 Retrieving Tone Events
- 13.1.7 Setting GTD Tones as Termination Conditions
- 13.1.8 Maximum Amount of Memory for Tone Templates
- 13.1.9 Estimating Memory
- 13.1.10 Guidelines for Creating User-Defined Tones
- 13.1.11 Global Tone Detection Application
- 13.2 Global Tone Generation (GTG)
- 13.3 Cadenced Tone Generation
- 13.3.1 Using Cadenced Tone Generation
- 13.3.2 How To Generate a Custom Cadenced Tone
- 13.3.3 How To Generate a Non-Cadenced Tone
- 13.3.4 TN_GENCAD Data Structure - Cadenced Tone Generation
- 13.3.5 How To Generate a Standard PBX Call Progress Signal
- 13.3.6 Predefined Set of Standard PBX Call Progress Signals
- 13.3.7 Important Considerations for Using Predefined Call Progress Signals
- 13.1 Global Tone Detection (GTD)
- 14. Global Dial Pulse Detection
- 14.1 Key Features
- 14.2 Global DPD Parameters
- 14.3 Enabling Global DPD
- 14.4 Global DPD Programming Considerations
- 14.5 Retrieving Digits from the Digit Buffer
- 14.6 Retrieving Digits as Events
- 14.7 Dial Pulse Detection Digit Type Reporting
- 14.8 Defines for Digit Type Reporting
- 14.9 Global DPD Programming Procedure
- 14.10 Global DPD Example Code
- 15. R2/MF Signaling
- 16. Syntellect License Automated Attendant
- 17. Building Applications
- Glossary
- Index

Voice API Programming Guide — June 2005 207
TID_SIT_ANY 52
TID_SIT_IC 52
TID_SIT_INEFFECTIVE_OTHER 52
TID_SIT_IO 52
TID_SIT_NC 52
TID_SIT_NC_INTERLATA 52
TID_SIT_NO_CIRCUIT 52
TID_SIT_NO_CIRCUIT_INTERLATA 52
TID_SIT_OPERATOR_INTERCEPT 52
TID_SIT_REORDER_TONE 52
TID_SIT_REORDER_TONE_INTERLATA 52
TID_SIT_RO 52
TID_SIT_RO_INTERLATA 52
TID_SIT_VACANT_CIRCUIT 52
TID_SIT_VC 52
TN_GEN data structure 156
TN_GENCAD data structure 157
, 160
tone definitions
DM3 56
modifying, DM3 57
modifying, Springware 71
Springware 71
tone detection
call progress analysis, DM3 51
call progress analysis, Springware 66
global tone detection 147
tone generation
cadenced 157
tone template
DM3 56
Springware 71
tone templates
building 149
, 150
functions used 150
global tone detection 148
tone types
call progress analysis 66
call progress analysis, DM3 51
TONE_DATA data structure 58
TONE_SEG data structure 58
tones
cadenced, custom 157
maximum number for global tone detection 153
maximum number for global tonedetection 154
predefined standard PBX 160
transaction record 92
TrueSpeech voice coder 90
trunks busy 162
two-way ADSI 124
implementing 131
, 132
technical overview 130
two-way FSK 124
U
user-defined I/O functions 35
user-defined tones
building tone templates 148
definition 147
tp_data 152
tp_termno 152
V
VAD
see voice activity detector 95
variables
compiling and linking 191
virtual board
definition 25
voice activity detector (VAD) 95
voice coders 89
voice encoding methods 89
voice library 189
voice profile for internet messaging (VPIM) 91
voice.prm 94
volume control
adjustment digits 118
adjustment functions 114
convenience functions 113
explicitly adjusting 118
modification tables 114
on DM3 boards 117
setting adjustment conditions 118
VPIM 91
W
wink
inbound 42
setting delay 41
setting duration 41