Dialogic 05-0867-005 User Manuals

Table of Contents

• 1. How To Use This Guide

  1
• 1.1. Products Covered by this Guide

  1
• 1.2. Organization of this Guide

  1
• 2. Introduction to Dialogic ISDN Products

  3
• 2.1. The Basic Rate Interface

  3
• 2.1.1. Features of BRI

  4
• 2.1.2. Typical BRI Applications

  7
• 2.2. The Primary Rate Interface

  7
• 2.2.1. Benefits of PRI

  8
• 2.2.2. PRI Configurations and Applications

  9
• 2.3. Dialogic ISDN Protocol Support

  11
• 3. ISDN Technology Overview

  13
• 3.1. Signaling

  13
• 3.2. Framing

  14
• 3.2.1. Data Link Layer (Layer 2) Frames

  14
• 3.2.2. Network Layer (Layer 3) Frames

  14
• 3.3. ISDN Call Control States

  15
• 3.3.1. Asynchronous Call Establishment

  17
• 3.3.2. Synchronous Call Establishment

  20
• 3.3.3. Asynchronous Call Termination

  23
• 3.3.4. Synchronous Call Termination

  25
• 4. ISDN Function Overview

  29
• 4.1. ISDN Library Function Categories

  29
• 4.2. API Functions and Supported ISDN Technologies

  40
• 5. ISDN Function Reference

  45
• 5.1. Function Description Format

  45
• 5.2. Programming Conventions

  47
• 5.3. Function References: CRNs, CRVs, and Line Device Handles

  47
• 5.4. Interpreting Function Call Failures

  48
• cc_AcceptCall( ) - responds to an incoming call request

  50
• cc_AnswerCall( ) - accepts a connection request from the remote end

  53
• cc_CallAck( ) - send the first response to an incoming call

  56
• cc_CallProgress( ) - sends a PROGRESS message to the network

  60
• cc_CallState( ) - retrieves the state of a call

  63
• cc_CauseValue( ) - retrieves the error/cause code of a failure

  67
• cc_Close( ) - closes a previously opened line device

  70
• cc_CRN2LineDev( ) - matches a CRN to its line device handle

  73
• cc_DropCall( ) - allows the application to disconnect a call

  75
• cc_GetBChanState( ) - retrieves the status of the B channel

  83
• cc_GetBilling( ) - gets the call charge information

  86
• cc_GetCallInfo( ) - gets the information elements associated with the CRN

  89
• cc_GetCES( ) - retrieves the connection endpoint suffix

  93
• cc_GetChanId( ) - gets the last channel information

  96
• cc_GetCRN( ) - retrieves the call reference number for the event

  101
• cc_GetDChanState( ) - retrieves the status of the D channel

  104
• cc_GetDLinkCfg( ) - retrieves the configuration of a logical link

  107
• cc_GetDLinkState( ) - retrieves the logical data link state

  109
• cc_GetDNIS( ) - gets the dialed number information string

  112
• cc_GetEvtMsk( ) - retrieves the current ISDN event mask

  115
• cc_GetFrame( ) - retrieves the frame

  119
• cc_GetLineDev( ) - retrieves the line device handle for an event

  125
• cc_GetMoreDigits( ) - collects more digits via overlap receiving

  127
• cc_GetNetCRV( ) - retrieves the network call reference value

  131
• event

  134
• cc_GetParm( ) - gets the current parameter values of the line device

  138
• cc_GetParmEx( ) - retrieve parameters containing variable data

  144
• cc_GetSAPI( ) - retrieves the service access point ID

  148
• cc_GetSigInfo( ) - gets the signaling information of an incoming message

  151
• cc_GetUsrAttr( ) - gets the established attribute for the line device

  156
• cc_GetUsrAttr( ) - gets the established attribute for the line device

  156
• cc_GetVer( ) - retrieves the firmware version number

  159
• cc_HoldAck( ) - accept a hold request from remote equipment

  161
