CAPI Software System

CAPI Information Values Software Reference

1. Specifications

This document, last updated August 2000, details CAPI 1.1 and CAPI 2.0 information values and their associated error codes. These values are primarily used in the capiInfoNumber field.

The information values are categorized by error class for both CAPI 1.1 and CAPI 2.0.

1.2 CAPI 1.1 Info Values

Error Class 10: Formal error messages and errors during management of MessageQueues.

• 0x1001: Application registration error
• 0x1002: Wrong application id
• 0x1003: Message error
• 0x1004: Wrong CAPI command
• 0x1005: Message queue full
• 0x1006: Message queue empty
• 0x1007: Messages lost
• 0x1008: Error during deinstallation

Error Class 20: Addressing errors.

• 0x2001: Wrong controller
• 0x2002: Wrong PLCI
• 0x2003: Wrong NCCI
• 0x2004: Wrong type

Error Class 31: Incorrect parameters.

• 0x3101: B-channel incorrectly coded
• 0x3102: Info mask incorrectly coded
• 0x3103: Service SI mask incorrectly coded
• 0x3104: Service EAZ mask incorrectly coded
• 0x3105: B2 protocol incorrect
• 0x3106: DLPD incorrect
• 0x3107: B3 protocol incorrect
• 0x3108: NCPD incorrect
• 0x3109: NCPI incorrect
• 0x310a: Flags incorrectly coded

Error Class 32: Unsupported parameters.

• 0x3201: Controller error
• 0x3202: Conflict between registrations
• 0x3203: Function is not supported
• 0x3204: PLCI not active
• 0x3205: NCCI not active
• 0x3206: B2 protocol not supported
• 0x3207: Change of B2 protocol not possible in this state
• 0x3208: B3 protocol not supported
• 0x3209: Change of B3 protocol not possible in this state
• 0x320a: Parameters used not supported in DLPD
• 0x320b: Parameters used not supported in NCPD
• 0x320c: Parameters used not supported in NCPI
• 0x320d: Data length not supported
• 0x320e: DTMF number unknown

Error Class 33: Network errors.

• 0x3301: Error on setup of D-channel layer 1
• 0x3302: Error on setup of D-channel layer 2
• 0x3303: Error on setup of B-channel layer 1
• 0x3304: Error on setup of B-channel layer 2
• 0x3305: Abort D-channel layer 1
• 0x3306: Abort D-channel layer 2
• 0x3307: Abort D-channel layer 3
• 0x3308: Abort B-channel layer 1
• 0x3309: Abort B-channel layer 2
• 0x330a: Abort B-channel layer 3
• 0x330b: Re-establish B-channel layer 2
• 0x330c: Re-establish B-channel layer 3

Error Class 34: Network messages (whereby xx refers to the related 1TR6 Error-Cause).

• 0x3400: Normal call clearing
• 0x3480: Normal call clearing
• 0x3481: (Specific 1TR6 error cause)
• 0x3483: (Specific 1TR6 error cause)
• 0x3487: (Specific 1TR6 error cause)
• 0x3488: (Specific 1TR6 error cause)
• 0x348a: (Specific 1TR6 error cause)
• 0x3490: (Specific 1TR6 error cause)
• 0x3491: (Specific 1TR6 error cause)
• 0x34a0: (Specific 1TR6 error cause)
• 0x34a1: (Specific 1TR6 error cause)
• 0x34a2: (Specific 1TR6 error cause)
• 0x34a5: (Specific 1TR6 error cause)
• 0x34b0: (Specific 1TR6 error cause)
• 0x34b1: (Specific 1TR6 error cause)
• 0x34b2: (Specific 1TR6 error cause)
• 0x34b5: (Specific 1TR6 error cause)
• 0x34b8: (Specific 1TR6 error cause)
• 0x34b9: (Specific 1TR6 error cause)
• 0x34ba: (Specific 1TR6 error cause)
• 0x34bb: (Specific 1TR6 error cause)
• 0x34bd: (Specific 1TR6 error cause)
• 0x34be: (Specific 1TR6 error cause)
• 0x34d9: (Specific 1TR6 error cause)
• 0x34da: (Specific 1TR6 error cause)
• 0x34f0: (Specific 1TR6 error cause)
• 0x34f1: (Specific 1TR6 error cause)
• 0x34f2: (Specific 1TR6 error cause)
• 0x34f3: (Specific 1TR6 error cause)
• 0x34ff: User info discarded locally

