COMMON-ISDN-API

Version 1.1/2.0

- Remote CAPI over TCP/IP BinTec Communications GmbH

10/10/95

REMOTE-COMMON-ISDN-API Version 2.0

MOTIVATION

This
paper
describes
the
BinTec
extension
for
COMMON-ISDN-API
over
TCP/IP.
REMOTE-COMMON-ISDN-API allows distributed ISDN applications without need of a separate ISDN
adapter at each computer.
It is even possible to use ISDN service within computer environments where there is actual no COMMON-ISDNAPI Operating system specification available (e.g. IBM AS/400)
The REMOTE-COMMON-ISDN-API server is listening TCP port 6000 on a BinTec BIANCA/BRICK router.

1.1

Extended Message Structure

The whole message exchange between REMOTE-COMMON-ISDN-API (RCAPI) server and client is handled
via TCP protocol. The RCAPI server is listening the RCAPI-TCP port 6000 for incoming TCP connections.
Registering and releasing CAPI applications reflects in establishing and disconnecting TCP connections to the
RCAPI server.
Because of the stream oriented structure of a TCP connection each RCAPI message consists of an additional
message length block. If there is any datablock is included within the CAPI message (e.g.
DATAB3_IND,DATAB3_REQ) it is appended after the CAPI message.

Total
length

COMMON-ISDN-API
Message

possible datablock

Figure 2: Remote-COMMON-ISDN-API Message Layout

Explanation of the extended message format:

Message
Total length

COMMON-ISDN-API
Message
datapart

REMOTE-COMMON-ISDN-API Version 2.0

Type
NetWord

Contents
Total length of the message including the complete message
header and data part in network byteorder (highbyte,
lowbyte).
COMMON-ISDN-API Message as descriped in the CAPI
specification
possible datablock (DATAB3_REQ, DATAB3_IND)

1.2

Table of Messages

To represent the CAPI interface functions some additional CAPI messages have been defined.

Message

Description

REGISTER_REQ
REGISTER_CONF
GET_MANFACTURER_REQ
GET_MANUFACTURER_CONF
GET_SERIAL_NUMBER_REQ
GET_SERIAL_NUMBER_CONF
GET_VERSION_REQ
GET_VERSION_CONF
GET_PROFILE_REQ
GET_PROFILE_CONF

registers an application at RCAPI server

confirmation of register request from RCAPI server
request manufacturer identification from RCAPI server
confirmation of manufacturer request
request serialnumber from RCAPI server
confirmation of serialnumber request
request version from RCAPI server
confirmation of version request
request controller specific information from RCAPI server
confirmation of controller information request

Table 2: Interface messages

REMOTE-COMMON-ISDN-API Version 2.0

MESSAGE DESCRIPTIONS
The following section defines all REMOTE-COMMON-ISDN-API messages with
their respective parameters.
The following order always will be used
CONFIRMATION, INDICATION, RESPONSE.

2.1

for

basic

names: REQUEST,

REGISTER_REQ

Description
This message is used by an application to report its presence to REMOTECOMMON-ISDN-API. By passing the
parameters messageBufferSize,
maxLogicalConnection, maxBDataBlocks,
maxBDataLen and capiVersion the
application describes its needs for the connections it is going to accept or it will try to
establish itself.

REGISTER_REQ

Command
Subcommand

0xf2
0xff

Parameter

Type

Comment

Buffer
messageBufferSize

dword
word

maxLogicalConnections
maxBDataBlocks
maxBDataLen
capiVersion

word
word
word
byte

Buffer pointer (currently not used)

CAPI 1.1: number of CAPI messages (currently not used)
CAPI 2.0: size of message buffer (currently not used)
Maximum number of logical connections
Number of data blocks available simultaneously
Maximum size of a data block
CAPI Version to register (1 = CAPI 1.1, 2 = CAPI 2.0)

REMOTE-COMMON-ISDN-API Version 2.0

2.2

REGISTER_CONF

Description
This message confirms the reception of a REGISTER_REQ message.

REGISTER_CONF

Command
Subcommand

Parameter

Type

Comment

Info

word

0: application registered
0x0003:
0x2001:
0x2002:
0x2007:

REMOTE-COMMON-ISDN-API Version 2.0

0xf3
0xff

2.3

GET_MANUFACTURER_REQ

Description
With this message the application determines the manufacturer identification of
REMOTE-COMMON-ISDN-API. The identification string, coded as a zero
terminated ASCII string is returned in the corresponding confirmation message.

GET_MANUFACTURER_REQ

This message has no parameters.

REMOTE-COMMON-ISDN-API Version 2.0

Command
Subcommand

0xfa
0xff

2.4

GET_MANUFACTURER_CONF

Description
This message confirms the reception of a GET_MANUFACTURER_REQ message. It
also includes the requested manufacturer identifications as a zero terminated ASCII
string.