• cc_HoldCall( ) - place an active call on hold

  164
• cc_HoldRej( ) - reject a hold request from remote equipment

  167
• cc_MakeCall( ) - request a connection to make an outgoing call

  170
• cc_Open( ) - opens a device

  176
• cc_PlayTone( ) - play a user-defined tone

  179
• cc_ReleaseCall( ) - release all internal resources

  183
• cc_ReleaseCallEx( ) - release all Dialogic ISDN resources

  186
• cc_ReqANI( ) - returns the caller ID

  190
• cc_Restart( ) - resets the channel to Null state

  194
• cc_ResultMsg( ) - interprets the function return code

  198
• cc_ResultValue( ) - gets an error/cause code

  201
• cc_RetrieveAck( ) - accept a request to retrieve a call from hold

  204
• cc_RetrieveCall( ) - retrieve a call from the Hold state

  207
• cc_RetrieveRej( ) - reject a request to retrieve a held call

  210
• cc_SetBilling( ) - sets the billing rate for Vari-A-Bill services

  214
• cc_SetCallingNum( ) - sets the default calling party number

  218
• cc_SetChanState( ) - change the maintenance state of a specified B channel

  221
• cc_SetDChanCfg( ) - sets the configuration of the Digital Subscriber Loop

  224
• cc_SetDLinkCfg( ) - configures a logical link

  228
• cc_SetDLinkState( ) - set the logical data link state

  230
• cc_SetEvtMsk( ) - sets the event mask

  233
• cc_SetInfoElem( ) - sets additional information elements

  238
• cc_SetMinDigits( ) - sets the minimum number of digits to be collected

  241
• cc_SetParm( ) - sets the default channel parameters

  244
• cc_SetParmEx( ) - set parameters requiring variable data to be passed

  250
• cc_SetUsrAttr( ) - sets the user attribute

  254
• cc_SndFrame( ) - sends a frame to the data link layer

  257
• cc_SndNonCallMsg( ) - sends a non-call related ISDN message

  264
• cc_StartTrace( ) - start the capture of all D channel information

  268
• cc_StopTone( ) - forces the termination of a tone

  271
• cc_StopTrace( ) - stops the trace

  275
• CCEV_TERM_REGISTER

  278
• cc_ToneRedefine( ) - redefines a call progress tone’s attributes

  283
• cc_WaitCall( ) - sets up conditions for processing an incoming call

  289
• 6. Data Structure Reference

  293
• 6.1. CC_RATE_U

  294
• 6.2. channel_id

  294
• 6.3. DCHAN_CFG

  295
• 6.4. DLINK

  302
• 6.5. DLINK_CFG

  303
• 6.6. IE_BLK

  304
• 6.7. L2_BLK

  305
• 6.8. MAKECALL_BLK

  305
• 6.8.1. MAKECALL_BLK Initialization

  314
• 6.9. NONCRN_BLK

  315
• 6.10. PARM_INFO

  316
• 6.11. SPID_BLK

  316
• 6.12. TERM_BLK

  317
• 6.13. TERM_NACK_BLK

  319
• 6.14. ToneParm

  320
• 6.15. USPID_BLK

  321
• 6.16. USRINFO_ELEM

  322
• 6.17. WAITCALL_BLK

  323
• 7. ISDN Events and Errors

  325
• 7.1. Event Categories

  325
• 7.1.1. Termination Events

  325
• 7.1.2. Unsolicited Events

  330
• 7.2. Error Handling

  338
• 7.2.1. Cause/Error Codes from the ISDN Firmware

  339
• 7.2.2. Cause/Error Codes from the ISDN Network

  342
• 7.2.3. Cause/Error Codes from the ISDN Library

  347
• 8. Application Guidelines

  349
• 8.1. General Guidelines

  349
• 8.1.1. Symbolic Defines

  349
• 8.1.2. Header Files

  350
• 8.1.3. Aborting and Terminating the Application

  350