Error Class 40: (No specific errors listed in provided text)

1.3 CAPI 2.0 Info Values

Error Class 00: Informative values (corresponding message was processed).

• 0x0001: NCPI not supported by current protocol, NCPI ignored
• 0x0002: Flags not supported by current protocol, flags ignored
• 0x0003: Alert already sent by another application

Error Class 10: Error information concerning CAPI_REGISTER.

• 0x1001: Too many applications
• 0x1002: Logical block size too small, must be at least 128 bytes
• 0x1003: Buffer exceeds 64 kByte
• 0x1004: Message buffer size too small, must be at least 1024 byte
• 0x1005: Max. number of logical connections not supported
• 0x1006: Reserved
• 0x1007: The message could not be accepted because of an internal busy condition
• 0x1008: OS Resource error (e.g. no memory)
• 0x1009: COMMON-ISDN-API not installed
• 0x100a: Controller does not support external equipment
• 0x100b: Controller does only support external equipment

Error Class 11: Error information concerning message exchange functions.

(No specific errors listed in provided text)

2. Usage Instructions

These CAPI information values are returned in the capiInfoNumber field of CAPI messages to indicate the status or outcome of an operation. Developers should check this field after CAPI calls to understand if an operation was successful, if there were any warnings, or if an error occurred.

The values are categorized by ‘Error Class’ to help in identifying the general area of the issue (e.g., application registration, addressing, parameters, network).

When an error code is received, refer to the corresponding error class and specific code to diagnose the problem. For network messages in Error Class 34, the specific 1TR6 Error-Cause (represented by ‘xx’ in the documentation) provides more granular detail about the network event.

3. Troubleshooting

• Application Registration Errors (CAPI 1.1 Error Class 10, CAPI 2.0 Error Class 10):
  • If 0x1001 (CAPI 1.1) or 0x1001 (CAPI 2.0) is received, verify the application’s registration process and ensure unique application IDs.
  • For 0x1002 (CAPI 1.1), check the application ID being used.
  • If 0x1005 (CAPI 1.1) or 0x1007 (CAPI 2.0) indicates a full or busy message queue, consider optimizing message handling or increasing queue sizes if configurable.
  • 0x1009 (CAPI 2.0) suggests CAPI is not installed; ensure the CAPI software is correctly set up on the system.
  • 0x1008 (CAPI 2.0) points to OS resource issues; check system memory and other resource usage.
• Addressing Errors (CAPI 1.1 Error Class 20):
  • Errors like 0x2001 (Wrong controller), 0x2002 (Wrong PLCI), or 0x2003 (Wrong NCCI) indicate incorrect addressing parameters in CAPI commands. Verify the controller, PLCI (Physical Link Connection Identifier), and NCCI (Network Connection Channel Identifier) values.
• Incorrect/Unsupported Parameters (CAPI 1.1 Error Class 31 & 32):
  • If codes from Error Class 31 are encountered (e.g., 0x3101 B-channel incorrectly coded), review the parameters being passed to CAPI functions for correctness and adherence to CAPI specifications.
  • For Error Class 32 (e.g., 0x3203 Function is not supported, 0x3206 B2 protocol not supported), the CAPI implementation or the underlying hardware may not support the requested functionality or protocol. Check the capabilities of your CAPI controller.
• Network Errors (CAPI 1.1 Error Class 33 & 34):
  • Errors in Error Class 33 (e.g., 0x3301 Error on setup of D-channel layer 1) indicate issues with the underlying ISDN network layers. These often require checking the physical ISDN connection, line status, or contacting the ISDN service provider.
  • Error Class 34 provides network messages, often related to call clearing or specific 1TR6 error causes. These are typically informative about the state of a call or connection. 0x34ff indicates user information was discarded locally.
• Informative Values (CAPI 2.0 Error Class 00):
  • These are not errors but rather notifications. For example, 0x0001 (NCPI not supported) or 0x0002 (Flags not supported) mean certain parameters were ignored because the current protocol doesn’t support them. This might indicate a compatibility issue or a feature that won’t be utilized.

4. Frequently Asked Questions

