You are here: CSP API Reference > 4 Tag Length Value Blocks > BT IUP TLVs

BT IUP TLVs

Overview

The table below shows the format of the TLVs used in the BT IUP ICB for BT IUP messages.

TLV Name | TLV ID | TLV Length | TLV Data
--- | --- | --- | ---
Byte Number | Bit Description
H0, H1 Element | 0x01 | 0x02 | 0x01 | The H0 value
0x02 | The H1 value
IAM/IFAM Message Indicators | 0x02 | 0x05 | 0x01 | Bit Definition 0-5 Calling Party Category (CPC) or (CDPC) Only bits 0 through 5 are valid. (The values are different for CPC and CDPC usage.) 6 Enhanced Diversion Indicator (EDI) 7 0
0x02 | Bit Definition 0 Calling Line Identity Indicator (CLI) 1 CLI Blocking Indicator (CBI) 2 International Indicator (INT) 3 Interworking Indicator (I/W) 4 Priority Access Indicator (PA) 5 0 6 Meter Delay Guard Timeout Indicator (MDG) 7 Protection Indicator (PROT)
IAM/IFAM Message Indicators | 0x02 | 0x05 | 0x03 | Bits Definition 0-3 Service Handling Protocol (SHP)- (Currently only 0 and 1 are supported.) 4 Release Protocol Indicator (RPI) 5 Long Propagation Delay Indicator (LPD) 6 Reserved 7 Call Type Indicator (CTI) – L bit
0x04 | Bits Definition 0-1 CTI M and N bits 2 Echo Control Device Indicator (ECD) 3 Network Translated Address Indicator (NTA) 4-7 Interconnect Specific Information
0x05 | Bits Definition 0-3 Routing Control Indicator (RCI) 4-6 Call Path Indicator (CPI) (Currently only 0 and 2 are supported.) 7 Presentation Number Indicator (PNI)
Called Address | 0x03 | 0x01-0x0B | 0x01 | Bits Definition 0-4 Number of Called Address Signals 5-7 PRI
0x02-0x0B | From 1-10 bytes of BCD information may be present.
Line Identity | 0x04 | 0x01-0x09 | 0x01 | Bits Definition 0-1 BA-Bits Nature of Address Indicator (NAI) 2 Line Identity C-Bit, Incomplete Address Indicator (IAI) 3 Line Identity D-Bit, Identity Qualified (IQ) 4-7 Number of Address Signals
0x02-0x09 | From 1-8 bytes of BCD information may be present.
ASUI Message Information Contained Code (ICC) | 0x05 | 0x01 | 0x01 | All bits are valid.
Partial Calling Line Identity (PCLI) | 0x06 | 0x09 | 0x01 | Bits Definition 0-3 D1 Type of Switch 4-7 D2 Type of Switch
0x02 | Bits Definition 0-3 D1 PNO Identity 4-7 D2 PNO Identity
0x03 | Bits Definition 0-3 D3 PNO Identity 4-7 D1 Switch Number
0x04 | Bits Definition 0-3 D2 Switch Number 4-7 D3 Switch Number
0x05 | Bilateral Agreement Byte 1
0x06 | Bilateral Agreement Byte 2
Partial Calling Line Identity (PCLI) continued | 0x06 | 0x09 | 0x07 | Bilateral Agreement Byte 3
0x08 | Bilateral Agreement Byte 4
0x09 | Bilateral Agreement Byte 5
Number of Digits Requested | 0x07 | 0x01 | 0x01 | Only bits 0 through 3 are valid.
SAUSI Information Indicator | 0x08 | 0x01 | 0x01 | All bits are valid.
Address Complete Message Indicators | 0x09 | 0x03 | 0x01 | Bits Definition 0-5 Charge Indicator 6-7 Unused
0x02 | Bits Definition 0-5 Unused 6 Last Party Release Indicator (LPR) 7 Unused
0x03 | Bits Definition 0 Last Party Release Indicator 1-5 Interworking Indicators 6 Echo Control Device Indicator 7 Reserved
CNA Reason | 0x0A | 0x01 | 0x01 | All bits are valid.
CNA Diagnostics | 0x0B | 0x01 | 0x01 | All bits are valid.
Type of Answer | 0x0C | 0x01 | 0x01 | Only bits 0 through 3 are valid.
Release Reason | 0x0D | 0x01 | 0x01 | All bits are valid.
Confusion Message Qualifier | 0x0E | 0x01 | 0x01 | All bits are valid.
ACI Information Contained and Information Requested | 0x0F | 0x02 | 0x01 | Information Contained Code (ICC)
0x02 | Information Requested Code (IRC)
ACI Type 1 Reserved Bytes | 0x10 | 0x02 | 0x01 | Reserved Byte 1
0x02 | Reserved byte 2
ACI Type 1 Message Indicators | 0x11 | 0x01 | 0x01 | Bits Definition 0-6 Unused 7 Operator Indicator
Calling/Called Subscriber’s Basic Service Marks | 0x12 | 0x02 | 0x01 | Bits Definition 0 A - Admin/Maintenance Call Barring Indicator 1 B - Subscriber Controlled Incoming Calls Barred Indicator 2 C - Pre-arranged Incoming Calls Barred Indicator 3 D - Permanent Incoming Calls Barred Indicator 4 E - Temporary Out of Service (TOS) 5 F - ICB, Except for Operator, Indicator 6 G - Called Subscriber Facility Information Indicator 7 H - Calling Subscriber Facility Info. Indicator
Calling/Called Subscriber’s Basic Service Marks Continued | 0x12 | 0x02 | 0x02 | Bits Definition 0 I - Permanent Outgoing Calls Barred Indicator 1 J - Outgoing Local Calls Barred Indicator 2 K - Outgoing National Calls Barred Indicator 3 L - Outgoing International Calls Barred Indicator 4 M - Operator Calls Barred Indicator 5 N - Supplementary Facility Calls Barred Indicator 6 O - Digit Masking Indicator 7 P - Calls to Premium-phones Barred Indicator
ACI Type 3 Message Indicators | 0x13 | 0x01 | 0x01 | Bits Definition 0-5 Calling/Called Subscriber’s Tariff Group 6 Reserved 7 Operator Indicator
ACI Type 4 Message Indicators | 0x14 | 0x01 | 0x01 | Bits Definition 0-5 Called Subscriber’s Tariff Group 6-7 Reserved
Calling Subscriber’s Originating Facility Marks | 0x15 | 0x02 | 0x01 | Bits Definition 0 A - Disabled Subscriber’s Indicator 1 B - Attendant Call Office Indicator 2 C - Advise Duration and Charge (AD&C) Indicator 3 D - PBX Subscriber Indicator 4-7 Reserved
0x02 | Reserved
Called Subscriber’s Terminating Facility Marks | 0x16 | 0x02 | 0x01 | Bits Definition 0 A - SVI Indicator 1 B - CNI Indicator 2 C - PBX Night Interception Indicator 3 D - Call Waiting Indicator 4 E - Fixed Destination Service Indicator 5-7 Reserved
0x02 | Reserved
Generic TLC Entry (When this TLV occurs it must be the only TLV used. It must contain the entire user-defined message.) | 0x17 | 0x01-0xC8 | 0x01-0xC8 | First byte of generic TLV Entry Data. From 1-200 bytes of generic data may be present in this TLV.
Reserved Data Byte | 0x18 | 0x01 | 0x01 | Reserved
SAM and FAM Called Address | 0x19 | 0x01-0x0A | 0x01 | Bits Definition 0-4 Number of Called Address Signals 5-7 PRI
0x02-0x0A | From 1-9 bytes of BCD information may be present.
Accumulated Called Digits (This TLV is only sent from the switch to the host. It will be present whenever an IAM or IFAM H0,H1 TLV is present within an IUP ICB.) | 0x1A | 0x01-0x0F | 0x01 | Number of Called Digits to follow. Packed two BCD digits per byte.
0x02-0x0F | Bytes of BCD digits.
ISDN Composite SIM - Facility Indicator Code (FIC) | 0x1B | 0x02 | 0x01 | LSB - Facility Indicator Code
0x02 | MSB - Facility Indicator Code
Closed User Group (CUG) Interlock Code | 0x1C | 0x04 | 0x01 | Bits Definition 0-3 D1 6-7 D2
0x02 | Bits Definition 0-3 D3 4-7 D4
0x03 | LSB - Binary Code
0x04 | MSB - Binary Code
Service Indicator Code | 0x1D | 0x02 | 0x01 | First Octet
0x02 | Second Octet
Six Character Network Address Extension (NAE) - Subaddress | 0x1E | 0x02-0x07 | 0x01 | NAE Character Count (range 1 to 6)
0x02 | 1st NAE Character
n | nth NAE Character
Service Code | 0x1F | 0x01 | 0x01 | Service Code