• 8.2. Handling Errors, Events and Alarms

  350
• 8.2.1. Handling Errors

  351
• 8.2.2. Handling Events

  351
• 8.2.3. Handling Alarms

  352
• 8.3. Programming Considerations - PRI and BRI

  352
• 8.3.1. Resource Association

  352
• 8.3.2. MAKECALL Block Initialization and Settings

  353
• 8.3.3. Information Element Settings

  354
• 8.4. Programming Considerations - BRI/SC Only

  357
• 8.4.1. BRI/SC Configuration

  357
• 8.4.2. BRI/SC Terminal Initialization

  358
• 8.4.3. BRI/SC Tone Generation Configuration

  359
• 8.5. Diagnostic Tools (The DialView Suite)

  360
• 8.5.1. ISDIAG Utility

  360
• 8.5.2. ISDTRACE Utility

  362
• Appendix A - Call Control Scenarios

  367
• BRI Channel Initialization and Start Up (User Side)

  368
• BRI Channel Initialization and Start Up (Network Side)

  369
• PRI Channel Initialization and Start Up

  370
• Normal Call Establishment and Termination

  371
• Network initiated call (inbound call)

  371
• Network terminated call

  374
• Application initiated call (outbound call)

  378
• Aborting cc_MakeCall( )

  380
• Application Terminated Call

  381
• Call Rejection

  385
• Outgoing call rejected by the network

  385
• Incoming call rejected by the application

  386
• to the network

  388
• to the network

  390
• Simultaneous disconnect (any state)

  392
• Hold and retrieve - local initiated

  395
• Hold and retrieve - remote initiated

  396
• Network Facility Request or Service

  397
• Vari-A-Bill (AT&T Service Only)

  397
• ANI-on-demand - incoming call (AT&T Service Only)

  398
• Advice of charge - inbound and outbound call (AT&T Service Only)

  399
• Two B Channel Transfer (TBCT)

  400
• Non-Call Associated Signaling (NCAS)

  409
• User-initiated call

  410
• Network-initiated call

  413
• Appendix B - DPNSS Call Scenarios

  415
• Executive Intrusion - Normal

  416
• Executive intrusion - with prior validation

  416
• Local diversion - outbound

  417
• Local diversion - inbound

  417
• Remote diversion - outbound

  418
• Remote diversion - inbound

  419
• Transfer

  420
• Virtual call -outbound

  422
• Virtual call - inbound

  423
• Appendix C - IEs and ISDN Message Types for DPNSS

  425
• Information Elements for cc_GetCallInfo( ) and cc_GetSigInfo( )

  425
• Intrusion IE:

  425
• Diversion IE:

  425
• Diversion Validation IE:

  426
• Transit IE:

  426
• Text Display IE:

  427
• Network Specific Indications (NSI) IE:

  428
• Extension Status IE:

  428
• Virtual Call IE:

  429
• Information Elements for cc_SetInfoElem( )

  430
• Intrusion IE:

  430
• Diversion IE:

  431
• Diversion Bypass IE:

  431
• Inquiry IE:

  432
• Extension Status IE:

  432
• Virtual Call IE:

  433
• Text Display IE:

  433
• Network Specific Indications (NSI) IE:

  434
• DPNSS Message Types for cc_SndMsg( )

  434
• SndMsg_Divert:

  435
• SndMsg_Intrude:

  435
• SndMsg_NSI:

  436
• SndMsg_Transfer:

  436
• SndMsg_Transit:

  437
• Appendix D – BRI Supplemental Services

  439
• Appendix E - Establishing ISDN Cable Connections

  445
• Ordering Service

  445
• Establishing Connections to an NTU

  445
• Appendix F - Related Publications

  447
• Glossary

  449
• Index

  455
• Table 1. ISDN Protocols

  11
• Table 2. Call Control States

  16
• Table 3. Inbound Call Set-Up (Asynchronous Example)

  19