Q: What is the difference between CAPI 1.1 and CAPI 2.0 info values?
A: CAPI 2.0 is a more advanced version of the Common-ISDN-API, offering enhanced features and a slightly different set of error and informative codes. While some codes overlap or have similar meanings, CAPI 2.0 introduces new error classes and specific codes for its extended functionalities, such as those related to CAPI_REGISTER and message exchange functions.
Q: How do I interpret the ‘xx’ in CAPI 1.1 Error Class 34 (Network messages)?
A: The ‘xx’ refers to a specific 1TR6 Error-Cause code. 1TR6 is a German ISDN specification. To fully interpret these, you would need to consult the 1TR6 documentation for the exact meaning of the two-digit hexadecimal code that replaces ‘xx’. These codes provide more detailed reasons for network events like call clearing.
Q: What should I do if I receive an ‘Application registration error’ (0x1001)?
A: This typically means there was an issue when your application tried to register with the CAPI subsystem. Ensure your application ID is unique and that the CAPI subsystem is running and available. Check for any other applications that might be conflicting or if the maximum number of applications has been reached (CAPI 2.0 0x1001).
Q: My application is getting ‘Function is not supported’ (0x3203). What does this mean?
A: This indicates that the specific CAPI function or command you are trying to execute is not supported by the CAPI controller or the installed CAPI software. This could be due to hardware limitations, an outdated CAPI driver, or an attempt to use a CAPI 2.0 feature on a CAPI 1.1 system (or vice-versa) if not fully compatible.
Q: Why am I getting ‘NCPI not supported by current protocol, NCPI ignored’ (0x0001)?
A: This is an informative message, not an error. It means that the Network Call Progress Information (NCPI) you provided in your CAPI command is not supported by the specific ISDN protocol currently in use. The CAPI subsystem will proceed by ignoring the NCPI. If NCPI is critical for your application, you might need to adjust the protocol settings or accept that this feature won’t be utilized.

Loading PDF…

−+Fit width100%View FullscreenDownload PDFPrint PDF

×

Loading PDF…

CAPI INFORMATION
1
VALUES
August 2000

Software Reference

CAPI Information Values

1

2

CAPI Information Values

Software Reference

Table of Contents
CAPI INFORMATION TableofContents VALUES

A REFERENCE

5

1

CAPI Information Values

6

1.1

Overview

6

1.2

CAPI 1.1 Info Values

6

1.3

CAPI 2.0 Info Values

10

Software Reference

CAPI Information Values

3

Table of Contents

4

CAPI Information Values

Software Reference

A
AREFERENCE

Software Reference

CAPI Information Values

5

A CAPI Information Values
1 CAPI Information Values
1.1 Overview
CAPI 1.1 and CAPI 2.0 info values with their appropriate error-codes associated with the capiInfoNumber field are as follows. Both CAPI 1.1 and 2.0 info values are arranged by error class.
1.2 CAPI 1.1 Info Values
Error Class 10
Formal error messages and errors during management of MessageQueues. 0x1001 Application registration error 0x1002 Wrong application id 0x1003 Message error 0x1004 Wrong capi command 0x1005 Message queue full 0x1006 Message queue empty 0x1007 Messages lost 0x1008 Error during deinstallation
Error Class 20
Addressing errors. 0x2001 Wrong controller 0x2002 Wrong PLCI

6

CAPI Information Values

Software Reference

CAPI 1.1 Info Values

A

0x2003 0x2004

Wrong NCCI Wrong type

Error Class 31
Incorrect parameters. 0x3101 B-channel incorrectly coded 0x3102 Info mask incorrectly coded 0x3103 Service SI mask incorrectly coded 0x3104 Service EAZ mask incorrectly coded}, 0x3105 B2 protocol incorrect 0x3106 Dlpd incorrect 0x3107 B3 protocol incorrect 0x3108 NCPD incorrect 0x3109 NCPI incorrect 0x310a Flags incorrectly coded

Error Class 32
Unsupported parameters. 0x3201 Controller error 0x3202 Conflict between registrations 0x3203 Function is not supported 0x3204 PLCI not active 0x3205 NCCI not active 0x3206 B2 protocol not supported 0x3207 Change of B2 protocol not possible in this state 0x3208 B3 protocol not supported

