Appendix C: BRI Supplemental Services
The Global Call API functions allow BRI boards to perform the following Supplemental Services:
Call Hold and Retrieve are invoked using the following API functions (see the appropriate function descriptions in the Global Call API Library Reference and in this document for more information):
The other Supplemental Services are invoked by sending information from the board to the PBX using an appropriate API function. This information is sent as the part of the Layer 3 frame called the Information Element (IE) (see Section 1.2.1, Framing for more information). In order for the PBX to interpret the Information Elements as Supplemental Service requests, the Information Elements must be sent as Facility Messages.
The following functions can be used to send Facility Messages:
- gc_Extension( ) with ext_id as CC_EXID_SndMsg - Sends a call state associated message to the PBX.
- gc_Extension( ) with ext_id as CC_EXID_SndNonCallMsg - Sends a non-Call State related message to the PBX. This function does not require a call reference value.
- gc_SetUserInfo( ) - Sets an information element (IE) allowing the application to include application-specific ISDN information elements in the next outgoing message.
The following functions are used to retrieve Facility Messages:
- gc_GetCallInfo( ) - Retrieves the information elements associated with the CRN.
- gc_Extension( ) with ext_id as CC_EXID_GetNonCallMsg - Retrieves a non-Call State related ISDN messages to the PBX.
The gc_Extension( ) with ext_id as CC_EXID_SndMsg and CC_EXID_SndNonCallMsg( ) functions are used to send Facility Messages or Notify Messages to the PBX. The Facility Message (as defined in ETS 300-196-1) is composed of the following elements:
The Supplemental Service to be invoked and its associated parameters are specified in the Information Element. This information is PBX-specific and should be provided by the PBX manufacturer. Facility Messages are sent using the gc_Extension( ) with ext_id as CC_EXID_cc_SndMsg or gc_Extension( ) with ext_id as CC_EXID_SndNonCallMsg function with msg_type = SndMsg_Facility. These functions:
- format the Facility Message, inserting the protocol discriminator, call reference number (only for gc_Extension( ) with ext_id as CC_EXID_SndMsg) and message type elements
- add the Information Element data (stored in an application buffer)
- send all the information to the PBX
The PBX, in turn, interprets and acts on the information, and sends a reply to the BRI board.
As an example, to invoke Supplemental Service 'X', you could use the gc_Extension( ) function with ext_id as CC_EXID_SndMsg function with msg_type = SndMsg_Facility. The Information Element would be defined in a data structure as follows:
ieblk.length = 11; ieblk.data[0] = 0x1c; /* IE Identifier */ ieblk.data[1] = 0x09; /* Length of information */ ieblk.data[2] = 0x91; /* Protocol Profile */ /* information */ ieblk.data[3] = 0xa1; /* Component Type */ ieblk.data[4] = 0x06; /* Component Length */ ieblk.data[5] = 0x02; /* invoke tag id */ ieblk.data[6] = 0x01; /* invode tag length */ ieblk.data[7] = 0x00; /* invoke id */ ieblk.data[8] = 0x02; /* operation tag */ ieblk.data[9] = 0x01; /* operation length */ ieblk.data[10] = 0x06; /* operation */
- Note: The information included in the Information Element is dependent on the Supplemental Service being invoked.
The data sent to the switch would be formatted as follows:
Information elements can also be sent using the gc_SetUserInfo( ) function, which allows the BRI board to send application-specific information elements in the next outgoing message. (For more information, see the gc_SetUserInfo( ) function description.)
When a Supplemental Service is invoked, the network may return a NOTIFY Message to the user. This message can be retrieved using the gc_GetCallInfo( ) function.
The Notify Message (as defined in ETS 300-196-1) is composed of the following elements:
The Notify message is coded as follows:
Coding requirements for other supported Supplemental Services are listed in Table 58.
Click here to contact Telecom Support Resources
Copyright 2003, Intel Corporation