• Table 4. Outbound Call Set-up (Asynchronous Example)

  20
• Table 5. Inbound Call Set-Up (Synchronous Example)

  22
• Table 6. Outbound Call Set-up (Synchronous Example)

  23
• Table 7. Call Termination (Asynchronous Example)

  25
• Table 8. Call Termination (Synchronous Example)

  27
• Table 9. Call Control Functions

  31
• Table 10. Optional Call Handling Functions

  32
• Table 11. System Control Functions

  34
• Table 12. System Tool Functions

  35
• Table 13. Data Link Layer Handling Functions

  38
• Table 14. Hold and Retrieve Functions

  39
• Table 15. Global Tone Generation Functions

  40
• Table 16. ISDN API Functions and Supported Technologies

  41
• Table 17. ISDN Function Description Format

  46
• Table 18. cc_DropCall( ) Causes

  75
• Table 19. cc_GetCallInfo( ) Info_ID Definitions

  90
• Table 20. Bitmask Values

  115
• Table 21. cc_GetParm( ) Parameter ID Definitions

  139
• Table 22. cc_GetParmEx( ) Parameter ID Definitions

  145
• Table 23. cc_GetSigInfo( ) Info_ID Definitions

  152
• Table 24. Bitmask Values

  233
• Table 25. Bitmask Actions

  235
• Table 26. cc_SetParm( ) Parameter ID Definitions

  245
• Table 27. ISDN Message Types for cc_SndMsg( )

  261
• Table 28. Terminal Initialization Events and Data Structures

  279
• Table 29. Tone Template Table

  284
• Table 30. CC_RATE_U Field Descriptions

  294
• Table 31. channel_id Descriptions and Values

  295
• Table 32. DCHAN_CFG Field Descriptions and Values

  297
• Table 33. DLINK Field Descriptions

  303
• Table 34. DLINK_CFG Field Descriptions

  303
• Table 35. IE_BLK Field Descriptions

  304
• Table 36. L2_BLK Field Descriptions

  305
• MAKECALL_BLK Parameter ID Definitions

  307
• NONCRN_BLK Field Descriptions

  315
• PARM_INFO Field Descriptions

  316
• SPID_BLK Field Descriptions

  317
• TERM_BLK Field Descriptions

  318
• TERM_NACK_BLK Field Descriptions

  319
• Cause Values Associated with CCEV_RCVTERMREG_NACK

  320
• ToneParm Field Descriptions

  321
• USPID_BLK Field Descriptions

  322
• USRINFO_ELEM Field Descriptions

  323
• Termination Events

  326
• Unsolicited Events

  330
• Cause/Error Locations

  339
• ISDN Firmware Error Codes

  340
• ISDN Firmware Error Codes for cc_SetBilling( )

  342
• ISDN Network Error Codes

  343
• ISDN Library Error Codes

  347
• Variable Length IEs

  354
• NON-LOCKING Shift IEs - Type 1

  355
• Single Byte IEs - Type 2

  355
• LOCKING Shift IEs - Option 1

  355
• LOCKING Shift IEs - Option 2

  356
• ISDTRACE Example File

  363
• ETSI Specification Cross-Reference for Supplemental Services

  443
• Figure 1. Layer 2 Frame (D Channel)

  14
• Figure 2. Layer 3 Frame (D Channel)

  15
• Figure 3. Asynchronous Call Establishment Process

  18
• Figure 4. Synchronous Call Establishment Process

  21
• Figure 5. Asynchronous Call Disconnect or Failure Process

  24
• Figure 6. Synchronous Call Disconnect or Failure Process

  26
• Figure 7. TBCT Invocation with Notification (Both Calls Answered)

  401
• Alerting)

  402
• Figure 9. User-Accepted Network-Initiated NCAS Request

  409
• Figure 10. User-Rejected Network-Initiated NCAS Request

  410
• Figure 11. User-Disconnected NCAS Call

  410
• Figure 12. Information Element Format

  441