Software Reference

CAPI Information Values

7

A CAPI Information Values

0x3209 0x320a 0x320b 0x320c 0x320d 0x320e

Change of B3 protocol not possible in this state Parameters used not supported in DLPD Parameters used not supported in NCPD Parameters used not supported in NCPI Data length not supported DTMF number unknown

Error Class 33
Network errors. 0x3301 Error on setup of D-channel layer 1 0x3302 Error on setup of D-channel layer 2 0x3303 Error on setup of B-channel layer 1 0x3304 Error on setup of B-channel layer 2 0x3305 Abort D-channel layer 1 0x3306 Abort D-channel layer 2 0x3307 Abort D-channel layer 3 0x3308 Abort B-channel layer 1 0x3309 Abort B-channel layer 2 0x330a Abort B-channel layer 3 0x330b Re-establish B-channel layer 2 0x330c Re-establish B-channel layer 3

Error Class 34
Network messages (whereby xx refers to the related 1TR6 Error-Cause). 0x3400 Normal call clearing 0x3480 Normal call clearing

8

CAPI Information Values

Software Reference

CAPI 1.1 Info Values

A

0x3481 0x3483 0x3487 0x3488 0x348a 0x3490 0x3491 0x34a0 0x34a1 0x34a2 0x34a5 0x34b0 0x34b1 0x34b2 0x34b5 0x34b8 0x34b9 0x34ba 0x34bb 0x34bd 0x34be 0x34d9 0x34da 0x34f0 0x34f1 0x34f2 0x34f3

Invalid call reference value Bearer service not implemented Call identity does not exist Call identity in use No channel available Requested facility not implemented}, requested facility not subscribed Outgoing calls barred User Busy negative GBG Comparison as SPV not aloud Reverse charging not allowed at origination Reverse charging not allowed at destination Reverse charging rejected Destination not obtainable Number changed Out of order User not responding User access busy Incoming calls barred Call rejected Network congestion Remote user initiated Local procedure error Remote procedure error Remote user suspended Remote user resumed

Software Reference

CAPI Information Values

9

A CAPI Information Values

0x34ff

User info discarded locally

Error Class 40
FAX-G3 Errors. 0x4001 Remote station is not a fax G3 machine 0x4002 Local fax module busy 0x4003 Disconnected during transfer (remote abort) 0x4004 Disconnected before transfer (training error) 0x4005 Disconnected during transfer (local tx data underrun) 0x4006 Fax module temporary disabled 0x4007 Local disconnect (local abort) 0x4008 Disconnect during transfer (remote procedure error) 0x4009 Remote disconnect (remote abort) 0x400a Line Disconnect during transfer 0x400b Disconnect before transfer 0x400c Local Disconnect (SFF coding error)

1.3 CAPI 2.0 Info Values

Error Class 00

Informative values (corresponding message was processed).

0x0001

NCPI not supported by current protocol, NCPI ignored

0x0002

Flags not supported by current protocol, flags ignored

0x0003 Alert already sent by another application

10

CAPI Information Values

Software Reference

CAPI 2.0 Info Values

A

Error Class 10

Error information concerning CAPI_REGISTER.

0x1001 Too many applications

0x1002 Logical block size too small, must be at least 128 bytes

0x1003 Buffer exceeds 64 kByte

0x1004

Message buffer size too small, must be at least 1024 byte

0x1005 Max. number of logical connections not supported

0x1006 Reserved

0x1007

The message could not be accepted because of an internal busy condition

0x1008 OS Resource error (e.g. no memory)

0x1009 COMMON-ISDN-API not installed

0x100a Controller does not support external equipment

0x100b Controller does only support external equipment

Error Class 11

Error information concerning message exchange functions.

0x1101 Illegal application number

0x1102

Illegal command or subcommand or message length less than 12 octets

0x1103

The message could not be accepted because of a queue full condition

0x1104 Queue is empty

0x1105 Queue overflow, a message was lost

0x1106 Unknown notification parameter

0x1107

The message could not be accepted because of an internal busy condition

Software Reference

CAPI Information Values

11

A CAPI Information Values

0x1108 0x1109 0x110a 0x110b

OS resource error (e.g. no memory) COMMON-ISDN-API not installed Controller does not support external equipment Controller does only support external equipment