Mapping BT IUP Messages to TLV Format

This section defines the TLVs required in a IUP DATA ICB to compose each message. TLVs may appear in any order within the IUP DATA ICB. If a TLV is not included and is required for the underlying PNO-ISC IUP Message a default value will be supplied from the appropriate configuration byte. Therefore, many messages can be generated from the configuration data area by only encoding a message containing the H0H1 TLV, since this uniquely identifies the message to be sent. However, several messages require additional TLVs to uniquely identify the message (for example, ACI and ASUI).

BT IUP Message | Valid TLVs
--- | ---
Initial Address Message/ Final Address Message (IAM/IFAM) | 0x01, 0x02, 0x03, 0x04
Subsequent Address Message/ Final Address Message (SAM/FAM) | 0x01, 0x18, 0x19
Additional Setup Information, Type 1 - Full Calling Line Identity | 0x01, 0x04, 0x05
Additional Setup Information, Type 2 - Partial Calling Line Identity | 0x01, 0x05, 0x06, 0x18
Send N Digits | 0x01, 0x07
Send All Digits | 0x01, 0x18
Send Additional Setup Information | 0x01, 0x08
Address Complete | 0x01, 0x09
Congestion | 0x01
Terminal Congestion | 0x01
Connection Not Admitted | 0x01, 0x0A, 0x0B
Repeat Attempt | 0x01
Subscriber Engaged | 0x01
Subscriber Out of Order | 0x01
Answer | 0x01, 0x0C
Clear | 0x01
Release | 0x01, 0x0D
Circuit Free | 0x01
Blocking | 0x01
Unblocking | 0x01
Blocking Acknowledgement | 0x01
Unblocking Acknowledgement | 0x01
Overload | 0x01
Confusion | 0x01
Additional Call Information, Type 1 | 0x01, 0x04, 0x0F, 0x10, 0x11
Additional Call Information, Type 2 | 0x01, 0x0F, 0x10
Additional Call Information, Type 3 | 0x01, 0x04, 0x0F, 0x12, 0x13
Additional Call Information, Type 4 | 0x01, 0x0F, 0x12, 0x14
Additional Call Information, Type 5 | 0x01, 0x0F, 0x15
Additional Call Information, Type 6 | 0x01, 0x0F, 0x16
Additional Call Information, Type 7 | 0x01, 0x0F

See Information Control Block.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
Interworking is a software feature within the Excel platform call control layer that enables protocol conversion by analyzing and converting Network Signaling (NS) Layer 3 information.
See Private Branch Exchange.
See Integrated Services Digital Network.
Least Significant Bit
Most Significant Bit
A bit framing standard for traditional time-division multiplexing, which standard describes user channels multiplexed onto a trunk that has been segmented (framed) into 24 bytes of 8 bits each. Note: The multiplexing function is performed in the D-4 framing structure by interleaving bits of consecutive bytes as they are presented from individual circuits into each D-4 frame.