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

202 Voice API Programming Guide — June 2005
call status transition
event handling
asynchronous 151
synchronous 151
call waiting tone 162
caller ID
accessing information 137
enabling 138
error handling 138
support 135
supported formats 135
CCITT Signaling System R2/MF tones 176
channel
definition 25
CLASS caller ID 135
cluster configuration 36
coders 89
compelled signaling, R2/MF 183
compile-time linking 190
compiling
library files 190
, 191
variables 191
CON_CAD connection type 67
CON_LPC connection type 69
CON_PAMD connection type 70
CON_PVD connection type 70
configuration
fixed/flexible routing 35
confirmation tone 162
continuous tone 160
convenience functions
dx_wtcallid( ) 137
speed and volume 113
coupled resources 36
CP_BUSY 162
CP_BUSY_VERIFY_A 162
CP_BUSY_VERIFY_B 162
CP_CALLWAIT1 162
CP_CALLWAIT2 162
CP_DIAL 162
CP_EXEC_OVERRIDE 162
CP_FEATURE_CONFIRM 162
CP_INTERCEPT 162
CP_MSG_WAIT_DIAL 162
CP_RECALL_DIAL 162
CP_REORDER 162
, 165
CP_RINGBACK1 162
CP_RINGBACK1_CALLWAIT 162
CP_RINGBACK2 162
CP_RINGBACK2_CALLWAIT 162
CP_STUTTER_DIAL 162
CT Bus 22
curses 191
Custom Local Area Signaling Services 135
D
data formats 89
data structures
clearing 35
DDI (Direct Dialing-In) service 176
DE_WINK event 42
device
definition 25
handle for 25
initializing hint 39
states of 31
device mapper functions 26
device name
definition 25
dial pulse detection 19
see Global DPD 169
dial tone 162
detection 67
dial tone (message waiting) 162
dial tone (recall) 162
dial tone (stutter) 162
Dialed Number Identification Service (DNIS) 176
DID (Direct Inward Dialing) service 176
digitizing methods 89
disabling call progress analysis, Springware 62
DM_WINK 42
DM3
call progress analysis scenarios 47
tone definitions 56
DNIS (Dialed Number Identification Service) 176
DV_DIGIT data structure 171
DV_TPT data structure 126
, 127
clearing 35
setting termination conditions 32
dx_addspddig( ) 113
dx_addtone( ) 149
used with global tone detection 148
used with tone templates 150
dx_addvoldig( ) 114
dx_adjsv( ) 114
, 118
dx_blddt( ) 149