GET_MANUFACTURER_CONF

Command
Subcommand

Parameter

Type

Comment

identification string

struct

manufacturer identification string

REMOTE-COMMON-ISDN-API Version 2.0

0xfb
0xff

2.5

GET_SERIAL_NUMBER_REQ

Description
With this operation the serial number of
requested.

GET_SERIAL_NUMBER_REQ

This message has no parameters

REMOTE-COMMON-ISDN-API Version 2.0

REMOTE-COMMON-ISDN-API is

Command
Subcommand

0xfe
0xff

2.6

GET_SERIAL_NUMBER_CONF

Description
This message confirms the reception of a GET_SERIAL_NUMBER_REQ message. It
also includes the requested REMOTE-COMMON-ISDN-API serial number

GET_SERIAL_NUMBER_CONF

Command
Subcommand

0xff
0xff

Parameter

Type

Comment

serial number

struct

The serial number, coded as a zero terminated ASCII string,

represents seven digit number

REMOTE-COMMON-ISDN-API Version 2.0

2.7

GET_VERSION_REQ

Description
With this operation version information of
requested.

GET_VERSION_REQ

Command
Subcommand

This message has no parameters

REMOTE-COMMON-ISDN-API Version 2.0

REMOTE-COMMON-ISDN-API is

10

0xfc
0xff

2.8

GET_VERSION_CONF

Description
This message confirms the reception of a GET_VERSION_REQ message. It also
includes the requested REMOTE-COMMON-ISDN-API version information.

GET_VERSION_CONF

Command
Subcommand

0xfd
0xff

Parameter

Type

Comment

CAPI version
Manufacturer version
version information

word
word
struct

The CAPI version.

The manufacturer revision
The version, coded as a zero terminated ASCII string.

REMOTE-COMMON-ISDN-API Version 2.0

11

2.9

GET_PROFILE_REQ

Description
The application uses this message to get the capabilities from REMOTE-COMMONISDN-API. Information about implemented features, number of controllers and
supported protocols is returned via GET_PROFILE_CONF. CtrlNr, which is an
input parameter for REMOTE-COMMON-ISDN-API, contains the controller
number (bit 0..6), for which this information is requested.

GET_PROFILE_REQ

Command
Subcommand

Parameter

Type

Comment

CtrlNr

word

Controller number

This message has no parameters

REMOTE-COMMON-ISDN-API Version 2.0

12

0xe0
0xff

2.10

GET_PROFILE_CONF

Description
This message confirms the reception of a GET_PROFILE_REQ message. It also
includes the requested REMOTE-COMMON-ISDN-API controller information.

GET_PROFILE_CONF

Command
Subcommand

0xe1
0xff

Retrieved structure format:

Parameter

Type

Description

Info

WORD

CtrlNr
nChannel
options

WORD
WORD
DWORD

b1protocols

DWORD

b2protocols

DWORD

0: profile information valid

0x2002: illegal controller
number of installed controllers, least significant octet first
number of supported B-channels, least significant octet first
Global Options (bit field):
[0]: internal controller supported
[1]: external equipment supported
[2]: Handset supported (external equipment must be set also)
[3]: DTMF supported
[4].[31]: reserved
B1 protocols support (bit field):
[0]: 64 kBit/s with HDLC framing, always set.
[1]: 64 kBit/s bit transparent operation with byte framing from the
network
[2]: V.110 asynchronous operation with start/stop byte framing
[3]: V.110 synchronous operation with HDLC framing
[4]: T.30 modem for fax group 3
[5]: 64 kBit/s inverted with HDLC framing.
[6]: 56 kBit/s bit transparent operation with byte framing from the
network
[7]..[31]: reserved
B2 protocol support (bit field):
[0]: ISO 7776 (X.75 SLP), always set
[1]: Transparent
[2]: SDLC
[3]: LAPD according Q.921 for D channel X.25
[4]: T.30 for fax group 3
[5]: Point to Point Protocol (PPP)
[6]: Transparent (ignoring framing errors of B1 protocol)
[7]..[31]: reserved

REMOTE-COMMON-ISDN-API Version 2.0

13

b3protocols

DWORD

reserved
manufacturer

6 DWORDs
5 DWORDs

B3 protocol support (bit field):

[0]: Transparent, always set
[1]: T.90NL with compatibility to T.70NL according to T.90 Appendix
II.
[2]: ISO 8208 (X.25 DTE-DTE)
[3]: X.25 DCE
[4]: T.30 for fax group 3
[5]..[31]: reserved
reserved for REMOTE-COMMON-ISDN-API usage
manufacturer specific information

Note
This function can be extended, so an application has to ignore unknown bits.
REMOTE-COMMON-ISDN-API will set every reserved field to 0.

REMOTE-COMMON-ISDN-API Version 2.0

14