Navigating this Publication Set
Cantata Technology Excel Product Line Warranty
Changes from Previous Release
CSP Hardware Product Descriptions
CSP Hardware Installation and Maintenance
SwitchKit CSA User’s Guide
SwitchKit Installation and Maintenance Guide
SwitchKit Programmer’s Guide
Intelligent Network & Wireless Protocols Overview
SwitchKit TCAP Interface User’s Guide
SwitchKit SNMP User’s Guide
CSP Developer’s Guide: Overview
CSP Developer’s Guide: Line Cards
CSP Developer’s Guide: Common Channel Signaling
CSP Developer’s Guide: Internet Protocol
CSP API Reference
Cantata Technology Excel Product Line Warranty
Numerical List of EXS API Messages
EXS API Message Set
SwitchKit Message Set
1 EXS & SwitchKit API Messages
2 Address Elements
3 Information Control Blocks
4 Tag Length Value Blocks
Introduction to TLVs
TLVs
0x01 Trunk Number
0x01 Module, IP Address, and Subnet Mask
0x01 Add Virtual Card
0x01 Client Socket Register by IP
0x02 Remove Virtual Card
0x02 Server Socket Register by IP
0x02 Local CLLI
0x02 Engage IP
0x03 Reset IP
0x03 Client Socket Register by Name
0x03 Remote CLLI
0x04 Trunk Type
0x04 Server Socket Register by Name
0x04 Reset Indicator
0x05 Gateway IP
0x05 Unregister Socket
0x06 Open Socket
0x07 Close Socket
0x08 Prohibit Traffic on Socket
0x09 Allow Traffic on Socket
0x09 Ethernet Link Redundancy
0x09 Ethernet Link Redundancy (DSP Series 2 Card)
0x0A Activate Ethernet Port
0x0A Activate Ethernet Port (DSP Series 2 Card)
0x0A Socket Status
0x0B Socket ID
0x0C Socket Information
0x11 Signaling Route Test Control Status
0x12 Signaling Route Test Control DPC
0x14 Reset VDAC Module
0x6F L3 IP Protocol Type
0x0001 Add IP Signaling Series 3 Card
0x0001 Create V5 ID
0x0002 Destroy V5 ID
0x0002 Remove IP Signaling Series 3 Card
0x0003 Matrix ID
0x0003 Protocol Type
0x0003 V5 Variant ID
0x0004 V5 Variant Type
0x0004 Remove Matrix
0x0004 Configuration Tag
0x0005 IP Signaling Series 3 Card IP Address
0x0005 IP Signaling Series 3 Card Slot Number
0x0005 V5 Side
0x0006 Route Group ID
0x0006 Add V5 User Port Range
0x0007 Remove V5 User Port Range
0x0007 IP Signaling Series 3 Card Service State
0x0007 Incoming Span/Channel, Single Address
0x0007 Incoming Span/Channel, Range Address
0x0008 IP Signaling Series 3 Card Compatibility Tag
0x0008 Criteria Type
0x0009 Address Element TLV
0x0009 Poll Interval
0x0009 Terminating Channel
0x0009 Terminating Span/Channel, Single Address
0x0009 Terminating Span/Channel, Range Address
0x000A Matrix IP Address
0x000A Add Poll Interval
0x000A V5 C Channel Assignment
0x000B V5 Cpath Assignment
0x000B IP Signaling Series 3 Card Version
0x000C Matrix IP Address
0x000C V5 Add Link
0x000D V5 Remove Link
0x000E Terminating Span/Channel Offset
0x000E IP Signaling Series 3 Card Interface Service State
0x000F IP Signaling Series 3 Card Interface Support
0x000F Router Protocol ID
0x000F V5 Remove C Channel Assignment
0x000F Link Down Timer
0x0010 Incoming Resource Group
0x0010 V5 Interface ID
0x0010 Incoming Res Group ID, Single Address
0x0010 Incoming Res Group ID, Range Address
0x0012 Remove V5 Cpath Assignment
0x0013 Routing Method
0x0014 Message Header Information
0x0015 Terminating Resource Group
0x0015 Terminating Resource Group ID, Single Address
0x0015 Terminating Resource Group ID, Range Address
0x001A Incoming Node
0x001D Special Routing Instruction
0x0020 IP Signaling Series 3 Card Interface Status
0x0021 IP Signaling Series 3 Card Host Poll
0x0051 Dialog Terminated
0x005E Resource Client ID
0x0061 Reject Reason
0x0062 Resource Group Reorder Method
0x0063 Route Number
0x0065 Physical VoIP Channel
0x006D SCCP Return Reason
0x0071 Virtual VoIP Channel
0x0076 SCCP Other Return Reason
0x0080 IP Signaling Series 3 Card Status
0x0100 RTP Payload Type (VDAC-ONE)
0x0100 RTP Payload Type (IPN Series 2)
0x0100 RTP Payload Type (IPN Series 3)
0x0101 RTP Payload Size (VDAC-ONE)
0x0101 RTP Payload Size (IPN Series 2)
0x0101 RTP Payload Size (IPN Series 3)
0x0102 RTP Silence Suppression
0x0103 RTP Echo Cancellation
0x0104 RTP Packets Lost
0x0105 RTP Packets Received
0x0110 RTP Octets Received
0x0111 RTP Packets Sent
0x0112 RTP Octets Sent
0x0115 Call Agent Mode
0x0116 Channel Service TLV
0x0117 Alerting Propagation Mode
0x0118 Companding Conversion Mode
0x0119 Media Offer Stage
0x011A Call Agent Mode Physical Channel ID
0x011B Reliable Provisional Response Mode
0x011C SIP Stack T.38 Fax Support
0x0141 Modify Connection
0x0168 VDAC Module IP Address
0x01AE Poll Interval Configure
0x01C2 Minimum Jitter Buffer Delay
0x01C3 Maximum Jitter Buffer Delay (IPN-2 Card)
0x01C3 Maximum Jitter Buffer Delay (IPN-2 Card)
0x01C3 Maximum Jitter Buffer Delay (IPN-3 Card)
0x01C4 Adaptation Rate
0x01C5 Fax Type Enable
0x01C6 Modem Enable Transport Method
0x01C7 Fax/Modem Bypass Coder Type
0x01C8 Protocol Type
0x01C9 Primary Matrix IP Port
0x01CA Secondary Matrix IP Port
0x01D0 Gateway Mode
0x01D1 RTP Payload Redundancy
0x01D2 Fax Payload Redundancy
0x01D4 Type of Service
0x01D6 DNS IP Address
0x01D7 Default Domain Name
0x01DB Connection Mode
0x01DC VoIP Module
0x01DD Flush ARP Cache Table Entry
0x01DE ARP Cache Table Entry
0x01DF UDP Source Port Validate
0x01E0 ARP Cache Report Information
0x01E1 Fax Compatibility Mode
0x01E2 RFC 2833 Enable
0x01E5 VoIP Resource Profile Assign
0x01E6 Source T.38 Port
0x01E7 Destination T.38 Port
0x01E8 Source RTCP Port
0x01E9 Destination RTCP Port
0x01EA VoIP Terminal Capabilities
0x01EB RTP Timer Timeout (VDAC-ONE)
0x01EB Initial Media Inactivity Timeout (IP Network Interface Series 2 Card)
0x01EC Media Inactivity Detection Timer
0x01ED RFC 2833 Jitter Buffer Size
0x01EE Invalid Packet Alarm Threshold
0x01EF Initial UDP Port Number
0x01F0 Number of UDP Ports
0x01F1 RFC 2833 Dynamic Payload Type
0x01F2 RFC 2198 Dynamic Payload Type
0x0262 Use SIP Local Port
0x0263 Use SIP Remote Port/Default Proxy Port
0x0264 Use SIP Remote Host/Default Proxy Host
0x0265 Use SIP Site ID
0x0266 Use SIP Anonymous Caller
0x0267 Use SIP Invite T1 Timer
0x0268 Use SIP BYE T1 Timer
0x0269 Use SIP T2 Timer
0x026A Use SIP Maximum Retransmissions Invite
0x026B Use SIP Max Retransmissions BYE
0x0270 SIP Tunnel Type
0x0272 Use SIP Registration Timeout
0x0274 Use No Local Media
0x0275 Local Registration Enable/Disable
0x0277 SIP Version
0x0279 SIP Local Route Lookup
0x027A SIP Registration Mode
0x027B Session Interval
0x027C Min-SE Interval
0x027D SIP Transport Type
0x027F SIP Message Information Mask
0x027E SIP Persistent Sockets
0x0280 SIP Existing Socket Reuse
0x0281 SIP Idle Socket Timeout
0x0282 PPL Event Notification Mask
0x0283 Minimum Registration Duration
0x0284 Resynchronize VoIP Media Parameter
0x02BC Gatekeeper IP and Port
0x02BE Variant ID
0x02BF Version Number
0x02C0 Terminal Type
0x02C1 Vendor ID
0x02C2 Gatekeeper Auto Discovery
0x02C3 Gatekeeper Auto Registration
0x02C4 Gateway E164
0x02C6 Gateway URL ID
0x02C7 Gateway E-mail ID
0x02C8 H.225 T301 Timer
0x02C9 H.225 T303 Timer
0x02CA H.225 T310 Timer
0x02CB H.245 T101 Timer
0x02CC H.245 T103 Timer
0x02CD H.245 T105 Timer
0x02CE H.245 T106 Timer
0x02CF H.245 T108 Timer
0x02D0 H.245 T109 Timer
0x02D1 RAS GRQ Timer
0x02D2 RAS RRQ Timer
0x02D3 Gateway Technology Prefix
0x02D4 H.323 Message Information Mask
0x02D5 H.245 Tunneling Configure
0x05DC File Management Configuration
0x05DD Server Address
0x05DF Vocabulary Index File
0x05E0 File ID
0x05E1 File Format
0x05E2 File Location
0x05E3 Gain
0x05E4 Speed
0x05E5 Barge In
0x05E6 File Event Descriptor
0x05E7 Playback Repeat
0x05E8 Beep Tone Parameters
0x05E9 Initial Silence Timer
0x05EA Final Silence Timer
0x05EB Maximum Record Timer
0x05EC Skip Steps
0x05ED Dual Channel Record Option
0x05EF Alarm Threshold Configure
0x05F0 DSP 2 Main Board Memory Alarm Threshold Configure
0x05F1 DSP Temporary Memory Alarm Threshold Configure
0x05F2 Play File Queue
0x05F3 Vocabulary Index Read Information
0x05F4 Statistics Update Timer
0x05F5 Fixed Memory Statistics
0x05F6 DSP Series 2 Cache Statistics
0x05F7 DSP Function Statistics
0x05F8 NFS Statistics
0x05F9 Query Statistics
0x05FA Card Object
0x05FB Silence Threshold
0x05FC Temporary Record File Timer
0x05FD CPU Statistics
0x05FE Resource Point Statistics
0x05FF DSP Cache Modify Action
0x0600 NFS User Group ID
0x0601 NFS Poll Retries
0x0602 Resource Type
0x0603 Channel/DSP Pool
0x0604 DTMF Clamping/Filtering Enable
0x0605 EXS Conferencing Encoding Type
0x0606 Monitor Conference Enable
0x0607 Output Gain Control
0x0608 Noise Gating Enable
0x0609 Noise Gate Parameters
0x060A Echo Suppression Enable
0x060B Echo Suppression Parameters
0x060C Automatic Gain Control Enable
0x060D Automatic Gain Control Input Level
0x060E Automatic Gain Control Parameters
0x060F Conference Failure Behavior
0x0610 Conference ID
0x0611 Forced Flag
0x0612 Connection Type
0x0613 Conference Size
0x0614 Offset and Length
0x0615 Append or Replace
0x0616 DSP Series 2 Overload Statistics
0x0617 Alarm Threshold Query
0x0618 Alarm Threshold Enabled Report
0x0619 PVD Parameters
0x0620 AMD Parameters
0x061B AMD Reports
0x061C Server State
0x0640 Matrix/Host Sequence Number Size
0x0641 Header Parameter Format
0x0642 T.30 Control Parameter Max Value
0x0643 T.30 Control Parameter Transmit Level
0x0644 T.30 Control Parameter ECM Enabled
0x0645 T.30 Control Parameter Local Session ID
0x0647 Receive Modem Type
0x0648 Receive Resolution Type
0x0649 Receive Encoding Type
0x064B Receive Bad Line
0x064C Receive Page Size
0x0651 Receive Enable ECM
0x0652 Receive Add Header
0x0654 Receive Line Error Threshold
0x0655 Receive Timeout
0x0657 Receive Terminal ID
0x065A Transmit Modem Type
0x065B Transmit Resolution Type
0x065C Transmit Page Size
0x0661 Transmit Enable ECM
0x0662 Transmit Add Header
0x0664 Transmit Enable CNG
0x0666 Transmit Timeout
0x0668 Transmit dbm Level
0x066A Transmit Terminal ID
0x066C Fax Processing Events Set Register
0x066D Fax Configuration Query Type
0x0673 Echo Cancel Tap Length
0x0674 Echo Cancel NLP Type
0x0675 Echo Cancel ADAPT
0x0676 Echo Cancel Bypass
0x0677 Echo Cancel G.176 Modem Answer Detection
0x0678 Echo Cancel NLP Threshold
0x0679 Echo Cancel CNG Noise Threshold
0x067A Echo Cancel H Register Reset
0x067E Echo Cancel Comfort Noise Level
0x0687 - Enable RTP for Play/Record File
0x0688 - RTP Record Mode
0x0689 - Start/Stop Sending RTP Packets
0x068A - Calender Time Offset for Sending RTP Packets
0x068B Input Gain Control
0x068C FAX Page Range
0x068D Transit Connection Mode
0x0690 Frequency Shift Keying (FSK) Data
0x0691 Terminal Equipment Alerting Signal (TAS)
0x0692 Subscriber Alerting Signal (SAS)
0x0693 FSK Data Transmission Type
0x0694 Short Message Service (SMS) Data
0x0695 FSK Modem Type
0x0750 Dial Pulse Detection Parameters
0x0751 - Play Continue On Digit Detection
0x09CA Add Global Title Group
0x09CB Delete Global Title Group
0x09CC Add Global Title Entry
0x09CD Delete Global Title Entry
0x09CE Build Index Table
0x09CF Global Title Group Query
0x09D0 Global Title Entry Query
0x09D1 Global Title Group Query Response
0x09D2 Global Title Entry Query Response
0x2710 Universal Protocol Data, Single
0x2710 Universal Protocol Data, Range
0x2712 Congestion Level (Interworking Only)
0x2716 Call Identity (Interworking Only)
0x2717 Called Party Number
0x2718 Calling Party Number (Connected Number)
0x271A Circuit State (Interworking Only)
0x271B Cause Indicators (Interworking Only)
0x2725 Forward Call Indicators (Interworking Only)
0x2727 Generic Digit Information (Interworking Only)
0x2729 Generic Number (Interworking Only)
0x272A Generic Reference Number (Interworking Only)
0x272B Hop Counter (Interworking Only)
0x2737 Original Called Number (Interworking Only)
0x273C Redirecting Number (Interworking Only)
0x273D Redirection Information (Interworking Only)
0x273E Redirection Number (Interworking Only
0x2745 Transit Network Selection (Interworking Only)
0x2749 Bearer Capability (Interworking Only)
0x274E NPDI Message Type
0x274F Progress Indicator (Interworking Only)
0x2750 Display (Interworking Only)
0x2751 High Layer Compatibility (Interworking Only)
0x2752 Low Layer Compatibility (Interworking Only)
0x2753 Calling Party Sub Address (Interworking Only)
0x2754 Called Party Sub Address (Interworking Only)
0x2755 Low Layer Compatibility Layer 1 Info (Interworking Only)
0x2756 Low Layer Compatibility Layer 2 Information (Interworking Only)
0x2757 Low Layer Compatibility Layer 3 Information
0x2758 Pulse Notification (Interworking Only)
0x2759 Call State (Interworking Only)
0x275A Generic Command (Interworking Only)
0x275B Generic Command Response (Interworking Only)
0x275C Signal (Interworking Only)
0x275D Pulsed-Signal (Interworking Only)
0x275E Steady Signal (Interworking Only)
0x275F Recognition Time (Interworking Only)
0x2760 Line Information (Interworking Only)
0x2761 Channel Identification
0x2762 Date and Time (Interworking Only)
0x2763 Carrier Information (Interworking Only)
0x277D Universal Message Envelope (Interworking Only)
0x277E Remote Side Protocol
0x277F - 0x2783 Display (Interworking Only)
0x2784 Charge Number (Interworking Only)
0x278C Connected Number Subaddress (Interworking Only)
0x278F Originating Line Information (Interworking Only)
0x2792 Source IP Address
0x2793 Source RTP Port
0x2794 Destination IP Address
0x2795 Destination RTP Port
0x27AF NPDI SIP Fax Mode
0x27B0 RTP Payload Type
0x27B1 RTP Payload Size
0x27B2 NPDI RTP Silence Suppression
0x27B3 NPDI RTP Connection Mode
0x27B4 IP Address Criteria
0x27C1 IP Signaling Series 3 Card ID
0x27C2 Remote End Signaling IP Address (Q.931)
0x27C3 Remote End Signaling Port (Q.931)
0x27C4 Source IP
0x27C5 Source Port
0x27C9 Charge Area Information Parameter
0x27CA Carrier Information Parameter (Interworking Only)
0x27CB Non-Presentation Reason (Interworking Only)
0x27D0 Partial Calling Line Identity (Interworking Only)
0x27D8 Source H.323 ID
0x27D9 Source URL
0x27DA Source E-mail
0x27DC Remote H.323 ID
0x27DD Remote URL
0x27DE Remote E-mail
0x27E3 Release Cause Code
0x27E4 H.245 Outbound Tunneling
0x290E NPDI SIP Proxy IP Address
0x290F NPDI SIP Proxy Port
0x2910 NPDI SIP Route Type
0x2914 NPDI SIP Local Lookup
0x2915 NPDI SIP Response Code
0x2916 SIP A Leg Transport Type
0x2917 SIP B Leg Transport Type
0x2919 NPDI SIP To Username
0x291A NPDI SIP To Password
0x291B NPDI SIP To Host Name
0x291C NPDI SIP To Port
0x291E NPDI SIP Refer to Username
0x291F NPDI SIP Refer to Password
0x2920 NPDI SIP Refer to Host Name
0x2921 NPDI SIP Refer to Port
0x2922 SIP REFER-To Header Param
0x2923 NPDI SIP From User Name
0x2924 NPDI SIP From Password
0x2925 NPDI SIP From Host Name
0x2926 NPDI SIP From Port
0x2928 SIP From Display Name
0x2929 - SIP Referred By Header URI TLV
0x292A - SIP Referred By Header Parameters TLV
0x292D NPDI SIP Contact URI User Name
0x292E NPDI SIP Contact Password
0x292F NPDI SIP Contact Hostname
0x2930 NPDI SIP Contact Port
0x2931 NPDI SIP Contact Expires
0x2933 SIP Contact Transport Type
0x2934 SIP Contact URI User Information Qualifier
0x2935 SIP Contact URI Parameters
0x2936 SIP Tunnel Type
0x2937 NPDI SIP Authenticate Scheme
0x2938 NPDI SIP Authentication Realm
0x2939 NPDI SIP Authenticate Username
0x293A NPDI SIP Authenticate Password
0x293B NPDI SIP Authorization Username
0x293C NPDI SIP Authorization Password
0x293D NPDI SIP Proxy Authorization Username
0x293E NPDI SIP Proxy Authorization Password
0x293F NPDI SIP Authentication Timeout
0x2941 SIP Authorization Header
0x2942 SIP Proxy Authorization Header
0x2943 SIP Authenticate Header
0x2944 SIP Proxy-Authenticate Header
0x2946 - SIP Request URI Password
0x2947 - SIP Request URI Header
0x2949 - SIP Response Reason Phrase
0x294A - NPDI SIP Extensions
0x294B Notify Status
0x294C Refer Spans Channel
0x294E SIP Remote IP Address
0x294F SIP Remote IP Port
0x2950 SIP Call ID
0x2951 SIP From Tag
0x2952 SIP to Tag
0x2953 Subsequent Information Status
0x2954 SIP Request URI User Name
0x2955 SIP Request URI Host Name
0x2956 SIP Request URI Port
0x2957 SIP Request URI User Information Qualifier
0x2958 SIP Request URI Parameters
0x2959 SIP Remote Party ID
0x295A SIP RPID Privacy
0x295B SIP Subject Header
0x295C SIP Message Body
0x295D Content Type
0x295E SIP Hostname
0x295F SIP Port Number
0x2960 Privacy Header
0x2961 Private Header Container
0x2962 Private Header Type
0x2963 Private Header Data
0x2964 SIP MIME Information
0x2965 SIP Content Encoding
0x2966 SIP Content Disposition
0x2967 SIP Content Language
0x2968 SIP MIME Message Body
0x2969 SIP Session Expiry Interval
0x2970 SIP Minimum Session Expiry Interval
0x299A SIP Header Field Container
0x299B SIP Header Field ID
0x299C SIP Header Field
0x29D4 SIP Do Not Close Socket
0x29FF Media Local End Point Information
0x2A00 Media Remote End Point Information
0x2A01 Media Per Stream Information
0x2A02 Media Per Codec Information
0x2A03 Media Type
0x2A07 Media Port
0x2A08 Media Payload Type
0x2A09 Media Payload Description
0x2A0A Media Payload Size
0x2A0B Media Clock Rate
0x2A0E Media Connection Address
0x2A13 Media Flow Direction
0x2A17 SDP Media Stream Native Text
0x4E21 Message Configuration Valid
0x4E22 Message Processing Supported
0x4E24 Acceptance Rate
0x9041 Protocol Parameters
0x9042 Application Server
0x9043 Application Server Process
0x9044 Signaling Gateway
0x9045 Signaling Gateway Process
0x9046 Connection
0x9048 Application Server In Service
0x9049 Route Set Query
0x904A Protocol Query
0x904B Application Server Query
0x904C Application Server Process Query
0x904D Signaling Gateway Query
0x904E Signaling Gateway Process Query
0x904F Connection Query
0x9050 General Query Data
0x9051 Application Server State Query
0x9052 Route Set
0x9053 Modify Destination
0x9054 Modify Protocol
0xE001 Command
0xE002 Service State
0xE003 AIB Container TLV
BT IUP TLVs
5 Response Status Values
6 PPL Component Information
7 Timers and Filters
PPL Developer’s Guide
