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
138 Voice API Programming Guide — June 2005
Caller ID
11.4 Enabling Channels to Use the Caller ID Feature
During Intel Dialogic System Service startup, before the initial use of caller ID functions, the
application must enable the caller ID feature on the channels requiring caller ID.
On Springware boards, caller ID is enabled by setting the DXCH_CALLID channel-based
parameter to DX_CALLIDENABLE using dx_setparm( ). The default setting is caller ID
disabled, DX_CALLIDDISABLE. Caller ID on DM3 boards is available via the Global Call API.
For more information, see the Global Call Technology User’s Guide for your technology.
11.5 Error Handling
When the caller ID function completes, check the return code:
• If the caller ID function completes successfully, the buffer will contain the caller ID
information.
• If the caller ID function fails, an error code will be returned that indicates the reason for the
error. The call is still active when the error is returned.
When using the dx_gtextcallid( ) function, error codes depend upon the Message Type ID
argument (infotype) passed to the function. All Message Types can produce an EDX_CLIDINFO
error. Message Type CLIDINFO_CALLID can also produce EDX_CLIDOOA and
EDX_CLIDBLK errors.
When using the dx_gtcallid( ) caller ID function, if an error is returned indicating that the caller’s
phone number (DN) is blocked or out of area, other information (for example, date or time) may be
available by issuing the dx_gtextcallid( ) caller ID function. The information that is available,
other than the caller’s phone number, is determined by the CO.
11.6 Caller ID Technical Specifications
For information about caller ID technical specifications, contact the appropriate authority and
request the technical references you require:
CLASS
CLASS documents are published by Telcordia Technologies (previously Bellcore). To obtain a
copy of these technical references, call 1-800-521-2673 (from the U.S. and Canada) or +1-
732-699-5800 (worldwide), or visit http://www.telcordia.com. Note that Bellcore is now
known as Telcordia Technologies.
• TR-NWT-000031 (issue 4) CLASS Feature Calling Number Delivery
• TR-NWT-001188 CLASS Feature Calling Name Delivery Generic Requirements
• TR-NWT-000030 (issue 2) Voice Data Transmission Interface Generic Requirement
ACLIP
Contact the Telecommunications Authority of Singapore and Telcordia Technologies.
• TAS TS PSTN1 A-CLIP: 1994