Error Class 20
Error information concerning resource/coding problems. 0x2001 Message not supported in current state 0x2002 Illegal Controller/PLCI/NCCI 0x2003 Out of PLCI 0x2004 Out of NCCI 0x2005 Out of LISTEN 0x2006 Out of FAX resources (protocol T.30) 0x2007 Illegal Message parameter coding

Error Class 30
Error information concerning requested services. 0x3001 B1 protocol not supported 0x3002 B2 protocol not supported 0x3003 B3 protocol not supported 0x3004 B1 protocol parameter not supported 0x3005 B2 protocol parameter not supported 0x3006 B3 protocol parameter not supported 0x3007 B protocol combination not supported 0x3008 NCPI not supported 0x3009 CIP Value unknown

12

CAPI Information Values

Software Reference

CAPI 2.0 Info Values

A

0x300a 0x300b 0x300c 0x300d

Flags not supported (reserved bits) Facility not supported Data length not supported by correct protocol Reset procedure not supported by current protocol

Error Class 33

Protocol error reasons.

0x3301 Protocol error layer 1 (broken line or B-channel removed by signalling
protocol)

0x3302 Protocol error layer 2

0x3303 Protocol error layer 3

0x3304 Another application got that call

0x3311

Connecting not successful (remote station is no FAX G3 machine)

0x3312 Connecting not successful (training error)

0x3313

Disconnected before transfer (remote station does not support transfer mode, e.g. resolution)

0x3314 Disconnected during transfer (remote abort)

0x3315

Disconnected during transfer (remote procedure error, e.g. unsuccessful repetition of T.30 commands)

0x3316 Disconnected during transfer (local tx data underrun)

0x3317 Disconnected during transfer (local rx data overflow)

0x3318 Disconnected during transfer (local abort)

0x3319 Illegal parameter coding (e.g. SFF coding error)

Software Reference

CAPI Information Values

13

A CAPI Information Values

Error Class 34

Disconnect cause from the network according to ETS 300102-1/Q.931. In the field ‘xx’ the cause value received within a cause information element (octet 4) from the network is indicated.

0x3481 Unallocated (unassigned) number

0x3482 No route to specified transit network

0x3483 No route to destination

0x3486 Channel unacceptable

0x3487

Call awarded and being delivered in an established channel

0x3490 Normal call clearing

0x3491 User busy

0x3492 No user responding

0x3493 No answer from user (user alerted)

0x3495 Call rejected

0x3496 Number changed

0x349a Non-selected user clearing

0x349b Destination out of order

0x349c Invalid number format

0x349d Facility rejected

0x349e Response to STATUS ENQUIRY

0x349f

Normal, unspecified

0x34a2 No circuit / channel available

0x34a6 Network out of order

0x34a9 Temporary failure

0x34aa Switching equipment congestion

0x34ab Access information discarded

14

CAPI Information Values

Software Reference

CAPI 2.0 Info Values

A

0x34ac 0x34af 0x34b1 0x34b2 0x34b9 0x34ba 0x34bf 0x34c1 0x34c2 0x34c5 0x34c6
0x34cf 0x34d1 0x34d2 0x34d3 0x34d4 0x34d5 0x34d6
0x34d8 0x34db 0x34df 0x34e0 0x34e1 0x34e2

Requested circuit / channel not available Resources unavailable, unspecified Quality of service unavailable Requested facility not subscribed Bearer capability not authorized Bearer capability not presently available Service or option not available, unspecified Bearer capability not implemented Channel type not implemented Requested facility not implemented Only restricted digital information bearer capability is available Service or option not implemented, unspecified Invalid call reference value Identified channel does not exist A suspended call exists, but this call identity does not Call identity in use No call suspended Call having the requested call identity has been cleared Incompatible destination Invalid transit network selection Invalid message, unspecified Mandatory information element is missing Message type non-existent or not implemented Message not compatible with call state or message type non-existent or not implemented

Software Reference

CAPI Information Values

15

A CAPI Information Values

0x34e3
0x34e4 0x34e5 0x34e6 0x34ef 0x34ff

Information element non-existent or not implemented Invalid information element contents Message not compatible with call state Recovery on timer expiry Protocol error, unspecified Interworking, unspecified

16

CAPI Information Values

Software Reference