0% found this document useful (0 votes)

199 views1,526 pages

8.4.1API Reference

DIALOGIC(r) products are not intended for use in medical, life saving, life sustaining, critical control or safety systems, or in nuclear facility applications. Dialogic products may infringe one or more patents or other intellectual property rights owned by third parties.

Uploaded by

jgallartm

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

199 views1,526 pages

8.4.1API Reference

Uploaded by

jgallartm

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

Dialogic Converged Services Platform Release 8.4.

1 Engineering Release 3
API Reference

February 2008
[Link]

Copyright and Legal Disclaimer

............................................................................................................................................................................................................................................................

Copyright [1998-2008] Dialogic Corporation. All Rights Reserved. You may not reproduce this document in whole or in part without permission in writing from Dialogic Corporation at the address provided below. All contents of this document are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation or its subsidiaries. Reasonable effort is made to ensure the accuracy of the information contained in the document. However, due to ongoing product improvements and revisions, Dialogic Corporation and its subsidiaries do not warrant the accuracy of this information and cannot accept responsibility for errors or omissions that may be contained in this document. INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH DIALOGIC PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS EXPLICITLY SET FORTH BELOW OR AS PROVIDED IN A SIGNED AGREEMENT BETWEEN YOU AND DIALOGIC, DIALOGIC ASSUMES NO LIABILITY WHATSOEVER, AND DIALOGIC DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF DIALOGIC PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHT OF A THIRD PARTY. Dialogic products are not intended for use in medical, life saving, life sustaining, critical control or safety systems, or in nuclear facility applications. It is possible that the use or implementation of any one of the concepts, applications, or ideas described in this document, in marketing collateral produced by or on web pages maintained by Dialogic Corporation or its subsidiaries may infringe one or more patents or other intellectual property rights owned by third parties. Dialogic Corporation or its subsidiaries do not provide any intellectual property licenses with the sale of Dialogic products other than a license to use such product in accordance with intellectual property owned or validly licensed by Dialogic Corporation or its subsidiaries. More detailed information about such intellectual property is available from Dialogic Corporation's legal department at 9800 Cavendish Blvd., 5th Floor, Montreal, Quebec, Canada H4M 2V9. The software referred to in this document is provided under a Software License Agreement. Refer to the Software License Agreement for complete details governing the use of the software. Dialogic Corporation encourages all users of its products to procure all necessary intellectual property licenses required to implement any concepts or applications and does not condone or encourage any intellectual property infringement and disclaims any responsibility related thereto. These intellectual property licenses may differ from country to country and it is the responsibility of those who develop the concepts or applications to be aware of and comply with different national license requirements. Dialogic, Dialogic Pro, Brooktrout, Cantata, SnowShore, Eicon, Eicon Networks, Eiconcard, Diva, SIPcontrol, Diva ISDN, TruFax, Realblocs, Realcomm 100, NetAccess, Instant ISDN, TRXStream, Exnet, Exnet Connect, EXS, ExchangePlus VSE, Switchkit, N20, Powering The Service-Ready

page 2

Network, Vantage, Connecting People to Information, Connecting to Growth, Making Innovation Thrive, and Shiva, among others as well as related logos, are either registered trademarks or trademarks of Dialogic. Windows NT is a registered trademarks of Microsoft Corporation in the United States and/or other countries. Other names of actual companies and products mentioned herein are the trademarks of their respective owners. This document discusses one or more open source products, systems and/or releases. Dialogic is not responsible for your decision to use open source in connection with Dialogic products (including without limitation those referred to herein), nor is Dialogic responsible for any present or future effects such usage might have, including without limitation effects on your products, your business, or your intellectual property rights.

page 3

Dialogic Product Line Warranty

Unless otherwise stated in an applicable product purchase agreement between the Customer and Dialogic, Dialogic warrants that during the Warranty Period, products will operate in substantial conformance with Dialogic's standard published documentation accompanying the product. If a product does not operate in accordance therewith during the Warranty Period, the Customer must promptly notify Dialogic. Dialogic, at its option, will either repair or replace the product without charge. The Customer has the right, as their exclusive remedy, to return the product for a refund of purchase price or license fee if Dialogic is unable to repair or replace it.
Warranty Period

In the event that you have no signed agreement setting out a warranty period, the Warranty Period shall be the standard warranty period set out on [Link] on the date of your purchase of the product. The Warranty Period begins on the date of shipment of any products or software by Dialogic. The Warranty Period for repaired, replaced or corrected products and software shall be coterminous to the Warranty Provided for the original products or software purchased. To report warranty claims, Customer may contact Dialogic via email at techsupport@[Link] or call (781) 433-9600.
Warranty Provisions

A. During the Warranty Period, Dialogic warrants to Customer only that: (i) Products manufactured by Dialogic (including those manufactured for Dialogic by an original equipment manufacturer) will be free from defects in material and workmanship and will substantially conform to specifications for such products; (ii) software developed by Dialogic will be free from defects which materially affect performance in accordance with the specifications for such software. With respect to products or software or partial assembly of products furnished by Dialogic but not manufactured by Dialogic, Dialogic hereby assigns to Customer, to the extent permitted, the warranties given to Dialogic by its vendors of such items. B. If, under normal and proper use, a defect or non conformity appears in warranted products or software during the applicable Warranty Period and Customer promptly notifies Dialogic in writing during the applicable warranty period of such defect or non conformance, and follows Dialogic's instructions regarding return of such defective or non conforming Product or Software, then Dialogic will, at no charge to Customer, either: (i) repair, replace or correct the same at its manufacturing or repair facility or (ii) if Dialogic determines that it is unable or impractical to repair, replace or correct the product or software, provide a refund or credit not to exceed the original purchase price or license fee.

page 4

C. No product or software will be accepted for repair or replacement without the written authorization of and in accordance with instructions from Dialogic. Removal and reinstallation expenses as well as transportation expenses associated with returning such product or software to Dialogic shall be borne by Customer. Dialogic shall pay the costs of transportation of the repaired or replaced product or software to the destination designated in the original Order. If Dialogic determines that any returned product or software is not defective, Customer shall pay Dialogic's costs of handling, inspecting, testing and transportation. In repairing or replacing any product, part of product, or software medium under this warranty, Dialogic may use new, remanufactured, reconditioned, refurbished or functionally equivalent products, parts or software media. Replaced products or parts shall become Dialogic's property. D. Dialogic makes no warranty with respect to defective conditions or non conformities resulting from any of the following: Customer's modifications, misuse, neglect, accident or abuse; improper wiring, repairing, splicing, alteration, installation, storage or maintenance performed in a manner not in accordance with Dialogic's or its vendor's specifications, or operating instructions; failure of Customer to apply Dialogic's previously applicable modifications or corrections; or items not manufactured by Dialogic or purchased by Dialogic pursuant to its procurement specifications. Dialogic makes no warranty with respect to products which have had their serial numbers removed or altered; with respect to expendable items, including, without limitation, fuses, light bulbs, motor brushes and the like; or with respect to defects related to Customer's data base errors. Improper packaging of product for repair will not be covered under this warranty agreement. No warranty is made that software will run uninterrupted or error free. E. Warranty does not include: a) Dialogic's assistance in diagnostic efforts; b) access to Dialogic's Technical Support web sites, databases or tools; c) product integration testing; d) on-site assistance; or e) product documentation updates. These services are available either during or after warranty at Dialogic's published prices. F. THE FOREGOING WARRANTIES ARE EXCLUSIVE & ARE GRANTED IN LIEU OF ALL OTHER EXPRESS & IMPLIED WARRANTIES (WHETHER WRITTEN, ORAL, STATUTORY OR OTHERWISE), INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. CUSTOMER'S SOLE AND EXCLUSIVE REMEDY AND DIALOGIC'S SOLE OBLIGATION HEREUNDER, SHALL BE TO REPAIR, REPLACE, CREDIT OR REFUND AS SET FORTH ABOVE. G. IN NO EVENT SHALL DIALOGIC, ITS DIRECTORS, OFFICERS, EMPLOYEES, AGENTS OR AFFILIATES, BE LIABLE FOR ANY COSTS OR DAMAGES ARISING DIRECTLY OR INDIRECTLY FROM YOUR USE OF ANY PRODUCT INCLUDING ANY INDIRECT,
page 5

INCIDENTAL, SPECIAL, EXEMPLARY, MULTIPLE, PUNITIVE OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, WHETHER BASED ON CONTRACT, TORT (INCLUDING NEGLEGENCE), STRICT LIABILITY OR OTHER LEGAL THEORY, EVEN IF DIALOGIC, OR ANY OF ITS DIRECTORS, OFFICERS, EMPLOYEES, AGENTS OR AFFILIATES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN ANY EVENT, DIALOGIC'S CUMULATIVE LIABILITY TO YOU FOR ANY AND ALL CLAIMS RELATING TO THE USE OF ANY PRODUCT SHALL NOT EXCEED THE TOTAL AMOUNT OF THE PURCHASE PRICE OR LICENSE FEES PAID TO DIALOGIC FOR SUCH PRODUCT. H. CUSTOMER AND DIALOGIC HEREBY WAIVE THEIR RIGHT TO TRIAL BY JURY TO THE FULLEST EXTENT PERMITTED BY LAW IN CONNECTION WITH ALL CLAIMS ARISING OUT OF OR RELATED TO THIS WARRANTY, THE PRODUCTS COVERED HEREBY OR THE PERFORMANCE OF ANY PARTY HEREUNDER. I. THIS WARRANTY SHALL BE CONSTRUED UNDER AND GOVERNED BY THE LAWS OF THE COMMONWEALTH OF MASSACHUSETTS WITHOUT GIVING EFFECT TO ANY CHOICE OR CONFLICT OF LAW PROVISION OR RULE (WHETHER OF THE COMMONWEALTH OF MASSACHUSETTS OR ANY OTHER JURISDICTION) THAT WOULD CAUSE THE APPLICATION OF THE LAWS OF ANY JURISDICTION OTHER THAN THE COMMONWEALTH OF MASSACHUSETTS. CUSTOMER SPECIFICALLY AND IRREVOCABLY CONSENTS TO THE PERSONAL AND SUBJECT MATTER JURISDICTION AND VENUE OF THE FEDERAL AND STATE COURTS OF THE COMMONWEALTH OF MASSACHUSETTS AND SUCH COURTS SHALL HAVE EXCLUSIVE JURISDICTION WITH RESPECT TO ALL MATTERS CONCERNING THIS WARRANTY OR THE ENFORCEMENT OF ANY OF THE FOREGOING. J. THIS WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS. YOU MAY ALSO HAVE OTHER RIGHTS WHICH VARY FROM JURISDICTION TO JURISDICTION.

page 6

About this Publication

Purpose

This publication provides guidelines for using the Dialogic CSP.

Safety Labels

The following Safety labels may appear in this information product to alert customers to avoidable hazards. The following are in the order of priority:

DANGER
Danger indicates the presence of a hazard that will cause death or severe personal injury if the hazard is not avoided.

WARNING
Warning indicates the presence of a hazard that can cause death or severe personal injury if the hazard is not avoided.

CAUTION
Caution indicates the presence of a hazard that will or can cause minor personal injury or property damage if the hazard is not avoided. Caution can also indicate the possibility of data loss, loss of service, or that an application will fail.

page 7

Conventions used

This information product uses the text conventions explained below. In addition, hexadecimal numbers are preceded by a zero and small x. For example, the decimal number 15 is represented in hexadecimal as 0x0F.

Convention
... : n Sans serif mono space Sans serif monospace italic Serif italic Boldface Sans serif boldface

Description
A horizontal ellipsis in an API message indicates fields of variable length. A vertical ellipsis in an API message indicates that a block of information is repeated or is variable. The letter n is a generic placeholder for a number. Indicates a command name, option, input, output, non-GUI error, and system messages. Indicates a parameter name in an input message. Example: move *.dot a: c: -s The -s is the parameter. Indicates the name of a book, chapter, path, file, or API message. Example: UserDirectory/[Link] Indicates keyboard keys, key combinations, and command buttons Example: Ctrl+Alt+Del Identifies text that is part of a graphical user interface (GUI). Example: Go to the Configuration menu and select Card->Span Configuration

page 8

Numerical List of EXS API Messages

0x0000 ............................................................................... Connect 0x0000 0x0001 ...................................... Channel Connection Status Query 0x0001 0x0002 .................................................................. Version Request 0x0002 0x0003 ............................................................... Connect With Pad 0x0003 0x0005 ..............................................................Connect With Data 0x0005 0x0006 .................................... Synchronization Priority List Query 0x0081 0x0007 ........................................................ Card Population Query 0x0007 0x0008 ...................................................................Release Channel 0x0008 0x000A...................................................... Service State Configure 0x000A 0x000B.............................................................Reset Configuration 0x000B 0x000C........................................................ Clear System Software 0x000C 0x000D....................................... Subrate Connection Management 0x000D 0x000F .......................................................... DS3 Configure/Query 0x000F 0x0010 ...................................................... Assign Logical Node ID 0x0010 0x0011 ......................................................... Trunk Type Configure 0x0011 0x0012 .........................................................Filter/Timer Configure 0x0012 0x0013 ............................................................. Start Dial Configure 0x0013 0x0014 ..............................................Transmit Signaling Configure 0x0014 0x0015 ............................................... Receive Signaling Configure 0x0015 0x0016 ....................................................... Flash Timing Configure 0x0016 0x0017 ....................................................................... Connect Wait 0x0017 0x0018 .............................................................................. Busy Out 0x0018 0x0019 ................................................................J1 Span Configure 0x0019 0x001A....................................................... Cross Connect Channel 0x001A 0x001B.................................................. Cross Disconnect Channel 0x001B 0x001C............................................................ Cross Connect Span 0x001C 0x001D........................................................Cross Disconnect Span 0x001D 0x001E ......................................................Disconnect Tone Pattern 0x001E 0x0020 .................................................................... Outpulse Digits 0x0020 0x0021 .................................... Local End Release Mode Configure 0x0021
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x0023 .............................................. Standby Line Card Configure 0x0023 0x0024 .......................................................... Line Card Switchover 0x0024 0x0028 .......................................... Inpulsing Parameters Configure 0x0028 0x0029 ....................................... Inseize Instruction List Configure 0x0029 0x002A.................................... Outseize Instruction List Configure 0x002A 0x002B.................................................................... Inseize Control 0x002B 0x002C..................................................................Outseize Control 0x002C 0x002D...........................................Request For Service With Data 0x002D 0x002E ..........................................................Call Processing Event 0x002E 0x002F .......................................................... Connect Tone Pattern 0x002F 0x0030 ...................................Transmit Cadence Pattern Configure 0x0030 0x0031 .................................................................... Tone Configure 0x0031 0x0034 .............................................. Call Progress Analysis Result 0x0034 0x0036 ................................................. Release Channel With Data 0x0036 0x0037 ..................................................... Channel Release Request 0x0037 0x003A..................................................................... TFTP Manage 0x003A 0x003D.............................Generic Event Logger Configure/Query 0x003D 0x0040 ............................................................. Request For Service 0x0040 0x0042 .............................................................. DS0 Status Change 0x0042 0x0043 ........................................................... PPL Event Indication 0x0043 0x0044 .............................................................. PPL Event Request 0x0044 0x0045 ......................................................... Diagnostics Indication 0x0045 0x0046 ..................................................................... Generic Report 0x0046 0x0047 ..................................................................... CPC Detection 0x0047 0x0049 .................................................................Channel Released 0x0049 0x004A...................................................... Loop Timing Configure 0x004A 0x004B............................................................... Conference Create 0x004B 0x004C................................................. Conference Delete Request 0x004C 0x004D.............................................................Conference Deleted 0x004D 0x004E ....................................................... Connect To Conference 0x004E 0x004F .......................................Connect One-Way To Conference 0x004F 0x0050 ....................................................Connect One-Way Forced 0x0050 0x0052 .......................Recorded Announcement Download Initiate 0x0052
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x0053 ................................... Recorded Announcement Download 0x0053 0x0054 ......................................... Recorded Announcement Delete 0x0054 0x0055 ...................................... Recorded Announcement Connect 0x0055 0x0056 ..................................Recorded Announcement Disconnect 0x0056 0x0057 ..........................................Recorded Announcement Query 0x0057 0x0058 ......................................... Recorded Announcement Report 0x0058 0x0059 ......................................... Transmit Cadence Pattern Query 0x0059 0x005A......................................................................... Tone Query 0x005A 0x005B............................................... CCS Redundancy Configure 0x005B 0x005C........................................... SS7 Signaling Stack Configure 0x005C 0x005D...................................... SS7 Signaling Link Set Configure 0x005D 0x005E .............................................SS7 Signaling Link Configure 0x005E 0x005F ...........................................SS7 Signaling Route Configure 0x005F 0x0060 ....................................................ISDN Interface Configure 0x0060 0x0062 ................................................... ISDN Terminal Configure 0x0062 0x0063 ......................................................................... ISDN Query 0x0063 0x0064 ............................................. SS7 Signaling Link Set Query 0x0064 0x0065 ................................................... SS7 Signaling Link Query 0x0065 0x0066 ................................................. SS7 Signaling Route Query 0x0066 0x0067 .................................................................... SS7 CIC Query 0x0067 0x0068 ................................................... SS7 ISUP Message Query 0x0068 0x0069 ............................................... Channel Released With Data 0x0069 0x006A ............................................................ SS7 CIC Configure 0x006A 0x006B ............................... SS7 ISUP Message Format Configure 0x006B 0x006C..................................................... CCS Redundancy Query 0x006C 0x006D ................................................ SS7 Signaling Stack Query 0x006D 0x006E ....................................................... Assign EXS Host/Slave 0x006E 0x006F ............................................................... Node Status Query 0x006F 0x0070 .............................................................. Node Status Report 0x0070 0x0071 ................................................................ Ring Status Query 0x0071 0x0072 ............................................................... Ring Status Report 0x0072 0x0073 ..................................................... CCS Redundancy Report 0x0073 0x0074 ...................................................... EXNET Ring Configure 0x0074
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x0077 ................................................SS7 SCCP/TCAP Configure 0x0077 0x0078 ...................................................... SS7 SCCP/TCAP Query 0x0078 0x0079 .................................................. Product License Download 0x0079 0x007A........................................................Product License Query 0x007A 0x007B.......................................................................V5 Configure 0x007B 0x007C......................................................V5 Configuration Query 0x007C 0x007D.................................................................Matrix Configure 0x007D 0x007E ......................................... EXS Node Configuration Query 0x007E 0x007F ........................................................... EXS Node Configure 0x007F 0x0080 .................................................... Channel Parameter Query 0x0080 0x0081 .................................... Synchronization Priority List Query 0x0081 0x0082 .............................................................. System Log Query 0x0082 0x0083 ................................................................ Card Status Query 0x0083 0x0084 ................................................................Span Status Query 0x0084 0x0085 ..................................................................... T1 Span Query 0x0085 0x0086 ................................................................... Fault Log Query 0x0086 0x0087 ...........................................Call Control Instructions Query 0x0087 0x0089 .................................................Inpulsing Parameters Query 0x0089 0x008A......................Call Progress Analysis Configuration Query 0x008A 0x008E ........................................... System Resource Usage Query 0x008E 0x008F ..................................SS7 TUP Message Format Configure 0x008F 0x0090 .....................................................SS7 TUP Message Query 0x0090 0x0092 ................................................................. SNMP Configure 0x0092 0x0091 ................................................Loop Back Configure/Query 0x0091 0x0097 ........................................................................Matrix Query 0x0097 0x009B.................................................. Download Begin BRecord 0x009B 0x009C............................................................. Download BRecord 0x009C 0x009D........................................................................ Reset Matrix 0x009D 0x009E .........................................................................Poll Request 0x009E 0x009F ........................................................ Poll Interval Configure 0x009F 0x00A1.................................................................... Become Active 0x00A1 0x00A2...................................................Download Begin SRecord 0x00A2 0x00A3............................................................. Download SRecord 0x00A3
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x00A4........................................................... Download Complete 0x00A4 0x00A6.............................................................. Card Status Report 0x00A6 0x00A8...................................................... Assign Logical Span ID 0x00A8 0x00A9.............................................................. T1 Span Configure 0x00A9 0x00AB .....................................................................................Poll 0x00AB 0x00AF ........................................................ System Configuration 0x00AF 0x00B2........................... Call Progress Analysis Pattern Configure 0x00B2 0x00B3..............................Call Progress Analysis Class Configure 0x00B3 0x00B4...............................................System Configuration Query 0x00B4 0x00B5.............................................................................. Time Set 0x00B5 0x00B8.................................................. Distant End Release Mode 0x00B8 0x00B9...................................................................................Alarm 0x00B9 0x00BA ........................................ Generate Call Processing Event 0x00BA 0x00BB ............................... Answer Supervision Mode Configure 0x00BB 0x00BC ............................................................Collect Digit String 0x00BC 0x00BD .........................................................DSP Service Request 0x00BD 0x00BE ........................................................... DSP Service Cancel 0x00BE 0x00BF....................................................................... Park Channel 0x00BF 0x00C0.........................................................DSP SIMM Configure 0x00C0 0x00C1..................................................................... Alarm Cleared 0x00C1 0x00C4............................................................... D Channel Assign 0x00C4 0x00C5...........................................................D Channel De-assign 0x00C5 0x00C6...................................... D Channel Facility List Configure 0x00C6 0x00C8...........................................................B Channel Configure 0x00C8 0x00CA ............................................................... B Channel Query 0x00CA 0x00CB ...........................................D Channel Facility List Query 0x00CB 0x00CD ........................................................ Span Filter Configure 0x00CD 0x00CE ...............................................................Span Filter Query 0x00CE 0x00CF..........................................................PPL Timer Configure 0x00CF 0x00D0............................................................... Tag Configuration 0x00D0 0x00D1..........................................................................PPL Assign 0x00D1 0x00D2.......................................... PPL Transmit Signal Configure 0x00D2 0x00D3.................................................... Busy Out Flag Configure 0x00D3
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x00D4.......................................................................... PPL Create 0x00D4 0x00D5..............................................PPL Table Download Initiate 0x00D5 0x00D6.......................................................... PPL Table Download 0x00D6 0x00D7.....................................................................PPL Configure 0x00D7 0x00D8.............................................................. E1 Span Configure 0x00D8 0x00D9..................................... PCM Encoding Format Configure 0x00D9 0x00DA........................................................................ PPL Delete 0x00DA 0x00DB ...................................................................E1 Span Query 0x00DB 0x00DC .........................................................PPL Audit Configure 0x00DC 0x00DD...............................................................PPL Audit Query 0x00DD 0x00DE .................................................................PPL Data Query 0x00DE 0x00DF ........................................................... PPL Protocol Query 0x00DF 0x00E0 ........................................................Virtual Card Configure 0x00E0 0x00E2 ............................................................Virtual Span Control 0x00E2 0x00E3 ..............................................Resource Attribute Configure 0x00E3 0x00E4 ....................................................Resource Attribute Query 0x00E4 0x00E5 ............................................................Matrix Status Report 0x00E5 0x00E6 ................................................................ IP Address Query 0x00E6 0x00E7 .......................................................... IP Address Configure 0x00E7 0x00E8 ...................................................................... Route Control 0x00E8 0x00E9 .......................................................... Multi-Host Configure 0x00E9 0x00EA ..........................................................SS7 CLLI Configure 0x00EA 0x00EB ................................................................ SS7 CLLI Query 0x00EB 0x00EE.................................................... VoIP Protocol Configure 0x00EE 0x00EF........................................................... VoIP Protocol Query 0x00EF 0x00F0 .............................................................IP Socket Configure 0x00F0 0x00F1 ................................................................... IP Socket Query 0x00F1 0x00F2 ....................................................... IP Socket Status Report 0x00F2 0x00FB.............................................................. ARP Cache Report 0x00FB 0x00FC............................................................... ARP Cache Query 0x00FC 0x0100 .................................. IP Signaling Series 3 Card Configure 0x0100 0x0101 ........................................ IP Signaling Series 3 Card Query 0x0101 0x0102 ......................Recorded Announcement File System Query 0x0102
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x0103 .............Recorded Announcement File System Defragment 0x0103 0x0104 ................................... IP Signaling Series 3 Card Host Poll 0x0104 0x0105 ............................ IP Signaling Series 3 Card Status Report 0x0105 0x0107 ......................................... Reset IP Signaling Series 3 Card 0x0107 0x0108 ......................................... Clear IP Signaling Series 3 Card 0x0108 0x0117 .............................. Recorded Announcement Single Delete 0x0117 0x0118 ................... Recorded Announcement File System Convert 0x0118 0x0119 ..................... Recorded Announcement File System Report 0x0119 0x011A............................................................. DSP Cache Modify 0x011A 0x011B...................................................................... Play File Start 0x011B 0x011C..................................................................Play File Modify 0x011C 0x011D...................................................................... Play File Stop 0x011D 0x011E ..................................................................Record File Start 0x011E 0x011F ..............................................................Record File Modify 0x011F 0x0120 .................................................................. Record File Stop 0x0120 0x0121 .................................................................... Statistics Query 0x0121 0x0122 ....................................................... Generic Card Configure 0x0122 0x0123 ............................................................. Generic Card Query 0x0123 0x0124 ................................................................... Resource Create 0x0124 0x0125 ..................................................................Resource Modify 0x0125 0x0126 ................................................................... Resource Delete 0x0126 0x0127 ................................................................ Resource Connect 0x0127 0x0128 ............................................................Resource Disconnect 0x0128 0x0129 .................................................. Resource Delete Indication 0x0129 0x012C................................................................... Resource Query 0x012C 0x012D.................................................. Resource Release Request 0x012D 0x012E ...............................................Resource Release Indication 0x012E 0x0130 ....................................................................NGA Configure 0x0130 0x0131 .........................................................NGA Configure Query 0x0131 0x0141 ............................................... Resource Information Notify 0x0141 0x0160 .......................................................NGA Service Configure 0x0160 0x0161 ............................................................. NGA Service Query 0x0161 0x0162 ................................................................. NGA State Query 0x0162
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

0x0163 .................................................................NGA State Notify 0x0163

............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

EXS API Message Set

Alarm 0x00B9 Alarm Cleared 0x00C1 Answer Supervision Mode Configure 0x00BB ARP Cache Query 0x00FC ARP Cache Report 0x00FB Assign EXS Host/Slave 0x006E Assign Logical Node ID 0x0010 Assign Logical Span ID 0x00A8 B Channel Configure 0x00C8 B Channel Query 0x00CA Become Active 0x00A1 Busy Out 0x0018 Busy Out Flag Configure 0x00D3 Call Control Instructions Query 0x0087 Call Processing Event 0x002E Call Progress Analysis Class Configure 0x00B3 Call Progress Analysis Configuration Query 0x008A Call Progress Analysis Pattern Configure 0x00B2 Call Progress Analysis Result 0x0034 Card Population Query 0x0007 Card Status Query 0x0083 Card Status Report 0x00A6 CCS Redundancy Configure 0x005B CCS Redundancy Query 0x006C CCS Redundancy Report 0x0073 Channel Connection Status Query 0x0001 Channel Parameter Query 0x0080 Channel Release Request 0x0037 Channel Released 0x0049 Channel Released With Data 0x0069
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

Clear IP Signaling Series 3 Card 0x0108 Clear System Software 0x000C Collect Digit String 0x00BC Conference Create 0x004B Conference Delete Request 0x004C Conference Deleted 0x004D Connect 0x0000 Connect One-Way Forced 0x0050 Connect One-Way To Conference 0x004F Connect To Conference 0x004E Connect Tone Pattern 0x002F Connect Wait 0x0017 Connect With Data 0x0005 Connect With Pad 0x0003 CPC Detection 0x0047 Cross Connect Channel 0x001A Cross Connect Span 0x001C Cross Disconnect Channel 0x001B Cross Disconnect Span 0x001D D Channel Assign 0x00C4 D Channel De-assign 0x00C5 D Channel Facility List Configure 0x00C6 D Channel Facility List Query 0x00CB Diagnostics Indication 0x0045 Disconnect Tone Pattern 0x001E Distant End Release Mode 0x00B8 Download Begin BRecord 0x009B Download Begin SRecord 0x00A2 Download BRecord 0x009C Download Complete 0x00A4 Download SRecord 0x00A3 DS0 Status Change 0x0042 DS3 Configure/Query 0x000F
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

DSP Cache Modify 0x011A DSP Service Cancel 0x00BE DSP Service Request 0x00BD DSP SIMM Configure 0x00C0 E1 Span Configure 0x00D8 E1 Span Query 0x00DB EXNET Ring Configure 0x0074 EXS Node Configuration Query 0x007E EXS Node Configure 0x007F Fault Log Query 0x0086 Filter/Timer Configure 0x0012 Flash Timing Configure 0x0016 Generate Call Processing Event 0x00BA Generic Card Configure 0x0122 Generic Card Query 0x0123 Generic Event Logger Configure/Query 0x003D Generic Report 0x0046 Inpulsing Parameters Configure 0x0028 Inpulsing Parameters Query 0x0089 Inseize Control 0x002B Inseize Instruction List Configure 0x0029 IP Address Configure 0x00E7 IP Address Query 0x00E6 IP Signaling Series 3 Card Configure 0x0100 IP Signaling Series 3 Card Host Poll 0x0104 IP Signaling Series 3 Card Query 0x0101 IP Signaling Series 3 Card Status Report 0x0105 IP Socket Configure 0x00F0 IP Socket Query 0x00F1 IP Socket Status Report 0x00F2 ISDN Interface Configure 0x0060 ISDN Query 0x0063 ISDN Terminal Configure 0x0062
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

J1 Span Configure 0x0019 Line Card Switchover 0x0024 Local End Release Mode Configure 0x0021 Loop Back Configure/Query 0x0091 Loop Timing Configure 0x004A Matrix Configure 0x007D Matrix Query 0x0097 Matrix Status Report 0x00E5 Multi-Host Configure 0x00E9 Node Status Query 0x006F NGA Configure 0x0130 NGA Configure Query 0x0131 NGA Service Configure 0x0160 NGA Service Query 0x0161 NGA State Notify 0x0163 NGA State Notify 0x0163 Node Status Report 0x0070 Outpulse Digits 0x0020 Outseize Control 0x002C Outseize Instruction List Configure 0x002A Park Channel 0x00BF PCM Encoding Format Configure 0x00D9 Play File Modify 0x011C Play File Start 0x011B Play File Stop 0x011D Poll 0x00AB Poll Interval Configure 0x009F Poll Request 0x009E PPL Assign 0x00D1 PPL Audit Configure 0x00DC PPL Audit Query 0x00DD PPL Configure 0x00D7 PPL Create 0x00D4
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

PPL Data Query 0x00DE PPL Delete 0x00DA PPL Event Indication 0x0043 PPL Event Request 0x0044 PPL Protocol Query 0x00DF PPL Table Download 0x00D6 PPL Table Download Initiate 0x00D5 PPL Timer Configure 0x00CF PPL Transmit Signal Configure 0x00D2 Product License Download 0x0079 Product License Query 0x007A Receive Signaling Configure 0x0015 Record File Modify 0x011F Record File Start 0x011E Record File Stop 0x0120 Recorded Announcement Connect 0x0055 Recorded Announcement Delete 0x0054 Recorded Announcement Disconnect 0x0056 Recorded Announcement Download 0x0053 Recorded Announcement Download Initiate 0x0052 Recorded Announcement File System Convert 0x0118 Recorded Announcement File System Defragment 0x0103 Recorded Announcement File System Query 0x0102 Recorded Announcement File System Report 0x0119 Recorded Announcement Query 0x0057 Recorded Announcement Report 0x0058 Recorded Announcement Single Delete 0x0117 Release Channel 0x0008 Release Channel With Data 0x0036 Request For Service 0x0040 Request For Service With Data 0x002D Reset Configuration 0x000B Reset IP Signaling Series 3 Card 0x0107
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

Reset Matrix 0x009D Resource Attribute Configure 0x00E3 Resource Attribute Query 0x00E4 Resource Connect 0x0127 Resource Create 0x0124 Resource Delete 0x0126 Resource Delete Indication 0x0129 Resource Disconnect 0x0128 Resource Information Notify 0x0141 Resource Release Request 0x012D Resource Query 0x012C Resource Release Indication 0x012E Resource Modify 0x0125 Ring Status Query 0x0071 Ring Status Report 0x0072 Route Control 0x00E8 Service State Configure 0x000A SNMP Configure 0x0092 Span Filter Configure 0x00CD Span Filter Query 0x00CE Span Status Query 0x0084 SS7 CIC Configure 0x006A SS7 CIC Query 0x0067 SS7 CLLI Configure 0x00EA SS7 CLLI Query 0x00EB SS7 ISUP Message Format Configure 0x006B SS7 ISUP Message Query 0x0068 SS7 SCCP/TCAP Configure 0x0077 SS7 SCCP/TCAP Query 0x0078 SS7 Signaling Link Configure 0x005E SS7 Signaling Link Query 0x0065 SS7 Signaling Link Set Configure 0x005D SS7 Signaling Link Set Query 0x0064
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

SS7 Signaling Route Configure 0x005F SS7 Signaling Route Query 0x0066 SS7 Signaling Stack Configure 0x005C SS7 Signaling Stack Query 0x006D SS7 TUP Message Format Configure 0x008F SS7 TUP Message Query 0x0090 Standby Line Card Configure 0x0023 Start Dial Configure 0x0013 Statistics Query 0x0121 Subrate Connection Management 0x000D Synchronization Priority List Configure 0x0006 Synchronization Priority List Query 0x0081 System Configuration 0x00AF System Configuration Query 0x00B4 System Log Query 0x0082 System Resource Usage Query 0x008E T1 Span Configure 0x00A9 T1 Span Query 0x0085 Tag Configuration 0x00D0 TFTP Manage 0x003A Time Set 0x00B5 Tone Configure 0x0031 Tone Query 0x005A Transmit Cadence Pattern Configure 0x0030 Transmit Cadence Pattern Query 0x0059 Transmit Signaling Configure 0x0014 Trunk Type Configure 0x0011 V5 Configure 0x007B V5 Configuration Query 0x007C Version Request 0x0002 Virtual Card Configure 0x00E0 Virtual Span Control 0x00E2 VoIP Protocol Configure 0x00EE
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

VoIP Protocol Query 0x00EF

............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

SwitchKit Message Set

ActivateMatrix AddLLCCard AddLLCNode AddSS7TCAPCard AdjustMessageTimeout Alarm AlarmCleared AllInService AllocateChannel AllocateChannelGroup AllOutOfService AnswerSuperviseConfig AppConnectionQuery AppDescriptionData AppPopulationQuery ARPCacheQuery ARPCacheReport AssignEXSHostSlave AssignNode AssignSpan AssociateChanGroup BChannelConfig BChannelQuery BroadcastLoad BusyOut BusyOutFlagConfig CallControlInstructionQuery CallProcessingEvent CancelUserTimer CardPopulationQuery
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

CardStatusQuery CardStatusReport CCSRedundancyConfig CCSRedundancyQuery CCSRedundancyReport ChannelConnectionStatusQuery ChannelGroupContentsQuery ChannelGroupPopulationQuery ChannelParameterQuery ChannelProblem ChannelReleased ChannelReleasedWithData ChannelReleaseRequest ClearAllChanGroups ClearChanGroup ClearLog ClearSoftware ClearSystemSoftware CollectDigitString ConferenceCreate ConferenceDeleted ConferenceDeleteRequest ConfigChanGroup ConfigStatusMsg ConfigSwitch Connect ConnectionStatusMsg ConnectOneWayForced ConnectOneWayToConference ConnectToConference ConnectTonePattern ConnectWait ConnectWithData
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

ConnectWithPad CPAClassConfig CPAConfigQuery CPAPatternConfig CPAResult CPCDetection CreateConnection CrossConnectChannel CrossConnectSpan CrossDisconnectChannel CrossDisconnectSpan CSAPPLConfig CSAPPLTimerConfig D Channel Assign DChannelDeAssign DChannelFacilityListConfig DChannelFacilityListQuery DeviceServerConfig DeviceServerEx DeviceServerQuery DeviceServerStatusReport DiagnosticsIndication DisconnectTonePattern DistantEndReleaseMode DownloadBeginBRecord Download Begin SRecord DownloadBRecord DownloadComplete DownloadSRecord DS0StatusChange DS3GenericMessage DSPCacheModify DSPServiceCancel
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

DSPServiceRequest DSPSIMMConfig DynamicConfig E1SpanConfig E1SpanQuery FaultLogQuery FilterTimerConfig FlashTimingConfig ForceGroupState GELConfigQuery GenerateCallProcessingEvent GenerateLogMsg GenericCardConfigure Generic Card Query GenericLLCReport GenericReport HexTool HostAlarm IgnoreChanGroup InpulsingParametersConfig InpulsingParametersQuery InseizeControl InseizeInstrListConfig InterAppMsg IPAddressConfig IPAddressQuery IPCallServerConfig IPCallServerQuery IPSocketConfig IPSocketQuery IPSocketStatusReport ISDNInterfaceConfig ISDNQuery
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

ISDNTerminalConfig J1SpanConfig LineCardSwitchover LLCControl LLCQuery LocalReleaseConfig LoopBackConfig LoopTimingConfig MessageWrapper MonitorChannel MultiHostConfig NodeConfig NodeConfigQuery NodeStatusQuery NodeStatusReport OutpulseDigits Outseize Control OutseizeInstrListConfig ParkChannel PCMEncodingConfig PlayFileModify PlayFileStart PlayFileStop Poll PollIntervalConfig PollRequest PPLAssign PPLAuditConfig PPLAuditQuery PPLConfig PPLCreate PPLDataQuery PPLDelete
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

PPLEventIndication PPLEventRequest PPLInitiateDownload PPLProtocolQuery PPLTableDownload PPLTimerConfig PPLTool PPLTransmitSignalConfig ProductLicenseDownload ProductLicenseQuery RecAnnConnect RecAnnDelete RecAnnDisconnect RecAnnDownload RecAnnDownloadInitiate RecAnnFSConvert RecAnnFSDefrag RecAnnFSQuery RecAnnFSReport RecAnnQuery RecAnnReport RecAnnSingleDelete RecordFileModify RecordFileStart RecordFileStop ReceiveSignalingConfig RedundantAppPoolMembersQuery RedundantAppPoolsQuery RedundantAppQuery RedundantAppStatusMsg RedundantLLCRegister RegisterAsRedundantApp RegisterVirtualName
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

ReleaseCacheChannels ReleaseChannel ReleaseChannelWithData Remove Channels From Group RemoveLLCRoutingID RequestChannelAck RequestChannelMsg RequestForService RequestForServiceWithData RequestStandbyPoll ReselectPrimaryApp ResetConfig ResetMatrix ResetStandbyMatrix ResourceAttributeConfig ResourceAttributeQuery Resource Connect Resource Create Resource Delete Resource Modify RingConfig RingStatusQuery RingStatusReport RouteControl ServerStatusChange ServiceStateConfig SNMPConfig SpanFilterConfig SpanFilterQuery SpanStatusQuery SS7CICConfig SS7CICQuery SS7CLLIConfig
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

SS7CLLIQuery SS7ISUPMessageFormatConfig SS7ISUPMessageQuery SS7SCCPTCAPConfig SS7SCCPTCAPQuery SS7SignalingLinkConfig SS7SignalingLinkQuery SS7SignalingLinkSetConfig SS7SignalingLinkSetQuery SS7SignalingRouteConfig SS7SignalingRouteQuery SS7SignalingStackConfig SS7SignalingStackQuery SS7TUPMessageFormatConfig SS7TUPMessageQuery StandbyLineCardConfig StartDialConfig Statistics Query SubrateConnectionManagement SwitchBackFromStandby SwitchMgrQuery SynchPriorityConfig SynchPriorityQuery SystemConfig SystemConfigQuery SystemLogQuery SystemResourceUtilQuery T1SpanConfig T1SpanQuery TagConfig TCAPMessageRegister TFTPManage TimeSet
............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

TransferChanMsg TransmitCadencePatternConfig TransmitCadencePatternQuery TransmitSignalingConfig TransmitToneConfig TransmitToneQuery TrunkTypeConfig UpgradeSoftwarePatch UserTimer V5Config V5Query VersionRequestQuery VirtualSlotConfig VirtualSpanControl VoIPProtocolConfig VoIPProtocolQuery WatchChanGroup WriteCfgFile

............................................................................................................................................................................................................................................................. Release 8.4.1 ER3, February 2008

EXS & SwitchKit API Messages

Overview
............................................................................................................................................................................................................................................................

Purpose

This chapter provides an introduction to API messages and then lists the EXS Application Programming Interface (APIs) messages created by Dialogic. The messages are listed alphabetically. Within the messages are hyperlinks to messages modules (AIBs, ICBs, and TLVs) that are carried by the messages.

............................................................................................................................................................................................................................................................ Release 8.4.1 ER3, February 2008

1 - 1

Introduction to API Messages

EXS & SwitchKit API Messages

Introduction to API Messages

Overview

Messages and Responses

Messages and Responses each contain a header and a checksum, and can also contain AIBs (Address Information Blocks), ICBs (Information Control Blocks), TLVs (Tag-Length-Value blocks), and data.
Data

Data can reside in its own Data field or within AIBs, ICBs, or TLVs.
Field

A Field corresponds to a single row in the main Message/Response table, and it can be either one byte (for example 0x1B) or two bytes long (for example 0x1B4D). In accordance with Big Endian formatting, when a field is two bytes long, the first byte (in this case 0x1B) is the Most Significant Byte (MSB) and the second byte (in this case 0x4D) is the Least Significant Byte (LSB). The next figure, EXS API Message / Response Table, provides an overview of API messages and refers to the chapters containing the specific information.

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 2

Introduction to API Messages Figure 1-1

EXS & SwitchKit API Messages

EXS API Message / Response Table

Messages and Responses each contain a header, checksum, and AIB (Address Information Block). Messages and Responses can also contain ICBs (Information Control Blocks), TLVs, (Tag-Length-Value blocks) and data. Data can reside in its own Data field or within ICBs or TLVs. A Field corresponds to a single row in the main Message/Response table, and it can be either one byte (for example 0x1B) or two bytes long (for example 0x1B4D). In accordance with Big Endian formatting, when a field is two bytes long, the first byte (in this case 0x1B) is the Most Significant Byte (MSB) and the second byte (in this case 0x4D) is the Least Significant Byte (LSB). A Response is sent from the EXS CSP in reply to a Message from the host computer, or vice versa. If the Response comes from the EXS CSP, the AIBs, ICBs, TLVs, and Data field values might match those that were sent in the corresponding Message.

A Message is sent from the host computer to the EXS CSP, or vice versa.

Message (white)
Header

Response (gray)
Header

AIB An AIB contains one or more AEs. AIBs are listed in the API message and are fully defined in the AIBs chapter. AE AE (possible)

AIB AE AIB AE (possible)

ICB TLV (possible) ICB There are three types of ICB: Action (0x01) Data (0x02) and Extended Data (0x03).An ICB can contain TLVs, and ISDN ICBs can contain IEs. ICBs are listed in the API messages and are fully defined in the ICBs chapter. TLV (possible)

TLV Nested TLV (possible)

TLV A TLV can stand on its own in a message or it can be embedded in an ICB. A TLV can also contain one or more levels of nested TLVs. In this case, the TLV Count applies to only the "outermost" (highest level) TLVs, and not to the nested TLVs. TLVs are listed in the API messages and are fully defined in the TLVs chapter. Nested TLV (possible)

Status Unlike a Message, a Response can have a Status field, but only if the Response comes from the EXS CSP. A Response from the host computer has no Status field. A value that appears in the Status field is named a Response Status Value (RSV). If an RSV is used by more than one message, it is defined in the Common Response Status Values chapter. An RSV that is unique to a specific Response is defined on the Response side of the Message/Response table itself.

Checksum

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 3

Introduction to API Messages Generic API Message Format

EXS & SwitchKit API Messages

API messages and responses are frames, containing strings of paired characters. The characters are represented in hexadecimal notation. Each frame consists of a standard header, followed by a variable number of data bytes. The data is unique to each message. All messages, whether initiated by the CSP or by the host, must have a corresponding Response. The message fields are shown on the left (white) side of the table and the response fields are shown on the right (gray) side. In this example, standard header information (bytes 0) is indicated by the bold outline.

Field Descriptions

This section describes the fields in the header of each API message and response.
Frame

The first field in every message is always the Frame field. It is a onebyte value that indicates the beginning of the frame. The value 0xFE is reserved for this purpose alone. Because the value 0xFE is reserved for the Frame field, you must never use this value in any other field. If you must send the value 0xFE within the contents of a message, you must encode it using an escape sequence.
Length

The second field is always the Length field. It is a value that indicates the number of bytes to follow, excluding the Checksum. The system calculates the message length before using an escape sequence. You must do the same.
Important!

To calculate the value of the Length field, count the bytes between, but not including, the Length field and the Checksum field. In the message below, the length is 5. You can see the value 5 in the second byte of the length field, represented in hexadecimal notation as 0x05.
MESSAGE Byte
0 1 2 3

Field Description
Frame Character (0xFE) Length, MSB (0x00) Length, LSB (0x05) Message Type, MSB

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 4

Introduction to API Messages

EXS & SwitchKit API Messages

MESSAGE Byte
4 5 6 7 8

Field Description
Message Type, LSB Reserved (0x00) Sequence Number Node ID Checksum

Message Type

The third field is always the Message Type field. It is a value that identifies the format and particular information contained in the message or response.
Sequence Number

Use the Sequence Number field(s), Bytes 5 and 6, to match corresponding responses and messages. Because the EXS API protocol is asynchronous, the system may contain more than one outstanding message of the same type. When a response to one of these messages returns, the response would be useless if there were no way to trace it to its corresponding message. The Sequence Number resolves this issue by initiating either an 8-bit or 16-bit sequence number in an EXS API message. The sender of the message (either the host or the CSP) assigns the sequence number. To provide backward compatibility, the 16-bit sequence number is enabled using the Generic Card Configure 0x0122 message and can be queried using the Generic Card Query 0x0123 message. The Matrix/ Host Sequence Number Size TLV (0x0640) is used to configure either the 8-bit or 16-bit sequence number. 8-Bit Sequence Number

An 8-bit sequence number in the Byte 6 field is the default configuration. In this configuration, the Byte 5 field should always be set to 0x00 in CSP and Host initiated messages. Any other value in this field is reset to 0x00 in the response message to the Host. An 8-bit sequence number is in the range of 0x00-0xFF. 16-bit Sequence Number

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

A 16-bit sequence number extends the 8-bit sequence number Byte 6 (LSB) field into the Byte 5 (MSB) field to create a 16-bit sequence number. A 16-bit sequence number will be in the range of 0x00-0xFFFF.

1 - 5

Introduction to API Messages

EXS & SwitchKit API Messages

When the CSP Matrix Series 3 Card is configured to use the 16-bit sequence number, Bytes 5 and 6 will contain the sequence number for both Host and CSP-initiated messages. A 16-bit sequence number in a Host-initiated message will follow the message through the CSP and be returned in the response. A 16-bit sequence number in a CSP-initiated message will be passed to the Host and be expected in the Host response. The 16-bit Sequence Number does not support LAPD and EXNET Connect .
Important!

AIB

Address Information Blocks (AIBs) are used to address system objects such as slots, spans, and channels. An AIB can contain one or more Address Elements (AEs) to accommodate a variety of addressing requirements. An Address Element is a group of data bytes that represent specific address information.
Status

Most responses contain a Status field that follows the header. If the CSP processes a message successfully, it returns a positive acknowledgment (ACK) value of 0x10 in this field. If an error occurs while the CSP is processing the message, the CSP returns a negative acknowledgment (NACK) value that indicates the reason for the error. Negative acknowledgements identify problems such as call processing anomalies and configuration errors. A negative acknowledgment value can be anything other than 0x10, which is reserved for positive acknowledgements.
Data

The contents of the data bytes vary for every message and response. Please refer to individual messages for data definitions.

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 6

Introduction to API Messages Checksum

EXS & SwitchKit API Messages

The value of the Checksum field is the sum of the values of all header and data bytes, except for the Frame field. The system calculates the checksum before it uses an escape sequence, if an escape sequence is required.
Message Format Documentation Conventions

This section describes the conventions used in this publication for the following: Byte Numbering Variable Number of Fields Word-sized Fields Bit Masks Double-Line in Table

Byte Numbering

In this Reference, the actual number of bytes in a message field is shown only if the value never changes. For example, the number of bytes in the header field is shown because the header bytes will always be 0-.
Variable Number of Fields

The number of bytes in a series often changes (for example, with variable data) so it cannot be shown in this Reference. In these cases, the first field is defined in the Reference, but subsequent fields are represented by vertical dots, as shown in below.
12 : Data :

Word-size Fields

API messages frequently use multiple byte fields for the following: Timers Conference IDs PPL Event IDs PPL Component IDs

Fields that are more than one byte long use the Big Endian format of Most Significant Byte (MSB) first, Least Significant Byte (LSB) last.
........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 7

Introduction to API Messages

EXS & SwitchKit API Messages

For example, as shown in below, Byte 8 is the MSB and Byte 9 is the LSB for the Conference ID field.
Byte 8 Byte 9 Conference ID, MSB Conference ID, LSB

If the Conference ID is 05, you would enter the ID as shown in the next figure. Note that the first value (MSB) is 0x00 until the value of the LSB field overflows (is greater than 255). These two-byte fields are often represented as a combined Hexadecimal number. For example, in the figure below, the combined representation of 0x00 and 0x05 would be 0x0005.
Figure 1-2 Conference ID

Bit Mask

A bit mask is a byte that uses its individual bits to enable or disable functions. Setting the bit enables the function. This process is shown in the following example, taken from the Alarm message:
Example:

Data[1]Span Status This is a bit mask indicating the information that is sent and received on the span. You can set multiple bits. Bit 0 Receiving Red 1 Receiving Remote Alarm Indication/Yellow 2 Receiving Loss of Signal 3 Receiving Out of Frame 4 Sending Red (AIS) 5 Sending Remote Alarm Indication/Yellow
........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 8

Introduction to API Messages

EXS & SwitchKit API Messages

6 Receiving AIS 7 Receiving constant E-bit with Remote Alarm Indication. This bit is valid for E1 with insert CRC and Euro-ISDN. When you print a message trace, you read a two-byte bit mask from right to left, as shown below (0 to 15).
15

. . .

Double Line in Table

A double line in a table indicates that you do not repeat the fields above it. In the example below, the double line between String 1 and String 2 indicates that you can have multiple strings in the ICB but that you do not repeat the information above the field, "String 2: BCD Digit Count.
ICB Type ICB ID Data Length Data[0] Data[1] Data[2] 0x02 (Data) 0x01 Variable Stage Number (14) 0x01 (Host-Supplied Digits) Outpulsing Signal Type 0x01 DTMF 0x02 MFR1 (host does not include KP or ST) 0x03 MFR2 0x04 MFR1 (host includes KP and any ST signal) 0x05 Dial Pulse String Count (1 or 2) String 1: BCD Digit Count String 1: 1st BCD Digit Pair : String 1: Last BCD Digit Pair String 2: BCD Digit Count String 2: 1st BCD Digit Pair : String 2: Last BCD Digit Pair

Data[3] Data[4] Data[5] : : : : : :

Escape Sequences

The CSP uses the value 0xFE in the Frame field to indicate the beginning of a new frame. If a field value within a message or response is 0xFE, the CSP erroneously tries to process the next piece of data as a new message or response.

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 9

Introduction to API Messages

EXS & SwitchKit API Messages

An escape sequence resolves this issue. Use the value 0xFD plus an extra byte that immediately follows it to send the values 0xFE or 0xFD. The table below shows the values that the system recognizes.

Value To Be Sent
0xFD 0xFE

Escape Sequence Values

0xFD 0x02 0xFD 0x01

When the CSP reads the value 0xFD within a frame, it uses the following byte to one-complement the 0xFD value. The sum of the complement byte and 0xFD produces the actual value sent. You cannot use the values 0xFE or 0xFD immediately following the initial 0xFD value.
Important!

When you calculate the length of a message that uses an escape sequence, do not include the extra byte that you added to the message. The length of a message is defined before the escape sequence is used. For example, if you are sending the Version Request message and it includes the value 0xFE:The value of the Length field is the number of bytes between the Length and Checksum fields. The original length of this message is 0x. When you use the escape sequence, you add another byte to the message. Although you added another byte to the message, you do not change the value of the Length field.
Frame Length, MSB Length, LSB Message Type, MSB Message Type, LSB Reserved Sequence Number

X
01

Logical Node ID

Checksum

Basic Message Set

The primary function of the basic message set is to download the CSP Software from the host, and to query the CSP. When the CSP Software is completely downloaded, the CSP stops running from the CSP Matrix Series 3 Card firmware, and starts running from the CSP Matrix Series 3 Card RAM load. You can think of the Basic Message Set as a core group of messages. The following messages comprise the basic message set: Alarm Alarm Cleared Become Active
1 - 10

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

Introduction to API Messages

EXS & SwitchKit API Messages

Card Status Query Clear System Software Download Begin BRecord Download Begin SRecord Download BRecord Download Complete Download SRecord Fault Log Query Poll Poll Interval Configure Poll Request Reset Matrix TFTP Control/Query Version Request

API Messages Sent to the Standby CSP Matrix Series 3 Card

The host can send the following API messages to the standby matrix card. Card Status Query (0x0083) Clear System Software (0x000C) Download Begin BRecord (0x009B) Download Begin SRecord (0x00A2) Download BRecord (0x009B) Download Complete (0x00A4) Download SRecord (0x00A3) Fault Log Query (0x0086) Poll (0x00AB) ACK Poll Interval Configure (0x009F) Poll Request (0x009E) Reset Matrix (0x009D) Version Request (0x0002)

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

1 - 11

AddLLCCard

AddLLCCard
Type Overview

SwitchKit API message Use the SK_AddLLCCard message as an external application connected to the LLC. This message opens sockets to the SS7 cards on the node and sets up routing to the SS7 card. AddLLCCard is used to create and connect pairs of card level device to the LLC. It has the ability to accommodate various card types including SS7 TCAP. Additional routing IDs can be added to the same connection by sending multiple AddLLCCard messages to the same IP pair and specifying a different Routing ID. By setting the action field to 0x01 (Remove Connection), it is assumed that all routing IDs on this connection will no longer be used and will therefore be removed by the LLC. For an application to maintain communication to the card, there must always be at least one routing ID configured for that IP pair. This message cannot be used in a SwitchManager configuration file. Instead use the Add SS7TCAPCard [Link] will generate the appropriate AddLLCCard messages for you.

Sent by C Structure

Application
typedef struct { BaseFields Base; char CardIP1[30]; char CardIP2[30]; int RoutingID; int ControlNode; unsigned short CardType; UBYTE Action; UBYTE reserved88[5]; } SK_AddLLCCard;

C Structure Response

typedef struct { BaseFields Base; int Status; int RoutingID; UBYTE Reserved1; UBYTE reserved26[5]; } SK_AddLLCCardAck;

1- 12
Release 8.4.1 ER3, February 2008

AddLLCCard

C++ Class

class SKC_AddLLCCard : public SKC_ToolkitMessage { public: SKC_AddLLCCard(int sz = 0); ~SKC_AddLLCCard(); SK_DECLARE_CLASS(SKC_AddLLCCard,SKC_ToolkitMessage) virtual MsgStruct *getStructPtr(); virtual const MsgStruct *getStructPtr() const; virtual int getTag() const; const char *getCardIP1() const; void setCardIP1(const char *x) ; const char *getCardIP2() const; void setCardIP2(const char *x); int getRoutingID() const; void setRoutingID(int x); int getControlNode() const; void setControlNode(int x); unsigned short getCardType() const; void setCardType(unsigned short x); UBYTE getAction() const; void setAction(UBYTE x);

C++ Class Response

class SKC_AddLLCCardAck : public SKC_ToolkitAck { public: SKC_AddLLCCardAck(int sz = 0); ~SKC_AddLLCCardAck(); SK_DECLARE_CLASS(SKC_AddLLCCardAck,SKC_ToolkitAck) virtual MsgStruct *getStructPtr(); virtual const MsgStruct *getStructPtr() const; virtual int getTag() const; int getStatus() const; void setStatus(int x); int getRoutingID() const; void setRoutingID(int x); UBYTE getReserved1() const; void setReserved1(UBYTE x);

1- 13
Release 8.4.1 ER3, February 2008

AddLLCCard AddLLCCardAck

The LLC will acknowledge AddLLCCard messages with an AddLLCCardAck message.

AddLLCCardAck(Status=<*Response Value>, RoutingID= < Unique ID for Card Pair Added>, Reserved1= <Not currently used>);

Status field

Possible Response Values found in the status field of an AddLLCCardAck message.

Action SubComponent connection was successfully added to the LLC. The RoutingID specified is currently in use. One of the IPs is being used by another pair of Devices. The max number of subComponents has been exceeded. There was a problem allocating memory within the LLC. The node id specified has not been added to the LLC via an AddLLCNode message. An invalid IP string was encountered Invalid message parameter found while processing request.

*Response Values SK_SUCCESS SK_CONNECT_IN_USE SK_DUP_IP_ADDR SK_INTERNAL_LIMIT_REACHED SK_INTERNAL_MEM_ERROR SK_NODE_DOESNT_EXIST SK_BAD_IP_ADDRESS SK_NO_MESSAGE

1- 14
Release 8.4.1 ER3, February 2008

AddLLCCard RoutingID Macros

To avoid duplicate values, the routing ID for each type of subcomponent card must be derived using that cards corresponding get_RoutingID macro. Macros will be defined within SK_API.h so that they are globally accessible.

Macros available for deriving RoutingIDs.

CardType SK_SS7TCAP_BOARD (0x03)

Function getSS7TCAP_RoutingID(int stackid(0-255));

1- 15
Release 8.4.1 ER3, February 2008

AddLLCNode

AddLLCNode
Type

EXS SwitchKit API message For the same functionality, the EXS API message is Assign Node ID (0x0010).

Purpose

Use SK_AddLLCNode at the initial configuration of your system and to dynamically add a node while Low-Level Communicator is running. To assign a logical node ID within a CSP system, the ring must be out-of-service (OOS). Assuming the ring is OOS and the nodes already assigned, if you try to re-assign a logical node ID, the AssignNode messages issued on behalf of the AddLLCNode message will be NACKed by that node. You must have unique logical node IDs at all times within a CSP system. For example, if you have two nodes (nodes 2 and 3) and you want to re-assign logical node ID 2 to node 3 and logical node ID 3 to node 2 the AssignNode messages will be NACKED by the CSP and the AddLLCNode will ultimately fail. You will have to de-assign logical node IDs 2 and 3 first by sending a ResetConfig message to each of the nodes. Only then can you freely assign node IDs using the AddLLCNode message.
Important!

Description

The AddLLCNode message informs the LLC of a CSP Node. It specifies the Node ID and the CSP Matrix Series 3 Card IP addresses for each node. This can be used to add, update, or delete a node. The node must already have software downloaded through TFTP. Sending SK_AddLLCNode for a node that needs software will fail.

CAUTION
Do not use the shared IP address that can be used for SIP and H.323 redundancy. See Configuring a Shared IP Address Using BOOTP Server in the API Developers Guide: Overview. Use the fixed IP addresses for the matrix cards in the AddLLCNode() message. If you don't, the LLC will inaccurately reflect the state of the CSP. When LLC receives a request to connect to a node using AddLLCNode(), LLC will maintain that connection until a disconnect message is received. If the specified IP address is not
Important!
...........................................................................................................................................................................................................................................................

1- 16
Release 8.4.1 ER3, February 2008

AddLLCNode

reachable, LLC will continue attempting the connection indefinitely. This condition will be logged in the LLC maintenance log file. When the Switch Manager reconnects to the LLC, AddLLCNode messages are sent from the Switch Manager to the LLC. This causes the LLC to open a socket (connection) to the CSP and the AssignNode message (which is the switch-level equivalent of AddLLCNode) is sent to the CSP.
Sent by Add a Node

SwitchManager To add a node, you must send a configuration file with SwitchManager. The configuration file should contain at least the following information:
AddLLCNode (matrix1=[Link], matrix2=[Link], RequestedNode=0x08);

If you are adding a node with a single CSP Matrix Series 3 Card and you use the Matrix2 argument in your message, be sure to enter the 0-length string as its value. The configuration file should contain at least the following information:
AddLLCNode (matrix1=[Link], matrix2=, RequestedNode=0x08);

Arguments

The following table shows the arguments you can change:

Argument Action

Description Specifies whether a node gets added, updated, or deleted. The values are: SK_ADD_NODE = 0 (default) SK_DELETE_NODE =1 SK_UPDATE_NODE =2 Reserved A text field corresponding to the IP address of the primary CSP Matrix Series 3 Card. A text field corresponding to the IP address of the secondary CSP Matrix Series 3 Card, if it exists. If there is only one CSP Matrix Series 3 Card in the node, this field must be set to , that is, the 0-length string.

CallControlNode Matrix1 Matrix2

1- 17
Release 8.4.1 ER3, February 2008

AddLLCNode

Argument NodeType

Description Needs to be specified for ISDN and H.323 device server nodes. NodeType = SK_LSS_DS_SYSTEM or 16. Needs to be specified for EXNET Connect nodes: NodeType = SK_EXNET_SYSTEM or 300. If the above values are not used, the NodeType will default to SK_CS_SYSTEM or 200.

PhysicalNode RequestedNode

Reserved RequestedNode is the logical node ID requested to be assigned to the new node. The API will attempt to assign this node:

If there is no node ID currently on the node; If it is currently assigned a different node ID.

It is not a guarantee that this node will be assigned. In particular, the node ID might already be in use on the ring. If so, AddLLCNode will fail, no connection will be established with the node. If the LLC is already connected to a node with the specified logical node ID, the AddLLCNode is considered an update, if treated accordingly. SeqNumWidth Determines whether a message will have two-byte sequence numbers or one-byte sequence numbers. A one-byte SeqNumWidth is 0xff A two-byte SeqNumWidth is 0xffff ISUPRemCon Specifies whether SS7 cards can act as though they are on a ring, even if they are not. The values are: If set to 0, a multi-node system must have an EXNET (ring) card. If set to 1, forces the system to act as if it is a multi-node system even when there is no EXNET (ring) card in the CSP. Configuration
AddLLCNode ( Node = integer, ConnectionID = integer, Matrix1 = string, Matrix2 = string, 1- 18
Release 8.4.1 ER3, February 2008

AddLLCNode
RequestedNode = integer, Action = integer);

C Structure

typedef struct { char Matrix1[30]; char Matrix2[30]; int RequestedNode; int PhysicalNode; unsigned short NodeType; unsigned short CallControlNode; UBYTE Action; unsigned short SeqNumWidth; UBYTE ISUPRemCon;; } SK_AddLLCNode;

1- 19
Release 8.4.1 ER3, February 2008

AddLLCNode C Structure Response

typedef struct { int Status; int ActualNode; UBYTE DownloadStatus; } SK_AddLLCNodeAck; class SKC_AddLLCNode : public SKC_ToolkitMessage { public: const char *getMatrix1() const; void setMatrix1(const char *x); const char *getMatrix2() const; void setMatrix2(const char *x); int getRequestedNode() const; void setRequestedNode(int x); int getPhysicalNode() const; void setPhysicalNode(int x); unsigned short getNodeType() const; void setNodeType(unsigned short x); unsigned short getCallControlNode() const; void setCallControlNode(unsigned short x); UBYTE getAction() const; void setAction(UBYTE x); unsigned short getSeqNumWidth() const; void setSeqNumWidth(unsigned short x); UBYTE getISUPRemCon() const; void setISUPRemCon(UBYTE x); };

C++ Class

C++ Class Response

class SKC_AddLLCNodeAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getActualNode() const; void setActualNode(int x); UBYTE getDownloadStatus() const; void setDownloadStatus(UBYTE x); };

1- 20
Release 8.4.1 ER3, February 2008

AddSS7TCAPCard

AddSS7TCAPCard
Type Overview

EXS SwitchKit API message The AddSS7TCAPCard message is used to make a direct TCP connection between the LLC Host and a SS7 card for the purpose of routing TCAP traffic on a separate link. This message creates the appropriate AddLLCCard messages and sends them to the LLC. Host, using Converged Services Administrator (CSA), webCSA or SwitchManager configuration file. The following table shows the arguments that you can modify:

Sent by

Arguments

Argument CardIP1 CardIP2

Description The primary SS7 card IP address in the CSP. The standby SS7 card IP address, if it exists. If there is only one SS7 card in the node, this field should be set to , that is, the 0-length string. The ID of the TCAP stack to which the LLC connects. The Subsystem Number configured on the SS7 card to which the LLC should connect. The logical node ID assigned to the CSP Matrix Series 3 Card which controls the chassis where the SS7 card resides. 0x00 To add a connection 0x01 To remove a connection and all RoutingIDs

StackID SSN ControlNode

Action

C Structure

typedef struct { char CardIP1[30]; char CardIP2[30]; UBYTE StackID; UBYTE SSN; int ControlNode; UBYTE Action; UBYTE reserved84[5]; } SK_AddSS7TCAPCard; class

C++ Class

SKC_AddSS7TCAPCard : public SKC_DummyMessage {

1- 21

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

AddSS7TCAPCard
public: const char *getCardIP1() const; void setCardIP1(const char *x); const char *getCardIP2() const; void setCardIP2(const char *x); UBYTE getStackID() const; void setStackID(UBYTE x); UBYTE getSSN() const; void setSSN(UBYTE x); int getControlNode() const; void setControlNode(int x); UBYTE getAction() const; void setAction(UBYTE x);

1- 22
Release 8.4.1 ER3, February 2008

AdjustMessageTimeout

AdjustMessageTimeout
Type Purpose

EXS SwitchKit API message Use the SK_AdjustMessageTimeout message to change the default time-out for responses. SwitchKit allows all requests to the CSP a fixed amount of time to complete before the request is considered timed out. For most messages, this time is 15 seconds which is often acceptable for these SwitchKit-defined time-outs. However, there are times when the timeout specified is insufficient. In particular, when several time consuming messages are sent to the same node simultaneously, the time to complete a request can increase due to latency within the CSP. These increased delays occur primarily during configuration time. The AdjustMessageTimeout message increases the time-out for all messages by TimeoutIncr. In other words, if an application requested that the time-out be adjusted by 10 seconds, the time-out on most messages sent by that application would become 25 seconds. Messages that have a larger default time-out would have their time-out increased by the same 10 seconds. You must set the Action field for SK_AMT_ACTIVATE_TIMEOUT, to activate a new time-out. To set this new time-out for all applications connected to the LLC, set the NumApps field to SK_ALL_APPS. If you attempt to set a new time-out for only one application, dont set the NumApps field. You can reset the time-out by setting the Action field to SK_AMT_DEACTIVATE_TIMEOUT.

Description

Sent by Arguments

Application The following table shows the user modifiable arguments of the AdjustMessageTimeout message:

1- 23
Release 8.4.1 ER3, February 2008

AdjustMessageTimeout

Argument Action TimeoutIncr NumApps

Description Action specifies whether a new timeout gets activated or deactivated. TimeoutIncr specifies the amount of time added to the prior timeout value. NumApps specifies whether the new timeout gets set for only one or all messages.

Configuration

AdjustMessageTimeout (
Node = integer, ConnectionID = integer, Action = integer, TimeoutIncr = integer, NumApps = integer);

C Structure

typedef struct { UBYTE Action; unsigned short TimeoutIncr; UBYTE NumApps; } SK_AdjustMessageTimeout; typedef struct { int Status; } SK_AdjustMessageTimeoutAck; class SKC_AdjustMessageTimeout : public SKC_ToolkitMessage { public: UBYTE getAction() const; void setAction(UBYTE x); unsigned short getTimeoutIncr() const; void setTimeoutIncr(unsigned short x); UBYTE getNumApps() const; void setNumApps(UBYTE x); }; class SKC_AdjustMessageTimeoutAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); };

C Structure Response

C++ Class

C++ Class Response

1- 24
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Alarm 0x00B9
SwitchKit Name Type Description Alarm EXS API and SwitchKit API message Alarm 0x00B9 The CSP sends Alarm 0x00B9 message to indicate that an alarm condition has been detected. The following information is reported: Severity Alarm Type Alarm Number Alarm Data Alarm Cleared In some cases, the CSP sends an Alarm Cleared message after the alarm condition ceases. The alarms that are followed by an Alarm Cleared message are marked with an asterisk (*). Related Messages Sent by SwitchKit Code Alarm Cleared (AlarmCleared) 0x00C1 CSP C Structure
typedef struct { UBYTE InfoSize; UBYTE Severity; UBYTE Entity; UBYTE AlarmNum; UBYTE Info[249]; } XL_Alarm;

C++ Class
class XLC_Alarm : public XLC_InboundMessage { public: UBYTE getInfoSize() const; void setInfoSize(UBYTE x); UBYTE getSeverity() const; void setSeverity(UBYTE x); UBYTE getEntity() const; void setEntity(UBYTE x); UBYTE getAlarmNum() const; void setAlarmNum(UBYTE x); const UBYTE *getInfo() const; UBYTE *getInfo(); void setInfo(UBYTE *x); };
...........................................................................................................................................................................................................................................................

1- 25
Release 8.4.1 ER3, February 2008

Alarm 0x00B9 Resent in EXS API EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00B9) Reserved (0x00) Sequence Number Logical Node ID Severity 0x01 Informative 0x02 Minor 0x03 Major Alarm Type 0x01 General Alarms 0x02 Card Alarms 0x03 Span Alarms 0x04 Channel Alarms 0x05 DSP SIMM Alarms 0x06 DSP Alarms 0x07 Node Alarms 0x08 DS3 Alarms 0x09 VoIP Module Alarms 0x0B SIP Alarm Alarm Number (see table below) Data Length (n) Data[0] (if applicable) Data[n-1] Checksum Byte 0 1, 2 3, 4 5 6 7 8 Frame (0xFE) Length (0x0005) Message Type (0x00B9) Reserved (0x00) Same Sequence Number Logical Node ID Checksum RESPONSE (Gray) Field Description

This message is resent once after five seconds.

10 11 12 : :

Alarm Type

The table below contains a summary of the alarms showing the range of alarm numbers for each type and the length. See the table for each alarm type below for the following information: Alarm Severity Alarm Number/Alarm Data Length Data

Alarm Information

Summary of Alarms
Alarm Type 0x01 General Alarm Number Value or Range 0x01-0x1F, 0x21-0x22 Data Length Variable

1- 26
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Alarm Type 0x02 Card 0x03 Span 0x04 Channel 0x05 DSP SIMM 0x06 DSP 0x07 CSP Node 0x08 DS3 0x09 VoIP Module

Alarm Number Value or Range 0x01-0x1C 0x01-0x05 0x02 0x03 0x01-0x06 0x01, 0x02 0x01-0x08, 0x0A-0x15 0x01 - 0x03 0x00, 0x01, 0x02, 0x03

Data Length Variable 0x06 0x17 0x12 0x06 Variable 0x06 0x07 0x07

0x01 General Alarms

Severity
Major 0x01*

Alarm (Number/Name)
System busy condition The CSP sends this alarm when the CSP Matrix Series 3 Card is flooded with messages. The CSP will ignore all incoming calls until the alarm is cleared.

Data Length
0x00

Data/Troubleshooting
The system ignores incoming calls until the alarm is cleared. Ignoring incoming calls decreases the traffic load and eventually the alarm will clear. Ensure that System Busy Warning messages are no longer being seen. Slowly ramp traffic back to normal levels and resume normal operation.

1- 27
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major: Default Minor: If clock mode was switched to REF1 or REF2. 0x02

Alarm (Number/Name)
Clock mode switched

Data Length
0x02

Data/Troubleshooting
The system automatically switches the clock mode to the next available clock source and reports the following data to the host: Data[0] - Current Synchronization Mode Data[1] - Previous Synchronization Mode Values for Data[0] and Data[1] fields: 0x01 Primary Reference Clock Signal 0x02 Secondary Reference Clock Signal 0x03 Primary Loop Clock Signal 0x04 Secondary Loop Clock Signal 0x05 Free Running Clock Signal _______________________________ This notification occurs when the clock mode was automatically switched or reference clock sources have been lost. The CSP will automatically set the clock mode to the next available clock source. Either a master timing source has been disconnected or gone bad, or a span signal has been lost. Investigate why the signal has been lost and try to restore it if possible. This signal may be controlled by the network in which the Loop timing is dependent.

Inform. Major

0x03 0x04*

Hardware cannot support DSP function Reference 1 Clock Source Lost No host intervention is needed. The CSP will automatically switch the clock mode to the next available clock source. 0x00

Verify the correct card type. The system automatically switches the clock mode to the next available clock source. The Reference Clock Source has been lost. No host intervention is needed for this occurrence. The CSP will automatically switch the clock mode to the next available clock source. Have Operational Personnel Check to see what happened to the External Timing Source Connected the CSP Matrix I/O.

1- 28
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x05*

Alarm (Number/Name)
Reference 2 Clock Source Lost No host intervention is needed. The CSP will automatically switch the clock mode to the next available clock source.

Data Length
0x00

Data/Troubleshooting
The system automatically switches the clock mode to the next available clock source. The Reference Clock Source has been lost. No host intervention is needed for this occurrence. The CSP will automatically switch the clock mode to the next available clock source. Have Operational Personnel Check to see what happened to the External Timing Source Connected the CSP Matrix I/O.

Major Major

0x06 0x06

DSP Resource Blocked DSP Resource Blocked

0x01 0x04

Data[0] DSP Function Type Data[0] Slot where VRA Block occurred Data[1] Chain across SIMMs Data[2-3] RAN ID blocked _______________________________ The CSP will send this alarm when all the resources of the particular resource type are all in use. The request to use a specific resource is placed in a queue until there is a resource of the alarmed type freed. The request is placed in a queue waiting for a resource to free unless a DSP Service Cancel (0x00BE) message is send by the host or the channel that the resource was requested on is release. See the DSP SIMM Configure (0x00C0) message in the API Reference and the CSP Developers Guide: Overview for details on DSP function types. Either wait for the resource requested to free up which is the most likely response. Send a DSP Service Cancel (0x00BE) message. Release the channel that the resource was requested on. If you find that the CSP is reporting a large number of these alarm it maybe a good idea to reevaluate the number of resources per function type you have configure. You may need to increase the number of configured functions type.

1- 29
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x07

Alarm (Number/Name)
DSP Resource Function Type Not Configured

Data Length
0x02

Data/Troubleshooting
Data[0] Resource Type Data[1] Resource Type 2 (0x00 if no second resource type) _______________________________ The DSP function type requested is not configured and will need to be configure in order to use the resource being requested. Can also indicate a function is configured but the SIMM is out-of-service. See the DSP SIMM Configure (0x00C0) message in the API Reference and the CSP Developers Guide: Overview for details on DSP function types. Configure the DSP function type for the resource being requested.

1- 30
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x08

Alarm (Number/Name)
DSP Resource Management Inconsistent. (An internal task has asked to attach the same type of DSP resource to a single timeslot twice. This Alarm is sent when: - A receiver has been requested but a Call Progress or Digit receiver for the same layer is already attached to the timeslot - A transmitter has been requested but a Digit or Recorded Announcement transmitter for the same layer is already attached to the timeslot

Data Length
0x09

Data/Troubleshooting
Data[0-6] 0x0D Channel AIB (Dialogic use only) Data[7] Process Virtual Identifier (The process that requested the DSP service. For example, Call Control, Layer 4, or E1 PPL) (Dialogic use only) 06 - L4 PPL call processing 11 - Logical ID for all Layer 3's 1A - Layer 3 Plus 24 - SS7 25 - SS7 MTP2 28 - E1 Protocol Layer PPL

29 - T1 Protocol Layer PPL

Data[8] Resource Type (The DSP Resource requested. For example, DTMF Digit Transmitter). 00 - Outpulse CP 01 - Outpulse digits 02 - Collect CP 03 - Collect digits 04 - Conference 05 - Outpulse Announcement 06 - Detect energy 07 - Broadcast 08 - Collect FSK 09 - Outpulse FSK 0A - Detect coin 0B - Play file 0C - Record file 0D - Modify play 0E - Fax XMT 0F - Fax RCV 10 - Modify record 11 - Echo cancel XMT 12 - Echo cancel RCV 13 - PVD/AMD RCV _______________________________ An internal task has asked to attach the same type of DSP resource to a single timeslot twice. Free the resource that is attached to the timeslot. Send down a DSP Service Cancel (0x00BE) message to release the channel and start a new call.

1- 31
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Inform. 0x09

Alarm (Number/Name)
Download Record Timeout

Data Length
0x00

Data/Troubleshooting
Restart the download. This alarm only concerns legacy download procedures. The Series 3 Matrix card supports only Full TFTP. The host must follow each download message with another download message or a Download Complete message within five minutes, or the download aborts. For example, when a Download Begin BRecord is sent, a Download BRecord must follow within five minutes. The Download BRecord must be followed by either another Download BRecord or Download Complete within five minutes. Check ethernet connectivity or the application's download module for delays. Restart the download. If problem persists contact Dialogic Technical Support. Please be advised that an Ethernet capture may be requested.

Major

0x09

Invalid Associated Channel

0x03

Data [0] Logical Span ID MSB Data [1] Logical Span ID LSB Data [2] Channel _______________________________ Verify the configuration and call flow in the [Link] file. If the problem persists, contact Dialogic Technical Support

Inform.

0x0A

Partial Message Received (for example, incorrect checksum, zero length message, or message did not begin with frame character)

0x00

Partial Message Received (for example, incorrect checksum, zero length message, or message did not begin with frame character) Collect the [Link], [Link], maintenance_llc_xxx.log and a list of the applications running on the system and contact Dialogic Technical Support.

0x0B

RAN Requested is Unavailable in System

Check if this announcement was reached in error. Check in the Vocabulary Index File to see if the file ID is listed there. If it is not listed, then report the problem to Dialogic Technical support along with [Link], [Link], and timestamp of when the trap occurred.

1- 32
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Inform. 0x0C

Alarm (Number/Name)
Unacknowledged Message If you configured the systems message resend logic to Resend Once and Generate Alarm, these data fields contain the bytes of the resent message. For more information, refer to the System Configuration message. Recorded Announcement ID Inconsistency

Data Length
Variable

Data/Troubleshooting
Data[0-N] The bytes of the message _______________________________ Check for other error messages that would indicate a network or system condition leading to this problem.

Major

0x0D

0x04

Data[0] Slot Number Data[1] SIMM Number Data[2, 3] RAN ID _______________________________ Sent upon completion of download or on card Insertion. This alarm indicates that an announcement being downloaded has the same ID as an existing announcement, but with different information. When the ID is specified in the Recorded Announcement Connect message, either announcement could be played. Each RAN must have a unique ID. One of the announcements (usually the older one) should be deleted. A Query addressed to one RAN ID returns information for only one of the RANs that share the ID. It is not possible to determine for which RAN the information will be returned. For example, if one file sharing the ID is 20 Kb and one file is 40Kb, only one of the sizes is reported, either 20 Kb or 40 Kb, but not both.

Minor

0x0E

SS7 Signaling Network Congestion When a route to a destination is congested, MTP sends the MTP_STATUS to ISUP which in turn sends this alarm to the host.

0x06

Data[0] SS7 Stack ID Data[1-4] DPC Data[5] Congestion Level _______________________________ Decrease the load or create a new route to the destination. If the system has not decreased the call load and this symptom persists, check the network engineering plan to possibly create a new route to the destination.

1- 33
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x0F*

Alarm (Number/Name)
SS7 Remote ISUP Unavailable

Data Length
0x05

Data/Troubleshooting
Data[0] SS7 Stack ID Data[1-4] DPC _______________________________ SS7 Remote ISDN User Part (ISUP) unavailable. The address information represents the SS7 stack and Destination Point Code (DPC). Check the status of the Links and see if they are in service by sending the SS7 Signalling Link Query (0x0065) message. If they are not in service, attempt to determine why the links are Out Of Service. Make sure that they are marked in service from a host perspective using the Service State Configure (0x000A) message. Also check the status of the SS7 Signalling Routes using SS7 Signalling Route Query (0x0066). If the routes are unavailable, contact your SS7 service provider and ask why they are not in service. Also check the status of layer 1 span using Span Status Query (0x0084) message. This will tell you if the span is in sync, and if not how many slips and errors occurring on the physical span.

Major Inform.

0x10 0x11

Node ID Already Exists Invalid Message Length

0x00 0x00

Check configuration and/or installation for correction. The application software sent a message with an invalid length field. Provide the application development team and Dialogic Technical support with the [Link] and the information from the trap.

1- 34
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x12

Alarm (Number/Name)
System Busy Warning

Data Length
0x00

Data/Troubleshooting
This notification indicates that the traffic volume on the CSP is approaching its capacity. This message is only a warning. It does not mean a System Busy condition will definitely occur. The System Busy Warning does not have a clearing Alarm. It continues to occur every few seconds, until the CPU utilization reduces. The System Busy Warning messages can be between 2 and 20 seconds apart, depending on system load fluctuations. The EXS CSP CPU occupancy has exceeded the "System Busy Warning" threshold. This condition can happen due to traffic congestion or CSP configuration during high traffic or by having Debug printing enabled on a CSP card or cards. When a System Busy Warning is generated, the Host should reduce the number of new calls until the System Busy Warning messages cease. Whenever possible, ramp call rates up slowly and evenly to prevent an initial System Busy. Do not re-configure the CSP and do not enable unnecessary diagnostics. For more information on this alarm, refer to the CSP Developer's Overview Guide, Chapter 4 EXS API Application Development, section System Busy Warning and System Busy Alarm.

Inform.

0x13

Resource Utilization Threshold Reached

0x01

Data[0]

Free Conferencing Timeslots (0x01) _______________________________ This normally occurs during high traffic and high utilization of conference resources. Calculate the number of free timeslots available for EXS Conferencing using the System Resource Usage Query. Determine if free timeslots need to be made available. For complete information see CSP Conferencing Section in the Configuring Multi-Node Systems of the Developers Guide: Overview.

1- 35
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
0x14

Alarm (Number/Name)
Subrate Resources Unavailable

Data Length

Data/Troubleshooting
The subrate resource (channels) provided by the SRC card are no longer available as (possibly) the card has been removed. Find out what the Subrate Card Status is and take actions depending on the result. Reset or change the card. If that does not work, contact Dialogic Technical Support.

Major

0x15

SS7 Remote TUP Unavailable

0x05

Data[0] SS7 Stack ID Data[1-4] DPC _______________________________ Bring remote Telephone User Part in service.

Major

0x16*

ISDN/SS7 Signaling Stack Congestion

0x03

Data[0] Data[1]

Stack ID (SS7), Board Slot Number (ISDN) Direction: 0x00 Incoming 0x01 Outgoing

Data[2]

Status: 0x00 Congestion Cleared (Alarm Cleared) 0x01 Congestion Level 1 0x02 Congestion Level 2 0x03 Congestion Level 3 _______________________________ Decrease the load on the ISDN/SS7 card. Consult Dialogic Technical Support. Calls will resume to normal after the congestion clears. You will receive an alarm cleared message when this occurs. Inform. 0x17 Route Table Updated 0x01 Data[0] Table ID (1-10) _______________________________ The active route table has been updated. The address information represents the table ID of the route table. Verify the route table is changed correctly.

1- 36
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Inform. 0x18

Alarm (Number/Name)
Resource Group Table Updated

Data Length
0x01

Data/Troubleshooting
Data[0] Table ID (1-10) _______________________________ The active resource group table has been updated. The address information represents the table ID of the route table. Verify the resource group table is changed correctly.

Inform.

0x19

Old Route Table Deleted

0x01

Data[0] Table ID (1-10) _______________________________ A previously active routing table has been deleted. The address information represents the table ID. Verify that the table being deleted is no longer needed.

Inform.

0x1A

Old Resource Group Table Deleted

0x01

Data[0] Table ID (1-10) _______________________________ A resource group table has been deleted. Verify the table being deleted is no longer needed.

Inform.

0x1B

Route Table Forcefully Deleted

0x01

Data[0] Table ID (1-10) _______________________________ The active route table was forcefully deleted. The address information represents the table ID. Verify the table being deleted is no longer needed.

Inform.

0x1C

Resource Group Table Forcefully Deleted

0x01

Data[0] Table ID (1-10) _______________________________ The active resource group table has been forcefully deleted. The address information represents the table ID. Verify the table being deleted is no longer needed.

1- 37
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major or Minor (see Data) 0x1D

Alarm (Number/Name)
Flash Copy or Load Problem

Data Length
0x02

Data/Troubleshooting
Data[0] Severity 0x00 Major 0x01 Major 0x02 Major 0x03 Major 0x04 Minor 0x05 Minor 0x06 Major Data(1) Entity Valid entries for this field based on the Entity field value 0x00 are as follows: 0x00 Flash erase failed 0x01 Flash write failed 0x02 RAM load to copy is bad 0x03 Flash load bad after copy from RAM 0x04 RAM and flash have different timestamps 0x05 RAM load bad after a soft reset 0x06 RAM load bad after copy from Flash _______________________________ There is a problem during the flash or RAM loading. Contact Dialogic Technical Support.

1- 38
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x1E

Alarm (Number/Name)
TFTP Alarm

Data Length
Variable

Data/Troubleshooting
Typically the following events result in this alarm. 1. Filename/path that is returned in BOOTP Response does not match. 2. TFTP Server is not reachable or running. 3. TFTP Configuration File indicates a load that is not resident or incorrectly named on the TFTP Server. 4. The TFTP file has been altered from previous version. There are four things to validate: 1. Verify that TFTP is running on the machine with the software files. 2. Verify that the TFTP Server is a reachable ethernet address from the CSP. 3. Verify that the BOOTP response indicates the correct name and path of the tftp configuration file. 4. Verify that the tftp configuration for the all .bin files specified in the tftp configuration exist on the TFTP server and contain the correct path and filenames of the software .bin files. Assume Dialogic Technical support will require information on BOOTP, TFTP, and Ethernet setups. An ethernet trace may be required. Debug access to the Matrix may also be required. See 0x1E TFTP Alarm after this table.

1- 39
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Major 0x1F

Alarm (Number/Name)
System Memory Low

Data Length

Data/Troubleshooting
System memory has dropped below the minimum level of satisfactory performance. When the system is in this condition, it is also in a System Busy condition and the CSP sends a System Busy Alarm (0x01) to the host. Check for other error messages that would indicate a network or system condition leading to this problem. Check Ring Interface hardware and then bring the ring in service.

Major

0x20

System Memory Low Cleared

Indicates that the system returns to the minimum level of satisfactory performance. The CSP sends a System Memory Satisfactory Alarm (0x20) to the host, along with an Alarm Cleared (0xC1) message. Resume normal operation.

Major Major

0x21 0x22

Host Connection Dropped EXNET Ring Down

0x02 0x08

Data[0] Multi-host port ID 0x3142 - 0x3147 Data[0-4] Slot AIB Data[5] Logical Ring ID Data[6] Host Service State Data[7] EXNET Ring Error Status _______________________________ This notification is sent when an EXNET ring goes down. The address information represents the slot of the EXNET-ONE card and logical ring ID of the ring.

Inform. Inform.

0x2F 0x30

Log F/Log B Buffer is 75% Full Log T Buffer is 75% Full 0x01 Data[0] Slot Number _______________________________ Contact Dialogic Technical Support.

Inform.

0x31

Log F/Log B Buffer is Full

0x01

Data[0] Slot Number _______________________________ Contact Dialogic Technical Support.

Inform.

0x32

Log T Buffer is Full

0x01

Data[0] Slot Number _______________________________ Contact Dialogic Technical Support.

0x33

MGC Lost Connection

1- 40
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Inform. 0x34

Alarm (Number/Name)
DSP CPA Configuration Conflict

Data Length
0x04

Data/Troubleshooting
Data[0] Tone Group: 0x00 Data[1] Tone ID: 0x10 Data[2-3]Frequency 0x01-0xA4 _______________________________ Consult the CSP Developers Guide: Overview for details on configuring CPA. Modify the configuration.

Major

0x35 0x3A

ISDN Congestion SS7 Signaling Destination Congestion Sent to the host when a particular remote node is congested as indicated by a change in the congestion level. 0x06 Data[0] Stack ID Data[1-4] DPC Data[5] ACL Level _______________________________ If the system has not decreased a call to this DPC and this symptom persists, check the network engineering plan to possibly create a new route to the destination. Data[0] Stack ID Data[1-4] DPC Data[5] LINK_CONGESTION_LEVEL _______________________________ If the system has not decreased a call to this DPC and this symptom persists, check the network engineering plan to possibly create another link in the link set. Data[0] Slot Data[1,2] Server ID _______________________________ The VIF is missing or wrong. Check NFS settings for the DSP2 Card. Data[0] Function Type _______________________________ The system application has requested more that the allowed resource points configured on the system. Increase the number of resource points in the system with a downloadable license. Contact your sales person to purchase more licenses. You can also contact your sales engineer who can help you design your DSP2 configuration as well as estimate the number of resource points needed.

Major

0x3B

Signaling Link Congestion When a link is congested, MTP sends MTP Status to ISUP which in turn sends this alarm to the host.

0x06

Inform.

0x3D

NFS RAM Disk Configuration Failure

0x03

Major

0x3F

Insufficient Resource Points for DSP Function

0x01

Inform. Major

0x3E 0x40

NFS Server Disconnect DSP Request Queued Due to DSP Series 2 CPU Overload Level 2

0x02 0x01

Data[0,1] Server ID Data[0] DSP Function Type Requested _______________________________ Either reduce recourse requests at the application layer or add more DSP2 cards to the system.

1- 41
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Severity
Inform. 0x41

Alarm (Number/Name)
Channel has an Echo Canceller resource attached but the requested receiver resource is not available on the same DSP Card.

Data Length
0x05

Data/Troubleshooting
Data[0] Slot of DSP Card providing Echo Cancel to channel Data[1] Function type of requested receiver Data[2, 3] Span (MSB, LSB) Data[4] - Channel _______________________________ When attaching echo cancellers together with DSP receivers, be sure that the same DSP2 card is being used. The host can force the slot AIB for both message. Data[0] FSK Alarm ID 0x01 FSK Stop ACK Not Rcvd from DSP Chip 0x02 Invalid Resource Type for SMS 0x03 Internal Error Setting PPL Timer Data[1,2] Midplane Time Slot Data[3] DSP Series 2 Slot Data[4,n] Additional Data Specific to FSK Alarm IDs Data[0] RTP Alarm ID: 0x01 RTP socket open error while Record Data[1] DSP2 slot Data[2-5] File ID Data[0-3] Current "Leaky Bucket" value in TCAP transactions Minor alarm is generated with each one second of licensed bucket capacity exceeded. Major alarm generated once 10 seconds of bucket capacity is exceeded indicating all TCAP transactions are now being rejected. The alarm clears when the bucket capacity returns to a 0.5 second of licensed capacity.

Minor

0x42

DSP Series 2 FSK General Alarms

0xnn (Variable)

Major

0x43

DSP2 RTP

0x06

Minor

0x44

SCCP/TCAP Capacity Exceeded

0x04

*Followed by an Alarm Cleared message

1- 42
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x02 Card Alarms

Severity
0x01

Alarm (Number/Name)
Card Taken Out of Service

Data Length
Variable

Data/Troubleshooting
0x01 Slot AIB _________________________________________ Check with operations personnel to verify card removal. Once card is brought in service, the CSP sends the Alarm Cleared message (0x00C1).

Major

0x02

Unable to Allocate Timeslots for this Card

0x05

0x01 Slot AIB _________________________________________ Verify that the CSP contains the required number of available timeslots for this card. If sufficient timeslots are available, contact Dialogic Technical Support. 0x01 Slot AIB _________________________________________ Reseat the card. Try a different card. Try a different software load. If all above options fail, contact Dialogic Tech Support.

0x03

Card Download is Corrupt

0x05

Major

0x04

Card Type Not Recognized

0x05

0x01 Slot AIB _________________________________________ Check the TFTP server and the tftp configuration file to make sure the card being used is included. Contact Dialogic Technical Support.

Inform.

0x05 0x06 0x07

Reserved Reserved Cards Configuration has been Reset to Defaults 0x05 0x01 Slot AIB _________________________________________ One of the following occurred: Card has been reset by the host/switchkit. Card has reset/faulted due to software error. Card has reset due to a hardware problem. If running Switchkit, Switchmgr will take care of reconfiguring the card. If not using Switchkit the host has to reconfigure the card.

Major

0x08 0x09

Reserved Card Reset 0x05 0x01 Slot AIB _________________________________________ Card has either faulted (software error) or was manually reset (either via software or via push button reset) The card should come back in service by itself.

0x0A

Connection Map Failure

0x05

0x01 Slot AIB

1- 43
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x0B

Software Does Not Have Download for Card

0x05

0x01 Slot AIB _________________________________________ Software cannot be downloaded to the card. Check the TFTP server and the tftp configuration file to make sure the card being used is included. Contact Dialogic Technical Support.

Major

0x0C

Card Does Not Support A-Law Encoding Format

0x05

0x01 Slot AIB _________________________________________ Card does not support A-law encoding format. Check the card type and the card configuration.

Major

0x0D

Card Revision Not Supported by System Software

0x05

0x01 Slot AIB _________________________________________ Card revision not supported by system software revision. Replace the card with a different REV card. The REV can be found on the card itself and is made of a letter and a two digit number (for example, C12). The higher letter/number the newer the REV.

Major

0x0E

Card Removed

0x05

0x01 Slot AIB _________________________________________ Check with operations personnel to verify card removal.

Major

0x0F

Hardware Failure Occurred on Slot Specified The CSP also sends a Card Status Report with a description of the failure Ethernet Host Link Error Detected NOTE: To use the Host Link Failure Detection feature and receive this message, you must have polling enabled. Card or Fan Tray Not Installed in Chassis

0x05

0x01 Slot AIB _________________________________________ A hardware failure has been detected on a card. Reseat the card. If that does not work, replace card.

Minor

0x10

0x00

Major

0x11

0x05

0x01 Slot AIB _________________________________________ Check if fan tray and card are installed.

1- 44
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x12

EXNET Port A - Communication Failure

0x08

Data[0-4] Slot AIB Data[5] Logical Ring ID Data[6] Host Service State Data[7] EXNET Ring Error Status _________________________________________ Hardware failure on EXNET Port A. The Remote Node terminating to the local EXNET Port A is not accessible (that is, the problem is not with local node but with the remote node). Verify EXNET Port A's terminating connection (remote node) is accessible. There could be a faulty fiber cabled connected to EXNET Port A. Check fiber connections are snug and connected properly. Bring the ring out of service then back in service. Reset Ring Interface card. If the lights on the Ring Interface card are still not all green, then collect the [Link],[Link], and maintenance_llc_xxx.log and contact Dialogic Technical Support.

Minor

0x13

EXNET Port B - Communication Failure

0x08

Data[0-4] Slot AIB Data[5] Logical Ring ID Data[6] Host Service State Data[7] EXNET Ring Error Status _________________________________________ Hardware failure on EXNET Port B The Remote Node terminating to the local EXNET Port B is not accessible (that is, the problem is not with local node but with the remote node). There could be a faulty fiber cabled connected to EXNET Port B. Check fiber connections are snug and connected properly. Verify EXNET Port B's terminating connection (remote node) is accessible. Bring the ring out of service then back in service. Reset Ring Interface card.

Minor

0x14

EXNET Port A - Fiber Laser Failure

0x05

0x01 Slot AIB _________________________________________ Refer to the Hardware Installation and Maintenance Guide.

1- 45
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Minor

0x15

EXNET Port B - Fiber Laser Failure

0x05

0x01 Slot AIB _________________________________________ The fiber driver on the Ring interface card has gone bad. Contact Dialogic Technical Support and replace the Ring Interface Controller card.

0x16 Inform. 0x17

Subrate Card Switchover Software Error (Please report this error to Dialogic Technical Support) Variable

A switchover has occurred. No action required. 0x01 Slot AIB Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x01) Data[3] Data Length (0x01) Data[4] Slot Number Data[5-44] Filename (in ASCII) Data[45,46] Line Number Data[47-n] Diagnostic Data _________________________________________ A software error occurred on a line card. The address information represents the slot containing the card. Gather information as to what was occurring on the system at the time of the error and report to Dialogic Technical Support.

Major

0x18

Remote SS7 card removed

0x05

0x01 Slot AIB (if SS7 card in local node) 0x69 Slot Number (if SS7 card in remote node) _________________________________________ Check with operations personnel to verify card removal. Re-insert the working SS7 card and, Switch Manager will reconfigure this card. SwitchManager will trigger a Card Status Report (0x00A6) message and reconfigure the card per the configuration file that was used to start/configure the system.

Major

0x19

Bus Contention with Rear Card

0x05

0x01 Slot AIB _________________________________________ The front card or I/O card are mismatched and incompatible with each other. Verify the I/O and card type and make sure they are supposed to be paired up.

1- 46
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x1A

Bus Contention with Front Card

0x05

Major

0x1B

Internal Diagnostic Failure

0x08

Data[0-4] Slot AIB Data[5] Logical Ring ID Data[6] Host Service State Data[7] EXNET Ring Error Status _________________________________________ An internal diagnostic error has been detected on an EXNET Ring card. Test the Ring Interface Card in a different slot. If the matrix continues to report this alarm to the host, replace the Ring Interface Card.

Major

0x1C

EXNET card Looped Out of Ring

0x08

Data[0-4] Slot AIB Data[5] Logical Ring ID Data[6] Host Service State Data[7] EXNET Ring Error Status _________________________________________ Test the Ring Interface Card in a different slot. If the matrix continues to report this alarm to the host, replace the Ring Interface Card.

Major

0x1D

Card Added to Virtual Slot

0x05

0x01 Slot AIB _________________________________________ The host or Switchkit has configured a virtual card. Verify card type and that the card has been placed in the correct slot. If symptoms continue, contact Dialogic Technical Support for configuration guidance.

1- 47
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x1E

Line Card Approaching Busy/ Line Card Approaching Busy Clear

Variable

SS7 card Data[0] Slot Number Data[1-n] Reason Codes: 0x00 Low Memory 0x01 Low MCB 0x02 Low Idle CPU Data[n+1] Stack ID 16-Span SLC Data[0] Slot Number Data[1-n] Reason Codes: 0x00 Low Memory 0x01 Low MCB 0x02 Low Idle CPU _________________________________________ Line card busy conditions exceeding the line card "Approaching Busy Threshold". Reduce the line card load by diverting traffic from the overloaded line card. Disable Debug if enabled on the line card.

Major

0x1F

Line Card Busy Line Card Busy Clear

Variable

SS7 card Data[0] Stack ID Data[1] Slot Number Data[2-n] Reason Codes: 0x00 Low Memory 0x01 Low MCB 0x02 Low Idle CPU 16-Span SLC Data[0] Slot Number Data[1-n] Reason Codes: 0x00 Low Memory 0x01 Low MCB 0x02 Low Idle CPU _________________________________________ Caused by line card overload busy conditions. Reduce line card load by diverting traffic from the overloaded line card. Disable Debug if enabled on the line card.

0x20

DS3 Card Limited Spans for SS7

0x05

0x01 Slot AIB _________________________________________ Look for other error messages that indicate a network or system condition leading to this problem. If symptoms persist contact Dialogic Technical Support.

1- 48
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x21

Too many DS3s Configured for Limited Spans

0x05

0x01 Slot AIB _________________________________________ Ensure proper DS3 card DIP Switch positioning. Only one DS3 card can have DIP Switch 4 and 6 set to OFF "limited SS7 CIC traffic". The Standby DS3 card, must always have DIP switch 4 and 6 set to the ON position.

Major

0x22

Ethernet Link Failure

0x06

Data[0-4] Slot AIB (0x01) Data[5] I/O Card Ethernet Port Number This alarm is sent when an SS7 card loses its connection to a local host. _________________________________________ This alarm is sent if a VDAC-ONE I/O or Multi-Function Media I/O card port that was previously in a steady LINK_UP state loses its connection. The VDAC-ONE slot and failed I/O port (0-2 for the 3 I/O ports on the Multi-Function Media I/O card) is sent in the data portion of the Alarm message. The alarm is cleared when the link returns to a steady Link-Up state. This alarm is sent if any I/O ports lose their network connection, and will be cleared when the connection is re-established. Trace the network cable between the I/O card and the remote Ethernet switch. Replace the Ethernet cable or the connector if necessary.

Inform.

0x39

Ethernet Link-Up

0x06

Data[0-4] Slot AIB (0x01) Data[5] Ethernet Port Number (0x00-0x02) _________________________________________ This alarm is sent to the host the first time a link-up state is seen on the Multi-Function Media I/O card. Because there are three Ethernet ports on the MultiFunction Media I/O card, the host might see three of these alarms when the card comes into service. No action required.

Inform.

0x3E

NFS Server Disconnect

0x07

Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID ___________________________________________ The connection between the DSP2 card and the NFS server has broken down. Check the Ethernet network and all Ethernet connections. If the alarms persists, update the Generic Card Configuration message in the CSP configuration with a NFS Poll Retries (0x601) TLV. This TLV can change the default number of polls that can be missed before this alarm is sent.

Inform.

0x40

NFS Server Mounted Successfully

0x07

Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID

1- 49
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x41

NFS Server Mounting Error

0x09

Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[7, 8] Error ID _________________________________________ 0x0001 - NFS Polling and Ping Failed 0x0002 - NFS Polling and Mount Failed 0x0003 - NFS Server Unreachable Diagnose the LAN connection between the DSP2 card and the NFS server.

Inform.

0x42

DSP Series 2 File Space Low

0x0C

Data[0-4] Data[5, 6] Data[7, 8] Data[9]

Slot AIB (0x01) Number of Files Number of Free Blocks TFTP (future) or NFS 0 TFTP (future) 1 NFS Data[10, 11] Threshold Data[0-4] Data[5, 6] Data[7, 8] Data[9] Slot AIB (0x01) Number of Files in Cache Number of Free Blocks Needed TFTP (future) or NFS 0 TFTP (future) 1 NFS Data[10, 11] Threshold

Major

0x43

DSP Series 2 File Space Out of Memory

0x0C

Minor

0x44*

NFS Traffic Minor Threshold Alarm

0x10

Data[0-4] Slot AIB (0x01) Data[5] Alarm Type (See list below) 0 (0x00) Number of Reads 1 (0x01) Total Bytes Read 2 (0x02) Average Read Delay 3 (0x03) Maximum Read Delay 4 (0x04) Number of Writes 5 (0x05) Total Bytes Written 6 (0x06) Average Write Delay 7 (0x07) Maximum Write Delay 8 (0x08) Maximum Simultaneous Files Opened 9 (0x09) Average Simultaneous Files Opened 10 (0x0A) CPU Idle Time 11 (0x0B) VRA Process Delay 12 (0x0C) VRA IO Queue Delay Data[6-9] Value of Statistics (Units vary) Data[10] M Value (Hits in window) Data[11] N Value (Samples in window) (N>=M) Data[12-15] Threshold value (if this is a time value, it is in microseconds.) The M-value indicates number of times the threshold is exceeded in the sample window of size N. See the CSP Developers Guide Oveview, DSP2 Overload Management for more data.

1- 50
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x45*

NFS Traffic Threshold Major Alarm

0x10

Data[0-4] Slot AIB (0x01) Data[5] Alarm Type (See list below.) 0 (0x00) Number of Reads 1 (0x01) Total Bytes Read 2 (0x02) Average Read Delay 3 (0x03) Maximum Read Delay 4 (0x04) Number of Writes 5 (0x05) Total Bytes Written 6 (0x06) Average Write Delay 7 (0x07) Maximum Write Delay 8 (0x08) Maximum Simultaneous Files Opened 9 (0x09) Average Simultaneous Files Opened 10 (0x0A) CPU Idle Time 11 (0x0B) VRA Process Delay 12 (0x0C) VRA IO Queue Delay Data[6-9] Value of Statistics (Units vary) Data[10] M Value (Hits in window) Data[11] N Value (Samples in window) (N>=M) Data[12-15] Threshold value (if this is a time value, it is in microseconds.) The M-value indicates number of times the threshold is exceeded in the sample window of size N. See CSP Developers Guide Overview, DSP2 Overload Logic Overload Management for more data.

Major Major

0x46 0x47

DSP Series 2 TFTP Communications Error NFS Read Error

0x07 0x0B

Data[0-4] Slot AIB (0x01) Data[5, 6] Error ID Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[7-10] File ID Data[11-14] Bytes written to server up to time of failure Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[7-10] File ID Data[11-14] Bytes written to server up to time of failure Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[7-10] Checksum Data[11-14] File ID (Last successfully loaded VIF line) Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[0-4] Data[5] Data[6] Data[7] Data[8] Data[9] Data[10] Slot AIB (0x01) Server ID (MSB) Server ID (LSB) File ID (MSB) File ID . . . File ID . . . File ID (LSB)

Major

0x48

NFS Write Error

0x0B

Inform.

0x49

Vocabulary Index File Read

0x0F

Inform. Major Major

0x4A 0x4B 0x4C

NFS Server Unmounted NFS Server Unmount Error NFS Open File Error

0x07 0x07 0x0B

1- 51
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x4D

File Queue Failed

0x0D

Data [0-4] Slot AIB Data[5] Parent Conference ID MSB Data[6] Parent Conference ID LSB Data[7] Child Conference ID MSB Data[8] Child Conference ID LSB Data[9] File ID (MSB) Data[10] File ID Data[11] File ID Data[12] File ID (LSB) ________________________________________ In the case of a parent conference, the Child Conference ID bits (Data[7-8]) shall be 0xFFFF. Data [0-4] Slot AIB Data [5-6] Server ID Data [7-10] File ID Data [11] Alarm Subtype (see below) Data [12-15] Value (Incorrect value found in file, see below) Subtype - Value (0xnnnnnnnn) 0x00 - No RIFF Chunk Found - Name of first chunk 0x01 - RIFF type .wav not found - RIFF type found 0x02 - No Format subchunk found - N/A (0x00000000) 0x03 - Invalid number of channels - Number of channels 0x04 - Invalid number of samples per second - Number of samples per second 0x05 - Invalid number of bits per second - Number of bits per second 0x06 - Unsupported encoding format - Encoding Format 0x07 - Data subchunk not found - N/A (0x00000000)

Inform.

0x4E

Error reading a .wav file

0x0E

1- 52
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x4F

Ethernet Switchover Occurred

Data [0-4] Slot AIB Data [5] Bit mask Bit 0 Interface B link state: 0=Down. 1=Up Bit 1 Interface A link state: 0=Down. 1=Up Bit 2 The active Ethernet Interface: 0=Interface A 1= Interface B ________________________________________ Diagnose the LAN connection between the DSP2 card and the NFS server.

Inform.

0x4F

Ethernet Switchover Occurred (DSP Series 2 card)

0x06

Data [0-4] Slot AIB Data [5] Active Port: 01, 02, or 03 Port 01 02 03 Interface NET1 NET2 NET3

Major

0x50

DSP Ethernet Unavailable

0x04

Ethernet address of the DSP Series 2 Card. If at any point the RCOMM link fails, this alarm is sent to the host. Ethernet address of the ISDN Series 3 Card. If at any point the RCOMM link fails, this alarm is sent to the host. 0x01 Slot AIB Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x01) Data[3] Data Length (0x01) Data[4] Slot Number Data[5] Error Reason 0x00 Unknown cause of error message 0x01 Frame symbol (0xFE) caused error message 0x02 Escape symbol (0xFD) error 0x03 Message has zero length 0x04 Message has bad checksum 0x05 Message has bad length Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID Data[7-10] Checksum Data[11-14] File ID (Last successfully loaded VIF line) Data[15-18] VIF bytes loaded into memory successfully Data[0-4] Slot AIB (0x01) Data[5, 6] Server ID

Major

0x52

ISDN Ethernet Unavailable

0x04

Inform.

0x58

Bad message received from local host

0x06

Minor

0x59

Vocabulary Index File Read Incomplete

0x13

Inform.

0x5A

Vocabulary Index File Potential Delay

0x0B

*Followed by an Alarm Cleared message

1- 53
Release 8.4.1 ER3, February 2008

Alarm 0x00B9 0x03 Span Alarms

Severity
Major

Alarm (Number/Name)
0x01 Carrier Group Alarm (CGA) or Span Dead (Please refer to the Span Filter Configure message)

Data Length
0x07

Data/Troubleshooting
0x0C Logical Span AIB Span Status (a bit mask that indicates what is being sent and received on the span): Bit 0 0x01 Receiving Red Bit 1 0x02 Receiving Remote Alarm Indication/Yellow Bit 2 0x04 Receiving Loss of Signal Bit 3 0x08 Receiving Out of Frame Bit 4 0x10 Sending Red (AIS) Bit 5 0x20 Sending Remote Alarm Indication/Yellow Bit 6 0x40 Receiving AIS Bit 7 0x80 Receiving constant E-bit with Remote Alarm Indication (valid for E1 with insert CRC and Euro-ISDN) ____________________________________________________ This alarm is generated when the CSP detects a carrier group alarm for more than the configured time period. Either you lost a clock source or someone pulled the patch cord and broke the physical connection to the TDM (Time Division Multiplexed) network. Request operational personnel find out why the physical connection has been compromised between the CSP to the telecom network. Also look at the way the span has been configured - it must be the same on both ends. See the T1 Span Configure, E1 Span Configure or J1 Span Configure messages for different configuration parameters.

0x02 Reserved Major 0x03 Excessive Burst of Slips 0x08 0x0C Logical Span AIB Slot Number Span Offset ____________________________________________________ This notification occurs when the CSP detects an abnormally high number of slips. The address information represents the logical span of the span. There might be noisy T1 signals on the line, a configuration mismatch that is, B8Zs/AMI/SF/ESF etc. for T1, HDB3, CRC-4 etc for E1 spans or a bad timing source for span synchronization. Use the Span Status Query message (0x0084) which will return all Layer 1 parameters. See the API Reference for more details. Also, you can check your timing source. Most of the time the CSP uses a Span from the network to Time the entire CSP chassis. If that source is not good, it may trigger slips and carrier Group Alarms (CGA) on other spans. Major 0x04 J1-Specific Failure 0x06 0x0C Logical Span AIB

1- 54
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x05 Logical Span ID already exists on another node

0x06

0x0C Logical Span AIB ____________________________________________________ An application is trying to configure a Logical Span ID that already exists on another node. There could be a software error in SwitchMgr or an error in the configuration file. Check the configuration. Collect the [Link] and [Link] and contact Dialogic Technical Support.

Inform.

0x0F CGA Filter set to 0xFFFF

0x06

0x0C Logical Span AIB

*Followed by an Alarm Cleared message 0x04 Channel Alarms

Severity
Inform. 0x01 0x02

Alarm (Number/Name)
Reserved ISDN D Channel Establishing (the distant end is not communicating on the D Channel)

Data Length
0x07

Data/Troubleshooting

0x0D Channel AIB __________________________________ ISDN D channel is trying to get established and the distant end is not communicating on the D channel. Initial configuration or the distant end has stopped communicating on the D channel. Investigate the distant end D channel.

Inform.

0x03 0x04

PPL Error Data

Variable Refer to the PPL Error Data at the end of this message for the data format. Check D Channel Out of Service condition. The Primary D channel has gone from being in-service to out-of-service. The address information represents the slot and channel of the D channel. Look for Card or Span alarms that would also indicate a hardware failure. Reset the D Channel if is does not come back inservice contact remote end network administrator to check remote end status.

Switchover Initiate

0x05

Switchover Success

The D channel switchover was successful. The new D channel is now the controller. The address information represents the span and channel of the new D channel. Investigate the cause of the switchover.

1- 55
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x06

Switchover Failure

The controller switchover failed. The existing D channel is still the controlling D channel. The address information represents the span and channel of the new D channel. Investigate cause of switchover and state of the Backup D Channel.

0x07

Backup Diagnostic

Information Alarm when the state of the D channel changes. The address information represents the span and channel of the D channel. Investigate the cause of D Channel switchover. Look for other error messages that would indicate a network or system condition leading to this problem. If symptoms persist, contact Dialogic Technical Support. The Device Server ID and 0x0D Channel AIB. The Device Server ID and 0x0D Channel AIB. __________________________________ A DSP Resource Wait timeout occurs when the CSP gets no response when requesting a physical channel. Could be a hardware failure. If the problem persists, contact Dialogic Technical Support

0x08

SS IPDC Error

Major Major

0x09

Invalid Associated Channel

0x09 0x09

0x0A DSP Resource Wait Timeout

Major Inform.

0x0E EXNET Connection Error 0x11 DSP Service Cancel Timeout Severity 0x09

Contact Dialogic Technical Support. Data[0-6] 0x0D Channel [7-8] L4 CH State

*Followed by an Alarm Cleared message 0x05 DSP SIMM Alarms

Severity
Inform. 0x01

Alarm (Number/Name)
DSP SIMM Taken Out of Service

Data Length
0x06

Data/Troubleshooting
0x12 DSP SIMM AIB. _______________________________ Check with operations personnel to verify card removal. Verify the host did not send a Service State Configure (0x000A) message to take the SIMM out of service. Also verify that the DSP card is still installed and powered on.

0x02

Reserved

0x00

No Data

1- 56
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Inform.

0x03

Recorded Announcement Erase Complete

0x00

No Data Sent upon completion of erasure. When you have erased a VRA SIMM using Recorded Announcement (0x0054), this alarm indicates that the erasure is complete. The host must wait for this alarm before it begins any download.

1- 57
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x04

Recorded Announcement Download Inconsistency

0x00

No Data Sent upon completion of download. This alarm indicates an inconsistency between the information in a Recorded Announcement Download 0x0052 message and the actual announcement in the Recorded Announcement Download 0x0053 message. The inconsistency is usually caused by an incorrect checksum or announcement size. The announcement information is stored as it appears in the Recorded Announcement Download 0x0053 message. Play out the announcement to check it. Could be caused by an incorrect checksum or announcement size. Check the announcement and delete one of the announcements.

Major

0x05

Recorded Announcement ID Inconsistency (on same card)

0x00

No Data Sent when a VRA SIMM is brought in service. This alarm indicates that an announcement uses the same ID as another announcement, with different information, on the DSP card. Both announcements have the same ID, and either announcement might be played when the ID is specified in the Recorded Announcement Connect 0x0055 message. Indicates that the host downloaded an announcement using the same ID as another announcement, with different information on the DSP card. Check the configuration to ensure that you are not using the same ID for different RAN files.

Inform.

0x06

Recorded Announcement Download Ready

0x08

An AIB indicating the slot number: Data[0] Address Method (0x00) Data[1] No. of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number Data[6, 7] RAN ID _______________________________ Sent upon completion of download. The DSP-ONE card will not accept another Recorded Announcement Download Initiate message until it has sent this alarm.

1- 58
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Inform

0x07

Recorded Announcement File System Conversion Success

0x06

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number _______________________________ Sent after the flash memory file system is converted. Informs the host that the RANs are now stored in the requested file system. This alarm takes three to five minutes to be generated after the host sends the file system conversion request. After this alarm you are able to bring the VRAS simm into service.

Major

0x08

Recorded Announcement File System Conversion Failure

0x07

Data Length: (0x07) Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number Data[6]:Failure Code _______________________________ Failure codes: VRA_FAILURE = 0, Amount of Flash Data invalid for New File System. VRA_FLASH_WRITE_FAILURE = 2, Writing to Flash failed. VRA_FLASH_ERASE_FAILURE = 3, Erasing Flash failed. VRA_RAM_WRITE_FAILURE = 4, Writing RAM failed. VRA_DATA_VALIDATION_FAILURE = 5 CRC validation failed. Sent after an unsuccessful attempt to convert the file system. Informs the host that the file system conversion process failed. You should delete the RANs on this VRA SIMM. If the file system convert fails then delete all RANs from this SIMM and try again.

1- 59
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x09

Recorded Announcement File System Timeout

0x06

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number _______________________________ Sent after an attempt to convert the file system times out, if the attempted deletion of entire flash memory, file system conversion, or defragmentation fails to complete in the time allowed. Try deleting each RAN from the SIMM.

Inform

0x0B Recorded Announcement Defragmentation Success

0x06

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number _______________________________ Sent after defragmentation of the flash memory is complete. Informs the host that the RANs now take up as little flash memory as possible. This alarm takes three to five minutes to be generated after the host sends the file system Defragment request.

Major

0x0C Recorded Announcement Defragmentation Failure

0x07

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number Data[6] Failure Code (see failure codes listed under Alarm File System Conversion Failure 0x08) _______________________________ Sent after an unsuccessful attempt to defragment flash memory. Informs the host that the flash memory defragmentation has failed. The host should delete the flash memory on this VRA SIMM.

1- 60
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Inform

0x0D Recorded Announcement Single Deletion Complete

0x08

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number Data[6] RAN ID (MSB) Data[7] RAN ID (LSB) _______________________________ Sent in response to the message, Recorded Announcement Single Delete. Informs the host that the RAN ID has been marked for deletion and is no longer available for use. This alarm takes zero to 30 seconds to be generated after the host sends the delete request.

Inform

0x0E Recorded Announcement Need Defragmentation

0x07

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x12) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] SIMM Number Data[6] Defragmentation Level _______________________________ Sent after a Recorded Announcement Single Delete has been processed and the flash memory where the RANs are stored has reached the highest level of fragmentation. Indicates that enough of the flash memory is occupied by deleted RANs to make it worthwhile to defragment the flash memory.

*Followed by an Alarm Cleared message

1- 61
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x06 DSP Alarms

Severity
Major

Alarm (Number/Name)
0x01 DSP Out of Service

Data Length
0x03

Data/Troubleshooting
Data[0] Slot Number Data[1] Module Number (0-1) Data[2] Chip Number (0-3) _______________________________ Either the user took the DSP chip out of service using a service state configuration message addressing the chip or the DSP mother card took the DSP chip out of service due to lose of polls from the DSP mother card. If SwitchMgr does not bring the DSP chip back into service using the service state configuration message addressing the DSP chip, then collect the [Link] and [Link] and call Dialogic Technical Support.

Inform.

0x02* Resources Exceed Limit

0x07

Data[0] Data[1] Data[2] Data[3, 4] Data[5, 6]

Function Type Alarm Threshold Alarm Cleared Threshold Number of Channels Used Number of Channels Configured for Function Type Data[7,8] Clear threshold for this function type

Major

0x03 DSP Playback Underrun

0x08

Data[0] Slot Number Data[1] Module Number (0-1) Data[2] Chip Number (0-3) Data[3] TFTP (future) or NFS Data[4,5] Total temporary storage Blocks Data[6,7] Number of Blocks in use by DSP Data[0] Data[1] Data[2] Data[3-6] Data[0] Data[1] Data[2] Data[3-6] Data[7,8] Data[9,10] Data[11,12] Slot Number Module Number (0-1) Chip Number (0-3) File ID Slot Number Module Number (0-1) Chip Number (0-3) File ID Total Number of Blocks Number of Blocks on DSP Threshold

Major

0x04 DSP Record Overrun

0x07

Major

0x05 DSP Temporary Storage Minor Alarm

0x0D

1- 62
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x06 DSP Temporary Storage Full

0x0D

Data[0] Data[1] Data[2] Data[3-6] Data[7,8] Data[9,10]

Slot Number Module Number (0-1) Chip Number (0-3) File ID Requested Number of Blocks Number of used Blocks on DSP Data[11,12] Number of free Blocks on DSP Alarm Threshold Alarm Clear Threshold Resource Points in use Resource Points Configured Slot Module Number Chip Number

Inform.

0x07* DSP Points Exceed Limit

0x0A

Data[0] Data[1] Data[2-5] Data[6-9] Data[0] Data[1] Data[2]

Major

0x08* DSP Chip Reset

0x03

*Followed by an Alarm Cleared message

1- 63
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x07 Node Alarms

Severity
Minor

Alarm (Number/Name)
0x01 Not Using Extended API

Data Length
0x06

Data/Troubleshooting
Data[0] Data[1] Data[2] Data[3] Data[4] Data[5] Physical Node ID, MSB Physical Node ID Physical Node ID Physical Node ID, LSB Logical Node ID Host Node ID

Inform. Inform.

0x02 Available Conferencing Timeslot Changed 0x05 Unable to Communicate with Node

0x02

Data[0] New Timeslot Count, MSB Data[1] New Timeslot Count, LSB Normally when this alarm is sent to the host, it includes the filename and line number where the error occurred. Send this information to Dialogic Technical Support. Data[0] Node ID Data[1] Board Slot Number _____________________________ Check with network operations for other network alarms that could be related.

Major

0x06 Remote SS7 Server Node Unavailable

0x07 0x07 Remote SS7 CIC Matrix Node Unavailable

Check with network operations for other network alarms that could be related. Data[0] Number of IDs (always 1) Data[1] 1=Active SS7 Card 2=Standby SS7 Card _____________________________ Ensure that the Ethernet cable is plugged in CCS I/O Ethernet Port A. Check for faulty hardware, (SS7PQ, SS7HP, CCS I/O, ethernet cable, and Ethernet switch). Check with network operations for other network alarms that could be related.

Major

0x08 Remote SS7 Card Unavailable

Major Major

0x0A Maximum Node Count Reached 0x0B H.100 Bus Failure This alarm occurs if the H.100 bus fails. For example, if there are no clock signals to drive the H.100 bus. This alarm occurs if the clock B signal of the H.100 bus fails. This alarm notifies the host about the clock signal failure, so that the host can appoint another board to source the clock or take other actions.

Major

0x0C Clock B Failure

1- 64
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x0D Clock A Failure

This alarm occurs if the clock A signal of the H.100 bus fails. This alarm notifies the host about the clock signal failure, so that the host can appoint another board to source the clock or take other actions. This alarm occurs when the board could not become the primary master driving clock A, when instructed to do so. This alarm is sent to the host to enable it to appoint another board as primary master driving clock A or take other actions. This alarm occurs when the board could not become the primary master driving clock B, when instructed to do so. This alarm is sent to the host to enable it to appoint another board as primary master driving clock B or take other actions. This alarm occurs when the board could not become the secondary master driving clock A, when instructed to do so. This alarm is sent to the host to enable it to appoint another board as secondary master driving clock A or take other actions. This alarm occurs when the board could not become the secondary master driving clock B, when instructed to do so. This alarm is sent to the host to enable it to appoint another board as secondary master driving clock B or take other actions. This alarm occurs when a momentary failure of clock A is observed and clock A recovers. This alarm occurs when a momentary failure of clock B is observed and clock B recovers. This alarm occurs when the board is acting as the secondary master, driving clock A and the primary master, driving clock B fails. Since the primary master, driving clock B has failed, the secondary master driving clock A takes over as the primary master, driving clock A. The board is taking over as the primary master driving clock A.

Major

0x0E Cannot Be Primary A

Major

0x0F Cannot Be Primary B

Major

0x10 Cannot Be Secondary A

Major

0x11 Cannot Be Secondary B

Major

0x12 Momentary Failure of Clock A

Major

0x13 Momentary Failure of Clock B

Major

0x14

Taking Over As Primary A

1- 65
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x15 Taking Over As Primary B

This alarm occurs when the board is acting as the secondary master, driving clock B and the primary master, driving clock A fails. Since the primary master, driving clock A has failed, the secondary master driving clock B takes over as the primary master, driving clock B. The board is taking over as the primary master driving clock B.

*Followed by an Alarm Cleared message 0x08 DS3 Alarms

Severity
Major

Alarm (Number/Name)
0x01 DS3 Alarm

Data Length
0x07 Data[0] Data[1] Data[2] Data[3] Data[4] Data[5] Data[6]

Data/Troubleshooting
Address Method (0x00) Number of Address Elements (0x01) Address Type (0x32) Data Length (0x02) Slot Number DS3 Offset Alarm (a bit mask that indicates what is being sent and received on the DS3): Bit 0 0x01 Receiving Red Bit 1 0x02 Receiving Remote Alarm Ind. / Yellow Bit 2 0x04 Receiving Loss of Signal Bit 3 0x08 Receiving Out of Frame Bit 4 0x10 Receiving AIS Bit 5 0x20 Sending AIS Bit 6 0x40 Sending Remote Alarm Ind. / Yellow Bit 7 Reserved _______________________________________________ Check for clock reference alarms that could be associated with this failure.

1- 66
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Inform.

0x02 Far End Alarm and Control (FEAC)

0x01 If Severity is Informative 0x07 Data[0] Data[1] Data[2] Data[3] Data[4] Data[5] Data[6] Address Method (0x00) Number of Address Elements (0x01) Address Type (0x32) Data Length (0x02) Slot Number DS3 Offset Alarm 0x00 Activate Span Offset 0 in Loopback Mode 0x01 Activate Span Offset 1 in Loopback Mode 0x02 Activate Span Offset 2 in Loopback Mode 0x03 Activate Span Offset 3 in Loopback Mode 0x04 Activate Span Offset 4 in Loopback Mode 0x05 Activate Span Offset 5 in Loopback Mode 0x06 Activate Span Offset 6 in Loopback Mode 0x07 Activate Span Offset 7 in Loopback Mode 0x08 Activate Span Offset 8 in Loopback Mode 0x09 Activate Span Offset 9 in Loopback Mode 0x0A Activate Span Offset 10 in Loopback Mode 0x0B Activate Span Offset 11 in Loopback Mode 0x0C Activate Span Offset 12 in Loopback Mode 0x0D Activate Span Offset 13 in Loopback Mode 0x0E Activate Span Offset 14 in Loopback Mode 0x0F Activate Span Offset 15 in Loopback Mode 0x10 Activate Span Offset 16 in Loopback Mode 0x11 Activate Span Offset 17 in Loopback Mode 0x12 Activate Span Offset 18 in Loopback Mode 0x13 Activate Span Offset 19 in Loopback Mode 0x14 Activate Span Offset 20 in Loopback Mode 0x15 Activate Span Offset 21 in Loopback Mode 0x16 Activate Span Offset 22 in Loopback Mode 0x17 Activate Span Offset 23 in Loopback Mode 0x18 Activate Span Offset 24 in Loopback Mode 0x19 Activate Span Offset 25 in Loopback Mode 0x1A Activate Span Offset 26 in Loopback Mode 0x1B Activate Span Offset 27 in Loopback Mode 0x1C Activate All Span Offsets in Loopback Mode 0x1D Activate DS3 in Loopback Mode

1- 67
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x20 Deactivate Span Offset 0 in Loopback Mode 0x21 Deactivate Span Offset 1 in Loopback Mode 0x22 Deactivate Span Offset 2 in Loopback Mode 0x23 Deactivate Span Offset 3 in Loopback Mode 0x24 Deactivate Span Offset 4 in Loopback Mode 0x25 Deactivate Span Offset 5 in Loopback Mode 0x26 Deactivate Span Offset 6 in Loopback Mode 0x27 Deactivate Span Offset 7 in Loopback Mode 0x28 Deactivate Span Offset 8 in Loopback Mode 0x29 Deactivate Span Offset 9 in Loopback Mode 0x2A Deactivate Span Offset 10 in Loopback Mode 0x2B Deactivate Span Offset 11 in Loopback Mode 0x2C Deactivate Span Offset 12 in Loopback Mode 0x2D Deactivate Span Offset 13 in Loopback Mode 0x2E Deactivate Span Offset 14 in Loopback Mode 0x2F Deactivate Span Offset 15 in Loopback Mode 0x30 Deactivate Span Offset 16 in Loopback Mode 0x31 Deactivate Span Offset 17 in Loopback Mode 0x32 Deactivate Span Offset 18 in Loopback Mode 0x33 Deactivate Span Offset 19 in Loopback Mode 0x34 Deactivate Span Offset 20 in Loopback Mode 0x35 Deactivate Span Offset 21 in Loopback Mode 0x36 Deactivate Span Offset 22 in Loopback Mode 0x37 Deactivate Span Offset 23 in Loopback Mode 0x38 Deactivate Span Offset 24 in Loopback Mode 0x39 Deactivate Span Offset 25 in Loopback Mode 0x3A Deactivate Span Offset 26 in Loopback Mode 0x3B Deactivate Span Offset 27 in Loopback Mode 0x3C Deactivate All Span Offsets in Loopback Mode 0x3D Deactivate DS3 in Loopback Mode _______________________________________________ If a major alarm is indicated, check network operations for farend CGA or other facility alarms. If the severity is informative, you can enable loopback mode or ignore. If the severity is major, sync with the carrier and verify Layer 1 integrity

1- 68
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x02 Far End Alarm and Control (FEAC)

0x03 If Severity is Major 0x07 Data[0] Data[1] Data[2] Data[3] Data[4] Data[5] Data[6] Address Method (0x00) Number of Address Elements (0x01) Address Type (0x32) Data Length (0x02) Slot Number DS3 Offset Alarm 0x01 DS3 Equipment Failure (Affecting Service) 0x02 DS3 Loss of Signal 0x03 DS3 Out of Frame 0x04 DS3 AIS 0x05 DS3 Idle 0x06 DS3 Equipment Failure (Not Affecting Service) 0x07 Common Equipment Failure 0x08 DS1 Multiple Loss of Signal 0x09 DS1 Equipment Failure (Affecting Service) 0x0A DS1 Single Loss of Service 0x0B DS1 Equipment Failure (Not Affecting Service)

Major

0x03* DS3 Application Mismatch

0x07

Alarm is send when the received DS3 Application bit does not match the configured DS3 framer mode. Data[0] Data[1] Data[2] Data[3] Data[4] Data[5] Data[6] Address Method (0x00) Number of Address Elements (0x01) Address Type (0x32) Data Length (0x02) Slot Number DS3 Offset Application ID bit received 0x00 - M13 0x01 - C-Bit

*Followed by an Alarm Cleared message

1- 69
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x09 VoIP Module Alarms

Severity
Major 0x00

Alarm (Number/Name)
Module In Service

Data Length
0x06

Data/Troubleshooting
See 0x42 VoIP Module (2-22) A VDAC-ONE or IPN2 module has come in service. The address information represents the slot and VDAC module ID. ___________________________________ No action required.

Major

0x01

Module Out of Service

0x06

See 0x42 VoIP Module (2-22) ___________________________________ The VDAC or IPN2 module is out-of-service. The address information represents the slot and VDAC-ONE or IPN2 module ID. Verify the module is no longer needed for the operation.

Major

0x02

Module Dead

0x06

See 0x42 VoIP Module (2-22) ___________________________________ The VDAC-ONE or IPN-2 module is no longer communicating. The address information represents the slot and VDAC-ONE/IPN-2 module ID. Review Field Bulletin O-4083 at [Link]/support If problem persists, contact Dialogic Technical Support

Major

0x03

DSP Dead

0x07

Data[0] Address Method Data[1] Number of Address Elements Data[2] Address Type (0x42) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] Module Number Data[6] DSP Number 0x00-0x07 ___________________________________ The DSP on VDAC-ONE or IPN-2 card is no longer communicating. The address information represents the slot and VDAC/IPN2 module ID. Check the IP network for the source of the error. If the problem persists, contact Dialogic Technical Support.

1- 70
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x04

Module Reset

0x06

See 0x42 VoIP Module (2-22) Check with the operations personnel to verify board reset.

Major

0x05

Module Resetting

0x06

See 0x42 VoIP Module (2-22) ___________________________________ A VDAC-ONE or IPN2 module is currently resetting. The address information represents the slot and VDAC-ONE or IPN2 module ID. Software fault could have occurred or the VoIP card or the module is being reset by the host. If the host did not issue the reset request, then perform the Fault Log Query for the VoIP module indicated in the message and contact Dialogic Technical Support.

Major

0x06

DSP Reset

0x07

Data[0] Address Method Data[1] Number of Address Elements Data[2] Address Type (0x42) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] Module Number Data[6] DSP Number 0x00-0x07 ___________________________________ This alarm is sent to the host upon reset of a DSP Resource on a VDAC-ONE cards VoIP Module or IPN-2 cards VoIP Module. Too many fatal errors are detected on this DSP module. Check the IP network for the source of the error. If the problem persists, contact Dialogic Technical Support.

Major

0x07

VMOD Inaccessible

0x06

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x42) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] Module Number ___________________________________ This alarm is sent to the host when a module becomes inaccessible from the motherboard. See also 0x42 VoIP Module (2-22)

1- 71
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Major

0x08

Fatal Calisto Error

0x07

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x42) Data[3] Data Length (0x02) Data[4] Module Number Data[5] Calisto Number _____________________________________ This alarm results from the host sending the Media Recovery Method TLV (0x01F4) in the Resources Attribute Configure (0x00E3) message.

Inf.

0x09

Media Recovery Procedure Started

Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x42) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] Module Number Datat[6] Calisto Number - set to 0xFF in case of Immedidate forced bleed-off. _____________________________________ This alarm results from the host sending the Media Recovery Method TLV (0x01F4) in the Resources Attribute Configure (0x00E3) message.

Inf.

0x17

Software Error

Variable

See 0x42 VoIP Module (2-22) Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x42) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] Module Number Data[6-45] Filename (in ASCII) Data[46,47] Line Number Data[48-n] Diagnostic Data

*Followed by an Alarm Cleared message

1- 72
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x1E TFTP Alarm

NOTE: This alarm is resent every 20 seconds as long as the alarm condition remains Length Variable

Data[0] Alarm Code 0x00 Cannot TFTP file 0x01 Invalid TFTP Configuration File Format 0x02 Invalid BRecord Format 0x03 RAM Corrupted 0x04 Old Timestamp 0x05 No timestamp supplied Data[1] Type 0x02 Alarm Status (See Data[2], below) All other types: Dialogic Use Only. Report to Dialogic Technical Support. Data[2] Status Applies to Alarm Type 0x02 (Alarm Status) only. 0x00 No Status 0x01 TFTP device detected a protocol error (such as a non-Data packet received or expected ACK not received. Occurs when a file is not found). 0x02 TFTP device timed out (Incorrect IP Address) 0x03 TFTP device is out of sync 0x04 TFTP device has no more free socket IDs (Occurs when another TFTP Download was in progress but was aborted) 0x05 TFTP device cannot use a channel number given to it 0x06 TFTP device has not been initialized 0x07 No server IP Address has been given 0x08 No TFTP Configuration filename has been given 0x09 No timestamp has been given 0x0A A TFTP Configuration or BRecord File line is too long 0x0B Too much data for internal buffer 0x0C TFTP Configuration File line has no '=' 0x0D TFTP Configuration File line has no second '=' 0x0E TFTP Configuration File timestamp is missing a parameter 0x0F Load filename is greater than 127 characters 0x10 EX/CPU Label in TFTP Configuration file not set to SAVE_LOAD_TRUE 0x11 Not enough RAM on EX/CPU card to save all loads that are configured to be saved 0x12 BRecord File is out of sync. There is no 'B' starting the record. 0x13 BRecord receiver is out of sync. Expected a different record type. 0x14 Invalid BRecord Checksum 0x15 Invalid BRecord Count 0x16 Incorrect Number of Bytes in BRecord Load

1- 73
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

0x17 0x18 0x19 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F 0x20 0x21

Invalid Load Checksum Incorrect Load for Card Load is from a different software version than the version on the EX/CPU Timeout waiting for response from internal download process Host download is in progress TFTP Download aborted by initiation of host download Timeout waiting for buffer Stopped by host starting another TFTP Configuration file has a new save option for an existing load Operating system general error Operating system I/O error

Data[3] Load Number 0x00 ST1LC 0x01 EX/CPU 0x02 MFDSP 0x03 Reserved 0x04 SE1LC 0x05 SJ1LC 0x06 SS7 0x07 ISDN PRI, DASS2/DPNSS 0x09 DSP-ONE 0x0B T-ONE, E-ONE 0xFF No Load Data[4] Error Information 0x00 No Error 0x01 Battery-backed configuration validation 0x02 System data validation 0x03 Input parameter validation 0x04 TFTP device initialization 0x05 TFTP device open 0x06 TFTP device read 0x07 TFTP device control 0x08 Loading Configuration File 0x09 Validating Configuration File 0x0A Loading Load Information 0x0B Validating Load Information 0x0C Sending Begin to download the state machine 0x0D Sending BRecord to download the state machine 0x0E Verifying TFTP completion 0x0F Sending Complete to download the state machine 0x10 Sending data buffer to line card 0x11 Verifying data for line card completion 0x21 Host Connection Dropped (Major) (Indicates that a connection to a host has been dropped)

1- 74
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

PPL Error Data

The data format for this alarm depends on the PPL component E1/T1 Components: Length Data[0] Data[1] Data[2] Data[3] Data[4-10] Data[4] Data[5] Data[6] Data[7] Data[8] Data[9] Data[10] Data[11] Data[12] Data[13] Data[12] Data[14] Data[15] Data[16] Data[17] Data[18] Data[19] 0x 14 Component ID, MSB Component ID, LSB Logical Span ID Channel The Channel AIB Address Method (0x00) Number of Address Elements (0x01) Address Type (0x0D) Data Length (0x03) Logical Span ID, MSB Logical Span ID, LSB Channel PPL Protocol ID Blocked PPL Event, MSB PPL Event, LSB Initial State Next State Timestamp, MSB Timestamp, LSB Error Status, MSB Error Status, LSB

See PPL Audit Query 0xDD" for values of the various PPL bytes.

ISDN and DASS Components:

Length 0x 1A Data[0] Component ID, MSB Data[1] Component ID, LSB Data[2] Logical Span ID Data[3] Channel Data[4-10] The Channel AIB Data[4] Address Method (0x00) Data[5] Number of Address Elements (0x01) Data[6] Address Type (0x0D) Data[7] Data Length (0x03) Data[8] Logical Span ID, MSB
...........................................................................................................................................................................................................................................................

1- 75
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Data[9] Data[10] Data[11] Data[12] Data[13] Data[14] Data[15] Data[16] Data[17] Data[18] Data[19] Data[20] Data[21] Data[22] Data[23] Data[24] Data[25]

Logical Span ID, LSB Channel Subrate Call Reference, MSB Call Reference, LSB Reserved Reserved PPL Protocol ID Blocked PPL Event, MSB PPL Event, LSB Initial State Next State Timestamp, MSB Timestamp, LSB Error Status, MSB Error Status, LSB

See PPL Audit Query 0xDD" for values of the various PPL bytes.

SS7 Components:
Length Data[0] Data[1] Data[2-n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Variable Component ID, MSB Component ID, LSB See PPL Component Addressing for the AIB PPL Protocol ID Blocked PPL Event, MSB PPL Event, LSB Initial State Next State Timestamp, MSB Timestamp, LSB Error Status, MSB Error Status, LSB

VDAC-ONE and IP Network Interface Series 2 Component Length Variable Data[0] Component ID, MSB Data[1] Component ID, LSB Data[2-n] See PPL Component Addressing for the AIB Data[n] PPL Protocol ID Data[n] Blocked Data[n] PPL Event, MSB Data[n] PPL Event, LSB ........................................................................................................................................................................................................................................................... 1- 76
Release 8.4.1 ER3, February 2008

Alarm 0x00B9

Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n] Data[n]

Initial State Next State Timestamp, MSB Timestamp, LSB Error Status, MSB Error Status, LSB External Initial State, MSB External Initial State, LSB External Next State, MSB External Next State, LSB

0x0B SIP Alarm

Severity
Inform. 0x01

Alarm (Number/Name)
Received destination unreachable ICMP error for the SIP message sent.

Data Length
0x16

Data/Troubleshooting
Data[0-6] Channel AIB (0x0D) Data[7] ICMP Type (0x03) - Destination Unreachable Data[8] ICMP Code - For example 0x03 Port Unreachable. Refer to RFC 792. Data[9] Protocol of failed packet (0x11) UDP Data[10-13] Source address of failed packet the CSP SIP IP Address Data[14-17] Destination address of failed packet Data[18-19] Source port of failed packet Data[20-21] Destination port of failed packet Data[0-6] Channel AIB (0x0D) Data[7-8] Response Code Data[9] Error Code Error Codes: 0x00 Syntax Error 0x01 Transaction Not found 0x02 Invalid CSeq number 0x03 Tags mismatch 0x04 Invalid CSeq message type 0x05 Retransmitted response

Inform.

0x02

Received invalid response for the SIP message sent

0x0A

1- 77
Release 8.4.1 ER3, February 2008

Alarm Cleared 0x00C1

SwitchKit Name Type Description AlarmCleared EXS API and SwitchKit API message Alarm Cleared 0x00C1 The CSP sends this message to indicate that an alarm previously reported in an Alarm message has been cleared because it has been resolved by a host action or by some external action or series of events. The following information about the originating alarm is reported: Severity Alarm Type Alarm Number Alarm Data See the Alarm message for Alarm Type, Alarm Number, and Data values. The Data will match that of the alarm that has been cleared, except for a span alarm, for which there is one byte of data indicating that the span status is 0x00 (Receiving Red) (0x000 for SwitchKit). Related Messages Sent by SwitchKit Code Alarm 0x00B9 CSP C Structure
typedef struct { UBYTE InfoSize; UBYTE Severity; UBYTE Entity; UBYTE AlarmNum; UBYTE Info[249]; } XL_AlarmCleared;

C++ Class
class XLC_AlarmCleared : public XLC_InboundMessage { public: UBYTE getInfoSize() const; void setInfoSize(UBYTE x); UBYTE getSeverity() const; void setSeverity(UBYTE x); UBYTE getEntity() const; void setEntity(UBYTE x); UBYTE getAlarmNum() const; void setAlarmNum(UBYTE x); const UBYTE *getInfo() const; UBYTE *getInfo(); void setInfo(UBYTE *x);

};
...........................................................................................................................................................................................................................................................

1- 78
Release 8.4.1 ER3, February 2008

Alarm Cleared 0x00C1 Resent for EXS API EXS API Hex Format
MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 9 10 11 12 : : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00C1) Reserved (0x00) Sequence Number Logical Node ID Severity Alarm Type Alarm Number Data Length (n) Data[0] Data[n] Checksum Byte 0 1, 2 3, 4 5 6 7 8 Frame (0xFE) Length (0x0005) Message Type (0x00C1) Reserved (0x00) Same Sequence Number Logical Node ID Checksum RESPONSE (Gray) Field Description

This message is sent once after five seconds.

1- 79
Release 8.4.1 ER3, February 2008

AllInService

AllInService
Type Purpose

SwitchKit API message Use the SK_AllInService message to automatically bring into service all entities referenced in the configuration file. This message is for SwitchManager configuration files. It instructs SwitchManager to bring into service any entity referenced in configuration files using ServiceStateConfig. AllInService saves you from having to explicitly add ServiceStateConfig messages for each single entity. SwitchManager AllInService (
Node = integer, ConnectionID = integer);

Description

Sent by Configuration

1- 80
Release 8.4.1 ER3, February 2008

AllocateChannel

AllocateChannel
Type Description

SwitchKit API message Use the SK_AllocateChannel message to manually allocate a channel outside of the standard automatic allocation functions (for example, sk_watchChannelGroup() and sk_requestOutseizedChannel()). Regardless of the channel groups that the channel is in, the LLC tries to allocate the channel specified by Span and Channel to the calling application. On success, the return Status value contains 0x00. If the channel is already allocated to another application, Status contains SK_NO_CHANNELS. Application
typedef struct { unsigned short Span; UBYTE Channel; } SK_AllocateChannel; typedef struct { int Status; } SK_AllocateChannelAck; class SKC_AllocateChannel : public SKC_ToolkitMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); }; class SKC_AllocateChannelAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); };

Sent by C Structure

C Structure Response

C++ Class

C++ Class Response

1- 81
Release 8.4.1 ER3, February 2008

AllocateChannelGroup

AllocateChannelGroup
Type Description

SwitchKit API message Use the SK_AllocateChannelGroup message to manually allocate all available channels in a given channel group. If GroupName is not valid, then Status in the acknowledgment contains SK_INVALID_GROUP. Otherwise, it contains 0x10, and Channels contains a list of all the channels that have been allocated. Channels[01] will contain the first span, Channels[2] will contain the first channel offset, and so on, for as many channels as are specified in NumChannels. Application
typedef struct { char GroupName[50]; UBYTE reserved67[203]; } SK_AllocateChannelGroup; typedef struct { int Status; int NumChannels; UBYTE Channels[245]; } SK_AllocateChannelGroupAck; class SKC_AllocateChannelGroup : public SKC_ToolkitMessage { public: const char *getGroupName() const; void setGroupName(const char *x); }; class SKC_AllocateChannelGroupAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getNumChannels() const; void setNumChannels(int x); const UBYTE *getChannels() const; UBYTE *getChannels(); void setChannels(UBYTE *x); };

Sent by C Structure

C Structure Response

C++ Class

C++ Class Response

1- 82
Release 8.4.1 ER3, February 2008

AllOutOfService

AllOutOfService
Type Purpose

SwitchKit API message Use the SK_AllOutOfService message to automatically take all referenced entities out-of-service on any configured node prior to sending another configuration. SwitchManager takes all entities found on any configured node out-ofservice after receiving this message. Sending this message saves you from having to explicitly add ServiceStateConfig messages for each entity. Taking entities out-of-service prior to configuration is important to prevent system purges caused by configuring a channel that is inservice. Use of AllOutOfService is not recommended for dynamic configurations.
Important!

Description

Sent by Configuration

SwitchManager AllOutOfService (
Node = integer, ConnectionID = integer);

1- 83
Release 8.4.1 ER3, February 2008

Answer Supervision Mode Configure 0x00BB

SwitchKit Name Type Description AnswerSuperviseConfig EXS API and SwitchKit API message Answer Supervision Mode Configure 0x00BB Use this message to configure the Answer Supervision mode for a channel or range of channels. The Answer Supervision Mode options are: Propagate Answer to Distant End Notify Host of Answer Propagate Answer to Distant End and Notify Host of Answer No Answer Supervision - no propagation of answer or notification

CAUTION
Do not send this message for channels configured as the following trunk types:
DP0 DPT FX0 loopstart and groundstart (OK to use if the answer supervision mode is 0x00 or 0x03) If you use this message for these trunk types, the CSP sends the response Status value Invalid Data Type (0x17). Sent by Example Message (SwitchKit Socket Log Output) Host The following socket log output/example message configures the Answer Supervision Mode to propagate answer to distant end for channels 0x00 0x17 on spans 0x01 - 0x02.
00 12 00 BB 00 00 FF 01 02 0D 03 00 01 00 0D 03 00 02 17 00

SwitchKit Code

Configuration
AnswerSuperviseConfig ( Node = integer, Range = StartSpan : StartChan - EndSpan : EndChan, AnswerMode = integer);

1- 84
Release 8.4.1 ER3, February 2008

Answer Supervision Mode Configure 0x00BB C Structure

typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE AnswerMode; } XL_AnswerSuperviseConfig;

C++ Class
class XLC_AnswerSuperviseConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; };

1- 85
Release 8.4.1 ER3, February 2008

Answer Supervision Mode Configure 0x00BB

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00BB) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x01 - Range Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00BB) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

Number AEs to follow AEs 0x0D Channel (Starting) 0x0D Channel (Ending) : 10 Checksum

Answer Supervision Mode Enter one of the following values: 0x00 Propagate Answer to Distant End (default) 0x01 Notify Host of Answer 0x02 Propagate Answer to Distant End and Notify Host of Answer 0x03 No Answer Supervision No propagation of answer or notification FX0 Loopstart/FX0 Groundstart The only valid entries for FX0 loopstart and FX0 groundstart are 0x0000 and 0x0003.

Checksum

1- 86
Release 8.4.1 ER3, February 2008

AppConnectionQuery

AppConnectionQuery
Type Purpose

SwitchKit API message Use the AppConnectionQuery message to query the Low-Level Communicator (LLC) for description data of a specific application. The message is for querying the LLC for description data of a specific application. All of the data is returned in AppConnectionQueryAck. In addition to returning the application IDs of connected applications, an acknowledgement will also contain the application IDs of the primary LLC and redundant LLC. Application To use an AppConnectionQuery message construct the message and set the application ID:
SKC_AppConnectionQuery acq; [Link](app_id);

Description

Sent by How to use

Arguments

The following table shows the user modifiable argument:

Argument AppID Status Field

Description Specifies the name of the specific application.

The following table shows the possible return values of the status field:

Value OK SK_NO_ACK_FROM_ SWITCH SK_UNKNOWN_APP

Description Query successfully acknowledged CSP did not respond. You used an unknown AppID. This indicates that no application with the specified ID is connected to the LLC. Indicates that the application has no description data associated with it.

SK_NO_APP_DATA

1- 87
Release 8.4.1 ER3, February 2008

AppConnectionQuery C Structure
typedef struct { int AppID; } SK_AppConnectionQuery; typedef struct { int Status; int AppID; char AppName[80]; char AppVersion[16]; int PID; char Hostname[32]; char StartTime[32]; char SkVersion[16]; char UserData[50]; } SK_AppConnectionQueryAck; class SKC_AppConnectionQuery : public SKC_ToolkitMessage { public: int getAppID() const; void setAppID(int x); }; class SKC_AppConnectionQueryAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getAppID() const; void setAppID(int x); const char *getAppName() const; void setAppName(const char *x); const char *getAppVersion() const; void setAppVersion(const char *x); int getPID() const; void setPID(int x); const char *getHostname() const; void setHostname(const char *x); const char *getStartTime() const; void setStartTime(const char *x); const char *getSkVersion() const; void setSkVersion(const char *x); const char *getUserData() const; void setUserData(const char *x); };

C Structure Response

C++ Class

C++ Class Response

1- 88
Release 8.4.1 ER3, February 2008

AppDescriptionData

AppDescriptionData
Type Description

SwitchKit API message The message AppDescriptionData is used by the function sk_appDescriptionData() that provides additional information to help uniquely identify the application. This message does not have a response acknowledgment.

Sent by C Structure

Function sk_appDescriptionData()
typedef struct { } SK_AppDescriptionData; class SKC_AppDescriptionData : public SKC_AdminMessage { public: };

C++ Class

1- 89
Release 8.4.1 ER3, February 2008

AppPopulationQuery

AppPopulationQuery
Type Purpose

SwitchKit API message Use the SK_AppPopulationQuery to query the application IDs of all applications connected to the Low-Level Communicator (LLC). The AppPopulationQuery message requires no arguments. The message is used for querying the application IDs of all applications connected to the LLC. All IDs are returned in the AppPopulationQueryAck message. Application To use an AppPopulationQuery, construct the message with no argument:
SKC_AppPopulationQuery apq;

Description

Sent by How to use

Status Field

The following table shows the possible return values of the status field:

Value OK SK_NO_ACK_FROM_ SWITCH C Structure

Description Query successful acknowledged. The CSP did not respond.

typedef struct { } SK_AppPopulationQuery; typedef struct { int Status; int NumApps; int AppIDs[50]; } SK_AppPopulationQueryAck; class SKC_AppPopulationQuery : public SKC_ToolkitMessage { public: };

C Structure Response

C++ Class

1- 90
Release 8.4.1 ER3, February 2008

AppPopulationQuery C++ Class Response

class SKC_AppPopulationQueryAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getNumApps() const; void setNumApps(int x); const int *getAppIDs() const; void setAppIDs(const int *x); };

1- 91
Release 8.4.1 ER3, February 2008

ARP Cache Query 0x00FC

SwitchKit Name Type Description: ARPCacheQuery EXS API and SwitchKit API message ARP Cache Query 0x00FC Use this message to query or flush the entries in a modules ARP cache. If a query is sent, the CSP returns the data in an ARP Cache Report message. You can query a specific module by using the ARP query TLV. If the amount of data returned exceeds the 512 byte maximum limit of a host message, the CSP sends multiple messages. To remove entries, use the ARP Remove TLV. You can remove multiple entries by including multiple TLVs. The CSP returns a Status of Positive Acknowledgment (0x000A) upon removal. NOTE: Entries are automatically flushed from the table if not accessed within five minutes after the connection is torn down.

Sent by: SwitchKit Code

Host C Structure
typedef struct { UBYTE AddrInfo[30]; UBYTE TLVDataType; UBYTE TLVCount; UBYTE TLVData[221]; } XL_ARPCacheQuery;

C++ Class
class XLC_ARPCacheQuery : public XLC_OutboundMessage { public: virtual int getTag() const; const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); // Extended addressing functions // Slot AIB functions UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getTLVDataType() const; void setTLVDataType(UBYTE x); UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getTLVData() const; UBYTE *getTLVData(); void setTLVData(UBYTE *x); };
...........................................................................................................................................................................................................................................................

1- 92
Release 8.4.1 ER3, February 2008

ARP Cache Query 0x00FC EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00FC) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00FC) Reserved (0x00) Sequence Number Logical Node ID Response Status MSB, LSB 0x0001 Invalid VoIP Module Length 0x0002 Invalid Number of TLVs 0x0003 Invalid VoIP Module 0x0004 Invalid Number of Modules 0x0005 Invalid ARP Length 0x0006 Invalid ARP Cache TLV 0x0007 Entry Not Found in ARP Cache 0x0010 Positive ACK (Entry Flushed) Checksum

: : :

Data Type (0x00: TLVs) Number of TLVs to follow Data (TLVs) 0x01DC VoIP Module 0x01DD Flush ARP Cache Table Entry Checksum

1- 93
Release 8.4.1 ER3, February 2008

ARP Cache Report 0x00FB

SwitchKit Name Type Description: ARPCacheReport EXS API and SwitchKit API message ARP Cache Report 0x00FB This message is sent by the CSP in response to an ARP Cache Query message. The report includes the IP address and Ethernet address for each entry queried. If the ARP cache size is larger than 512 bytes, multiple messages are sent. SwitchKit Users

If you want to get this report, you must register for it by calling the sk_msgRegister function with the parameter, SK_ARP_CACHE_REPORT.
Sent by: Resent in EXS API: SwitchKit Code CSP This message is resent once after five seconds. C Structure
typedef struct { unsigned short Status; UBYTE AddrInfo[30]; unsigned short TLVDataType; unsigned short TLVCount; UBYTE TLVData[217]; } XL_ARPCacheReport;

C++ Class
class XLC_ARPCacheReport : public XLC_InboundMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); // Extended addressing functions // Slot AIB functions UBYTE getSlot() const;; void setSlot(UBYTE x); // Module AIB functions UBYTE getModule() const; void setModule(UBYTE x); unsigned short getTLVDataType() const;void setTLVDataType(unsigned short x); unsigned short getTLVCount() const; void setTLVCount(unsigned short x); const UBYTE *getTLVData() const;
...........................................................................................................................................................................................................................................................

1- 94
Release 8.4.1 ER3, February 2008

ARP Cache Report 0x00FB

UBYTE *getTLVData(); void setTLVData(UBYTE *x); };

1- 95
Release 8.4.1 ER3, February 2008

ARP Cache Report 0x00FB

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8, 9 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00FB) Reserved (0x00) Sequence Number Logical Node ID Query Status (MSB, LSB) Always 0x10 (Positive ACK) AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot : : : : Data Type: TLVs (0x00) Total ARP Cache Entry Count Number of TLVs to follow Data (TLVs) 0x01DC VoIP Module 0x01DE ARP Cache Table Entry 0x01E0 ARP Cache Report Information Checksum Byte 0 1, 2 3, 4 5 6 7 8 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x00FB) Reserved (0x00) Sequence Number Logical Node ID Checksum

1- 96
Release 8.4.1 ER3, February 2008

Assign EXS Host/Slave 0x006E

SwitchKit Name Type Description AssignEXSHostSlave EXS API and SwitchKit API message Assign EXS Host/Slave 0x006E Use this message to establish a relationship between a host node and a slave node in a CSP system. You can route this message through any node. If you indicate the same node as both the host node and the slave node, the CSP returns the response status 0xFC (Invalid Logical Node ID). NOTE: Do not use this message to establish a node as a host node. A node becomes a host node when any API message is sent to it through a direct TCP connection.

Sent by SwitchKit Code

Host Configuration
AssignEXSHostSlave( Node = integer, HostNode = integer, SlaveNode = integer);

C Structure
typedef struct { BaseFields Base; UBYTE HostNode; UBYTE SlaveNode; } XL_AssignEXSHostSlave;

C Structure Response
typedef struct { BaseFields Base; unsigned short Status; unsigned short Span; UBYTE Channel; } XL_AssignEXSHostSlaveAck;

C++ Class
class XLC_AssignEXSHostSlave : public XLC_OutboundMessage { public: UBYTE getHostNode() const; void setHostNode(UBYTE x); UBYTE getSlaveNode() const; void setSlaveNode(UBYTE x); };
...........................................................................................................................................................................................................................................................

1- 97
Release 8.4.1 ER3, February 2008

Assign EXS Host/Slave 0x006E C++ Class Response

class XLC_AssignEXSHostSlaveAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

1- 98
Release 8.4.1 ER3, February 2008

Assign EXS Host/Slave 0x006E

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x006E) Reserved (0x00) Sequence Number Logical Node ID (Host Node) AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0E EXS Host-Slave Node : Checksum : Only if Response Status field is not 0x10: AE 0x0E EXS Host-Slave Node Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x006E) Reserved (0x00) Same Sequence Number Logical Node ID (Host Node) Response Status MSB, LSB If the value of this field is anything other than a Positive Acknowledgment (0x10), the system inserts the Logical Node AIB after this field.

1- 99
Release 8.4.1 ER3, February 2008

Assign Logical Node ID 0x0010

SwitchKit Name Type Description AssignNode EXS API and SwitchKit API message Assign Logical Node ID 0x0010 Use this message to assign a logical node ID to a CSP that is a node in a multinode system. If the node has an EXNET-ONE card installed or if you plan to have an EXNET-ONE card installed, you must assign the node ID at configuration. The default logical node ID for a stand-alone CSP is 0xFF. To specify the node that you are assigning a logical ID, you use its physical node ID (serial number). NOTE: For SwitchKit, DO NOT use the XL_AssignNode message with EXS SwitchKit. XL_AssignNode is obsolete with the introduction of SK_AddLLCNode.

Sent by Example Message (SwitchKit Socket Log Output) SwitchKit Code

Host In the following socket log output/example message, the host assigns logical node ID 01 to the physical node 0000 23AC for the first time: 00 0D 00 10 00 00 FF 00 01 10 05 00 00 23 AC 01 Configuration
AssignNode ( Node = integer, PhysicalNode = integer, LogicalNode = integer);

C Structure
typedef struct { BaseFields Base; int PhysicalNode; UBYTE LogicalNode; } XL_AssignNode;

C++ Class
class XLC_AssignNode : public XLC_OutboundMessage { public: int getPhysicalNode() const; void setPhysicalNode(int x); UBYTE getLogicalNode() const; void setLogicalNode(UBYTE x); UBYTE getISUPRemCon() const; void setISUPRemCon(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 100
Release 8.4.1 ER3, February 2008

Assign Logical Node ID 0x0010

};

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0010) Reserved (0x00) Sequence Number Current Logical Node ID If assigning for first time, byte 7 is 0xFF. AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x10 Logical/Physical Node : ISUP Remote Control 0x00 Disable ISUP Remote Control (Default) 0x01 Enable ISUP Remote Control Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0010) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x007F Software Module Locked See also the Common Response Status Values chapter

1- 101
Release 8.4.1 ER3, February 2008

Assign Logical Span ID 0x00A8

SwitchKit Name Type Description AssignSpan EXS API and SwitchKit API message Assign Logical Span ID 0x00A8 Use this message to map a logical span ID to a physical location. You must assign a unique ID to each span in the system before you can configure any spans or channels. Sent by Example Message (SwitchKit Socket Log Output) SwitchKit Code Host In the following socket log output/example message, the host assigns spans in a single node system to offset 00 in a VDAC-ONE card. 00 0D 00 A8 00 00 FF 01 00 01 11 04 A8 01 00 Configuration
AssignSpan ( Node = integer, Span = integer, Slot = integer, Offset = integer );

C Structure
typedef struct { UBYTE AddrInfo[30]; UBYTE reserved48[222]; } XL_AssignSpan;

C Structure Response
typedef struct { unsigned short Status; UBYTE reserved6[13]; UBYTE AddrInfo[30]; UBYTE reserved50[220]; } XL_AssignSpanAck;

C++ Class
class XLC_AssignSpan : public XLC_SlotMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); // Extended addressing functions // Assign Span AIB functions XBYTE getSpan() const;
...........................................................................................................................................................................................................................................................

1- 102
Release 8.4.1 ER3, February 2008

Assign Logical Span ID 0x00A8

void setSpan(XBYTE x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getOffset() const; void setOffset(UBYTE x); };

C++ Class Response

class XLC_AssignSpanAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); // Extended addressing functions // Assign Span AIB functions XBYTE getSpan() const; void setSpan(XBYTE x) UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getOffset() const; void setOffset(UBYTE x);

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A8) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A8) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB 0x007F Software Module Locked See also the Common Response Status Values chapter Number of AEs to follow AE 0x11 Logical/Physical Span To de-assign spans, see AIB below table. Checksum : AIB Same as message. Checksum

1- 103
Release 8.4.1 ER3, February 2008

Assign Logical Span ID 0x00A8 0x11 Logical Span AIB for De-Assigning Spans To de-assign a physical span, logical span, or all spans, use the field values as shown in the table below in the Assign Logical Span ID message (0x00A8).
Byte 0 1 2 3 4 5 6 7 Address Method: 0x00 Number of AEs: 0x01 Address Element: 0x11 Data Length: 0x04 All Spans Data[0] Logical Span ID, MSB Data[1] Logical Span ID, LSB Data[2] Slot Data[3] Physical Span 0xFF 0xFF 0xFF 0xFF Physical Span ID 0xFF 0xFF Valid Physical Slot Valid Span Offset Logical Span ID Valid Logical Span Valid Logical Span 0xFF 0xFF AIB Field Description

NOTES: 1. De-assigning a Logical Span ID takes the span, and all channels on the span, out of service. 2. De-assigning a span resets its configuration to the default values. When you want to re-initialize a cards configuration (for example, when you restart a host application) use the Reset Configuration message. 3. When you de-assign a span, you do not receive a DS0 Status Change message with a Channel Status field value 0x01 (Out of Service) for every channel on the span. Assume that all channels on a de-assigned span are out of service. 4. De-assigning all spans will clean up all virtual slots which acts as if the virtual cards were removed.

1- 104
Release 8.4.1 ER3, February 2008

Associate Chan Group

Type Description

SwitchKit API message Use the SK_AssociateChanGroup message to associate a ChannelGroup with specified channels. SK_AssociateChanGroup commands are cumulative. To build a non-contiguous channel group, issue multiple commands. Furthermore, as long as the Low-Level Communicator (LLC) is running, the channel groups are in force. It is recommended that in your configuration files, you have a SK_ClearChanGroup for all the channel groups you intend to use. In channel management, if an application specifies a channel group that was not configured in LLC using an AssociateChannelGroup, the LLC will create that group and assign no channels to that channel group. When AssociateChannelGroup is sent to the LLC, LLC will add the specified channels to that group.
Important!

If sent by SwitchManager, and SK_AssociateChanGroup includes any signaling channels (D Channel, Link or R2 signaling channel), SwitchManager will exclude those channels from that group. In case an application is responsible for building the groups of channels, the application must call the function sk_associateChannelGroup(). That function then uses the message to create the specified groups.
Sent by Configuration

SwitchManager or Application AssociateChanGroup(

ChannelGroup = quoted string, range = startSpan:startChannel - endSpan:endChannel);

C Structure

typedef struct { unsigned short StartSpan; unsigned short EndSpan; UBYTE StartChannel; UBYTE EndChannel; char ChannelGroup[45]; } SK_AssociateChanGroup; class SKC_AssociateChanGroup : public SKC_AdminMessage { public: unsigned short getStartSpan() const; 1- 105

C++ Class

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

Associate Chan Group

void setStartSpan(unsigned short x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); const char *getChannelGroup() const; void setChannelGroup(const char *x); };

Example

The following is an example of AssociateChanGroup for Group Name all, with a range of span 0/channel 0 - span 2/channel 23. AssociateChanGroup(
groupname = all, range = 0:0-2:23);

If span 0/channel 23 were a D Channel, SwitchManager would split the message as follows: AssociateChanGroup(
groupname = all, range = 0:0-0:22);

AssociateChanGroup(
groupname = all, range = 1:0-2:23);

1- 106
Release 8.4.1 ER3, February 2008

B Channel Configure 0x00C8

SwitchKit Name Type Description BChannelConfig EXS API and SwitchKit API message B Channel Configure 0x00C8 Use this message to configure the following information contained in ISDN PRI messages associated with outgoing B channel calls: Network Type (network-specific facilities) Outgoing Information Transfer Capability Calling Number Type Calling Number Plan ID Calling Presence Indicator Calling Screening Indicated Called Number Type Called Number Plan ID Outgoing Response Enable Values Related API Messages Sent by Overview of message B Channel Query 0x00CA (SwitchKit Name: BChannelQuery)

Host The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 Frame (0xFE) Length (0x0007) Message Type (0x00C8) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum Field Description

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : : : : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00C8) Reserved (0x00) Sequence Number Logical Node ID AIB (Starting with Byte 0) Entity (B Channel Characteristic) Configuration Option (Value) Checksum

1- 107
Release 8.4.1 ER3, February 2008

B Channel Configure 0x00C8

SwitchKit Code

Configuration
BChannelConfig ( Node = integer, Range = StartSpan:StartChan - EndSpan:EndChan, Entity = integer, Value = integer);

C Structure
typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE Entity; UBYTE Value; } XL_BChannelConfig;

C++ Class
class XLC_BChannelConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getEntity() const; void setEntity(UBYTE x); UBYTE getValue() const; void setValue(UBYTE x); };

EXS API Hex Format Detail

MESSAGE (White) Byte 0 1 2 3 4 5 6 Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xC8) Reserved (0x00) Sequence Number Byte 0 1 2 3 4 5 6 Frame (0xFE) Length, MSB (0x00) Length, LSB (0x07) Message Type, MSB (0x00) Message Type, LSB (0xC8) Reserved (0x00) Same Sequence Number RESPONSE (Gray) Field Description

1- 108
Release 8.4.1 ER3, February 2008

B Channel Configure 0x00C8

Logical Node ID

AIB Address Method 0x01 Range of AEs Number of AEs to follow AEs 0x0D Channel (Starting) 0x0D Channel (Ending)

8, 9 10

Status MSB, LSB Checksum

Entity (B Channel Characteristic) Enter the value for the B channel characteristic that you are configuring: 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x09 Network Type (network-specific facilities) Outgoing Information Transfer Capability Calling Number Type Calling Number Plan ID Calling Presence Indicator Calling Screening Indicated Called Number Type Called Number Plan ID Outgoing Response Enable Values

1- 109
Release 8.4.1 ER3, February 2008

B Channel Configure 0x00C8

Configuration Option (Value) Enter the desired configuration option. The options for each B Channel Characteristic are listed below: 0x01 Network Type 0x01 Do Not Include Network-Specific Facilities (NSF) IE (default) 0x02 AT&T Software Defined Network 0x03 AT&T Megacom 800 Service 0x04 AT&T Megacom 0x05 AT&T Accunet 0x06 AT&T Long Distance Service 0x07 AT&T International 800 0x08 AT&T Multiquest 0x09 Northern Telecom Private Net 0x0A Northern Telecom Inroads 0x0B Northern Telecom OutWats 0x0C Northern Telecom Foreign Exchange 0x0D Northern Telecom Tie Trunk 0x0E Northern Telecom TRO Call 0x10 NI 2 INWATS 0x11 NI 2 OUTWATS 0x12 NI 2 Foreign Exchange 0x13 NI 2 Tie Trunk 0x02 Outgoing Information Transfer Capability 0x01 Voice (Default) 0x02 Modem (3.1 KHz audio) 0x03 56 KBPS 0x04 64 KBPS 0x05 64 KBPS Restricted 0x06 Ho (Information Transfer Rate 384 Kbps) 0x07 H11 (Information Transfer Rate 1536 Kbps) 0x08 Multi-rate 0x03 Calling Number Type 0x01 Unknown 0x02 International number 0x03 National number (Default) 0x04 Subscriber number 0x05 Abbreviated number 0x04 Calling Number Plan ID 0x01 Unknown 0x02 ISDN Numbering Plan/Recommendation E.164/E.163 (Default) 0x03 Private numbering plan 0x04 Telephony numbering plan 0x05 Calling Presentation Indicator 0x01 Presentation is allowed (Default) 0x02 Presentation is restricted 0x03 Number not available due to interworking

1- 110
Release 8.4.1 ER3, February 2008

B Channel Configure 0x00C8

0x06 Calling Screen Indicator 0x01 User provided, not screened (Default) 0x02 User provided, verified and passed 0x03 User provided, verified and failed 0x04 Network provided 0x07 Called Number Type 0x01 Unknown type of number 0x02 International number 0x03 National number (Default) 0x04 Subscriber number 0x05 Abbreviated number 0x08 Called Number Plan ID 0x01 Unknown numbering plan (Default) 0x02 ISDN Numbering Plan/Recommendation E.164/E.163 0x03 Private numbering plan 0x04 Telephony numbering plan 0x09 Outgoing Response Enable (This field is reserved for future use) : Checksum

1- 111
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

SwitchKit Name Type Description BChannelQuery EXS API and SwitchKit API message B Channel Query 0x00CA Use this message to query the configuration and current channel state information on an ISDN PRI B Channel, DASS2, or DPNSS B Channel. The information in the response varies for ISDN and DASS2/DPNSS. Related API Messages Sent by SwitchKit Code B Channel Configure 0x00C8 (SwitchKit Name: BChannelConfig) Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_BChannelQuery;

C Structure Response
typedef struct { unsigned short Status; unsigned short Span; UBYTE Channel; UBYTE DChannelID; UBYTE Facility; UBYTE BChannel; UBYTE CurrentState; UBYTE PriDEnable; UBYTE PriBEnable; UBYTE ExternalEnable; UBYTE HostEnable; UBYTE ControllingDChannelFlag; UBYTE NetworkType; UBYTE CallType; UBYTE CallingType; UBYTE CallingNumberPlanID; UBYTE CallingPresentationInd; UBYTE CallingScreeningInd; UBYTE CalledType; UBYTE CalledNumberPlanID; UBYTE PCMEncodingFormat; UBYTE DistantEndReleaseMode; UBYTE AnswerSupervisionMode; UBYTE ISDNEventEnable; UBYTE LocalEndReleaseMode; UBYTE NetworkBlocked; } XL_BChannelQueryAck;
...........................................................................................................................................................................................................................................................

1- 112
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA C++ Class

class XLC_BChannelQuery : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

C++ Class Response

class XLC_BChannelQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getDChannelID() const; void setDChannelID(UBYTE x); UBYTE getFacility() const; void setFacility(UBYTE x); UBYTE getBChannel() const; void setBChannel(UBYTE x); UBYTE getCurrentState() const void setCurrentState(UBYTE x); UBYTE getPriDEnable() const void setPriDEnable(UBYTE x); UBYTE getPriBEnable() const; void setPriBEnable(UBYTE x); UBYTE getExternalEnable() const; void setExternalEnable(UBYTE x); UBYTE getHostEnable() const; void setHostEnable(UBYTE x); UBYTE getControllingDChannelFlag() const; void setControllingDChannelFlag(UBYTE x); UBYTE getNetworkType() const; void setNetworkType(UBYTE x); UBYTE getCallType() const; void setCallType(UBYTE x); UBYTE getCallingType() const; void setCallingType(UBYTE x); UBYTE getCallingNumberPlanID() const; void setCallingNumberPlanID(UBYTE x); UBYTE getCallingPresentationInd() const; void setCallingPresentationInd(UBYTE x); UBYTE getCallingScreeningInd() const; void setCallingScreeningInd(UBYTE x); UBYTE getCalledType() const; void setCalledType(UBYTE x); UBYTE getCalledNumberPlanID() const; void setCalledNumberPlanID(UBYTE x); UBYTE getPCMEncodingFormat() const; void setPCMEncodingFormat(UBYTE x); UBYTE getDistantEndReleaseMode() const; void setDistantEndReleaseMode(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 113
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

UBYTE getAnswerSupervisionMode() const; void setAnswerSupervisionMode(UBYTE x); UBYTE getISDNEventEnable() const; void setISDNEventEnable(UBYTE x); UBYTE getLocalEndReleaseMode() const; void setLocalEndReleaseMode(UBYTE x); UBYTE getNetworkBlocked() const; void setNetworkBlocked(UBYTE x); };

1- 114
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

Overview of message

The following two tables provides an overview of this message. The tables following them, provides the detail for each byte. Overview of ISDN PRI B Channels

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00CA) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow 0x0D Channel : Checksum : Byte 0 1, 2 3, 4 5 6 7 8, 9

RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00CA) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

AIB Address Method 0x00 - Individual AEs Number of AEs to follow 0x0D Channel

: (Response continued below.) : : : : : : : : : : : : : : : : : : : Facility Number B Channel ID (Reserved) Current State (Reserved) PRI D Enable (Reserved) PRI B Enable (Reserved) External Enable (Reserved) Host Enable (Reserved) Controlling D Channel Flag Network Type Outgoing Information Transfer Capability Calling Number Type Calling Number Plan ID Calling Presentation Indicator Calling Screen Indicator Called Number Type Called Number Plan ID PCM Encoding Format Distant End Release Mode Answer Supervision Mode

D Channel ID (Reserved)

1- 115
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

: : : :

ISDN Event Enable (Reserved) Local End Release Mode Network Blocked (Reserved) Checksum

Overview of DASS2/DPNSS B Channels

Byte 0 1 2 3 4 5 6 7 : MESSAGE Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xCA) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow 0x0D Channel : Checksum : AIB Address Method 0x00 - Individual AEs Number of AEs to follow 0x0D Channel (Response continued below.) : : : : : : : : : : : : : : : : : D Channel ID (Reserved) Reserved B Channel ID (Reserved) L3P State L3 State L2 State Reserved Reserved Controlling D Channel Flag Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Byte 0 1 2 3 4 5 6 7 8,9 RESPONSE Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xCA) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 116
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

: : : : : : :

PCM Encoding Format Distant End Release Mode Answer Supervision Mode Reserved Local End Release Mode Reserved Checksum

1- 117
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

EXS API Hex Format for ISDN PRI B Channels Detail

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 :

NOTE:

The reserved fields are used by Dialogic Technical Support for diagnostic purposes only. Please ignore these fields during normal operation.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00CA) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB AIB (Individual AEs) 0x0D Channel D Channel ID (Reserved)

Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00CA) Reserved (0x00) Sequence Number Logical Node ID AIB (Individual AEs) 0x0D Channel Checksum

(Response continued below.) : Facility Number The network-relative facility (or span) number for the associated D channel. 0x00: For both FAS and NFAS, this value represents the facility in which the controlling D channel resides 0x010x09: For NFAS, these values represent the other facilities that the D channel controls In Facility-Associated Signaling (FAS), one D channel controls the B channels within the same span. In Non-Facility Associated Signaling (NFAS), one D channel controls the B channels on up to 10 spans. These spans are designated as facilities 09. : : : B Channel ID (Reserved) Current State (Reserved) PRI D Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled PRI B Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled External Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled Host Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled

1- 118
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

Controlling D Channel Flag 0x00 Channel is not a D channel 0x01 Channel is a D channel Network Type 0x01 Do Not Include Network-Specific Facilities (NSF) IE 0x02 AT&T Software Defined Network 0x03 AT&T Megacom 800 Service 0x04 AT&T Megacom 0x05 AT&T Accunet 0x06 AT&T Long Distance Service 0x07 AT&T International 800 0x08 AT&T Multiquest 0x09 Northern Telecom Private Net 0x0A Northern Telecom Inroads 0x0B Northern Telecom OutWats 0x0C Northern Telecom Foreign Exchange 0x0D Northern Telecom Tie Trunk 0x0E Northern Telecom TRO Call Outgoing Information Transfer Capability 0x01 Voice 0x02 Modem 0x03 56 Kbps 0x04 64 Kbps 0x05 64 Kbps Restricted Calling Number Type 0x01 Unknown 0x02 International number 0x03 National number 0x04 Subscriber number 0x05 Abbreviated number Calling Number Plan ID 0x01 Unknown 0x02 ISDN Numbering Plan/Recommendation E.164/E.163 0x03 Private numbering plan 0x04 Telephony numbering plan Calling Presentation Indicator 0x01 Presentation is allowed 0x02 Presentation is restricted 0x03 Number not available due to interworking Calling Screen Indicator 0x01 User provided, not screened 0x02 User provided, verified and passed 0x03 User provided, verified and failed 0x04 Network provided Called Number Type 0x01 Unknown type of number 0x02 International number 0x03 National number 0x04 Subscriber number 0x05 Abbreviated number

1- 119
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

Called Number Plan ID 0x01 Unknown numbering plan 0x02 ISDN numbering plan/Recommendation E.164/E.163 0x03 Private numbering plan 0x04 Telephony numbering plan PCM Encoding Format 0x01 -law Encoding 0x02 A-law Encoding Distant End Release Mode 0x01 Park 0x02 Release Answer Supervision Mode 0x00 Propagate Answer to the Distant End 0x01 Notify Host of Answer 0x02 Propagate Answer to the Distant End and Notify Host of Answer 0x03 No Answer Supervision no propagation of answer or notification ISDN Event Enable (Reserved) You can send this data to the host using the PPL messages. Local End Release Mode 0x01 Park 0x02 Release Network Blocked (Reserved) Checksum

: :

EXS API Hex Format for DASS2/DPNSS B Channels - Detail

NOTE:

The reserved fields are used by Dialogic Technical Support for diagnostic purposes only. Please ignore these fields during normal operation.

Byte 0 1 2 3 4 5 6 7 8 :

MESSAGE Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xCA) Reserved (0x00) Sequence Number Logical Node ID AIB (Individual AEs) 0x0D Channel Checksum (Response continued below.)

Byte 0 1 2 3 4 5 6 7 8, 9 10

RESPONSE Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xCA) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB AIB (Individual AEs) 0x0D Channel

: : : :

D Channel ID (Reserved) Reserved B Channel ID (Reserved) L3P State - Call Control PPL State (0x0D) Indicates the state of the DASS2/DPNSS Call Control PPL component.

1- 120
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

L3 State DASS2 States 0x01 Connected 0x02 Dial In (receiving overlap call) 0x03 Dial Out (sending overlap call) 0x04 Idle 0x05 Incoming (received CS) 0x06 Offered (received ICI[C]) 0x07 Offered Incomplete (received ICI[I]) 0x08 Origination (sent ISRM) 0x09 Recovery (Received unexpected message in Idle State) 0x0A Releasing (Waiting for CIM) 0x0B Routing In 0x0C Routing Out DPNSS States 0x01 Channel Idle 0x02 Spurious Message Received 0x03 Incoming Service Request Incomplete 0x04 Incoming Service Request Complete 0x05 Channel Release Guard 0x06 Channel Release Guard Tell Host 0x07 Setup Complete 0x08 Outgoing Service Request Complete 0x09 Outgoing Service Request Incomplete 0x0A Host Release Wait

L2 State 0x01 0x02 0x03 0x04

Establishing Wait (sent SABMR, waiting for UA) Idle (Down) Ready (Up) Wait Response (Up, waiting for UI[R])

: : :

Reserved Reserved Controlling D Channel Flag 0x00 Channel is not a D channel 0x01 Channel is a D channel Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved PCM Encoding Format 0x01 -law Encoding 0x02 A-law Encoding Distant End Release Mode 0x01 Park 0x02 Release

: : : : : : : : :

1- 121
Release 8.4.1 ER3, February 2008

B Channel Query 0x00CA

Answer Supervision Mode 0x00 Propagate Answer to the Distant End 0x01 Notify Host of Answer 0x02 Propagate Answer to the Distant End and Notify Host of Answer 0x03 No Answer Supervision no propagation of answer or notification Reserved Local End Release Mode 0x01 Park 0x02 Release Reserved Checksum

: :

1- 122
Release 8.4.1 ER3, February 2008

Become Active 0x00A1

SwitchKit Name Type Description ActivateMatrix EXS API and SwitchKit API message Become Active 0x00A1 For EXS API Use this message to initiate a switchover in an CSP with a redundant CSP Matrix Series 3 Card or SS7 card. You must send this message to the standby CSP Matrix Series 3 Card from the matrix host or send this message to the standby SS7 card from the SS7 local host. If you send this message to the active CSP Matrix Series 3 Card or active SS7 card, it has no effect on the CSP. Dialogic recommends sending this message from the Matrix host to initiate a switchover to the standby CSP Matrix Series 3 Card or sending this message from the SS7 local host to initiate a switchover to the standby SS7 card. For SwitchKit API ActivateMatrix() initiates a Matrix switchover regardless of what parameters are passed in. With EXS SwitchKit you must send a function call to sk_activateExnetMatrix(). You cannot send the message directly to the standby CSP Matrix Series 3 Card. EXS SwitchKit API does not support sending this message from the host to the standby SS7 card. Sent by EXS API Hex Format
MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x00A1) Reserved (0x00) Sequence Number Logical Node ID Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 Frame (0xFE) Length (0x0007) Message Type (0x00A1) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum RESPONSE (Gray) Field Description

Host

1- 123
Release 8.4.1 ER3, February 2008

BroadcastLoad

BroadcastLoad
Type Purpose

EXS SwitchKit API message Do not use this message. This is an internal message used by the function call sk_broadcastLoad(), refer to the EXS SwitchKit Programmers Guide for information on the sk_broadcastLoad() function. The Low-Level Communicator (LLC) uses the load value to determine how to distribute the load across several applications that are load sharing. Function sk_broadcastLoad()

Description

Sent by

1- 124
Release 8.4.1 ER3, February 2008

Busy Out 0x0018

SwitchKit Name Type Description BusyOut EXS API and SwitchKit API message Busy Out 0x0018 Use this message to busy out a channel or range of channels. This allows the host to control the incoming call rate by busying out a selected group of channels, normally on the front end of a system. You can busy out channels configured with the following trunk types only: E&M FXO Loop Start FXO Ground Start Related API Messages Sent by SwitchKit Code Busy Out Flag Configure 0x00D3 (SwitchKit Name: BusyOutFlagConfig) Host C Structure
typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE Action; } XL_BusyOut;

C++ Class
class XLC_BusyOut : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); };

1- 125
Release 8.4.1 ER3, February 2008

Busy Out 0x0018

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0018) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x01 - Range Number of AEs to follow 0x0D Channel (Starting) 0x0D Channel (Ending) : Action 0x01 Busy Out 0x02 Release Busy Out Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0018) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 126
Release 8.4.1 ER3, February 2008

Busy Out Flag Configure 0x00D3

SwitchKit Name Type Description BusyOutFlagConfig EXS API and SwitchKit API message Busy Out Flag Configure 0x00D3 Use this message to enable the busy out feature on a channel or range of channels. You cannot busy out a channel with the Busy Out message if the Flag field in this message is disabled (0x00). Only channels configured with a trunk type of E&M, FXO Loop Start, or FXO Ground Start can be busied out. Related API Messages Sent by SwitchKit Code Busy Out 0x0018 (SwitchKit Name: BusyOut) Host Configuration
BusyOutFlagConfig ( Node = integer, Range = StartSpan:StartChan - EndSpan:EndChan, Flag = integer);

C Structure
typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE Flag; } XL_BusyOutFlagConfig;

C++ Class
class XLC_BusyOutFlagConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getFlag() const; void setFlag(UBYTE x); };

1- 127
Release 8.4.1 ER3, February 2008

Busy Out Flag Configure 0x00D3 EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00D3) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel (Starting) 0x0D Channel (Ending) : Flag 0x00 Busy Out Disabled (Default) 0x01 Busy Out Enabled Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x00D3) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

1- 128
Release 8.4.1 ER3, February 2008

Call Control Instructions Query 0x0087

SwitchKit Name Type Description CallControlInstructionQuery EXS API and SwitchKit API message Call Control Instructions Query 0x0087 Use this message to query the preprogrammed inseize and outseize call control instructions on a channel or range of channels. The response lists the instructions using three bytes each for 20 inseize and 20 outseize instructions, even if they are not all configured. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_CallControlInstructionsQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE Data[120]; } XL_CallControlInstructionsQueryAck;

C++ Class
class XLC_CallControlInstructionsQuery : public XLC_OneChannelOutbound { public: unsigned short getSpan() const void setSpan(unsigned short x) UBYTE getChannel() const void setChannel(UBYTE x); };

C++ Class Response

class XLC_CallControlInstructionsQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 129
Release 8.4.1 ER3, February 2008

Call Control Instructions Query 0x0087 EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0087) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel : Checksum 10 11 12 : : : : : : : : : : : : Inseize Instruction 1: Inseize Instruction 1: Inseize Instruction 1: : Inseize Instruction 20: Inseize Instruction 20: Inseize Instruction 20: Outseize Instruction 1: Outseize Instruction 1: Outseize Instruction 1: : Outseize Instruction 20: Type Outseize Instruction 20: Data[0] Outseize Instruction 20: Data[1] Checksum Type Data[0] Data[1] Type Data[0] Data[1] Type Data[0] Data[1] Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0087) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 130
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

SwitchKit Name Type Description CallProcessingEvent EXS API and SwitchKit API message Call Processing Event 0x002E The CSP uses this message to report a call processing event on a specified channel. The event to be reported is specified by the host in the messages that support the generation of call processing events. Sent by Resent in EXS API SwitchKit Code CSP This message is resent once after five seconds. C Structure
typedef struct { UBYTE AddrInfo[30]; unsigned short Span; UBYTE Channel; UBYTE Event; UBYTE Data[222]; } XL_CallProcessingEvent;

C++ Class
class XLC_CallProcessingEvent : public XLC_OneChannelMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); XBYTE getConferenceID() const; void setConferenceID(XBYTE x); XBYTE getParentConferenceID() const; void setParentConferenceID(XBYTE x); XBYTE getChildConferenceID() const; void setChildConferenceID(XBYTE x); XBYTE getSpan() const; void setSpan(XBYTE x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getEvent() const; void setEvent(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1-131
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Overview of message
MESSAGE Byte 0 1, 2 3, 4 5 6 7 8 : : : : :

The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x002E) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

Field Description Frame (0xFE) Length (0x00NN) Message Type (0x002E) Reserved (0x00) Sequence Number Logical Node ID AIB (starting with byte 0) Call Processing Event Data (0) : Data (n) Checksum

EXS API Hex Format Detailed

MESSAGE Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x002E) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs One of the following: 0x0D Channel 0x55 Conference ID 0x45 Child Conference ID Byte 0 1, 2 3, 4 5 6 7 8 Frame (0xFE) Length (0x0005) Message Type (0x002E) Reserved (0x00) Same Sequence Number Logical Node ID Checksum RESPONSE Field Description

1-132
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Call Processing Event 0x00* No Event (the specified event did not occur before the Report Call Processing Event instruction was invoked) 0x01* ANI Request Off-hook 0x02 Digits 0x03* Wink 1 0x04* Wink 2 0x05* Wink 3 0x06* Wink 4 0x07* Wink 5 0x08* Wink 6 0x09* Wink 7 0x0A* Wink 8 0x0B* Dialtone Detected 0x0C Reserved 0x0D Backward R2 Signal 0x0E First Digit Report 0x0F PPL Event 0x10 Digit With Timing Information 0x11* Receive Idle 0x13* FAX Tone Detection 0x20* Answer 0x21* Tone Complete 0x22* Outpulsing Complete 0x23* Flash Detected 0x24* CPC Detected 0x25 Recorded Announcement Started 0x26 Recorded Announcement Complete 0x27* Timed-out waiting for energy 0x28 Energy Result Report 0x29* Coin Tone Detection Timeout 0x2A Coin Tone Detection Report 0x2B Play File Started 0x2C Play File Complete 0x2D Record File Started 0x2E Record File Complete 0x2F File Not Found 0x30 File Play Underrun 0x31 File Record Overrun 0x32 Record Initial Silence Timeout 0x33 Play File Queue Failure 0x34 Play File Stopped 0x35 Record File Stopped 0x36 DSP Resource Inconsistency 0x40* DTMF Subscription Terminated (either by remote end or because of subscription refresh failure.) 0x41 DSP Series 2 Fax Processing Events 0x42 Truly Silent Channel (PVD/AMD) 0x43 Voice Detect Rising Edge (PVD/AMD) 0x44 Voice Detect Falling Edge (PVD/AMD) 0x45 Long Term Voice Detect Rising Edge (PVD/AMD) 0x46 Long Term Voice Detect Falling Edge (PVD/AMD) 0x47 Tone Detect Rising Edge (PVD/AMD)

1-133
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

0x48 0x49 0x50 0xfff0 :

Tone Detect Falling Edge (PVD/AMD) Echo Canceller Event (when a G.164 tone disabling event occurs on the near or far end) DSP Series 2 FSK Events

*Event includes no data for Data fields Data These fields provide the specific information for each Event. The length and contents of the information depend on the Event. Some events contain no data.

Valid entries for this field are listed below by Call Processing Event field value. 0x02 Digits Data[0] Number of Stages Reported Data[1] Inpulsed Stage Number Data[2] Inpulsed Stage Status Data[3] Stage String Count Data[4] String 1: Digit Count Data[5] String 1: First BCD Encoded Digit Pair : Data[n] String 1: Last BCD Encoded Digit Pair Data[n+1] String 2: First BCD Encoded Digit Pair : Data[m] String 2: Last BCD Encoded Digit Pair Data[4n] are repeated for each string reported. Data[1n] are repeated for each stage reported. Stage Status The system reports the stage status for each of the four stages. Timers can be configured. Valid entries for this field are as follows: 0x10 Positive Acknowledgment - Digits received 0x80 Partial Dial Condition - Receive Inter-digit Duration timer expired 0x81 Permanent Signal Condition - Receive 1st Digit Detection timer expired 0x91 Inpulse Stage Not Collected - Stage not collected; no further stage information will be reported. 0x92 Digit Complete Timeout 0x97 Positive Acknowledgment - Pulse Digits received If the Call Processing Event message is in response to a DSP Service Request or Collect Digit String message, the Inpulsed Stage Number is 0xFF. When the digits are collected using a KP_ST framed digit string collection method, the KP_ST digits are not contained in the reported string. 0x0D Backward R2 Signal Data[0] R2 Signal Value (0x010x0F) 0x0E First Digit Report Data[0] DTMF/MFR1 Digit Value (0x000x0F)

1-134
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

0x0F PPL Event Data[0] PPL Event Number (0x000xFF) 0x10 Digit with Timing Information. An asterisk (*) denotes a byte that is always set to 1 Data[0] Number of Stages Reported * Data[1] Inpulsed Stage Number Data[2] Inpulsed Stage Status Data[3] Stage String Count * Data[4] Digit Count * Data[5] BCD-encoded Digit Data[6, 7] Digit Duration (in 10 ms units)

1-135
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

The Inpulsed Stage Number will be 0xFF if the Call Processing Event message is in response to a DSP Service Request or Collect Digit String message. The maximum time detected for digit duration is 26.35 seconds. When actual digit duration is greater than 26.35 seconds, it reports as 26.35 (0x0A4B) seconds. Only a DSP Service Request message request can result in the Call Processing Event of Digit With Timing Information being returned by the CSP. 0x25 Recorded Announcement Started Data[0,1] ID of announcement being played (MSB, LSB) 0x26 Recorded Announcement Completed Data[0,1] ID of announcement completed (MSB, LSB) 0x28 Energy Result Report Data[0] Energy Result Flag 0x00 No Energy Detected 0x01 Energy Detected Data[1,2] Duration of previous Energy Result in 10 ms units 0x2A Coin Tone Detection Report Data[0,1] Value of coin detected, in cents 0x0005 5 cents (Nickel) 0x000A 10 cents (Dime) 0x0019 25 cents (Quarter) 0x0064 100 cents (Dollar) 0x2B Play File Started Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-7] Offset (starting byte) Data[8-9] Server ID Play File Complete Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-7] Offset (ending byte) Data[8-9] Server ID Record File Started Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-7] Offset (starting byte) Data[8-9] Server ID Record File Complete Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-7] Offset Duration of Record (seconds) Data[8-9] Server ID File Not Found Data[0-3] File ID (MSB, ... , ... , LSB) File Play Underrun Data[0-3] File ID (MSB, ... , ... , LSB) File Record Overrun Data[0-3] File ID (MSB, ... , ... , LSB)

0x2C

0x2D

0x2E

0x2F

0x30

0x31

1-136
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

0x32

Record Initial Silence Timeout Data[0-3] File ID (MSB, ... , ... , LSB) Play File Queue Failure Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-7] Offset (starting byte) Data[8-9] Server ID Play File Stopped Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-5] Stop Reason 0x0000 - Channel Released 0x0001 - Host Initiated Stop 0x0004 - Out of Chip Cache Space 0x0005 - Digit Detected Data[6-9] Duration of Play (seconds) Data[10-11] Server ID Record File Stopped Data[0-3] File ID (MSB, ... , ... , LSB) Data[4-5] Stop Reason 0x0000 - Channel Released 0x0001 - Host Initiated Stop 0x0002 - Out of File Space 0x0003 - NFS Write Error 0x0004 - Out of Chip Cache Space 0x0005 - Digit Detected Data[6-9] Duration of Record (seconds) Data[10-11] Server ID - For cached files, the Server ID is not applicable. In those cases, the Server ID is 0xFFFF. DSP Resource Inconsistency Data[0-3] File ID (MSB, ... , ... , LSB) DSP Series 2 Fax Processing Events Data[0, 1] Fax processing event code (see below) Data[2, n] Fax processing event data For Data[0, 1] Fax processing event code, above: Phase A, B, C, D, or E: 0x09 Got CRC error in V.21 frame 0x0F Transmit V21 complete 0x1D ERR frame received 0x35 HS modem detected V21. Switch to receive V21 0x39 Unknown V21 frame received with correct CRC 0x3C CRP frame received 0x12D STAT_PHASE_A 0x12E STAT_PHASE_B 0x12F STAT_PHASE_C 0x130 STAT_PHASE_D 0x131 STAT_PHASE_E

0x33

0x34

0x35

0x36

0x41

1-137
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Phase A - Call Establishment Set Event Bit 0x01 0x3E Request the operator line Phase B - Pre-Message Procedure Note: Phase B consists of two sections: Identification and Command Set Event Bit 0x02 0x06 DCS frame received 0x07 DIS frame received 0x08 DTC frame received 0x0C Switch to ECM mode 0x11 CFR frame received 0x12 CTC frame received 0x1E FTT frame received 0x2F Remote machine can receive detected 0x30 Remote machine can transmit detected 0x36 Receive training ended successfully 0x37 Receive training ended in failure 0x38 Transmit training ended 0x3D CTR frame received 0x42 Switch from ECM mode to Normal mode 0x43 Change mode after EOM Phase C Note: Phase C consists of two sections: Phase C1, In-Message Procedure and Phase C2, Message Transmission Set Event Bit 0x04 0x00 Command to start receiving 0x01 Command to start transmitting 0x15 EOR frame received 0x16 EOR_EOM frame received 0x17 EOR_EOP frame received 0x18 EOR_MPS frame received 0x19 EOR_NULL frame received 0x1A EOR_PRI_EOM frame received 0x1B EOR_PRI_EOP frame received 0x1C EOR_PRI_MPS frame received 0x3A Start of image receive 0x40 ECM frames where detected in error 0x47 End of image transmit 0x48 Start of image transmit 0x4A Receive image operation complete 0x4C Go to point D in the T.30 flow chart 0x4D Got the 4th PPR 0x4E Decided to continue to correct after 4th PPR

1-138
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Phase D - Post Message Procedure Set Event Bit 0x08 0x13 EOM frame received 0x14 EOP frame received 0x20 MCF frame received 0x21 MPS frame received 0x22 PIN frame received 0x23 PIP frame received 0x24 PPR frame received 0x25 PPS_EOM frame received 0x26 PPS_EOP frame received 0x27 PPS_MPS frame received 0x28 PPS_NULL frame received 0x29 PPR_PRI_EOM frame received 0x2A PPS_PRI_EOP frame received 0x2B PPS_PRI_MPS frame received 0x2C PRI_EOM frame received 0x2D PRI_EOP frame received 0x2E PRI_MPS frame received 0x31 RNR frame received 0x32 RR frame received 0x33 RTN frame received 0x34 RTP frame received 0x41 Receiver is not ready to continue 0x44 Got end of a page 0x45 Last document in the queue was processed Phase E - Call Release Set Event Bit 0x10 0x05 DCN frame received 0x0A Go to B point in T.30 flow chart 0x1F Transition to C-point on T.30 flow charts 0x65 FAX Protocol Complete only for Send FAX 0xFFF0 FAX I/O Complete for RCV FAX and Send FAX 0xFE FAX Failed

1-139
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Timer Event Set Event Bit 0x20 0x03 Hardware failure timer expired 0x0D T1 timer expired 0x0E T4 timer expired 0x3B T2 timer expired (see T.30) 0x4B T3 timer expired 0x4F T5 timer expired Data Pump Set Event Bit 0x40 0x02 T.30 is ready to receive 0x04 T.30 is ready to transmit 0x10 Hardware close completed 0x51 V.21 receiver has started to send preamble 0x52 V.21 receiver has completed operation 0x53 V.21 transmitter has started to send preamble 0x54 V.21 transmitter has completed operation 0x55 High-speed receiver has started to send preamble 0x56 High-speed receiver has received TCF, no errors 0x57 High-speed receiver has received TCF with errors 0x58 High-speed transmitter has started to send TCF 0x59 High-speed transmitter has completed TCF 0x5A High-speed transmitter has started 0x5B High-speed transmitter has completed operation 0x5C High-speed receiver has started to send preamble 0x5D High-speed receiver has lost carrier 0x5E V21 Receive Frame 0x5F V21 Transmit Frame 0x62 V21 signal detected by the HS receiver 0x63 Modem subsystem ready to transmit 0x64 Modem subsystem ready to receive 0x65 Modem subsystem has stopped operations 0x79 Non-Standard facilities (NSF) frame sent or receive 0x7A Non-Standard facilities Set-up (NSS) frame sent or receive 0x7B Non-Standard facilities Command (NSC) frame sent or receive 0x7C Called Subscriber Identification (CSI) frame sent or receive 0x7D Transmitting Subscriber Identification (TSI) frame sent or receive 0x7E Calling Subscriber Identification (CIG) frame sent or receive 0x7F Selective Polling (SEP) frame sent or receive 0x80 Subaddress (SUB) frame sent or receive 0x81 Password (PWD) frame sent or receive 0x82 Digital Identification Signal (DIS) frame sent or received 0x83 Digital Command Signal (DCS) frame sent or receive

1-140
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

0x84 0x85 0x86 0x87 0x88 0x89 0x8A 0x8B 0x8C 0x8D 0x8E 0x8F 0x90 0x91 0x92 0x93 0x94 0x95

Digital Transmit Command (DTC) frame sent or receive Continue To Correct (CTC) frame sent or receive Partial Page Request (PPR) frame sent or received Partial Page Signal-NULL(PPS-NULL) frame sent or receive Partial Page Signal (PPS)-MPS frame sent or receive Partial Page Signal (PPS)-EOM frame sent or receive Partial Page Signal (PPS)-EOP frame sent or receive PRI-PPS-MPS frame sent or receive PRI-PPS-EOM frame sent or receive PRI-PPS-EOP frame sent or receive EOR-NULL frame sent or receive EOR-MPS frame sent or receive EOR-EOM frame sent or receive EOR-EOP frame sent or receive PRI-EOR-MPS frame receive PRI-EOR-EOM frame sent or receive PRI-EOR-EOP frame sent or receive CRC error reported

1-141
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Debugging - Set Event Bit 0x80 I/O Events 0x1F5 STAT_IO_OPEN_FILE 0x1F6 STAT_IO_CLOSE_FILE 0x1F7 STAT_IO_READ_ERR 0x1F8 STAT_IO_WRT_ERR 0x1F9 STAT_IO_BAD_LINES EFT I/O Events 0x1FA STAT_IO_BO_READ 0x1FB STAT_IO_B1_READ 0x1FC STAT_IO_BO_WRITE 0x1FD STAT_IO_B1_WRITE 0x1FE 0x1FF 0x200 0x201 0x202 0x203 0x204 0x205 0x206 0x207 0x208 0x209 0x20A 0x20B 0x20C 0x20D 0x20E 0x20F 0x210 0x211 0x212 0x213 0x214 0x215 0x216 0x217 0x218 0x219 0x21A 0x21B 0x21C 0x21D 0x21F STAT_IO_BO_READ_DN STAT_IO_B1_READ_DN STAT_IO_BO_WRITE_DN STAT_IO_B1_WRITE_DN STAT_IO_IFD_READ STAT_IO_IFD_WRITE STAT_IO_HDR_READ STAT_IO_HDR_WRITE STAT_IO_1ST_IMG_READ STAT_IO_NTH_IMG_READ STAT_IO_IMG_WRITE STAT_IO_FXP_WRITE STAT_IO_IFD_READ_DN STAT_IO_IFD_WRITE_DN STAT_IO_HDR_READ_DN STAT_IO_HDR_WRITE_DN STAT_IO_1ST_IMG_READ_DN STAT_IO_NTH_IMG_READ_DN STAT_IO_IMG_WRITE_DN STAT_IO_FXP_WRITE_DN STAT_IO_WRT_NO_BFR STAT_IO_RD_NO_BFR STAT_IO_IFD_INVALID STAT_IO_CLOSE_CLEANUP STAT_IO_ERASE_LAST_PG STAT_IO_WRT_LST_IFD STAT_IO_WRT_LST_IFD_DN STAT_IO_TIFF_WRT_DONE STAT_IO_FLUSH_LST_PG STAT_IO_TIFF_RD_DONE STAT_IO_FOUND_START_PG STAT_IO_END_PG_REACHED IS_FILE_EVENT (x)

1-142
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

Informational Events NSF Types 0x79 STAT_INFO_NSF 0x7A STAT_INFO_NSS 0x7B STAT_INFO_NSC ID Frames 0x7C 0x7D 0x7E

STAT_INFO_CSI STAT_INFO_TSI STAT_INFO_CIG

Miscellaneous Information Frames 0x7F STAT_INFO_SEP 0x80 STAT_INFO_SUB 0x81 STAT_INFO_PWD Negotiation Frames 0x82 STAT_INFO_DIS 0x83 STAT_INFO_DCS 0x84 STAT_INFO_DTC 0x85 STAT_INFO_CTC ECM Information Frames 0x86 STAT_INFO_PPR 0x87 0x88 0x89 0x8A 0x8B 0x8C 0x8D 0x8E 0x8F 0x90 0x91 0x92 0x93 0x94 0x95 STAT_INFO_PPS_NULL STAT_INFO_PPS_MPS STAT_INFO_PPS_EOM STAT_INFO_PPS_EOP STAT_INFO_PRI_PPS_MPS STAT_INFO_PRI_PPS_EOM STAT_INFO_PRI_PPS_EOP STAT_INFO_EOR_NULL STAT_INFO_EOR_MPS STAT_INFO_EOR_EOM STAT_INFO_EOR_EOP STAT_INFO_EOR_PPS_MPS STAT_INFO_EOR_PPS_EOM STAT_INFO_EOR_PPS_EOP STAT_INFO_EOR_FCS

1-143
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

For Technical Support Only - Internal FAX Processing Events Debugging - Set Event Bit 0x80 Call Back Event Codes for Frames without Data 0x1C8 STAT_FRM_BASE 0x1C9 STAT_FRM_CFR 0x1CA STAT_FRM_CRP 0x1CB STAT_FRM_CTR 0x1CC STAT_FRM_DCN 0x1CD STAT_FRM_EOM 0x1CE STAT_FRM_EOP 0x1CF STAT_FRM_EOR 0x1D0 STAT_FRM_ERR 0x1D1 STAT_FRM_FTT 0x1D2 STAT_FRM_MCF 0x1D3 STAT_FRM_MPS 0x1D4 STAT_FRM_PIN 0x1D5 STAT_FRM_PIP 0x1D6 STAT_FRM_PRI_EOM 0x1D7 STAT_FRM_PRI_EOP 0x1D8 STAT_FRM_PRI_MPS 0x1D9 STAT_FRM_RR 0x1DA STAT_FRM_RNR 0x1DB STAT_FRM_RTN 0x1DC STAT_FRM_RTP DIS/DCS/DTC Negotiation Problems Error Events Note: The following events are generated as a result of problems in negotiation. DIS Format Problems 0x44D STAT_DIS_INVLD_RATE (DIS parameters mismatch on rates) 0x44E STAT_DIS_INVLD_REC_LEN (DIS invalid record length) DCS Format Problems 0x44F STAT_DCS_INVLD_RATE (DCS invalid rate value) 0x450 STAT_DCS_INVLD_PAGESIZE (DCS invalid page size value) 0x451 STAT_DCS_INVLD_REC_LEN (DCS invalid record length) Problems Computing DCS from DIS File Format and Parameters 0x452 STAT_NEG_Resolution Received DCS did not match DIS capabilities for the following: 0x453 STAT_DCS_BAD_RATE (DCS and DIS mismatch on rate modems) 0x454 STAT_DCS_BAD_ENCODING (DCS and DIS mismatch on encoding) 0x455 STAT_DCS_BAD_ECM (DCS and DIS mismatch on ECM) 0x456 STAT_DCS_BAD_PAGESIZE (DCS and DIS mismatch page size) 0x457 STAT_DCS_BAD_200_RES (DCS and DIS mismatch on 200 x 200/204 x 391) 0x458 STAT_DCS_BAD_SPR_RES (DCS and DIS mismatch on SPR-RES) 0x459 STAT_DCS_BAD_300_RES (DCS and DIS mismatch on 300 x 300) 0x45A STAT_DCS_BAD_400_RES (DCS and DIS mismatch on 400 x 400/408 x 391) 0x45B STAT_NEG_NO_ID (ID required but not present) 0x45C STAT_NEG_RAISE_RATE (Negotiate higher rate) 0x45D STAT_NEG_LOWER_RATE (Negotiate lower rate) 0x45E STAT_NEG_END_OF_RATES (No additional rates exist)
...........................................................................................................................................................................................................................................................

1-144
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

0x45F 0x460 0x461 0x462 0x463 0x464 0x465 0x466 0x467 0x468 0x469 0x46A 0x46B 0x46C 0x46D 0x46E 0x46F 0x470 0x471 0x472 0x473 0x474 0x475 0x476 0x477 0x478 Hardware Events 0x51 0x52 0x53 0x54 0x55 0x56 0x57 0x58 0x59 0x5A 0x5B 0x5C 0x5D 0x5E 0x5F 0x60 0x61 0x62 0x63 0x64 0x65 0x66

STAT_NEG_INVLD_RATE STAT_NEG_V27_2400 (Selected rate) STAT_NEG_V27_4800 STAT_NEG_V27_7200 STAT_NEG_V27_9600 STAT_NEG_V17_7200 STAT_NEG_V17_9600 STAT_NEG_V17_12000 STAT_NEG_V17_14400 STAT_NEG_MH STAT_NEG_MR STAT_NEG_MMR STAT_NEG_ECM STAT_NEG_RES_204 x 98 STAT_NEG_RES_204 x 196 STAT_NEG_RES_204 x 391 STAT_NEG_RES_408 x 3918 STAT_NEG_RES_200 x 200 STAT_NEG_RES_300 x 300 STAT_NEG_RES_400 x 400 STAT_NEG_RES_600 x 600 STAT_NEG_A4 STAT_NEG_A3 STAT_NEG_B4 STAT_NEG_LETTER STAT_NEG_LEGAL

STAT_HW_V21_RX_START STAT_HW_V21_RX_END STAT_HW_V21_TX_START STAT_HW_V21_TX_END STAT_HW_RX_TRAIN _START STAT_HW_RX_TRAIN _END STAT_HW_RX_TRAIN _FAIL STAT_HW_TX_TRAIN _START STAT_HW_TX_TRAIN _END STAT_HW_HS_TX_START STAT_HW_HS_TX_END STAT_HW_HS_RX_START STAT_HW_HS_RX_END STAT_HW_V21_RX_FRAME STAT_HW_V21_TX_FRAME STAT_HW_BUFUPDONE STAT_HW_BUFDNDONE STAT_HW_V21_DETECTED STAT_HW_HS_TX_READY STAT_HW_HS_RX_READY STAT_HW_PACKET_FAIL STAT_HW_FAXSTOPPED

1-145
Release 8.4.1 ER3, February 2008

Call Processing Event 0x002E

0x67 0x68 0x69

STAT_HW_REMOTEDISCONNECT STAT_HW_MODEMACTIVE STAT_FRM_MCF

0x42-0x48 (Positive Voice Detection/Answering Machine Detection (PVD/AMD)) Data[0-3] Calendar Time (seconds since Jan. 1, 1970) Data[4, 5] Milliseconds Remainder Data[6, 7] Milliseconds Since Last Event Data[8, 9] Frequency Band Detected (Events 0x47 and 0x48 only) 0x50 DSP Series 2 FSK Events Data[0, 1] FSK Event Code 0x0001 FSK Transmit Complete 0x0002 FSK Transmit Failure 0x0003 FSK Init FSK Failure 0x0004 FSK Send SMS DLL Failure 0x0005 FSK Receive SMS DLL Failure 0x0006 FSK SMS DLL Released 0x0007 FSK Received Failed 0x0008 FSK Received Complete Data[2-5] FSK Event Data 0x00000001 Internal TLV Data Error 0x00000002 Timeout waiting for INIT ACK from DSP Chip 0x00000003 Invalid Data Type 0x00000004 Timeout waiting for FSK Message Sent Indication from DSP Chip 0x00000005 Timeout waiting for XMT DT-AS ACK from DSP Chip 0x00000006 Timeout waiting for XMT SAS ACK from DSP Chip 0x00000007 Timeout waiting for TE-ACK from TE 0x00000008 Timeout waiting for Incoming FSK DLL MSG from TE 0x00000009 Timeout waiting for Stop FSK ACK from DSP Chip 0x0000000A Timeout waiting for Host Response to Send Outgoing DLL 0x0000000B Invalid CAS Acknowledge (ACK) 0x0000000C Timeout waiting for Incoming DTMF Digit from CPE Checksum

1-146
Release 8.4.1 ER3, February 2008

Call Progress Analysis Class Configure 0x00B3

SwitchKit Name Type Description CPAClassConfig EXS API and SwitchKit API message Call Progress Analysis Class Configure 0x00B3 Use this message to add a pattern, delete a pattern, or to change the parameters of a pattern in a call progress analysis class. Sent by Overview of message Host The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 8 9 10 11 : : : Update All Flag (see also text below this table) Class ID Action Data[0] : Data[n] Checksum Field Description Frame (0xFE) Length (0x0007) Message Type (0x00B3) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00B3) Reserved (0x00) Sequence Number Logical Node ID

SwitchKit Code

Configuration
CPAClassConfig ( Node = integer, UpdateFlag = integer, Class = integer, Action = integer, Data = byte array);

C Structure
typedef struct { UBYTE UpdateFlag; UBYTE Class; UBYTE Action;

1- 147
Release 8.4.1 ER3, February 2008

Call Progress Analysis Class Configure 0x00B3

UBYTE Data[250]; } XL_CPAClassConfig;

C++ Class
class XLC_CPAClassConfig : public XLC_OutboundMessage { public: UBYTE getUpdateFlag() const; void setUpdateFlag(UBYTE x); UBYTE getClass() const; void setClass(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 148
Release 8.4.1 ER3, February 2008

Call Progress Analysis Class Configure 0x00B3

EXS API Hex Format Detailed

MESSAGE (White) Byte 0 1 2 3 4 5 6 7 Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xB3) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1 2 3 4 5 6 7 8, 9 10 8 RESPONSE (Gray) Field Description Frame (0xFE) Length, MSB (0x00) Length, LSB (0x07) Message Type, MSB (0x00) Message Type, LSB (0xB3) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

Update All Flag (see also text below this table) 0x00 Store new configuration but do not use it. Use if you are sending more configuration messages. Use for a new configuration that changes many parameters. The CSP does not use the new configuration until the last message has 0x01 in this field. 0x01 Use new configuration immediately Use in the last configuration message. When the CSP detects this value, it uses this and all stored configuration commands to define a new call progress analysis class configuration. This field indicates whether you are going to update all fields with the configuration that you are defining in this and previous messages. For example, suppose you are updating several characteristics of call progress analysis. To do so, you are sending several of these CPA Class Configure messages. To prevent the CSP from performing a call progress analysis with a half-old and half-new configuration, you store the new configuration commands until the last new command is sent to the CSP. The Call Progress Analysis Configuration Query message reports configuration changes even when the Update All Flag is not set. But detection does not take place until the flag is set to 0x01.

Class ID This field indicates the class number, which contains the information for detecting one group of patterns. Action 0x01 Add member pattern 0x02 Delete member pattern 0x03 Change class parameter

1- 149
Release 8.4.1 ER3, February 2008

Call Progress Analysis Class Configure 0x00B3

11 . . .

Data[0-n] This field or set of fields provides the necessary information to perform the action indicated in the Action field. 0x01 Add Member Pattern Data[0] Pattern ID 0x02 Delete Member Pattern Data[0] Pattern ID 0x03 Change Class Parameter For parameter definitions, refer to the appropriate Developers Guide. Data[0] Parameter 0x01 Mode* 0x02 Start Delay** 0x03 Continuous Silence Timeout** 0x04 Time to Wait for Pattern Confirmation** 0x05 Time to Wait after Confirmation and No Report** 0x06 Minimum Frequency Glitch Time* 0x07 Minimum Silence Glitch Time** 0x08 Maximum On Timer** 0x09 Maximum Off Timer** 0x0A Advanced Answer Detect*** 0x0B Mode Specific 1 0x0C Mode Specific 2 *If Data[0] is 0x01, Data[12] are as follows: Data[1] Reserved Data[2] Mode This field is a bit mask that defines the mode. (0 = disabled, 1 = enabled). To enable multiple options, or the bits together. Bit 0 Advanced Answer Detect Bit 1 Energy Detection Bits 27 Reserved **If Data[0] is 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, or 0x09, Data[12] are as follows: Data[1] The time in 10-ms units, MSB Data[2] The time in 10-ms units, LSB ***If Data[0] is 0x0A, Data[12] are as follows: Data[1] 0x00 Data[2] Number of Frequency Bursts in 500 ms before answer is declared

1- 150
Release 8.4.1 ER3, February 2008

Call Progress Analysis Class Configure 0x00B3

If Data[0] is 0x0B, Data[12] are as follows: Data[1] 0x00 (Reserved) Data[2] Sensitivity Level (for more information on Energy Detection mode, refer to the DSP Series 2 Card Product Description in the Developers Guide Overview). 0x00 0 dBm 0x01 5 dBm 0x02 10 dBm 0x03 15 dBm 0x04 20 dBm 0x05 25 dBm 0x06 30 dBm If Data[0] is 0x0C, Data[12] are as follows: Data[1] Scan Duration in 20-ms increments, MSB Data[2] Scan Duration in 20-ms increments, LSB The value must be expressed in 20 ms increments, using 10 ms units. For example, you should use 0x0002 = 20 ms, 0x0004 = 40 ms, and so on. The CSP rounds down odd values. For example, the system rounds down 0x0003 to = 20ms. For more information on Energy Detection mode, refer to the appropriate Developers Guide. : Checksum

Example 1

The table that follows shows a message that changes the number of frequency bursts per 500 ms (before declaring answer) to 5.

MESSAGE Byte 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 Frame Length, MSB Length, LSB Message Type, MSB Message Type, LSB Reserved Sequence Number Logical Node ID Update All Flag Class ID Action Data[0] Parameter Field 0xFE 0x00 0x0B 0x00 0xB3 0x00 0x01 0xFF 0x01 0x00 0x03 (Change Class Parameter) 0x0A (Advanced Answer Detect) Field Value

Data[1] Number of Frequency Bursts, MSB 0x00 Data[2] Number of Frequency Bursts, LSB 0x05 (5 bursts per 500 ms) Checksum 0xD1

1- 151
Release 8.4.1 ER3, February 2008

Call Progress Analysis Class Configure 0x00B3 Example 2 This example shows the message sequence you would use to change the mode of Call Progress Analysis Class 3 to Energy Detection, with a sensitivity level of -30 dBm and a scan duration of 60ms. To change the mode, you send the following three Call Progress Analysis Class Configure messages in this sequence:

Byte 8 9 10 11

Message Field Action Data[0] Parameter Data[1] Reserved Data[2] Mode

Field Value 0x03 (Change Class Parameter) 0x01 (Mode) 0x00 0x02 (Energy Detection enabled)

Byte 8 9 10 11

Message Field Action Data[0] Parameter Data[1] Reserved

Field Value 0x03 (Change Class Parameter) 0x0B (Mode Specific 1) 0x00

Data[2] Sensitivity Level 0x06 (-30 dBm)

Byte 8 9 10 11

Message Field Action Data[0] Parameter Data[1] Reserved Data[2] Scan Duration

Field Value 0x03 (Change Class Parameter) 0x0C (Mode Specific 2) 0x00 0x06 (60 ms)

1- 152
Release 8.4.1 ER3, February 2008

Call Progress Analysis Configuration Query 0x008A

SwitchKit Name Type Description CPAConfigQuery EXS API and SwitchKit API message Call Progress Analysis Configuration Query 0x008A Use this message to query call progress analysis (CPA) configuration information. Sent by SwitchKit Code Host C Structure
typedef struct { UBYTE QueryEntity; UBYTE DataType; } XL_CPAConfigQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE Data[251]; } XL_CPAConfigQueryAck;

C++ Class
class XLC_CPAConfigQuery : public XLC_OutboundMessage { public: UBYTE getQueryEntity() const; void setQueryEntity(UBYTE x); UBYTE getDataType() const; void setDataType(UBYTE x); };

C++ Class Response

class XLC_CPAConfigQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 153
Release 8.4.1 ER3, February 2008

Call Progress Analysis Configuration Query 0x008A

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0007) Message Type (0x008A) Reserved (0x00) Sequence Number Logical Node ID Query Entity This field indicates the characteristic of call progress analysis (CPA) about which the host is seeking information: 0x01 CPA Tone Group 0x02 CPA Pattern List 0x03 CPA Class Data[0] This field provides the necessary information to perform the action indicated in the Query Entity field. 0x01 CPA Tone Group Data[0] Tone Group ID 0x02 CPA Pattern List Data[0] Pattern ID 0x03 CPA Class Data[0] Class ID 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x008A) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

10 ...

Data[0-N] This set of Data fields represents the CPA information requested by the host. The type and amount of data in the response depends on the value of the Query Entity field in the message. NOTE: Values in data fields marked with an asterisk (*) represent the number of 10ms units. 0x01 CPA Tone Group Data[0] Number of tones in group Tone Descriptor 1 Data[1] Tone ID Data[2] Number of frequencies in tone Data[3, 4] Frequency Data[5, 6] Dbm Data[7, 8] Frequency (not included if Data[2] is 1) Data[9, 10] Dbm (not included if Data[2] is 1) Response continued below...

10 (Cont.)

: Tone Descriptor N Data[M] Tone ID Data[M+1] Number of frequencies in tone Data[M+2, M+3] Frequency Data[M+4, M+5] Dbm Data[M+6, M+7] Frequency (not included if Data[M+1] is 1) Data[M+8, M+9] Dbm (not included if Data[M+1] is 1)

1- 154
Release 8.4.1 ER3, February 2008

Call Progress Analysis Configuration Query 0x008A

0x02 CPA Pattern List Values in data fields marked with an asterisk (*) represent the number of 10ms units. Data[0] Reserved Data[1] Reserved Data[2] Pattern ID (Value returned upon detection) Data[3] Tone Group ID Data[4] Pattern Configuration 0x01 Last Interval Continuous 0x02 Detect Tone After Determination 0x04 Use as Internal Dialtone Data[5] CPA Result on Pattern Loss (for example, Answer) Data[6] Interval Cycles to Match Data[7] Interval Cycles to Report Data[8] Reserved Data[9] Interval Descriptor Count Interval Descriptor 1 Data[10] Tone ID (0x00 for silence) Data[11] Reserved (0x00) Data[12,13] Minimum filter * Data[14,15] Maximum filter * : Interval Descriptor 8 (All 8 are sent even if not in use) Data[N] Tone ID (0x00 for silence) Data[N+1] Reserved (0x00) Data[N+2, N+3] Minimum filter * Data[N+4, N+5] Maximum filter * 0x03 CPA Class Values in data fields marked with an asterisk (*) represent the number of 10ms units. Data[0] Mode Data[1] Advanced Answer Detect Data[2,3] Start Delay Data[4,5] Continuous Silence Timeout * Data[6,7] Time to wait for pattern confirmation * Data[8,9] Time to wait after confirmation and no report * Data[10,11] Minimum frequency glitch time * Data[12,13] Minimum silence glitch time * Data[14,15] Maximum on timer * Data[16,17] Maximum off timer * Data[18,19] Mode Specific 1 Data[20,21] Mode Specific 2 Data[22] Number of patterns in class Data[23] Pattern ID (First one) : Data[N] Pattern ID (Last one) : Checksum

1- 155
Release 8.4.1 ER3, February 2008

Call Progress Analysis Pattern Configure 0x00B2

SwitchKit Name Type Description CPAPatternConfig EXS API and SwitchKit API message Call Progress Analysis Pattern Configure 0x00B2 Use this message to add, delete, or change a call progress analysis (CPA) pattern. Sent by Overview of message Host The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 8 9 10 11 : : Update All Flag Pattern ID Action Data [0] Data [n] Checksum Field Description Frame (0xFE) Length (0x0007) Message Type (0x00B2) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00B2) Reserved (0x00) Sequence Number Logical Node ID

SwitchKit Code

Configuration
CPAPatternConfig ( Node = integer, UpdateFlag = integer, Pattern = integer, Action = integer, Data = byte array);

C Structure
typedef struct { UBYTE UpdateFlag;
...........................................................................................................................................................................................................................................................

1- 156
Release 8.4.1 ER3, February 2008

Call Progress Analysis Pattern Configure 0x00B2

UBYTE Pattern; UBYTE Action; UBYTE Data[250]; } XL_CPAPatternConfig;

C++ Class
class XLC_CPAPatternConfig : public XLC_OutboundMessage { public: UBYTE getUpdateFlag() const; void setUpdateFlag(UBYTE x); UBYTE getPattern() const; void setPattern(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 157
Release 8.4.1 ER3, February 2008

Call Progress Analysis Pattern Configure 0x00B2

EXS API Hex Format Detailed

MESSAGE (White) Byte 0 1 2 3 4 5 6 7 Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0xB2) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1 2 3 4 5 6 7 8, 9 10 8 RESPONSE (Gray) Field Description Frame (0xFE) Length, MSB (0x00) Length, LSB (0x07) Message Type, MSB (0x00) Message Type, LSB (0xB2) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

Update All Flag 0x00 Store new configuration but do not use it. Use this value if you are sending more configuration messages. You use this value for a new configuration that changes many parameters. The system does not use the new configuration until the last message has 0x01 in this field. 0x01 Use new configuration immediately. Use this value in the last configuration message. When the system detects this value, it will use this and all stored configuration commands to define a new call progress analysis class configuration. This field indicates whether or not you are going to update all fields with the configuration you are defining in this and previous messages. For example, suppose you are updating several characteristics of call progress analysis. To do so, you send several of these Call Progress Analysis Pattern Configure messages. To prevent the CSP from performing a call progress analysis with a half-old and half-new configuration, you store the new configuration commands until the last new command is sent to the CSP. The Call Progress Analysis Configuration Query message reports configuration changes even when the Update All Flag is not set; however, detection does not happen until the flag is set to 0x01.

1- 158
Release 8.4.1 ER3, February 2008

Call Progress Analysis Pattern Configure 0x00B2

9 Pattern ID The number of the pattern to add, delete, or change. The following are the default IDs. Because you can modify the patterns, your pattern IDs may not correspond to this list. 0x01 Ringback 0x02 Double Ringback 0x03 Busy 0x04 Reorder 0x05 PBX Intercept 0x06 SIT Intercept A 0x07 Vacant Code 0x08 Reorder-SIT 0x09 No Circuit LEC 0x0A Reorder-Carrier 0x0B No Circuit-Carrier 0x0C PBX Dialtone 0x0D Standard Dialtone 0x0E CPC Detection 0x0F PILOT 2000 ON 0x10 PILOT 2000 REMOVED 0x11 PILOT 1780 ON 0x12 SS7 PILOT 1780 REMOVED 0x13 FAX 0x14 SIT Intercept B Action 0x01 Add/Replace Pattern 0x02 Delete Pattern 0x03 Change Pattern Parameter Data[0-N] This set of data fields provides the necessary information to perform the action indicated in the Action field. Valid entries for this field are listed below by Action field value. 0x01 Add/Replace Pattern Data[0] Pattern ID (Value to be returned upon detection) Data[1] Tone Group ID Data[2] Pattern Configuration This data byte is a bit mask you use to set the configuration options of a pattern. You can set multiple bits. Bit 0 Last Interval Continuous 1 Detect Tone After Determination 2 Use as Internal Dialtone 3 Receiver does not terminate after reporting this pattern. 47 Reserved Data[3] Data[4] Data[5] Data[6] Data[7] CPA Report on Pattern Loss (for example, Answer) Interval Cycles to Match Interval Cycles to Report Reserved Interval Descriptor Count (maximum is 8)

11 . . .

1- 159
Release 8.4.1 ER3, February 2008

Call Progress Analysis Pattern Configure 0x00B2

Interval Descriptor 1 Data[8] Tone ID (0x00 for silence) Data[9] Reserved (0x00) Data[10,11] Minimum filter (given in 10ms units) Data[12,13] Maximum filter (given in 10ms units) : Interval Descriptor N Data[N] Tone ID (0x00 for silence) Data[N+1] Reserved (0x00) Data[N+2, N+3]Minimum filter Data[N+4, N+5]Maximum filter 0x02 Delete Pattern Data[0] Pattern ID to Delete 0x03 Change Pattern Parameter Data[0] Parameter to Change 0x01 Pattern ID 0x02 Tone Group ID 0x03 Pattern Configuration 0x04 CPA Result on Pattern Loss (for example, Answer) 0x05 Interval Cycles to Match 0x06 Interval Cycles to Report 0x07 Reserved 0x08 Interval Data for all Parameters except 0x03 and 0x08 Data[1] New Parameter Value ( for Parameter 0x03 Data[1] New Pattern Configuration This data byte is a bit mask you use to set the configuration options of a pattern. You can set multiple bits. Bit 0 Last Interval Continuous 1 Detect Tone After Determination 2 Use as Internal Dialtone 37 Reserved for Parameter 0x08 Data[1] Interval Descriptor Count Data[2] Interval Index Data[3] Tone ID Data[4] Reserved (0x00) Data[56] Minimum Filter (given in 10ms units) Data[78] Maximum Filter (given in 10ms units) : Checksum

1- 160
Release 8.4.1 ER3, February 2008

Call Progress Analysis Pattern Configure 0x00B2

Example Message

This example shows changing the Interval Sequences to detect before reporting pattern of Ringback to 2.

Byte 0 1 2 3 4 5 6 7 8 9 10 11 12 13

Message Message Frame Length, MSB Length, LSB Message Type, LSB Reserved Sequence Number Logical Node ID Update All Flag Pattern ID Action Data[0] Parameter Data[1] Value Checksum 0xFE 0x00 0x0A 0xB2 0x00 0x01 0xFF 0x01

Values

Message Type, MSB 0x00

0x01 (Ringback) 0x03 (Change Parameter) 0x06 (Interval Cycles to Report) 0x02 0xC1

1- 161
Release 8.4.1 ER3, February 2008

Call Progress Analysis Result 0x0034

SwitchKit Name Type Description CPAResult EXS API and SwitchKit API message Call Progress Analysis Result 0x0034 The CSP sends this message to report the result of Call Progress Analysis on a channel. Only one result is reported per message. Sent by SwitchKit Code CSP C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE Result; UBYTE Diag1; UBYTE Diag2; UBYTE Diag3; } XL_CPAResult;

C++ Class
class XLC_CPAResult : public XLC_OneChannelMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getResult() const; void setResult(UBYTE x); UBYTE getDiag1() const; void setDiag1(UBYTE x); UBYTE getDiag2() const; void setDiag2(UBYTE x); UBYTE getDiag3() const; void setDiag3(UBYTE x); };

Resent in EXS API

This message is resent once after five seconds.

1- 162
Release 8.4.1 ER3, February 2008

Call Progress Analysis Result 0x0034

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0034) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Call Progress Analysis Result 0x01 Ringback * 0x02 Double Ringback 0x03 Busy 0x04 Reorder 0x05 PBX Intercept 0x06 SIT Intercept A 0x07 Vacant Code 0x08 Reorder-LEC 0x09 No Circuit-LEC 0x0A Reorder-Carrier 0x0B No Circuit-Carrier 0x0C PBX Dialtone 0x0D Standard Dialtone 0x13 Fax Tone Detected 0x14 SIT Intercept B 0x80 Answer 0x81 Reserved 0x82 Continuously On Tone 0x83 Initial Silence Timeout 0x84 Not Determined Timeout 0x85 Determined Timeout 0x86 Answer determined through line signaling 0x87 Reserved * Ringback is detected on the fourth cycle of ringback/silence : : : : Reserved (0x00) Reserved (0x00) Reserved (0x00) Checksum Byte 0 1, 2 3, 4 5 6 7 8 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x0034) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

1- 163
Release 8.4.1 ER3, February 2008

Call Progress Analysis Result 0x0034

1- 164
Release 8.4.1 ER3, February 2008

CancelUserTimer

CancelUserTimer
Type: Description

SwitchKit API message Use this message to cancel a previously sent UserTimer message or group of UserTimer messages. This will cause the canceled timer to go off with a negative status value, SK_CANCELED. All handler functions which are installed to handle UserTimer expirations should be prepared to do nothing if the Status is not positive. If you want to cancel a UserTimer, the GroupTag should be set when the UserTimer is sent. This GroupTag should be saved for later use. When you want to cancel that timer, you need to send a CancelUserTimer message with the appropriate GroupTag entered. All currently unexpired UserTimer messages from that application with the corresponding GroupTag are canceled, and the acknowledgment sent back will contain the number of timers that were canceled. Depending on how the UserTimer messages are set up, you can cancel a set of UserTimer messages with a single CancelUserTimer message. It is important to realize that the GroupTag domain is unique to each application. This prevents one application from canceling another applications UserTimer. If multiple applications use the same GroupTag in a timer, and one application cancels that tag, only the timers from that application will be canceled. All other timers will still expire normally.

Sent by Arguments

Application The following table shows the arguments that you can modify:

1- 165
Release 8.4.1 ER3, February 2008

CancelUserTimer

Argument GroupTag

Description Cancellation of a timer requires that this field be set at creation of the timer and then remembered. When you want to cancel that timer, you need to send a CancelUserTimer message with the appropriate GroupTag entered. All currently unexpired UserTimer messages from that application with the corresponding GroupTag are canceled. It is important to realize that the GroupTag domain is unique to each application. This prevents one application from canceling another applications UserTimer. If multiple applications use the same GroupTag in a timer, and one application cancels that tag, only the timers from that application will be canceled. All other timers will still expire normally.

C Structure

typedef struct { int GroupTag; } SK_CancelUserTimer; typedef struct { int Status; int GroupTag; int NumCanceled; } SK_CancelUserTimerAck; class SKC_CancelUserTimer : public SKC_ToolkitMessage { public: int getGroupTag() const; void setGroupTag(int x); }; class SKC_CancelUserTimerAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getGroupTag() const; void setGroupTag(int x); int getNumCanceled() const; void setNumCanceled(int x); };

C Structure Response

C++ Class

C++ Class Response

1- 166
Release 8.4.1 ER3, February 2008

Card Population Query 0x0007

SwitchKit Name Type Description CardPopulationQuery EXS API and SwitchKit API message Card Population Query 0x0007 Use this message to query the cards installed in the system. The response indicates the Card Type installed in each slot (or virtual slots) in the system. Related Information Chassis Slot Numbering Card Types Host C Structure
typedef struct { } XL_CardPopulationQuery;

Sent by SwitchKit Code

C Structure Response
typedef struct { unsigned short Status; UBYTE Info[96]; } XL_CardPopulationQueryAck;

C++ Class
class XLC_CardPopulationQuery : public XLC_OutboundMessage { public: };

C++ Class Response

class XLC_CardPopulationQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getInfo() const; UBYTE *getInfo(); void setInfo(UBYTE *x); };

Overview of message

The following table provides an overview of this message. The table following it provides the detail for each byte.

1- 167
Release 8.4.1 ER3, February 2008

Card Population Query 0x0007

RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0067) Message Type (0x0007) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Slot 0* Card Type Slot 1* Card Type Card Type Slot 63 Card Type Checksum

1- 168
Release 8.4.1 ER3, February 2008

Card Population Query 0x0007

EXS API Hex Format Detailed

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x0007) Reserved (0x00) Sequence Number Logical Node ID Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 11 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0067) Message Type (0x0007) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Slot 0* Card Type Slot 1* Card Type (Response continued below.)

1- 169
Release 8.4.1 ER3, February 2008

Card Population Query 0x0007

Card Type 0x00 0x01 0x03 0x0A 0x0B 0x0C 0x0E 0x13 0x14 0x15 0x16 0x17 0x18 0x19 0x1D 0x1E 0x1F 0x33 0x42 0x50 0x54 0x60 0x61 0x65 0x6B 0x6D 0x71 0x72 0x73 0x75 0x76 0x79 0x80 0xCA 0xCC 0xCF 0xD2 0xD5 8-Span ST1LC 4-Span ST1LC MFDSP SS7 SE1LC 4-Span SE1LC 8-Span SJ1LC 4-Span ISDN PRI DASS2 DSP-ONE T-ONE 8-Span E-ONE 8-Span T-ONE 16-Span E-ONE 16-Span J-ONE 8-Span J-ONE 16-Span DS3 Subrate Controller EXNET Connect PCI H.100 SS7 PQ EXNET ONE VDAC VDAC VOIP Module IP Network Interface Series 2 DSP Series 2 IP Network Interface Series 2 VoIP Module SS7 Series 3 CSP Matrix I/O CSP Matrix 2000 CSP Matrix 1000 ISDN Series 3 IP Signaling Series 3 Virtual 32 Span VDAC-ONE or IP Media Series 2 Multi-Function Media I/O DS3 Standby I/O VDAC I/O Virtual T1 16-Span Virtual E1/J1 16-Span

1- 170
Release 8.4.1 ER3, February 2008

Card Population Query 0x0007

0xD8 CCS I/O Series 3 0xDB J-ONE Redundant I/O 0xDC J-ONE Standby I/O 0xDD DS3 Redundant I/O 0xDF CCS I/O 0xE0 E-ONE 75 Ohm Redundant I/O 0xE1 T-ONE 100 Ohm Redundant I/O 0xE2 E-ONE 120 Ohm Redundant I/O 0xE3 E-ONE 75 Ohm Standby I/O 0xE4 T-ONE 100 Ohm Standby I/O 0xE5 E-ONE 120 Ohm Standby I/O 0xE8 SS7 Multi-Protocol I/O 0xF0 Power Supply 0xF5 EXNET Ring I/O 0xF6 Rear Fan Tray 0xF7 SS7 Redundant I/O 0xF8 Front Fan Tray 0xF9 ISDN Redundant I/O 0xFA Midplane 0xFE Dead Card All subsequent data fields are not applicable and all other bytes in the message should be ignored. 0xFF Empty Slot All subsequent data fields are not applicable. 73 74-105 106 Slot 63 Card Type Slot 64-95 Card Type - Virtual Slot Configuration (See Virtual Slots below.) Checksum

*Slot Numbers
Front of Chassis 0x000x0F Line Card Slots 015 0x000x03 Line Card Slots 03 0x10 Front Fan Tray 0x11 Power2/ PSC 2 0x12 Power1/PSC 1 0x16 Fan Tray 0x20 CSP Matrix Series 3 Card 1 0x21 CSP Matrix Series 3 Card 2 Back of Chassis 0x13 Midplane 0x14 CSP Matrix Card I/O for CPU1 0x15 CSP 2000 Matrix I/O for CPU2 0x16 Rear Fan Tray 0x300x3F Redundant Line Card I/Os 0x300x33 Redundant Line Card I/Os Virtual 0x40-0x5F Virtual Slots

1- 171
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

SwitchKit Name Type Description CardStatusQuery EXS API and SwitchKit API message Card Status Query 0x0083 Use this message to get a report on a specified card type. The host can also send this message to the active or standby CSP Matrix Series 3 Card. Sent by SwitchKit Code Host C Structure
typedef struct { } XL_CardStatusQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE AddrInfo[30]; UBYTE CardType; UBYTE CardStatus; UBYTE ConfTestRslts; UBYTE ArtRevision; UBYTE FunctRevision; UBYTE ROMMajorRevision; UBYTE ROMMinorRevision; UBYTE RAMMajorRevision; UBYTE RAMMinorRevision; unsigned short SerialNumber; unsigned short RAMSize; UBYTE CardSpecifics[384]; UBYTE HardwareConfig[16]; UBYTE CardID; UBYTE RAMBuildNum; unsigned short ConfigTag; UBYTE LineCardSpeed; UBYTE SoftwareResetReason; } XL_CardStatusQueryAck;

C++ Class
class XLC_CardStatusQuery : public XLC_OutboundMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); // Extended addressing functions // Slot AIB functions UBYTE getSlot() const; void setSlot(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 172
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

// Module AIB functions UBYTE getModule() const; void setModule(UBYTE x); };

C++ Class Response

class XLC_CardStatusQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getModule() const; void setModule(UBYTE x); UBYTE getCardType() const; void setCardType(UBYTE x); UBYTE getCardStatus() const; void setCardStatus(UBYTE x); UBYTE getConfTestRslts() const; void setConfTestRslts(UBYTE x); UBYTE getArtRevision() const; void setArtRevision(UBYTE x); UBYTE getFunctRevision() const; void setFunctRevision(UBYTE x); UBYTE getROMMajorRevision() const; void setROMMajorRevision(UBYTE x); UBYTE getROMMinorRevision() const; void setROMMinorRevision(UBYTE x); UBYTE getRAMMajorRevision() const; void setRAMMajorRevision(UBYTE x); UBYTE getRAMMinorRevision() const; void setRAMMinorRevision(UBYTE x); ;}

Overview of message

The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0083) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB AIB

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : : : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0083) Reserved (0x00) Sequence Number Logical Node ID AIB (starting with byte 0) : Checksum

1- 173
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

Response continued below. : : : : : : : : : Card Type Card Status Confidence Test Results PC Artwork Revision Functional Revision ROM Major Revision ROM Minor Revision RAM Major Revision RAM Minor Revision

2 bytes Serial Number MSB, LSB 2 bytes RAM Size MSB, LSB : : : : : : Card Information (Field length varies) Card ID RAM Build Number CPU Speed Software Reset Reason Checksum 16 bytes Hardware Configuration (16 bytes)

2 bytes Configuration Tag MSB, LSB

1- 174
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

EXS API Hex Format Detailed

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0083) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x01 Slot or 0x42 VoIP Module : : Checksum Response continued below. Card Type 0x00 0x01 0x03 0x0A 0x0B 0x0C 0x0E 0x13 0x14 0x15 0x16 0x17 0x18 0x19 0x1D 0x1E 0x1F 0x33 8-Span ST1LC 4-Span ST1LC MFDSP SS7 SE1LC 4-Span SE1LC 8-Span SJ1LC 4-Span ISDN PRI DASS 2 DSP-ONE T-ONE 8-Span E-ONE 8-Span T-ONE 16-Span E-ONE 16-Span J-ONE 8-Span J-ONE 16-Span DS3 Subrate Controller Byte 0 1, 2 3, 4 5 6 7 8, 9 : RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0083) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB AIB Same AIB sent in message

1- 175
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

0x42 0x50 0x54 0x60 0x61 0x65 0x6B 0x6D 0x6E 0x71 0x72 0x73 0x75 0x76 0x79 0x80 0x90 0x91 0x92 0xAA 0xCA 0xCC 0xCF 0xD2 0xD5 0xD8 0xDB 0xDC 0xDD 0xDF 0xE0 0xE1 0xE2 0xE3 0xE4 0xE5 0xE8 0xF0 0xF3 0xF5 0xF6 0xF7 0xF8 0xF9 0xFA 0xFE 0xFF

EXNET Connect PCI H.100 SS7 PQ EXNET-ONE VDAC ONE VDAC VoIP Module IP Network Interface Series 2 DSP Series 2 IP Network Interface Series 2 VoIP Module Mindspeed VoIP Module SS7 Series 3 CSP 2000 Matrix I/O CSP 2000 Matrix 2000 CSP 2000 Matrix 1000 ISDN Series 3 IP Signaling Series 3 Virtual 32 Span VDAC-ONE or IP Media Series 2 DSP Series 2 Plus IP Network Interface Series 3 Multi-Function Media I/O Plus Ilegal I/O Multi-Function Media I/O DS3 Standby I/O VDAC I/O Virtual T1 16-span Virtual E1/J1 16-Span CCS I/O Series 3 J-ONE Redundant I/O J-ONE Standby I/O DS3 Redundant I/O CCS I/O E-ONE 75 Ohm Redundant I/O T-ONE 100 Ohm Redundant I/O E-ONE 120 Ohm Redundant I/O E-ONE 75 Ohm Standby I/O T-ONE 100 Ohm Standby I/O E-ONE 120 Ohm Standby I/O SS7 Multi-Protocol I/O Power Supply Card Matrix I/O EXNET Ring I/O Rear Fan Tray SS7 Redundant I/O Front Fan Tray ISDN Redundant I/O Midplane Dead Card: All subsequent data fields do not apply and all other bytes in the message should be ignored. Empty Slot: All subsequent data fields do not apply.

1- 176
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

Card Status This field is a bit mask that applies to the following cards: CSP Matrix Series 3 Card, T-ONE, E-ONE, J-ONE, DS3, EXNET-ONE, SS7-PQ, SS7 Series 3, DSP-ONE, MFDSP, DSP Series 2, DSP Series 2 Plus, ISDN PRI, ISDN Series 3, ST1LC, SE1LC, SJ1LC, VDAC-ONE, IP Network Interface Series 2/3, IP Signaling Series 3 Bit 01

Reset Reason 0 Dialogic use only 1 Power-up 2 Dialogic use only 3 Reset button pushed Card State 0 In service 1 The CSP has taken the card out of service 2 The host has taken the card out of service 3 The host has put the card in a standby state Invalid battery-backed configuration data. The host must reconfigure the card Faults are logged Faults may be obtained using a Fault Log Query message. Obtain a Fault Log and report it to Dialogic Technical Support as soon as possible. Failed confidence tests. Information about the confidence test which failed is in the Confidence Test Results field. General hardware failure The card is off-line and must be serviced. See the Hardware Configuration Field for additional information on the ISDN PRI card.

4 5

1- 177
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

Series 3 Card cards and line cards.

PC Artwork Revision An ASCII character in the range A to Z (0x410x5B) that indicates the revision level of the cards Printed Circuit Artwork. Functional Revision The cards functional revision level ROM Major Revision The major revision level of the firmware running on the card. ROM Minor Revision The minor revision level of the firmware running on the card. RAM Major Revision The major revision level of the system software running on the card. RAM Minor Revision The minor revision level of the system software running on the card.

: : : : :

1- 178
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

: :

Serial Number MSB, LSB This two-byte field indicates the serial number of the card. RAM Size MSB, LSB This two-byte field indicates the amount of RAM on the card, in 1K increments. For the VDAC VoIP Card and VDAC VoIP Module, RAM is measured in 1 MB increments. Card Information (Field length varies) The card information, including the length of the field, varies per card type. The system uses the value 0x00 for fields that do not apply to the card or for all fields, if there is no card information.

IP Signaling Series 3 Card No card specific or hardware specific information is sent for this card. T-ONE, E-ONE, J-ONE, DS3, ST1LC, SE1LC, VDAC-ONE, IP Network Interface Series 2/3, and SS7 Multi- Protocol cards. The card information for these cards indicates the logical spans assigned to the card. The logical spans are indicated in the Logical Span AIB (0x0C) as shown below. The CSP uses the value 0xFF to indicate that no span has been assigned. An AIB for a 4-span line card has four address elements and the value 0x00 for the remaining bytes. An AIB for an 8-span line card has eight address elements and the value 0x00 for the remaining bytes. Data[0] Address Method (0x00, Single Entity) Data[1] Number of Address Elements (equal to number of spans) Address Element 1: Span 0 Data[2] Address Type (0x0C, Logical Span) Data[3] Data Length (0x02) Data[4] Logical Span ID, MSB Data[5] Logical Span ID, LSB Address Element N: Span N Data[...] Address Type (0x0C, Logical Span) Data[...] Data Length (0x02) Data[...] Logical Span ID, MSB Data[...] Logical Span ID, LSB

1- 179
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

MFDSP and DSP-ONE Cards The card information for the DSP-ONE cards indicates the function types for DSPs on all SIMMs on the card. NOTE: For more information on function types, refer to the DSP SIMM Configure (0xC0) message. Function Type Byte Data[0] SIMM 0/DSP 0 Data[1] SIMM 0/DSP 1 Data[2] SIMM 0/DSP 2 Data[3] SIMM 0/DSP 3 Data[4] SIMM 1/DSP 0 Data[5] SIMM 1/DSP 1 Data[6] SIMM 1/DSP 2 Data[7] SIMM 1/DSP 3 Data[8] SIMM 2/DSP 0 Data[9] SIMM 2/DSP 1 Data[10] SIMM 2/DSP 2 Data[11] SIMM 2/DSP 3 Data[12] SIMM 3/DSP 0 Data[13] SIMM 3/DSP 1 Data[14] SIMM 3/DSP 2 Data[15] SIMM 3/DSP 3 Data[1633] Reserved

1- 180
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

DSP Series 2 and DSP Series 2 Plus Cards The card information for the DSP Series 2 and DSP Series 2 Plus cards indicates the function types for all DSPs on all Modules on the card, because each DSP can do multiple configurations. Byte Function Type Data[0] Module 0 / DSP 0 / RCV 0 Data[1] Module 0 / DSP 0 / TXMT 0 Data[2] Module 0 / DSP 0 / RCV 1 Data[3] Module 0 / DSP 0 / TXMT 1 Data[4] Module 0 / DSP 1 / RCV 0 Data[5] Module 0 / DSP 1 / TXMT 0 Data[6] Module 0 / DSP 1 / RCV 1 Data[7] Module 0 / DSP 1 / TXMT 1 Data[8] Module 0 / DSP 2 / RCV 0 Data[9] Module 0 / DSP 2 / TXMT 0 Data[10] Module 0 / DSP 2 / RCV 1 Data[11] Module 0 / DSP 2 / TXMT 1 Data[12] Module 0 / DSP 3 / RCV 0 Data[13] Module 0 / DSP 3 / TXMT 0 Data[14] Module 0 / DSP 3 / RCV 1 Data[15] Module 0 / DSP 3 / TXMT 1 Data[16] Module 1 / DSP 0 / RCV 0 Data[17] Module 1 / DSP 0 / TXMT 0 Data[18] Module 1 / DSP 0 / RCV 1 Data[19] Module 1 / DSP 0 / TXMT 1 Data[20] Module 1 / DSP 1 / RCV 0 Data[21] Module 1 / DSP 1 / TXMT 0 Data[22] Module 1 / DSP 1 / RCV 1 Data[23] Module 1 / DSP 1 / TXMT 1 Data[24] Module 1 / DSP 2 / RCV 0 Data[25] Module 1 / DSP 2 / TXMT 0 Data[26] Module 1 / DSP 2 / RCV 1 Data[27] Module 1 / DSP 2 / TXMT 1 Data[28] Module 1 / DSP 3 / RCV 0 Data[29] Module 1 / DSP 3 / TXMT 0 Data[30] Module 1 / DSP 3 / RCV 1 Data[31] Module 1 / DSP 3 / TXMT 1 Data[32] Reserved Data[33] Reserved

1- 181
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

EXNET-ONE This card generates no special information for this field. All bytes are 0x00. SS7 Card Data[0] Maximum Configurable Links for card Data[1] Slot Number of Active SS7 Card (see Note) Data[2] Slot Number of Secondary SS7 Card in Redundant Pair (see Note) Data[3] Stack ID Data[4] Stack ID Data[5] Stack ID Data[6] Stack ID Data[715]Reserved NOTE: Do not try to determine the redundancy status from bytes Data[1] and Data[2]. To determine the redundancy status, use the CCS Redundancy Query message. Redundant I/O and Standby I/O A Slot AIB indicates the slot number of the other I/O (Standby I/O or Redundant I/O) involved in a switchover. PCI H.100 Card The card information fields depend upon on H.100 bus clock speed and the number of spans per channel. 4MHz and 24 channels per span display 21 span entries 4MHz and 32 channels per span display 16 span entries 8MHz and 24 channels per span display 80 span entries 8MHz and 32 channels per span display 64 span entries : Hardware Configuration (16 bytes) This 16-byte field describes the hardware configuration of the card specified. This field applies to only the cards described below. DS3 Cards Data[0] Number of SS7 Spans Supported: 0x18 24 Spans 0x1C 28 Spans Data[1] DS3 Offset Framer Status Bit 0 - DS3 Offset 0 Framer Status 0 - Out of Service 1 - In Service (default) Bit [1-7] Reserved Data [2-13] Reserved Data[14] Hardware Switch 1 Settings (also refer to the Hardware Product Descriptions) (the right-most bit is dip 1) Total Available Spans

Data[15]

1- 182
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

ST1LC and SE1LC cards Data[0] Informs the host of primary and secondary loop timing clock sources configured on the card. Bits 0-2 If secondary loop timing is enabled, this field contains the offset of the span for which it is enabled. Bit 3 Secondary Loop timing 0 Disabled 1 Enabled Bit 4-6 If primary loop timing is enabled, this field contains the offset of the span for which it is enabled. Bit 7 Primary Loop timing 0 Disabled 1 Enabled Data[1-15] Reserved

T-ONE, E-ONE, J-ONE cards Data 03 Informs the host of primary and secondary loop timing clock sources configured on the card Data[0] Primary Loop Timing 0 Not Enabled 1 Enabled Data[1] If Primary Loop Timing is enabled, this field contains the span offset of the span for which it is enabled. Data[2] Secondary Loop Timing 0 Not enabled 1 Enabled Data[3] If Secondary Loop Timing is enabled, this field contains the span offset of the span for which it is enabled. Data[413] Reserved Data[14] Hardware Switch 1 Settings (also refer to the Hardware Product Descriptions) (the right-most bit is dip 1) Total Available Spans

Data[15]

1- 183
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

MFDSP and DSP-ONE Card This field informs the host of the number and types of DSP SIMMs installed on the card. Data[0] Number of DSP SIMMs installed on the card Data[1] Reserved Data[2] SIMM 0 Type 0x00 C31 SIMM 0x01 VRA SIMM 0x03 No SIMM installed Data[3] SIMM 1 Type 0x00 C31 SIMM 0x01 VRA SIMM 0x03 No SIMM installed Data[4] SIMM 2 Type 0x00 C31 SIMM 0x01 VRA SIMM 0x03 No SIMM installed Data[5] SIMM 3 Type 0x00 C31 SIMM 0x01 VRA SIMM 0x03 No SIMM installed Data 6-9: SIMM State 0 - SIMM State 3 0x00 In Service 0x01 Out of Service (or No SIMM Installed) Data[6] SIMM 0 State Data[7] SIMM 1 State Data[8] SIMM 2 State Data[9] SIMM 3 State Data[1015]Reserved

1- 184
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

DSP Series 2 and DSP Series 2 Plus Cards This field informs the host of the number and types of DSP Modules installed on the card. Data[0] Number of Modules installed on the card Data[1] Reserved Data[2] Module 0 Type 0x6C DSP 2 Module 0x03 No Module installed Data[3] Module 1 Type 0x6C DSP 2 Module 0x03 No Module installed Data[4, 5] Reserved Data 6-13: DSP Chip States 0x00 In Service 0x01 Out of Service (or No Module Installed) Data[6] Module 0 / Chip 0 State Data[7] Module 0 / Chip 1 State Data[8] Module 0 / Chip 2 State Data[9] Module 0 / Chip 3 State Data[10] Module 1 / Chip 0 State Data[11] Module 1 / Chip 1 State Data[12] Module 1 / Chip 2 State Data[13] Module 1 / Chip 3 State Data[14-15] Reserved ISDN PRI Card Data[0] Munich Chip Count Data[1-15] Reserved EXNET-ONE card Data[03]Informs host of primary and secondary loop timing clock sources configured from ring timing on the card. For EXNET-ONE cards configured as a Single Ring Redundancy Standby, the Loop Timing fields are always disabled. Data[0] Primary Loop Timing 0x00 Not Enabled 0x01 Enabled Data[1] Reserved Data[2] Secondary Loop Timing 0x00 Not Enabled 0x01 Enabled Data[3] Reserved

SS7 cards The system does not report hardware configuration information for these cards. All bytes are 0x00.

1- 185
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

SS7 Multi-Protocol I/O card Data[0] Channel 0 Data Rate 0x00 64 Kbps 0x01 56 Kbps, for non-V.35 applications 0x80 V.35, 56 Kbps 0x81 48 Kbps, for non-V.35 applications 0xC0 V.35, 48 Kbps Data[1] Channel 0 Electrical Interface 0x00 No Timing 0x01 V.35, DTE 0x02 V.35, DCE Data[2] Data[3] Data[4] Data[5] Data[6] Data[7] Channel 1 Data Rate (same possibilities as Channel 0, above) Channel 1 Electrical Interface (same possibilities as Channel 0, above) Channel 2 Data Rate (same possibilities as Channel 0, above) Channel 2 Electrical Interface (same possibilities as Channel 0, above) Channel 3 Data Rate (same possibilities as Channel 0, above) Channel 3 Electrical Interface (same possibilities as Channel 0, above)

VDAC-ONE card Data[0] Number of VoIP Modules (1 - 4) Data[1] Number of channels supported (MSB) Data[2] Number of channels supported (LSB) Data[3] Installed VoIP Modules (Bit Field): Bit 0 VoIP Module 0 (0 = not installed, 1 = installed) Bit 1 VoIP Module 1 (0 = not installed, 1 = installed) Bit 2 VoIP Module 2 (0 = not installed, 1 = installed) Bit 3 VoIP Module 3 (0 = not installed, 1 = installed) Data[4] Module 0 state (0x05=ready, other values=not ready) Data[5] Module 1 state (0x05=ready, other values=not ready) Data[6] Module 2 state (0x05=ready, other values=not ready) Data[7] Module 2 state (0x05=ready, other values=not ready) Data[8] Port Consumption Mode 1 Reserved 2 Port-Consuming Data[9-15] Reserved (should be zero)

1- 186
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

Note that for Data 4 - 6 each module can be in one of the following states: 0x02 - Not Present, 0x05 - In Service, 0x06 - Out of Service, and 0x08 - Failed Data[4] Module 0 State Data[5] Module 1 State Data[6] Module 2 State Note that for Data 7 - 9 each module can be to one of the following IP resource profiles: 0x01 - G.711 Only (16 spans per module) 0x02 - G.711 + G.723.1 + G.729 + T.38 (8 spans per module) 0x0F - Not applicable (For example, module is not present) Data[7] Module 0 Profile Data[8] Module 1 Profile Data[9] Module 2 Profile Data[10] Port Consumption Mode 1 = Non Port-Consuming 2 = Port-Consuming Data[11-14] Refer to IPN-3 card Data[15] Reserved (Set to 0)

1- 187
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

IP Network Interface Series 2 Card Module Data[0] Total number of channels supported for the module (MSB) Data[1] Total number of channels supported for the module (LSB) Data[2] Module State Data[3] Module Profile Data[4] Bitmap of installed DSPs on a VoIP module (1 - Installed) Data[5] Bitmap of available DSPs on a VoIP module (1 - available) Data[6] Number of channels per available DSP Data[7] MII Bridge FPGA Version Data[8 - 15] Reserved (Set to 0) IP Network Interface Series 3 Card Data[0] Number of VoIP Modules (0 - 1) Data[1] Number of channels supported (MSB) Data[2] Number of channels supported (LSB) Data[3] Installed VoIP Modules (Bit Field): Bit 0 VoIP Module 0 (0 = not installed, 1 = installed) Bit 1 VoIP Module 1 (0 = not installed, 1 = installed) Data[4] Module 0 State Data[5] Module 1 State Note that for Data 4 - 5 each module can be in one of the following states: 0x02 - Not Present, 0x05 - In Service, 0x06 - Out of Service, and 0x08 - Failed Data[6] Module 0 Profile Data[7] Module 1 Profile Note that for Data 6-7 each module can be to one of the following IP resource profiles: 0x04 - G.711 Only (16 spans per module) 0x05 - LBR + T.38 (8 spans per module) 0x0F - Not applicable (For example, module is not present) Data[8] Port Consumption Mode 1 = Non Port-Consuming 2 = Port-Consuming Data[9] Main board dip switch settings (bit mask) (first value is default) Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero)

1- 188
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

Data[10] Port 0 Info (CTRL 0) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero)
IPN-3 card

Data[11] Port 1 Info (CTRL 1) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Data[12] Port 2 Info (DATA 0) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) Data[13] Port 3 Info (DATA 1) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex
...........................................................................................................................................................................................................................................................

1- 189
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero)

Data[14] Port 4 Info (DATA 2) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) Data[15] Port 5 Info (DATA 3) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) IP Network Interface Series 3 Card Module Data[0] Total number of channels supported for the module (MSB) Data[1] Total number of channels supported for the module (LSB) Data[2] Module State Data[3] Module Profile Data[4] Bitmap of installed DSPs on a VoIP module (1 - Installed) Data[5] Bitmap of available DSPs on a VoIP module (1 - available) Data[6] Number of channels per available DSP : MAC Addresses Data[0,1] Reserved Data[2-5] 1C 03 35 51 MAC Address for Ethernet Port A Data[6-9] 1C 03 35 51 MAC Address for Ethernet Port A Data[10-17] Reserved Card ID This field contains additional information about identification for the card. RAM Build Number This field indicates the application build number of the system software.

: :

1- 190
Release 8.4.1 ER3, February 2008

Card Status Query 0x0083

: :

Configuration Tag MSB, LSB The configuration tag number assigned by the Tag Configuration message. CPU Speed This field applies to cards other than CSP Matrix Series 3 Cards. If the system is reporting on a CSP Matrix Series 3 Card, this field is not included in the report. 0x00 16 Mhz 0x01 16 Mhz 0x02 20 Mhz 0x03 20 Mhz 0x04 25 Mhz 0x05 50 Mhz 0x08 66 Mhz 0x09 83 Mhz 0x0A 100 Mhz Software Reset Reason This field is reserved for Dialogic use only (it applies to cards other than matrix cards. For example, if the system is reporting on a CSP Matrix Series 3 Card, this field is not included in the report). Checksum

1- 191
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

SwitchKit Name Type Description CardStatusReport EXS API and SwitchKit API message Card Status Report 0x00A6 This message reports information about a cards status. Because this message is defined differently for different card types, some fields listed below may not apply. This message is sent to the host when the host sends the Card Status Query message or when a card is reset. Sent by Resent in EXS API Example Message for EXS API CSP This message is resent once after five (5) seconds. The following example shows a trace of a Card Status Report message for a 4span ST1LC card. Header (bytes 0-9):
fe [00 51] [00 a6] 00 06 ff [00 00]

AIB (bytes 10-14):

00 01 01 01 01

Misc. Info. (bytes 15-27):

0c 12 0f 42 09 01 04 04 01 [02 16] [08 00]

Card Information (bytes 28-61):

00 08 / 0c 02 ff ff / 0c 02 ff ff / 0c 02 ff ff / 0c 02 ff ff / 00 00 00 00 00 00 00 00 00 00 00 0000 00 00 00

Hardware Configuration (bytes 62-77):

[00 00] 00 00 00 00 00 00 00 00 00 00 00 00 00 00

Misc. Info. (bytes 78-84):

0c 00 [00 00] 02 0e cs

SwitchKit Code

C Structure
typedef struct { unsigned short Status; UBYTE AddrInfo[30]; UBYTE CardType; UBYTE CardStatus; UBYTE ConfTestRslts;

1- 192
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

UBYTE ArtRevision; UBYTE FunctRevision; UBYTE ROMMajorRevision; UBYTE ROMMinorRevision; UBYTE RAMMajorRevision; UBYTE RAMMinorRevision; unsigned short SerialNumber; unsigned short RAMSize; UBYTE CardSpecifics[384]; UBYTE HardwareConfig[16]; UBYTE CardID; UBYTE RAMBuildNum; unsigned short ConfigTag; UBYTE LineCardSpeed; UBYTE SoftwareResetReason; } XL_CardStatusReport;

C++ Class
class XLC_CardStatusReport : public XLC_InboundMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getModule() const;; void setModule(UBYTE x); UBYTE getCardType() const; void setCardType(UBYTE x); UBYTE getCardStatus() const; void setCardStatus(UBYTE x); UBYTE getConfTestRslts() const; void setConfTestRslts(UBYTE x); UBYTE getArtRevision() const; void setArtRevision(UBYTE x); UBYTE getFunctRevision() const; void setFunctRevision(UBYTE x); UBYTE getROMMajorRevision() const; void setROMMajorRevision(UBYTE x); UBYTE getROMMinorRevision() const; void setROMMinorRevision(UBYTE x); UBYTE getRAMMajorRevision() const; void setRAMMajorRevision(UBYTE x); UBYTE getRAMMinorRevision() const; void setRAMMinorRevision(UBYTE x); unsigned short getSerialNumber() const; void setSerialNumber(unsigned short x); unsigned short getRAMSize() const; void setRAMSize(unsigned short x); const UBYTE *getCardSpecifics() const; UBYTE *getCardSpecifics(); void setCardSpecifics(UBYTE *x); const UBYTE *getHardwareConfig() const; UBYTE *getHardwareConfig(); void setHardwareConfig(UBYTE *x); UBYTE getCardID() const;

1- 193
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

void setCardID(UBYTE x); UBYTE getRAMBuildNum() const; void setRAMBuildNum(UBYTE x); unsigned short getConfigTag() const; void setConfigTag(unsigned short x); UBYTE getLineCardSpeed() const; void setLineCardSpeed(UBYTE x); UBYTE getSoftwareResetReason() const; void setSoftwareResetReason(UBYTE x)

Overview of message

The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x00A6) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8, 9 : : : : : : : : : : : : : : : : : : : : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A6) Reserved (0x00) Sequence Number Logical Node ID Status MSB, LSB AIB Card Type Card Status Confidence Test Results PC Artwork Revision Functional Revision ROM Major Revision ROM Minor Revision RAM Major Revision RAM Minor Revision Serial Number MSB, LSB RAM Size MSB, LSB Card Information (Field length varies) Hardware Configuration Card ID RAM Build Number Configuration Tag MSB, LSB CPU Speed Software Reset Reason Checksum

1- 194
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

EXS API Hex FormatDetailed

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8, 9 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A6) Reserved (0x00) Sequence Number Logical Node ID Status MSB, LSB AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot : Card Type 0x00 0x01 0x03 0x0A 0x0B 0x0C 0x0E 0x13 0x14 0x15 0x16 0x17 0x18 0x19 0x1D 0x1E 0x1F 0x33 8-Span ST1LC 4-Span ST1LC MFDSP SS7 SE1LC 4-Span SE1LC 8-Span SJ1LC 4-Span ISDN PRI DASS 2 DSP-ONE T-ONE 8-Span E-ONE 8-Span T-ONE 16-Span E-ONE 16-Span J-ONE 8-Span J-ONE 16-Span DS3 Subrate Controller Byte 0 1, 2 3, 4 5 6 7 8 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x00A6) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

1- 195
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

0x42 0x50 0x54 0x60 0x61 0x65 0x6B 0x6D 0x71 0x72 0x73 0x75 0x76 0x79 0x80 0x90 0x91 0x92 0xAA 0xCA 0xCC 0xCF 0xD2 0xD5 0xD8 0xDB 0xDC 0xDD 0xDF 0xE0 0xE1 0xE2 0xE3 0xE4 0xE5 0xE8 0xF0 0xF5 0xF3 0xF6 0xF7 0xF8 0xF9 0xFA 0xFE 0xFF

EXNET Connect PCI H.100 SS7 PQ EXNET-ONE VDAC ONE VDAC VoIP Module IP Network Interface Series 2 DSP Series 2 IP Network Interface Series 2 VoIP Module SS7 Series 3 CSP 2000 Matrix I/O CSP 2000 Matrix CSP 1000 Matrix ISDN Series 3 IP Signaling Series 3 Card Virtual VDAC DSP Series 2 Plus IP Network Interface Series 3 Multi-Function Media I/O Plus Illegal I/O Multi-Function Media I/O DS3 Standby I/O VDAC I/O Virtual T1 16-span Virtual E1/J1 16-Span CCS I/O Series 3 J-ONE Redundant I/O J-ONE Standby I/O DS3 I/O CCS I/O E-ONE 75 Ohm Redundant I/O T-ONE 100 Ohm Redundant I/O E-ONE 120 Ohm Redundant I/O E-ONE 75 Ohm Standby I/O T-ONE 100 Ohm Standby I/O E-ONE 120 Ohm Standby I/O SS7 Multi-Protocol I/O Power Supply Card EXNET Ring I/O Matrix I/O Rear Fan Tray SS7 Redundant I/O Front Fan Tray ISDN Redundant I/O Midplane Dead Card: All subsequent data fields do not apply and all other bytes in the message should be ignored. Empty Slot: All subsequent data fields do not apply.

1- 196
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

Reset Reason 0 Dialogic use only 1 Power-up 2 Dialogic use only 3 Reset button pushed Card State 0 In service 1 The CSP has taken the card out of service 2 The host has taken the card out of service 3 The host has put the card in a standby state Invalid battery-backed configuration data. The host must reconfigure the card Faults are logged Faults may be obtained using a Fault Log Query message. Obtain a Fault Log and report it to Dialogic Technical Support as soon as possible. Failed confidence tests. Information about the confidence test which failed is in the Confidence Test Results field. General hardware failure The card is off-line and must be serviced. For the ISDN PRI card, see the Hardware Configuration Field for additional information.

* If the IP Network Interface Series 2 and 3 card is out of service, ignore the card state for the modules.

1- 197
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

Fan Tray Bit 0 Reserved 1 Fan 6 failed 2 Fan 5 failed 3 Fan 4 failed 4 Fan 3 failed 5 Fan 2 failed 6 Fan 1 failed 7 General hardware failure. The card is off-line and must be serviced. Power Supply Card Bit 0 Module 3 failed 1 Module 3 in tolerance 2 Module 2 failed 3 Module 2 in tolerance 4 Module 1 failed 5 Module 1 in tolerance 6 Out of Tolerance 7 General hardware failure. The card is off-line and must be serviced. DS3, E1 and T1 Redundant and Standby I/O Cards Bit 05 Reserved 6 Output Enabled 7 Relays Enabled (0=Normal, 1=Switchover) Matrix I/O Card Bit 0 Interface B link state: 0=Down, 1=Up 1 Interface A link state: 0=Down, 1=Up 2 The active Ethernet Interface: 0=Interface A. 1=Interface B : Confidence Test Results This field is bit-defined. It applies to the CSP Matrix Series 3 CardS and line cards. Bit 05 Reserved 6 Bit set indicates RAM test failure 7 Bit set indicates ROM checksum failure PC Artwork Revision An ASCII character in the range A to Z (0x410x5B) that indicates the revision level of the cards Printed Circuit Artwork. Functional Revision The cards functional revision level ROM Major Revision The major revision level of the firmware running on the card. ROM Minor Revision The minor revision level of the firmware running on the card. RAM Major Revision The major revision level of the system software running on the card. RAM Minor Revision The minor revision level of the system software running on the card.

: : : : :

1- 198
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

: :

T-ONE, E-ONE, J-ONE, DS3, ST1LC, SE1LC, VDAC-ONE, IP Network Interface Series 2 and 3, and SS7 Multi-Protocol cards The card information for these cards indicates the logical spans assigned to the card. The logical spans are indicated in the Logical Span AIB (0x0C) as shown below. The CSP uses the value 0xFF to indicate that no span has been assigned. An AIB for a 4-span line card has four address elements and the value 0x00 for the remaining bytes. An AIB for an 8-span line card has eight address elements and the value 0x00 for the remaining bytes. Data[0] Address Method (0x00, Single Entity) Data[1] Number of Address Elements (equal to number of spans) Address Element 1: Span 0 Data[2] Address Type (0x0C, Logical Span) Data[3] Data Length (0x02) Data[4] Logical Span ID, MSB Data[5] Logical Span ID, LSB Address Element N: Span N Data[...] Address Type (0x0C, Logical Span) Data[...] Data Length (0x02) Data[...] Logical Span ID, MSB Data[...] Logical Span ID, LSB

1- 199
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

1- 200
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

1- 201
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

Hardware Configuration (16 bytes) This 16-byte field describes the hardware configuration of the card specified. This field applies to only the cards described below. It also describes DIP switch positions on the cards indicated. DS3 cards Data[0] Number of Spans Supported: 0x18 24 Spans 0x1C 28 Spans Data[1] DS3 Offset Framer Status Bit 0 - DS3 Offset 0 Framer Status 0 - Out of Service 1 - In Service (default) Bit [1-7] Reserved Data [2-13] Reserved Data[14] Data[15] Hardware Switch 1 Settings (also refer to the Hardware Product Descriptions) (the right-most bit is dip 1) Total Available Spans

1- 202
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

T-ONE, E-ONE, J-ONE cards Data 03 informs the host of primary and secondary loop timing clock sources configured on the card Data[0] Primary Loop Timing 0 Not Enabled 1 Enabled Data[1] If Primary Loop Timing is enabled, this field contains the span offset of the span for which it is enabled. Data[2] Secondary Loop Timing 0 Not enabled 1 Enabled Data[3] If Secondary Loop Timing is enabled, this field contains the span offset of the span for which it is enabled. Data[413] Reserved Data[14] Hardware Switch 1 Settings (also refer to the Hardware Product Descriptions) (the right-most bit is dip 1) Data[15] Total Available Spans

1- 203
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

DSP Series 2 and DSP Series 2 Plus Cards This field informs the host of the number and types of DSP Modules installed on the card. Data[0] Number of Modules installed on the card Data[1] Reserved Data[2] Module 0 Type 0x6C DSP 2 Module 0x03 No Module installed Data[3] Module 1 Type 0x6C DSP 2 Module 0x03 No Module installed Data[4, 5] Reserved Data 6-13: DSP Chip States 0x00 In Service 0x01 Out of Service (or No Module Installed) Data[6] Module 0 / Chip 0 State Data[7] Module 0 / Chip 1 State Data[8] Module 0 / Chip 2 State Data[9] Module 0 / Chip 3 State Data[10] Module 1 / Chip 0 State Data[11] Module 1 / Chip 1 State Data[12] Module 1 / Chip 2 State Data[13] Module 1 / Chip 3 State Data[14] Main Board DIP Switch S1Settings (Bit Field) Bit 0 Debug 1 Mode (ON=Disabled; OFF= Enabled Bit 1 Reserved (ON) Bit 2 Debug 2 Mode (ON=Disabled; OFF= Enabled Bit 3 Ethernet Link Mode (ON=Auto-Negotiate; OFF= Force 100 Mbps/ Full Duplex Bit 4 Reserved (ON) Bit 5 Reserved (ON) Bit 6 Reserved (ON) Bit 7 Reserved (ON) Note: Each Bit maps to the physical DIP switch positions (Bit 0 to Position 1 - Bit 7 to Position 8 Note: Default setttings are ON position Data[15] Reserved

1- 204
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

CSP Matrix Series 3 Card Data[0] Main Board DIP Switch S1Settings (Bit Field) Bit 0 Print to Terminal (ON=Disabled; OFF= Enabled Bit 1 Reserved (ON) Bit 2 System Software/Probe (ON=Enables System Software; OFF Enables Probe Bit 3 CSP Call Control/Services (ON=Call Control Call Processing Enabled; OFF=Services Call processing Enabled) Bit 4 Reserved (ON) Bit 5 Reserved (ON); OFF=API Bit 6 Using Second Ethernet Port (ON=At startup, Ethernet Port 1 (ETH1) is only used; OFF=At startup, both Ethernet Ports (ETH1 and ETH2) can be used. Bit 7 No Static IP Address (ON=If RARP and BOOTP can not obtain an IP address, the static IP address is used; OFF=If RARP and BOOTP can not obtain an IP address, the static IP address is not used) Note: Each Bit maps to the physical DIP switch positions (Bit 0 to Position - Bit 7 to Position 8 Note: Default setttings are ON position, except Bit 5 which is OFF Data[1] Main Board DIP Switch S2Settings (Bit Field) Bit 0 Ethernet Link Mode (ON= Force 100 Mbps/Full Duplex; OFF=Auto-Negotiate) Bit 1 Reserved (OFF) Bit 2 Reserved (OFF) Bit 3 Reserved (OFF) Bit 4 Reserved (OFF) Bit 5 Reserved (OFF) Bit 6 Reserved (OFF) Bit 7 Reserved (OFF) Note: Each Bit maps to the physical DIP switch positions (Bit 0 to Position 1 - Bit 7 to Position 8 Note: Default setttings are OFF position IP Signaling Series 3 Card Data[0] Main Board DIP Switch SW1Settings (Bit Field) Bit 0 Debug 1 Mode (ON=Disabled; OFF= Enabled Bit 1 Monitor Port (ON= Monitor Port setting is 19200 baud and is and not selectable; OFF=Reserved Bit 2 Debug 2 Mode (ON=Disabled; OFF= Enabled) Bit 3 Ethernet Link Mode (ON=Auto-Negotiate; OFF= Force 100 Mbps/ Full Duplex Bit 4 Layer 5 (ON=Disabled; OFF= Enabled) Bit 5 Reserved (ON); API Bit 6 Reserved (ON) Bit 7 No Static IP Address (ON=If RARP and BOOTP can not obtain an IP address, the static IP address is used; OFF=If RARP and BOOTP can not obtain an IP address, the static IP address is not used) Note: Each Bit maps to the physical DIP switch positions (Bit 0 to Position 1 - Bit 7 to Position 8 Note: Default setttings are ON position, except Bit 5 which is OFF

1- 205
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

SS7 Series 3 Card Data[0] Main Board DIP Switch SW1Settings (Bit Field) Bit 0 Debug 1 Mode (ON=Disabled; OFF= Enabled Bit 1 Monitor Port (ON/OFF= Monitor Port setting is 19200 baud) Bit 2 Debug 2 Mode (ON=Disabled; OFF= Enabled) Bit 3 Reserved (ON) Bit 4 Reserved (ON) Bit 5 Reserved (ON) Bit 6 Reserved (ON) Bit 7 Reserved (ON) Note: Each Bit maps to the physical DIP switch positions (Bit 0 to Position 1 - Bit 7 to Position 8 Note: Default setttings are ON position ISDN Series 3 Card Data[0] Main Board DIP Switch SW1Settings (Bit Field) Bit 0 Debug 1 Mode (ON=Disabled; OFF= Enabled Bit 1 Monitor Port (ON/OFF= Monitor Port setting is 19200 baud) Bit 2 Debug 2 Mode (ON=Disabled; OFF= Enabled) Bit 3 Reserved (ON) Bit 4 Reserved (ON) Bit 5 Reserved (ON) Bit 6 Reserved (ON) Bit 7 Reserved (ON) Note: Each Bit maps to the physical DIP switch positions (Bit 0 to Position 1 - Bit 7 to Position 8 Note: Default setttings are ON position

EXNET-ONE card Data[03]Informs host of primary and secondary loop timing clock sources configured from ring timing on the card. For EXNET-ONE cards configured as a Single Ring Redundancy Standby, the Loop Timing fields are always disabled. Data[0] Primary Loop Timing 0x00 Not Enabled 0x01 Enabled Data[1] Reserved Data[2] Secondary Loop Timing 0x00 Not Enabled 0x01 Enabled Data[3] Reserved

SS7 cards The system does not report hardware configuration information for these cards. All bytes are 0x00.

1- 206
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

SS7 Multi-Protocol I/O card Data[0] Channel 0 Data Rate 0x00 64 Kbps 0x01 56 Kbps, for non-V.35 applications 0x80 V.35, 56 Kbps 0x81 48 Kbps, for non-V.35 applications 0xC0 V.35, 48 Kbps Data[1] Channel 0 Electrical Interface 0x00 V.35, DTE 0x01 V.35, DCE Data[2] Data[3] Data[4] Data[5] Data[6] Data[7] Channel 1 Data Rate (same possibilities as Channel 0, above) Channel 1 Electrical Interface (same possibilities as Channel 0, above) Channel 2 Data Rate (same possibilities as Channel 0, above) Channel 2 Electrical Interface (same possibilities as Channel 0, above) Channel 3 Data Rate (same possibilities as Channel 0, above) Channel 3 Electrical Interface (same possibilities as Channel 0, above)

1- 207
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

VDAC VoIP Module Data[0] Total number of channels supported on the module Data[1] Number of channels supported for DSP 0 Data[2] Number of channels supported for DSP 1 Data[3] Number of channels supported for DSP 2 Data[4] Number of channels supported for DSP 3 Data[5] Number of channels supported for DSP 4 Data[6] Number of channels supported for DSP 5 Data[7] Number of channels supported for DSP 6 Data[8] Number of channels supported for DSP 7 Data[9-15]Reserved (should be zero) IP Network Interface Series 2 card Data[0] Number of VoIP Modules (0 - 2) Data[1] Number of channels supported (MSB) Data[2] Number of channels supported (LSB) Data[3] Installed VoIP Modules (Bit Field): Bit 0 VoIP Module 0 (0 = not installed, 1 = installed) Bit 1 VoIP Module 1 (0 = not installed, 1 = installed) Bit 2 VoIP Module 2 (0 = not installed, 1 = installed) Note that for Data 4 - 6 each module can be in one of the following states: 0x02 - Not Present, 0x05 - In Service, 0x06 - Out of Service, and 0x08 - Failed Data[4] Module 0 State Data[5] Module 1 State Data[6] Module 2 State Note that for Data 7 - 9, each module can be for one of the following IP resource profiles: 0x01 - G.711 Only (16 spans per module) 0x02 - G.711 + G.723.1 + G.729 + T.38 (8 spans per module) 0x0F - Not applicable (For example, module is not present) Data[7] Module 0 Profile Data[8] Module 1 Profile Data[9] Module 2 Profile Data[10] Port Consumption Mode 1 = Non Port-Consuming 2 = Port-Consuming Data [11-14] Refer to IPN-3 card Data[15] Reserved (Set to 0) IP Network Interface Series 2 card Module Data[0] Total number of channels supported for the module (MSB) Data[1] Total number of channels supported for the module (LSB) Data[2] Module State Data[3] Module Profile Data[4] Bitmap of installed DSPs on a VoIP module (1 - Installed) Data[5] Bitmap of available DSPs on a VoIP module (1 - available) Data[6] Number of channels per available DSP Data[7] MII Bridge FPGA Version Data[8 - 15] Reserved (Set to 0)
...........................................................................................................................................................................................................................................................

1- 208
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

IP Network Interface Series 3 Card Data[0] Number of VoIP Modules (0 - 1) Data[1] Number of channels supported (MSB) Data[2] Number of channels supported (LSB) Data[3] Installed VoIP Modules (Bit Field): Bit 0 VoIP Module 0 (0 = not installed, 1 = installed) Bit 1 VoIP Module 1 (0 = not installed, 1 = installed) Data[4] Module 0 State Data[5] Module 1 State Note that for Data 4 - 5 each module can be in one of the following states: 0x02 - Not Present, 0x05 - In Service, 0x06 - Out of Service, and 0x08 - Failed Data[6] Module 0 Profile Data[7] Module 1 Profile Note that for Data 6-7 each module can be to one of the following IP resource profiles: 0x04 - G.711 Only (16 spans per module) 0x05 - LBR + T.38 (8 spans per module) 0x0F - Not applicable (For example, module is not present) Data[8] Port Consumption Mode 1 = Non Port-Consuming 2 = Port-Consuming Data[9] Main board dip switch settings (bit mask) (first value is default) Data[10] Port 0 Info (CTRL 0) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero)
IPN-3 card

Data[11] Port 1 Info (CTRL 1) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps ........................................................................................................................................................................................................................................................... Bits [4-7] Reserved (should be zero)

1- 209
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

Data[12] Port 2 Info (DATA 0) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) Data[13] Port 3 Info (DATA 1) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) Data[14] Port 4 Info (DATA 2) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero) Data[15] Port 5 Info (DATA 3) Bit 0 Ethernet Link Status 0 = Ethernet link down 1 = Ethernet link up Bit 1 Duplex Type 0 = Half Duplex 1 = Full Duplex Bit 2-3 Speed 0 0 = 10Mbps 0 1 = 100Mbps 1 0 = 1000Mbps Bits [4-7] Reserved (should be zero)

1- 210
Release 8.4.1 ER3, February 2008

Card Status Report 0x00A6

IP Network Interface Series 3 Card Module Data[0] Total number of channels supported for the module (MSB) Data[1] Total number of channels supported for the module (LSB) Data[2] Module State Data[3] Module Profile Data[4] Bitmap of installed DSPs on a VoIP module (1 - Installed) Data[5] Bitmap of available DSPs on a VoIP module (1 - available) Data[6] Number of channels per available DSP : MAC Addresses Data[0,1] Reserved Data[2-5] 1C 03 35 51 MAC Address for Ethernet Port A Data[6-9] 1C 03 35 51 MAC Address for Ethernet Port A Data[10-17] Reserved Card ID This field contains additional information about identification for the card. RAM Build Number This field indicates the application build number of the system software. Configuration Tag MSB, LSB The configuration tag number assigned by the Tag Configuration message. CPU Speed This field applies to cards other than CSP Matrix Series 3 Cards. If the system is reporting on a CSP Matrix Series 3 Card, this field is not included in the report. 0x00 16 Mhz 0x01 16 Mhz 0x02 20 Mhz 0x03 20 Mhz 0x04 25 Mhz 0x05 50 Mhz 0x08 66 Mhz 0x09 83 Mhz 0x0A 100 Mhz Software Reset Reason This field is reserved for Dialogic use only (it applies to cards other than matrix cards. For example, if the system is reporting on a CSP Matrix Series 3 Card, this field is not included in the report). Checksum

: : : :

1- 211
Release 8.4.1 ER3, February 2008

CCS Redundancy Configure 0x005B

SwitchKit Name Type Description CCSRedundancyConfig EXS API and SwitchKit API message CCS Redundancy Configure 0x005B This message configures a chassis for common channel signaling (CCS) redundancy. When the system is successfully configured, all configuration and call processing is mirrored on the secondary card. If the primary card fails, the secondary card resumes call processing where the primary left off. You enter the slot number of the primary and secondary SS7 or ISDN cards (using an AIB), and a configuration option to suspend synchronization or to not suspend synchronization. Related Message CCS Redundancy Report 0x0073 (CCSRedundancyReport)

CAUTION
Dialogic strongly recommends sending this message during minimal call processing loads only. Replicating database and call processing information entails heavy processor bandwidth, which affects call processing performance and throughput.
Sent by SwitchKit Code Host Configuration
CCSRedundancyConfig ( Node = integer, PrimaryCard = integer, SecondaryCard = integer, RedundancyType = integer);

C Structure
typedef struct { UBYTE PrimaryCard; UBYTE SecondaryCard; UBYTE RedundancyType; } XL_CCSRedundancyConfig;

C++ Class
class XLC_CCSRedundancyConfig : public XLC_OutboundMessage { public: UBYTE getPrimaryCard() const; void setPrimaryCard(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 212
Release 8.4.1 ER3, February 2008

CCS Redundancy Configure 0x005B

UBYTE getSecondaryCard() const; void setSecondaryCard(UBYTE x); UBYTE getRedundancyType() const; void setRedundancyType(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Description Frame (0xFE) Length (0x00NN) Message Type (0x005B) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1, 2 3, 4 5 6 7 8, 9 10 : AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x01 Slot (Primary Card) Enter the physical slot number of a non-redundant card or the primary card in a redundant pair. 0x01 Slot (Secondary Card) Enter the physical slot number of the secondary card in a redundant pair. If you define this value as 0xFF, the system cancels redundancy and resets the system to recognize the primary card as if it were a single card configuration. For a non-redundant card, this field must be 0xFF. : Options 0x00 Do Not Suspend Synchronization (Default) 0x01 Suspend Synchronization Checksum RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x005B) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

1- 213
Release 8.4.1 ER3, February 2008

CCS Redundancy Query 0x006C

SwitchKit Name Type Description CCSRedundancyQuery EXS API and SwitchKit API message CCS Redundancy Query 0x006C Use this message to query the redundancy status (primary or secondary) of common channel signaling (CCS) cards installed in the system. If a redundant pair of cards is installed, the status of both cards is reported. Related Messages CCS Redundancy Configure 0x0073 (CCSRedundancyConfig) CCS Redundancy Report 0x005B (CCSRedundancyReport)

Sent by SwitchKit Code

Host C Structure
typedef struct { UBYTE Slot; } XL_CCSRedundancyQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE PrimaryCard; UBYTE SecondaryCard; UBYTE ActiveCard; UBYTE RedundancyStatus; UBYTE RedundancyType; } XL_CCSRedundancyQueryAck;

C++ Class
class XLC_CCSRedundancyQuery : public XLC_OutboundMessage { public: UBYTE getSlot() const; void setSlot(UBYTE x); };

C++ Class Response

class XLC_CCSRedundancyQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); UBYTE getPrimaryCard() const; void setPrimaryCard(UBYTE x); UBYTE getSecondaryCard() const; void setSecondaryCard(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 214
Release 8.4.1 ER3, February 2008

CCS Redundancy Query 0x006C

UBYTE getActiveCard() const; void setActiveCard(UBYTE x); UBYTE getRedundancyStatus() const; void setRedundancyStatus(UBYTE x); UBYTE getRedundancyType() const; void setRedundancyType(UBYTE x); UBYTE getReserved() const; void setReserved(UBYTE x); };

1- 215
Release 8.4.1 ER3, February 2008

CCS Redundancy Query 0x006C

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x006C) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot : : Checksum Response continued below. AIB Address Method 0x00 - Individual AEs Number of AEs to follow Byte 0 1 2 0 1 2 0 1 2 AE Field Address Type Data Length Data[0] Address Type Data Length Data[0] Address Type Data Length Data[0] Description (0x01) (0x01) Slot of Primary Card (0x01) (0x01) Slot of Secondary Card (0x01) (0x01) Slot of Active Card Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x006C) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 216
Release 8.4.1 ER3, February 2008

CCS Redundancy Query 0x006C

Redundancy Status 0x01 Synchronizing (Primary Receive From Matrix (RFM)) 0x02 Synchronizing (Primary Send To Matrix (STM)) 0x03 Both Cards Active (Primary RFM) 0x04 Both Cards Active (Primary STM) 0x05 Redundancy is being disabled 0x14 Primary Card Reset 0x15 Secondary Card Reset 0x16 Double Reset 0x17 Wait for Secondary Query 0x18 Wait for Primary Query 0x19 Wait for Primary Recovery 0x1A Wait for Primary Alive 0x1B Secondary Card Reset 0x1C Double Reset 0x1D Wait for Secondary Query 0x1E Wait for Primary Query 0x20 Primary card is out-of-service 0x21 Wait for Secondary Recovery 0x22 Wait for Secondary Alive 0x23 Timer expired while waiting for synchronization 0x24 Redundancy disabled by the host 0x31 Dual internal redundancy failure. (Redundancy disabled. Card synchronizing while links & CICs being deconfigured) Reserved (0x00) Reserved (0x00) Checksum

: : :

1- 217
Release 8.4.1 ER3, February 2008

CCS Redundancy Report 0x0073

SwitchKit Name Type Description CCSRedundancyReport EXS API and SwitchKit API message CCS Redundancy Report 0x0073 This message informs the host that either a pair of common channel signaling (CCS) cards is available or a switchover is occurring in the system. This is initiated by the CSP redundancy manager on a redundancy state change. Related Messages CCS Redundancy Configure 0x005B (CCSRedundancyConfig) CCS Redundancy Query 0x006C (CCSRedundancyQuery)

Sent by SwitchKit Code

CSP C Structure
typedef struct { UBYTE PrimaryCard; UBYTE SecondaryCard; UBYTE ActiveCard; UBYTE RedundancyStatus; UBYTE RedundancyType; } XL_CCSRedundancyReport;

C++ Class
class XLC_CCSRedundancyReport : public XLC_InboundMessage { public: UBYTE getPrimaryCard() const; void setPrimaryCard(UBYTE x); UBYTE getSecondaryCard() const; void setSecondaryCard(UBYTE x); UBYTE getActiveCard() const; void setActiveCard(UBYTE x); UBYTE getRedundancyStatus() const; void setRedundancyStatus(UBYTE x); UBYTE getRedundancyType() const; void setRedundancyType(UBYTE x); UBYTE getReserved() const; void setReserved(UBYTE x); };

1- 218
Release 8.4.1 ER3, February 2008

CCS Redundancy Report 0x0073

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0073) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs 0x03 AEs 0x01 Slot (Primary Card) The physical slot number of either the primary or secondary SS7 or ISDN card. The value 0xFF indicates that a primary card is not in-service. 0x01 Slot (Secondary Card) The physical slot number of the secondary SS7 or ISDN card. The value 0xFF indicates that a secondary card is not in service. 0x01 Slot (Active Card) Slot number of the currently active SS7 or ISDN PRI card. Byte 0 1, 2 3, 4 5 6 7 8 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x0073) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

1- 219
Release 8.4.1 ER3, February 2008

CCS Redundancy Report 0x0073

Redundancy Status 0x01 Synchronizing (Primary Receive From Matrix (RFM)) 0x02 Synchronizing (Primary Send To Matrix (STM)) 0x03 Both Cards Active (Primary RFM) 0x04 Both Cards Active (Primary STM) 0x19 Double reset, primary recovery in progress 0x1A Primary recovery failed, redundancy deconfigured 0x1B Double reset, secondary recovery in progress 0x1C Secondary recovery failed, redundancy deconfigured 0x20* Primary card is out-of-service 0x21* Secondary card is out-of-service 0x22* Redundant I/O card is removed 0x23* Timer expired while waiting for synchronization 0x24* Redundancy disabled by the host 0x25* Primary card reset during synchronization 0x26* Secondary card reset during synchronization 0x27* Primary card detected link failure during synchronization state (1 or 2) 0x28* Secondary card detected link failure during synchronization state (1 or 2) 0x29 Primary card detected link failure to mate while in stable state (3 or 4) 0x30 Secondary card detected link failure to mate while in stable state (3 or 4) 0x31* Dual internal redundancy failure (card synchronizing while links and CICs are being deconfigured) 0x40 Primary CCS I/O card is out-of-service 0x41 Secondary CCSI/O is out-of-service * Redundancy is disabled Reserved (0x00) 0x01 Slot (Primary Card) The physical slot number of either the primary or secondary SS7 or ISDN card. Checksum

: : :

1- 220
Release 8.4.1 ER3, February 2008

Channel Connection Status Query 0x0001

SwitchKit Name Type Description ChannelConnectionStatusQuery EXS API and SwitchKit API message Channel Connection Status Query 0x0001 Use this message to retrieve a channels connection status. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_ChannelConnectionStatusQuery;

C Structure Response
typedef struct { unsigned short Status; unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; UBYTE ChannelAState; } XL_ChannelConnectionStatusQueryAck;

C++ Class
class XLC_ChannelConnectionStatusQuery : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

C++ Class Response

class XLC_ChannelConnectionStatusQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const; void setChannelB(UBYTE x); UBYTE getChannelAState() const; void setChannelAState(UBYTE x); }; ...........................................................................................................................................................................................................................................................

1- 221
Release 8.4.1 ER3, February 2008

Channel Connection Status Query 0x0001 EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (MSB, LSB) 0x00NN Message Type (0x0001) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel A 0x0D Channel B : Checksum Response continued below. : Channel A State This field indicates the call processing state for Layer 4: If the preceding Status field is a positive acknowledgement, this field does not apply. 0x00 0x03 0x04 0x05 0x07 0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x10 0x11 0x12 0x13 0x14 Out-of-service Idle Host Connect Wait Outseize ACK Network Wait Answered/connected Layer 4 Release Wait Network Release Wait Busied Out Externally Outseized Hold Acknowledge Wait Layer 3 Answer Wait Layer 4 Answer Wait Layer 4 Recall Wait Purge Response Wait Purge Wait Park Layer 4 Connection Clear Wait : Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (MSB, LSB) 0x00NN Message Type (0x0001) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x0010 Logical Span ID A, Channel A is connected to Logical Span ID B, Channel B. 0x0015 Logical Span ID A, Channel A is not connected. AIB Same as message

Checksum

1- 222
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

SwitchKit Name Type Description ChannelParameterQuery EXS API and SwitchKit API message Channel Parameter Query 0x0080 This message is used to query signaling timers and filters and configuration for Channel Associated Signaling (CAS) channels. The message response is formatted differently depending on the trunk type of the channel. PPL Format: E-ONE, T-ONE, SE1LC cards Non-PPL: T-ONE or ST1LC card using non-PPL format. This message handles all DS3 functionality, including enabling and disabling loop back configuration and loop back queries. You must specify the slot number and the DS3 offset. You must take a DS3 span out of service before you can place it into remote loop back. Do not use this message for Common Channel Signaling (CCS) channels. For ISDN, use the B Channel Query message. For SS7, use the SS7 CIC Query message. NOTE: The message format to query PPL channels includes a Response Format field. For backward compatibility, if no value is present, the response will be in non-PPL format.

Sent by SwitchKit Code

Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_ChannelParameterQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE TrunkType; UBYTE Data[235]; } XL_ChannelParameterQueryAck;

C++ Class
class XLC_ChannelParameterQuery : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); ........................................................................................................................................................................................................................................................... 1- 223
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

};

C++ Class Response

class XLC_ChannelParameterQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); UBYTE getTrunkType() const; void setTrunkType(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

Overview of message

The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 11 Frame (0xFE) Length (0x005B) Message Type (0x0080) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Trunk Type Host Service State Field Description

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : : : 12 13 14 15 16 17 1837 38, 39 40, 41 42, 43 44, 45 46, 47 48, 49 50, 51 52, 53 54, 55 56, 57 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0080) Reserved (0x00) Sequence Number Logical Node ID AIB Response Format Checksum Response continued below. Reserved Transmit Idle Signaling Transmit Out of Service Signaling Busy Out Enable Distant End Release Mode Answer Supervision Mode PPL Protocol Name R2 Timer 1 R2 Timer 2 R2 Timer 3 R2 Timer 4 DTMF Timer 1 DTMF Timer 2 DTMF Timer 3 DTMF Timer 4 DTMF Timer 5 DTMF Timer 6

1- 224
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

58, 59 60, 61 62, 63 64, 65 66, 67 68, 69 70, 71 72, 73 74, 75 76, 77 78, 79 80, 81 82, 83 84, 85 86, 87 88, 89 90, 91 92 93 94

MFR1 Timer 1 MFR1 Timer 2 MFR1 Timer 3 MFR1 Timer 4 MFR1 Timer 5 MFR1 Timer 6 MFR1 Timer 7 MFR1 Timer 8 DP Timer 1 DP Timer 2 DP Timer 3 DP Timer 4 DP Timer 5 DP Timer 6 DP Timer 7 DP Timer 8 DP Timer 9 Local End Release Mode PCM Encoding Format Checksum

EXS API Hex FormatDetailed

PPL Format The table below lists the message and response formats to query channels on an E-ONE, SE1LC, or T-ONE card with PPL format.
RESPONSE (Gray) Byte 0 1 2 3 4 5 6 7 Frame (0xFE) Length, MSB (0x00) Length, LSB (0x5B) Message Type, MSB (0x00) Message Type, LSB (0x80) Reserved (0x00) Same Sequence Number Logical Node ID Field Description

MESSAGE (White) Byte 0 1 2 3 4 5 6 7 Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0x80) Reserved (0x00) Sequence Number Logical Node ID

1- 225
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

AIB Address Method 0x00 - Individual AEs

8, 9

Status MSB, LSB

Number of AEs to follow AEs 0x0D Channel : Response Format The desired format of the response data from the CSP. NOTE: If no value is entered in this field, the response will be in non-PPL format. 0x00 PPL (T-ONE, E-ONE, SE1LC cards) : Checksum 11 Host Service State 0x00 Out of Service 0x01 In Service 10 Trunk Type 0x09 PPL

Response continued below. 12 13 14 15 Reserved Transmit Idle Signaling Transmit Out of Service Signaling Busy Out Enable 0x00 Busy Out disabled on this trunk 0x01 Busy Out enabled on this trunk Distant End Release Mode 0x01 Park 0x02 Release Answer Supervision Mode 0x00 Propagate Answer To The Distant End 0x01 Notify Host Of Answer 0x02 Propagate Answer To The Distant End And Notify Host Of Answer 0x03 No Answer Supervision (no propagation of answer or notification) PPL Protocol Name R2 Timer 1 R2 Timer 2 R2 Timer 3 R2 Timer 4 DTMF Timer 1 DTMF Timer 2 DTMF Timer 3 DTMF Timer 4 DTMF Timer 5 DTMF Timer 6 MFR1 Timer 1 MFR1 Timer 2 MFR1 Timer 3

1837 38, 39 40, 41 42, 43 44, 45 46, 47 48, 49 50, 51 52, 53 54, 55 56, 57 58, 59 60, 61 62, 63

1- 226
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

64, 65 66, 67 68, 69 70, 71 72, 73 74, 75 76, 77 78, 79 80, 81 82, 83 84, 85 86, 87 88, 89 90, 91 92

MFR1 Timer 4 MFR1 Timer 5 MFR1 Timer 6 MFR1 Timer 7 MFR1 Timer 8 DP Timer 1 DP Timer 2 DP Timer 3 DP Timer 4 DP Timer 5 DP Timer 6 DP Timer 7 DP Timer 8 DP Timer 9 Local End Release Mode 0x01 Park 0x02 Release PCM Encoding Format 0x01 -law Encoding 0x02 A-law Encoding Checksum

EXS API Hex Format Detailed

Non-PPL Format The following is the message and response format for non-PPL channels (ST1LC card or T-ONE card using non-PPL channels).
RESPONSE (Gray) Byte 0 1 2 3 4 5 6 7 8, 9 Frame (0xFE) Length, MSB (0x00) Length, LSB (0xF4) Message Type, MSB (0x00) Message Type, LSB (0x80) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Field Description

MESSAGE (White) Byte 0 1 2 3 4 5 6 7 8 : Field Description Frame (0xFE) Length, MSB Length, LSB (N) Message Type, MSB (0x00) Message Type, LSB (0x80) Reserved (0x00) Sequence Number Logical Node ID AIB 0x0D Channel Checksum Response continued below.

1- 227
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

Trunk Type 0x01 E&M 0x02 FXO Loop Start 0x03 FXS Loop Start 0x04 FXO Ground Start 0x05 FXS Ground Start 0x06 DPO 0x07 DPT 0x08 Reserved 0x0A DID Flash Timing Status 0x00 Flash Timing OFF 0x01 Flash Timing ON, propagate to distant end 0x02 Flash Timing ON, inform host 0x03 Flash Timing ON, inform host and propagate Current Layer 3 State Host Service State 0x00 Out of Service 0x01 In Service Preseize Inseize Modified Incoming Release Modified Outgoing Release Normal Incoming Release Normal Incoming Release with Flash Normal Outgoing Release Normal Outgoing Release with Flash Post Inseize Acknowledge Outseize Acknowledge Outseize Answer Outseize Dial Signal End First Release ANI Request Off-hook Inseize Complete Post Inseize Complete Start Normal Outgoing Release Start Normal Incoming Release Outseize Acknowledge Outseize Answer Guard Timeout Release Glare Detection Minimum Flash Maximum Flash Start Dial Minimum Wink Start Dial Maximum Wink

12 13

Signal Scanning Filters 14, 15 16, 17 18, 19 20, 21 22, 23 24, 25 26, 27 28, 29 30, 31 32, 33 34, 35 36, 37 38, 39 40, 41 42, 43 44, 45 46, 47 48, 49 50, 51 52, 53 54, 55 56, 57 58, 59 60, 61 62, 63 64, 65 66, 67

Signal Scanning Timers

1- 228
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

68, 69 70, 71 72, 73 74, 75 76, 77 78, 79 80, 81 82, 83 84, 85 86, 87 88, 89 90, 91 92, 93 94, 95 96, 97 98, 99

Minimum Delay Dial Signal Maximum Delay Dial Signal Post Start Dial Signal Outpulse Delay Wink 2 Min. Receive Duration Wink 2 Max. Receive Duration Wink 2 Min. Post Outpulse Delay Wink 2 Max. Post Outpulse Delay Wink 2 Max. Receive Detection Wink 3 Min. Receive Duration Wink 3 Max. Receive Duration Wink 3 Min. Post Outpulse Delay Wink 3 Max. Post Outpulse Delay Wink 3 Max. Receive Detection Wink 4 Min. Receive Duration Wink 4 Max. Receive Duration Wink 4 Min. Post Outpulse Delay

100, 101 Wink 4 Max. Post Outpulse Delay 102, 103 Wink 4 Max. Receive Detection 104, 105 Wink 5 Min. Receive Duration 106, 107 Wink 5 Max. Receive Duration 108, 109 Wink 5 Min. Post Outpulse Delay 110, 111 Wink 5 Max. Post Outpulse Delay 112, 113 Wink 5 Max. Receive Detection 114, 115 Wink 6 Min. Receive Duration 116, 117 Wink 6 Max. Receive Duration 118, 119 Wink 6 Min. Post Outpulse Delay 120, 121 Wink 6 Max. Post Outpulse Delay 122, 123 Wink 6 Max. Receive Detection 124, 125 Wink 7 Min. Receive Duration 126, 127 Wink 7 Max. Receive Duration 128, 129 Wink 7 Min. Post Outpulse Delay 130, 131 Wink 7 Max. Post Outpulse Delay 132, 133 Wink 7 Max. Receive Detection 134, 135 Wink 8 Min. Receive Duration 136, 137 Wink 8 Max. Receive Duration 138, 139 Wink 8 Min. Post Outpulse Delay 140, 141 Wink 8 Max. Post Outpulse Delay 142, 143 Wink 8 Max. Receive Detection 144, 145 Post ANI Off-Hook Outpulse Delay 146, 147 Max. Receive ANI Off-Hook Request Detection 148, 149 Max. Receive Dialtone Detection 150, 151 MFR1 Min. Receive KP Duration 152, 153 MFR1 Min. Receive Digit Duration 154, 155 MFR1 Max. Receive KP Detection 156, 157 MFR1 Min. Receive Interdigit Duration 158, 159 MFR1 Max. Receive Interdigit Duration
...........................................................................................................................................................................................................................................................

1- 229
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

160, 161 DTMF Max. Receive 1st Digit Detection 162, 163 DTMF Min. Receive 1st Digit Detection 164, 165 DTMF Min. Receive Interdigit Duration 166, 167 DTMF Max. Receive Interdigit Duration Transmit Signal Timers 168, 169 Wink Duration 170, 171 Flash Duration 172, 173 Primary Outseize Signaling 174, 175 Outseize Signaling 176, 177 Delay Dial Signal Start 178, 179 Fixed Pause 180, 181 Timed Answer 182, 183 Ringing On Duration 184, 185 Ringing Off Duration 186, 187 Wink 1 Min. Transmit Delay 188, 189 Wink 2 Min. Transmit Delay 190, 191 Wink 2 Max. Transmit Delay 192, 193 Wink 2 Transmit Duration 194, 195 Wink 3 Min. Transmit Delay 196, 197 Wink 3 Max. Transmit Delay 198, 199 Wink 3 Transmit Duration 200, 201 Wink 4 Min. Transmit Delay 202, 203 Wink 4 Max. Transmit Delay 204, 205 Wink 4 Transmit Duration 206, 207 Wink 5 Min. Transmit Delay 208, 209 Wink 5 Max. Transmit Delay 210, 211 Wink 5 Transmit Duration 212, 213 Wink 6 Min. Transmit Delay 214, 215 Wink 6 Max. Transmit Delay 216, 217 Wink 6 Transmit Duration 218, 219 Wink 7 Min. Transmit Delay 220, 221 Wink 7 Max. Transmit Delay 222, 223 Wink 7 Transmit Duration 224, 225 Wink 8 Min. Transmit Delay 226, 227 Wink 8 Max. Transmit Delay 228, 229 Wink 8 Transmit Duration 230, 231 MFR1 Transmit KP Duration 232, 233 MFR1 Transmit Digit Duration 234, 235 MFR1 Transmit Interdigit Duration 236, 237 DTMF Transmit Digit Duration 238, 239 DTMF Transmit Interdigit Duration Channel Configuration

1- 230
Release 8.4.1 ER3, February 2008

Channel Parameter Query 0x0080

240

Incoming Start Dial Type 0x00 Not Configured or Invalid for Trunk Type 0x01 Wink Start 0x02 Delay Dial 0x03 Immediate 0x04 Dial Tone Outgoing Start Dial Type 0x00 Not Configured or Invalid for Trunk Type 0x01 Wink Start 0x02 Delay Dial 0x03 Fixed Pause 0x04 Dial Tone Busy Out Flag 0x00 Busy Out disabled on this trunk 0x01 Busy Out enabled on this trunk Distant End Release Mode 0x01 Park 0x02 Release Answer Supervision Mode 0x00 Propagate Answer To The Distant End 0x01 Notify Host Of Answer 0x02 Propagate Answer To The Distant End And Notify Host Of Answer 0x03 No Answer Supervision (no propagation of answer or notification) Local End Release Mode 0x01 Park 0x02 Release PCM Encoding Format 0x01 -law Encoding 0x02 A-law Encoding Checksum

241

242

243

244

245

246

247

1- 231
Release 8.4.1 ER3, February 2008

Channel Release Request 0x0037

SwitchKit Name Type Description ChannelReleaseRequest EXS API and SwitchKit API message Channel Release Request 0x0037 The conditions in which the CSP uses this message depends on the protocol you are using. SS7 An SS7 channel reports this message to the host if both of the following conditions exist: The SS7 channel is connected to a channel that is released The release modes for the channels call for the SS7 channel to be released This lets the host insert parameters for the outgoing ISUP REL using the Release Channel With Data message. If no data is to be inserted, the host may use the Release Channel message. The CSP sends this message to the host upon a network-initiated ISDN Disconnect message if the ISUP mode configuration is set to allow release upon a disconnect. The host responds with either a Release Channel message or a Release Channel With Data message to send information to the ISDN with the release. CSP C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE ReleaseDataType; UBYTE Data[222]; } XL_ChannelReleaseRequest;

ISDN

Sent by SwitchKit Code

C++ Class
class XLC_ChannelReleaseRequest : public XLC_OneChannelMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getReleaseDataType() const; void setReleaseDataType(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };
...........................................................................................................................................................................................................................................................

1- 232
Release 8.4.1 ER3, February 2008

Channel Release Request 0x0037 EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0037) Reserved (0x00) Sequence Number Logical Node ID AIB 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel : Release Data Type 0x00 No Data 0x03 ISDN ICB 0x04 SS7 ICB Data ICBs The data format depends on the Release Data Type. 0x10 ISDN Formatted IEs 0x12 SS7 Parameters 0x25 ISDN Segmented Message Refer to Interworking TLVs Configure 0x00EE message. : Checksum Byte 0 1, 2 3, 4 5 6 7 8 Frame (0xFE) Length (0x0005) Message Type (0x0037) Reserved (0x00) Same Sequence Number Logical Node ID Checksum RESPONSE (Gray) Field Description

(4-4) if you have enabled interworking from the VoIP Protocol

1- 233
Release 8.4.1 ER3, February 2008

Channel Released 0x0049

SwitchKit Name Type Description: ChannelReleased EXS API and SwitchKit API message Channel Released 0x0049 This message informs the host that a channel has been released, is in an idle state, and is ready for incoming or outgoing calls. Sent by: Resent in EXS API SwitchKit Code CSP This message is resent once after five seconds. C Structure:
typedef struct { unsigned short Span; UBYTE Channel; } XL_ChannelReleased;

C++ Class:
class XLC_ChannelReleased : public XLC_OneChannelMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0049) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Checksum Byte 0 1, 2 3, 4 5 6 7 8 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x0049) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

1- 234
Release 8.4.1 ER3, February 2008

Channel Released With Data 0x0069

SwitchKit Name Type Description ChannelReleasedWithData EXS API and SwitchKit API message Channel Released With Data 0x0069 This message indicates that the network has initiated a release with associated data. If no parameter data is associated with the call release, then a Channel Released (0x49) message is sent instead. For a VoIP call, a Release TLV will appear in the message in the Extended ICB. For SS7 TUP, Release parameters are included in a BT IUP parameters ICB. When BT IUP is configured, then a BT IUP ICB with a release TLV may be present. For SwitchKit Only When an ICBType field is set to 0x03, use the following methods for extracting the data of the fields shown in the following table.
If the field is...
ICBSubType ICBLength ICBData getICBSubType() getICBLength() getICBData()

then the method for extracting the data is...

sk_extractExtendedICBFromChannelReleasedWithData() sk_extractExtendedICBFromChannelReleasedWithData() sk_extractExtendedICBFromChannelReleasedWithData() getExtendedICBSubtype() getExtendedICBLength() getExtendedICBData()

Sent by Resent in EXS API Example Message (Log Output in SwitchKit)

CSP This message is resent once after five seconds. The following socket log output/example message is an H.323 call, that the network has initiated a release with a Release TLV indicating Invalid Permission Chosen, Facility Call Deflection. 00 5d 00 69 00 2c 01 00 01 0d 03 00 00 04 02 02 1e 2a 00 05 01 04 00 04 00 00 00 00 01 05 00 04 00 00 00 00 01 11 00 04 00 00 00 00 01 10 00 04 00 00 00 00 01 12 00 04 00 00 00 00 03 00 33 00 1e 00 04 27 4e 00 02 00 10 27 92 00 04 c0 a8 00 1a 27 93 00 04 00 00 20 5c 27 e3 00 02 02 0c

SwitchKit Code

C Structure
typedef struct { unsigned short Span;

1- 235
Release 8.4.1 ER3, February 2008

Channel Released With Data 0x0069

UBYTE Channel; UBYTE ICBCount; UBYTE ICBType; UBYTE ICBSubtype; UBYTE ICBLength; UBYTE ICBData[219]; } XL_ChannelReleasedWithData; DllExport bool sk_extractExtendedICBFromChannelReleasedWithData(in t* xtICBSubtype, int* xtICBLength, UBYTE** ICBData, XL_ChannelReleasedWithData* crwd)

C++ Class
class XLC_ChannelReleasedWithData : public XLC_OneChannelMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getICBCount() const; void setICBCount(UBYTE x); UBYTE getICBType() const; void setICBType(UBYTE x); UBYTE getICBSubtype() const; void setICBSubtype(UBYTE x); UBYTE getICBLength() const; void setICBLength(UBYTE x); const UBYTE *getICBData() const; UBYTE *getICBData(); void setICBData(UBYTE *x); XBYTE getExtendedICBSubtype() const; XBYTE getExtendedICBLength() const; const UBYTE *getExtendedICBData() const; UBYTE *getExtendedICBData(); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0069) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel
...........................................................................................................................................................................................................................................................

RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x0069) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

1- 236
Release 8.4.1 ER3, February 2008

Channel Released With Data 0x0069

: :

Number of ICBs to follow (Ignore this field if no ICBs in message.) ICB 0x02 Data Type 0x12 SS7 Parameters 0x1C SS7 TUP Formatted Fields 0x1E Generic PPL in Channel Released with Data (See ICB format below this table) 0x1F SS7 Unformatted Raw Parameters 0x23 BT IUP Parameters 0x03 Extended Data Type 0x0033 NPDI Universal ICB in Channel Released with Data (See ICB format below this table) Refer to Interworking TLVs (4-4) if you have enabled interworking from the VoIP Protocol Configure 0x00EE message.

Checksum

0x1E Generic PPL in Channel Released with Data When an IP channel is released, the CSP sends a Channel Released with Data message to the host. The message contains the following data, providing IP statistics for the IP call:
ICB Type ICB ID Data Length Tag Length Value (4 Bytes) Tag Length Value (4 Bytes) Tag Length Value (4 Bytes) Tag Length Value (4 Bytes) Tag Length Value (4 Bytes) Data (0x02) Generic PPL ICB (0x1E) 0x2A 0x0104 RTP Packets Lost 0x0004 Data[0-3] Number of Packets RTP Packets Received (0x0105) 0x0004 Data[0-3] Number of Packets RTP Packets Sent (0x0111) 0x0004 Data[0-3] Number of Packets RTP Octets Received (0x0110) 0x0004 Data[0-3] Number of Octets RTP Octets Sent (0x0112) 0x0004 Data[0-3] Number of Octets

Number of TLVs 0x0005

1- 237
Release 8.4.1 ER3, February 2008

Channel Released With Data 0x0069

0x0033 NPDI Universal ICB in Channel Released with Data

ICB Type ICB ID Data Length Tag Length Value (4 Bytes) Tag Length Value (4 Bytes) Tag Length Value (2 Bytes) Tag Length Value (2 Bytes) Data (0x03) NPDI (0x0033) Variable RTP IP (0x2792) 0x0004 Variable RTP Port (0x2793) 0x0004 Variable NPDI Message Type (0x274E) 0x0002 Variable Release Cause Code (0x27E3) For H.323 0x0002 Variable

Number of TLVs 0x0004

1- 238
Release 8.4.1 ER3, February 2008

ChannelGroupContentsQuery

ChannelGroupContentsQuery
Type: Description

EXS SwitchKit API message Use the SK_ChannelGroupContentsQuery to query the contents of the channel group by name. The acknowledgment SK_ChannelGroupContentsQueryAck contains the number of channels in that group as well as all the spans and channels. To process all these channels, you use the following code:
SK_MSG_SWITCH(msg) { CASE_ChannelGroupContentsQueryAck(ack) { int i; UBYTE *dta = ack->Channels; for (i=0;i<ack->NumChannels;i++) { short span = ntohs(*(short *)dta); int chan = (int)dta[2]; processChannel(span,chan); dta += 3; } } } SK_END_SWITCH;

The format of the Channels data structure is two bytes for the span in network byte order, followed by one byte representing the channel offset.
Sent by C Structure

Application
typedef struct { char GroupName[50]; UBYTE reserved67[23]; } SK_ChannelGroupContentsQuery; typedef struct { int Status; int NumChannels; UBYTE Channels[245]; } SK_ChannelGroupContentsQueryAck; class SKC_ChannelGroupContentsQuery : public SKC_ToolkitMessage { public: const char *getGroupName() const; void setGroupName(const char *x); }; 1- 239

C Structure Response

C++ Class

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

ChannelGroupContentsQuery C++ Class Response

class SKC_ChannelGroupContentsQueryAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getNumChannels() const; void setNumChannels(int x); const UBYTE *getChannels() const; UBYTE *getChannels(); void setChannels(UBYTE *x); };

Status Field Return Values

The possible status values are:

Query successful acknowledged.

SK_INVALID_GROUP

The GroupName in the query does not exist.

Arguments

GroupName: Name of Group to be queried.

1- 240
Release 8.4.1 ER3, February 2008

ChannelGroupPopulationQuery

ChannelGroupPopulationQuery
Type: Description

EXS SwitchKit API message Use the SK_ChannelGroupPopulationQuery message to query the existing defined channel groups on the LLC. The GroupNames field contains a set of group names, each separated by the NULL character. For example, to loop over all the groups, as returned by this message, you could use the following code:
SK_MSG_SWITCH(msg) { CASE_ChannelGroupPopulationQueryAck(ack) { int i; char *gps = (char *)ack->GroupNames; for (i=0;i<ack->NumGroups;i++) { char *aGroup = gps; processGroup(aGroup); gps += strlen(gps) + 1; } } } SK_END_SWITCH;

Sent by C Structure

Application
typedef struct { } SK_ChannelGroupPopulationQuery; typedef struct { int Status; int NumGroups; UBYTE GroupNames[245]; } SK_ChannelGroupPopulationQueryAck; class SKC_ChannelGroupPopulationQuery : public SKC_ToolkitMessage { public: }; class SKC_ChannelGroupPopulationQueryAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getNumGroups() const; void setNumGroups(int x); const UBYTE *getGroupNames() const; UBYTE *getGroupNames(); void setGroupNames(UBYTE *x); }; 1- 241

C Structure Response

C++ Class

C++ Class Response

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

ChannelGroupPopulationQuery Return Status

Always 0x10

1- 242
Release 8.4.1 ER3, February 2008

ChannelProblem

ChannelProblem
Type: Description

EXS SwitchKit API message This message is generated by SwitchManager. To do this, SwitchManager must be running in order for an application to receive a channel problem message. An application can receive a message when a channel has encountered some problems, but has not gone out-ofservice. The application also receives this message when the problem clears. ErrorNum equals one (1) if a red or yellow span alarm occurs; or equals two (2) if a PPL Event Indication occurs. The LLC does not allocate a channel that is in an alarm state, but if an application already has a channel that has entered into an alarm state, the application must deal with this state. Text will contain a description of the problem, which in the case of red and yellow alarms is a description of the current network status. A problem with a value of one (1) means the problem just occurred; a value of zero (0) means the problem has cleared. In the case of a span alarm, Data1 will equal the status field extracted from the EXS API message. In the case of a PPL Event Indication, Data1 will equal the PPL Event.

Sent by C Structure

SwitchManager; forwarded by LLC

typedef struct { unsigned short Span; UBYTE Channel; UBYTE Problem; UBYTE ErrorNum; UBYTE Data1; UBYTE Data2; char Text[200]; } SK_ChannelProblem; class SKC_ChannelProblem : public SKC_ToolkitMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getProblem() const; void setProblem(UBYTE x);} UBYTE getErrorNum() const; void setErrorNum(UBYTE x); UBYTE getData1() const; void setData1(UBYTE x); 1- 243

C++ Class

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

ChannelProblem
UBYTE getData2() const; void setData2(UBYTE x); const char *getText() const; void setText(const char *x); };

1- 244
Release 8.4.1 ER3, February 2008

Clear System Software 0x000C

SwitchKit Name Type Description ClearSystemSoftware EXS API and SwitchKit API message Clear System Software 0x000C NOTE: This message is for use in a lab environment only. You must not send this message to a live system.

This message clears the system software stored in memory on the CSP Matrix Series 3 Card. Use this message immediately before you send a new load to the CSP Matrix Series 3 Card. To stop the running system software, push the Reset button or send a Reset Matrix message. System software is copied into maintained storage. Upon reset or boot, software is copied from maintained storage to RAM for execution. When the host sends this message, the copy in maintained storage is cleared, but the RAM is unaffected. If a card resets after you send this message, the card will not retrieve a software load from maintained storage and will not come back into service. Redundant Matrix Cards In a redundant system, sending this message to the active CSP Matrix Series 3 Card clears both CSP Matrix Series 3 Card. After sending this message to the active CSP Matrix Series 3 Card, you must send a Reset Matrix message to both CSP Matrix Series 3 Card. Sent by Related API Message SwitchKit Code Host Reset Matrix 0x009D (ResetMatrix) C Structure
typedef struct { } XL_ClearSystemSoftware;

C++ Class
class XLC_ClearSystemSoftware : public XLC_OutboundMessage { public: };

1- 245
Release 8.4.1 ER3, February 2008

Clear System Software 0x000C

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x000C) Reserved (0x00) Sequence Number Logical Node ID Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x000C) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

1- 246
Release 8.4.1 ER3, February 2008

ClearAllChanGroups

ClearAllChanGroups
Type: Description

EXS SwitchKit API message Use the SK_ClearAllChanGroups message to remove all channel groups. SwitchManager ClearAllChanGroups();
typedef struct { } SK_ClearAllChanGroups; class SKC_ClearAllChanGroups : public SKC_AdminMessage{ public: };

Sent by Configuration C Structure

C++ Class

1- 247
Release 8.4.1 ER3, February 2008

ClearChanGroup

ClearChanGroup
Type: Description

SwitchKit API message Use the SK_ClearChanGroup message to remove all channels from a channel group. Because channel group bindings accumulate for as long as the LLC is running, it is recommended that you clear every channel group that you use in a configuration file. SwitchManager ClearChanGroup(
ChannelGroup = string); typedef struct { char ChannelGroup[45]; } SK_ClearChanGroup; class SKC_ClearChanGroup : public SKC_AdminMessage { public: const char *getChannelGroup() const; void setChannelGroup(const char *x); };

Sent by Configuration

C Structure

C++ Class

1- 248
Release 8.4.1 ER3, February 2008

ClearLog

ClearLog
Type Description

SwitchKit API message The ClearLog message is used as an operations, administration and maintenance feature in the Converged Services Administrator (CSA) to clear log files. You can choose among different options to clear log files. Application or CSA To use a ClearLog message, construct the message and set the LoggingBitMask:
SKC_ClearLog cl; UBYTE log_bit_mask = SK_CLEAR_MSG_LOG | SK_CLEAR_SOCKET_LOG [Link](log_bit_mask);

Sent by How to use

Argument Values

The following table shows the common values of the LoggingBitMask argument. You can combine two or more values with a logical OR to clear several logs at once. Clear individual log files using the following values:

Argument Value SK_CLEAR_MSG_LOG SK_CLEAR_MAINT_LLC_LOG SK_CLEAR_SOCKET_LOG SK_CLEAR_ALARM_LOG SK_CLEAR_MAINT_SWMGR_LOG

Description Clears only the messages log file. Clears only the LLC maintenance log. Clears only the socket log file. Clears only the alarm log file. Clears only the SwitchManager maintenance log file.

Clear groups of log files using the following values:

Argument Value SK_CLEAR_ALL_SK_LOGS SK_CLEAR_ALL_LLC_LOGS Description Clears all the SwitchKit logs. Clears all LLC logs, including: SK_CLEAR_MSG_LOG | SK_CLEAR_MAINT_LLC_LOG | SK_CLEAR_SOCKET_LOG
1- 249
Release 8.4.1 ER3, February 2008

ClearLog

SK_CLEAR_ALL_SWMGR_LOGS

Clears all SwitchManager logs, including: SK_CLEAR_ALARM_LOG| SK_CLEAR_MAINT_SWMGR_LOG

C Structure

typedef struct { UBYTE LoggingBitMask; } SK_ClearLog; typedef struct { int Status; } SK_ClearLogAck; class SKC_ClearLog : public SKC_ToolkitMessage { public: UBYTE getLoggingBitMask() const; void setLoggingBitMask(UBYTE x); }; class SKC_ClearLogAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); };

C Structure Response

C++ Class

C++ Class Response

1- 250
Release 8.4.1 ER3, February 2008

Clear IP Signaling Series 3 Card 0x0108

Type Description EXS API message Clear IP Signaling Series 3 Card 0x0108 This message clears the system software on the IP Signaling Series 3 card before and/or after the IP Signaling Series 3 card interface is established. This message is sent directly to the IP Signaling Series 3 card and uses the extended logical node ID format. To initiate the download of the new software load, you need to reset the IP Signaling Series 3 card by pushing the Reset button or using the Reset IP Signaling Series 3 Card message (0x0107). Sent by Example Message Host The following clears the system software on the IP Signaling Series 3 card when the IP Signaling Series 3 card ID or Matrix ID is not assigned. 00 11 01 08 00 00 fe 00 02 52 02 ff ff 53 04 00 20 ff ff

Hex API Format

MESSAGE (White) Byte Field Description
0 1, 2 3, 4 5 6 7 : Frame (0xFE) Length (0xNNNN) Message Type (0x0108) Reserved (0x00) Sequence Number Extended Logical Node ID (0xFE) AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x48 Ring Communication Link 0x53 Object Type : Checksum : : AIB Same as message Checksum

RESPONSE (Gray) Byte Field Description

0 Frame (0xFE) 1, 2 Length (0xNNNN) 3, 4 Message Type (0x0108) 5 6 7 Reserved (0x00) Sequence Number (same as message) Extended Logical Node ID (0xFE)

8, 9 Status MSB, LSB (0x0010)

1- 251
Release 8.4.1 ER3, February 2008

ClearSoftware

ClearSoftware
Type: Purpose

SwitchKit API message Use the ClearSoftware message to clear system software and to reset the CSP Matrix Series 3 Card or device server of the CSP. This message is used for clearing system software and for resetting the the CSP Matrix Series 3 Card(s). Application or CSA To use a ClearSoftware message, construct the message and set the matrix and action arguments as shown below:
SKC_ClearSoftware cls(); [Link](matrix); [Link](action); [Link](node);

Description

Sent by How to use

Arguments

The following table shows the arguments you can change:

Arguments Matrix

Description This argument specifies on which CSP Matrix Series 3 Card the action is applied: SK_CLEARSW_ACTIVE (1) = Apply action to active CSP Matrix Series 3 Card SK_CLEARSW_STANDBY (2) = Apply action to standby CSP Matrix Series 3 Card SK_CLEARSW_ALL (3) = Apply action on both CSP Matrix Series 3 Card in the CSP

Action

This argument specifies which action is applied: SK_CLEARSW_CLEAR (1) = Clear software but do not reset the CSP Matrix Series 3 Card. SK_CLEARSW_CLEAR_AND_RESET (2) = Clear software and reset the CSP Matrix Series 3 Card.

1- 252
Release 8.4.1 ER3, February 2008

ClearSoftware

Arguments Node

Description This argument specifies the logical node ID of the CSP Matrix Series 3 Card pair or the Device Server ID of the Device Server card to which the action is to be applied.

1- 253
Release 8.4.1 ER3, February 2008

ClearSoftware Status Field

The following table shows the possible return values of the status field. The status field can contain any of the values or the logical OR combination of two or more of the following:

Value SK_SUCCESS (0x10) SK_ACTIVE_NOT_ CLEARED (0x0001) SK_STANDBY_NOT_ CLEARED (0x0002) SK_ACTIVE_NOT_ RESET (0x0004) SK_STANDBY_NOT_ RESET (0x0008) SK_INVALID_NODE (0xf002) C Structure
typedef struct { UBYTE Matrix; UBYTE Action; unsigned short NodeId; } SK_ClearSoftware;

Description Message successfully executed. The active CSP Matrix Series 3 Card was not cleared. The standby CSP Matrix Series 3 Card was not cleared. The active CSP Matrix Series 3 Card was not reset. The standby CSP Matrix Series 3 Card was not reset. This indicates that the application has no description data associated with it.

C++ Class

class SKC_ClearSoftware : public SKC_ToolkitMessage { public: UBYTE getMatrix() const; void setMatrix(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); unsigned short getNodeId() const void setNodeId(unsigned short x) };

1- 254
Release 8.4.1 ER3, February 2008

Collect Digit String 0x00BC

SwitchKit Name Type Description CollectDigitString EXS API and SwitchKit API message Collect Digit String 0x00BC This message instructs the CSP to attach a digit receiver to the specified channel. NOTE: The digit receiver collects digit strings only if the digits are either DTMF or MFR1, or if the call is in a state other than idle, out of service, or busied out

Once the receiver has collected the digits, the CSP sends a Call Processing Event message with the value 0x02 (Digits) in the Call Processing Event field. If an error occurs, the CSP sends a Call Processing Event message and indicates the error using the Status field. If the host sends this message and specifies a channel to which a digit receiver is already attached, the CSP sends the host a response with a status of 0x30 (DSP Resource Already Allocated). The channel is not affected. The CSP releases the digit receiver from the channel when one of the following occurs: The CSP sends a Call Processing Event message The call is released The CSP receives a DSP Service Cancel message from the host Sent by SwitchKit Code Host Application C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE Mode; UBYTE MaxDigits; UBYTE NumTermChars; UBYTE ConfigBits; unsigned short TermChars; unsigned short InterDigitTimer; unsigned short FirstDigitTimer; unsigned short CompletionTimer; unsigned short MinReceiveDigitDuration; UBYTE AddressSignallingType; UBYTE NumDigitStrings; unsigned short ResumeDigitCltnTimer; } XL_CollectDigitString;

1- 255
Release 8.4.1 ER3, February 2008

Collect Digit String 0x00BC C++ Class

class XLC_CollectDigitString : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getMode() const; void setMode(UBYTE x); UBYTE getMaxDigits() const; void setMaxDigits(UBYTE x); UBYTE getNumTermChars() const; void setNumTermChars(UBYTE x); UBYTE getConfigBits() const; void setConfigBits(UBYTE x); unsigned short getTermChars() const; void setTermChars(unsigned short x); unsigned short getInterDigitTimer() const; void setInterDigitTimer(unsigned short x); unsigned short getFirstDigitTimer() const; void setFirstDigitTimer(unsigned short x); unsigned short getCompletionTimer() const; void setCompletionTimer(unsigned short x); unsigned short getMinReceiveDigitDuration() const; void setMinReceiveDigitDuration(unsigned short x); UBYTE getAddressSignallingType() const; void setAddressSignallingType(UBYTE x); UBYTE getNumDigitStrings() const; void setNumDigitStrings(UBYTE x); unsigned short getResumeDigitCltnTimer() const; void setResumeDigitCltnTimer(unsigned short x); };

1- 256
Release 8.4.1 ER3, February 2008

Collect Digit String 0x00BC

Overview of message

The following table provides an overview of this message. The table following it provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 Field Description Frame (0xFE) Length (0x0005) Message Type (0x00BC) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x0002 DSP Receiver Request Timeout Checksum

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00BC) Reserved (0x00) Sequence Number Logical Node ID AIB (Starting with byte 0)

: : : : : : : : : : : : :

Mode Max Digits Number of Terminating Characters Configuration Bits Terminating Characters (MSB, LSB) Interdigit Timer (MSB, LSB) First Digit Timer (MSB, LSB) Completion Timer (MSB, LSB) Minimum Receive Digit Duration Timer (MSB, LSB) Address Signaling Type Number of Digit Strings Resume Digit Collection Timer (MSB, LSB) Checksum

1- 257
Release 8.4.1 ER3, February 2008

Collect Digit String 0x00BC

Hex API Format - Detailed

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length 0xNNNN Message Type (0x00BC) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Mode 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 Fixed Number of Digits Use Terminating Characters Use KP_ST Characters Use Fixed Number of Digits or Terminating Characters Reserved Reserved Reserved Fixed or Indefinite Number of Digits Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length 0xNNNN Message Type (0x00BC) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

If the first digit detected is zero, the Indefinite Number of Digits method is used and the Completion Timer or Interdigit Timer is used (whichever expires first) to terminate digit collection. If the first digit collected is not zero, the Fixed Number of Digits method is used. This method is used to help facilitate collecting digit strings on channels that process national and international calls. : Max Digits Maximum number of digits to collect (0100) This field is valid only if the Mode field value is either 0x01 (Fixed Number of Digits) or 0x04 (Use Fixed Number of Digits or Term Chars); otherwise, it is ignored. Number of Terminating Characters Number of terminating characters to collect (04). This field is valid only if the Mode field value is either 0x02 (Use Terminating Characters) or 0x04 (Use Fixed Number of Digits or Term Chars); otherwise, it must be 0x00.

1- 258
Release 8.4.1 ER3, February 2008

Collect Digit String 0x00BC

Configuration Bits Bit 0 Report Digit at Falling Edge 0 Digit is reported at its rising edge when the digit is first pressed or if it is present on the line at the time the receiver is attached. 1 Digit is reported at its falling edge when the digit is first released. 1 First Digit Collected 0 Do not inform the host that the first digit was collected. 1 Inform the host that the first digit was collected. Use the Call Processing Event message. The first digit will also be reported in the Call Processing Event message with the remaining digits. Ignore # Character 0 Do not ignore the # character as the first digit. 1 Ignore the # character as the first digit. Suspend Digit Collection 0 Do not suspend digit collection. 1 Suspend digit collection upon outpulsing digits.

The following requires that one DSP-2, DSP-ONE or MFDSP card be configured with both DTMF Transmission and DTMF Reception. Channels with this feature enabled will only have access to DTMF Receivers on cards which also have DTMF Transmitters configured. 4 Cancel Prompting Tone or Recorded Announcement 0 Prompting tone or RAN is cancelled on receipt of the first digit. 1 Prompting tone or recorded announcement continues. Detect Leading Silence (only used for rising edge detection) 0 Do not require leading silence before reporting valid rising edge digit. 1 Require detection of leading silence before reporting the first valid rising edge digit. Digits on the line at time of receiver attachment will not be reported.

6 Cancel Recording 0 Recording is cancelled on receipt of the first digit 1 Recording continues 7 Detect DTMF Frequencies 0 DTMF detection logic checks the two individual DTMF frequencies and the total of both frequencies that make up a DTMFdigit before reporting the detected digit. 1 DTMF detection logic only checks the total frequency of the two individual DTMF frequencies that make up a DTMFdigit before reporting the detected digit. (Default)

1- 259
Release 8.4.1 ER3, February 2008

Collect Digit String 0x00BC

Terminating Characters MSB, LSB Use this two-byte field only if the value of the Mode field is either 0x02 (Use Terminating Characters) or 0x04 (Use Fixed Number of Digits or Term Chars). The terminating characters are stored as nibbles. You can define up to four terminating characters, as shown below. MSB Bit 03 47 LSB Bit 03 47

Terminating Character 2 Terminating Character 1

Terminating Character 4 Terminating Character 3

Interdigit Timer MSB, LSB NOTE: Timers are in 10 ms units. The maximum time to wait between digits after the first one is received. The value 0xFFFF disables this timer. First Digit Timer MSB, LSB The maximum time to wait for the first digit of a string (in 10 ms units). The value 0xFFFF disables this timer. Completion Timer MSB, LSB The maximum time to wait for the entire string after the first digit is detected. The value 0xFFFF disables this timer. Minimum Receive Digit Duration Timer MSB, LSB The minimum time a digit must be detected before it is declared valid. The value must be at least 30 ms, which is the default. Address Signaling Type The address signaling type must be the same for both strings within a stage, but may differ between stages. 0x01 DTMF 0x02 MFR1 0x14 DTMF and Dial Pulse Receiver 0x15 Dial Pulse Receiver Number of Digit Strings Number of digit strings to collect (1 or 2, usually 1 unless strings are KP/ST framed) Resume Digit Collection Timer MSB, LSB The amount of time to wait after outpulsing is complete to resume digit collection. Checksum

: : :

1- 260
Release 8.4.1 ER3, February 2008

ConfigChanGroup

ConfigChanGroup
Type: Description

SwitchKit API message Use the SKC_ConfigChanGroup message to configure parameters for a channel group. SwitchManager ConfigChanGroup (
ChannelGroup = string, Entity = integer, Parameter = integer);

Sent by Configuration

C Structure

typedef struct { UBYTE Entity; UBYTE Parameter; char GroupName[50]; } SK_ConfigChanGroup; class SKC_ConfigChanGroup : public SKC_AdminMessage { public: UBYTE getEntity() const; void setEntity(UBYTE x); UBYTE getParameter() const; void setParameter(UBYTE x); const char *getGroupName() const; void setGroupName(const char *x); };

C++ Class

Entity Options

Entity

0 - Allocation Pattern Controls the order in which LLC will allocate the channels when you request a channel in a channel group.
Parameters for Allocation Pattern Value 0 default Allocator Round Robin Description

Begins with the first available channel, and proceeds through the group, always choosing the next available channel starting from the channel it last allocated.
Always chooses the first (i.e., lowest numbered) available channel in the group.

Ascending

1- 261
Release 8.4.1 ER3, February 2008

ConfigChanGroup

Value 2 3 4

Allocator Descending LRU (Least Recently Used) MRU (Most Recently Used)

Description Chooses the last (highest numbered) available channel in the group. Chooses the channel that has been in the idle state for the longest time.

Chooses the channel that has been in the idle state for the shortest time.

1- 262
Release 8.4.1 ER3, February 2008

ConfigChanGroup Example

ConfigChanGroup (
ChannelGroup = outbound, Entity = 0, Parameter = 1);

1- 263
Release 8.4.1 ER3, February 2008

ConfigStatusMsg

ConfigStatusMsg
Type: Purpose

SwitchKit API message SwitchManager sends the SK_ConfigStatusMsg message to a registered application at configuration time. An application can register to receive this message when SwitchManager configures the entire CSP or a part of an CSP configuration, including start-up, a dynamic change request, or a matrix failure. SwitchManager tracks when the configuration begins, when it ends, and the number of positive and negative ACKs received. To receive the message SK_ConfigStatusMsg, your application must register for this message using the sk_msgRegister() function. The application should not send an acknowledgement for this message. If SwitchManager is run with -s option and if there was no configuration message sent to the CSP, SwitchManager will not send any SK_ConfigStatusMsg.

Sent by C Structure

SwitchManager
typedef struct { UBYTE Event; UBYTE ConfigType; int NumMsgsSent; int NumMsgsNacked; } SK_ConfigStatusMsg; class SKC_ConfigStatusMsg : public SKC_ToolkitMessage { public: UBYTE getEvent() const; void setEvent(UBYTE x); UBYTE getConfigType() const; void setConfigType(UBYTE x); int getNumMsgsSent() const; void setNumMsgsSent(int x); int getNumMsgsNacked() const; void setNumMsgsNacked(int x); };

C++ Class

Field Values

The following table shows the possible field values of this message:

1- 264
Release 8.4.1 ER3, February 2008

ConfigStatusMsg

Field Event

Values and Description

SK_BEGIN_CONFIG = indicates SwitchManager began a configuration. SK_END_CONFIG = indicates SwitchManager finished the configuration. SK_PARSE_ERROR = indicates an error occurred when parsing the configuration.

ConfigType

This field indicates the reason the configuration takes place. Possible reasons are: SK_INITIAL_CONFIG SK_DYNAMIC_CONFIG SK_MATRIX_STATE SK_RECEIPT_OF_NSR SK_CONFIG_TAG_RESET SK_CARD_RECONFIG SK_CARD_FAILURE

NumMsgsSent NumMsgsNacked

This field indicates the number of messages sent to the CSP through SwitchManager. This field indicates the number of messages that have been negatively acknowledged by the CSP. If a config message gets a nack with status No Ack From Switch or Card Not ready for configuration, SwitchManager will try to re-send the config message several times before quitting. This would be reflected on the NumMsgsSent and NumMsgsNacked fields. SK_CARD_FAILURE SK_CARD_RECONFIG SK_CONFIG_TAG_RESET

Slot

CardType

SK_CARD_FAILURE SK_CARD_RECONFIG SK_CONFIG_TAG_RESET

Relevant Attributes to ConfigType ConfigType SK_MATRIX_STATE SK_DYNAMIC_CONFIG

Release 8.4.1 ER3, February 2008

Attributes Node Nothing

1- 265

ConfigStatusMsg

SK_RECEIPT_OF_NSR SK_CARD_FAILURE SK_CARD_RECONFIG SK_CONFIG_TAG_RESET

Node Node, Slot, CardType Node, Slot, CardType Node, Slot, CardType

1- 266
Release 8.4.1 ER3, February 2008

ConfigSwitch

ConfigSwitch
Type: Purpose

SwitchKit API message Use the SK_ConfigSwitch message to dynamically configure the switch without sending a configuration file. SK_ConfigSwitch uses the bytes of the message as parameters. The acknowledgement SK_ConfigSwitchAck contains a status value from SwitchKit and a status value from the switch. You have to declare a C Structure to contain a configuration that will be sent to the switch. Use the function sk_packMessage(MsgStruct *m, char *data, int *NumBytes) to find out the fields NumBytes and Data. Send the message to the LLC using its member function send(). Wait for an acknowledgment, the status fields give information about the configuration message. When you send the SK_ConfigSwitch message, SwitchManager extracts it using the function sk_unpackMessage() and sends the extracted information to the switch. Before SwitchManager can send an acknowledgment, if must wait until the switch processes the configuration. During this time, it is not possible to send another SK_ConfigSwitch message to the switch. If another SK_ConfigSwitch message is sent before receiving an acknowledgment, SwitchManager will NACK the second [Link] SKStatus field will indicate this with SK_NOT_READY.

Description

How to use SK_ConfigSwitch

Sent by Field Values Field Action

CSA or Application The following table shows the possible field values for this message:
Values and Description 0 = Do not send or process the message yet, there are more to come. SwitchManager stores the message in a TEMP collection. 1 = Send this message and all the messages previously added using Action set to 0. 0 = Process and send the message. 1 = Process the message but do not send it.

Offline

1- 267
Release 8.4.1 ER3, February 2008

ConfigSwitch C Structure
typedef struct { UBYTE Target; UBYTE Type; UBYTE MsgFormat; UBYTE Action; UBYTE Offline; int Tag1; int Tag2; char AppGroupTarget[32]; int DataSize; UBYTE Data[204]; } SK_ConfigSwitch; typedef struct { int Status; int XLStatus; } SK_ConfigSwitchAck; class SKC_ConfigSwitch : public SKC_ToolkitMessage { public: UBYTE getTarget() const; void setTarget(UBYTE x); UBYTE getType() const; void setType(UBYTE x); UBYTE getMsgFormat() const; void setMsgFormat(UBYTE x) UBYTE getAction() const; void setAction(UBYTE x); UBYTE getOffline() const; void setOffline(UBYTE x); int getTag1() const; void setTag1(int x); int getTag2() const; void setTag2(int x); const char *getAppGroupTarget() const; void setAppGroupTarget(const char *x); int getDataSize() const; void setDataSize(int x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); }; class SKC_ConfigSwitchAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); int getXLStatus() const; void setXLStatus(int x); 1- 268
Release 8.4.1 ER3, February 2008

C Structure Response

C++ Class

C++ Class Response

ConfigSwitch
};

1- 269
Release 8.4.1 ER3, February 2008

Conference Create 0x004B

SwitchKit Name Type Description ConferenceCreate EXS API and SwitchKit API message Conference Create 0x004B NOTE: If you are using the DSP Series 2 card, use the Resource Create 0x0124 message to create a conference. Use this message to create a multi-channel conference on the MFDS or DSPONE card. A DSP configured for conferencing may have more than one conference created on it, in any combination of the maximum allowed channels. Use the Conference ID returned by the CSP for any further references to the conference. The CSP assigns Conference IDs in descending order as they are created. You receive a NACK of 0x2D (Incompatible PCM Encoding for Conference) if a channel from a remote node tries to connect 1-Way to a conference and the encoding type does not match the broadcast type set during the conference creation.

You cannot use the following Conference Types with the DSP Series 2 card:
Sent by Example Message (Socket Log Output for SwitchKit) Host For EXS API, the following example message configures a unified conference of 25 channels with broadcast enabled. For SwitchKit, the following socket log output shows configuration of a unified conference of 25 channels with broadcast enabled.
00 08 00 4B 00 00 FF 19 25 01
00 08 Message Length 00 4B Message Type 00 00 FF 19 25 Reserved Sequence Number Logical Node ID (Single Node) Conference Size (25 channels) Conference Type (Any channel, Any DSP Unified)

A-law Standard -law Standard Mixed

1- 270
Release 8.4.1 ER3, February 2008

Conference Create 0x004B

01 Broadcast Enable (Broadcast Enabled)

The following example is for any channel, any DSP, Unified Dynamic, u-law conference of 25 channels, with broadcast enabled:
00 08 Message Length 00 4B Message Type 00 00 FF 19 27 Reserved Sequence Number Logical Node ID (Single Node) Conference Size (25 channels) Conference Type (Any channel, Any DSP, Unified Dynamic, -law) 01 Broadcast Enable (Broadcast Enabled)

SwitchKit Code

C Structure
typedef struct { UBYTE ConferenceSize; UBYTE ConferenceType; UBYTE BroadcastEnable; } XL_ConferenceCreate;

C Structure Response
typedef struct { unsigned short Status; unsigned short ConferenceID; } XL_ConferenceCreateAck;

C++ Class
class XLC_ConferenceCreate : public XLC_OutboundMessage { public: UBYTE getConferenceSize() const; void setConferenceSize(UBYTE x); UBYTE getConferenceType() const; void setConferenceType(UBYTE x); UBYTE getBroadcastEnable() const; void setBroadcastEnable(UBYTE x); };

C++ Class Response

class XLC_ConferenceCreateAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getConferenceID() const; void setConferenceID(unsigned short x); };
...........................................................................................................................................................................................................................................................

1- 271
Release 8.4.1 ER3, February 2008

Conference Create 0x004B EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Frame (0xFE) Length (0x0008) Message Type (0x004B) Reserved (0x00) Sequence Number Logical Node ID Conference Size The number of channels to be included in the conference. The allowed size range for each conference type is shown below. A-law Standard 27 (DSP-ONE only) -law Standard 27 (DSP-ONE only) Mixed 29 (DSP-ONE only) Monitor 29 (DSP-ONE only) Unified 2-25 for DSP-ONE card 2-128 for DSP Series 2 card DTMF Clamped 2-24 for DSP-ONE card 2-128 for DSP Series 2 card Field Description Byte 0 1, 2 3, 4 5 6 7 8, 9 10, 11 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0009) Message Type (0x004B) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Conference ID (MSB, LSB) The Conference ID returned by the CSP is 16 bits long. The host uses this conference ID for any future references to this conference. For a local conference, all the node ID bits are set to 1. Bits 0-8 Bit 9 Local Conference ID Monitor Bit 0 Non-Monitor 1 Monitor Bits 10-15 Node ID 12 9 Checksum

Conference Type The value of this field is divided into nibbles. The upper nibble represents channel and DSP allocation within the conference. The lower nibble represents the conference type. This format is backward-compatible with legacy versions of system software. If you enter 0 in the upper nibble, your existing applications are not affected.

1- 272
Release 8.4.1 ER3, February 2008

Conference Create 0x004B

Channel/DSP Pool (upper nibble): 0x0N Local Channels/Local DSP 0x1N Any Channels/Local DSP. Cannot be used without EXS Conferencing over the EXNET ring configured. 0x2N Any Channels/Any DSP. Cannot be used without EXS Conferencing over the EXNET ring configured. The Any Channel option in the Channel/DSP Pool conference type is available on EXNET systems (multi-node switches) only, after the EXS Node Configure 0x007F message (Entity 0x0001 Number of Timeslots) has been sent. Conference Type (lower nibble): 0xN1 -law Standard 0xN2 A-law Standard 0xN3 Mixed (-law and A-law encoded) 0xN4 Monitor 0xN5 Unified 0xN6 DTMF-Clamped 0xN7 Unified Dynamic, -law Broadcast 0xN8 Unified Dynamic, -law Broadcast with DTMF Clamping Support 0xN9 Unified Dynamic, A-law Broadcast 0xNA Unified Dynamic, A-law Broadcast with DTMF Clamping Support 10 Broadcast Enable NOTE: Broadcasting is not supported for mixed conferences. 0x00 Broadcast Not Enabled Mixed conferences should be set to 0, because broadcasting is not supported. 0x01 Broadcast Enabled

Full conference output is always provided for A-law, u-law, Unified Dynamic Broadcast, and Monitor [Link] full output can be broadcast to a
channel using the Connect One-Way to Conference message. 11 Checksum

1- 273
Release 8.4.1 ER3, February 2008

Conference Delete Request 0x004C

SwitchKit Name Type Description ConferenceDeleteRequest EXS API and SwitchKit API message Conference Delete Request 0x004C NOTE: If you are using the DSP Series 2 card, use the Resource Delete 0x0126 message to delete a conference.

Use this message to delete a conference on the MFDSP or DSP-ONE card. A response Status value of positive acknowledgment (0x0010) indicates that conference deletion has been initiated by the CSP. When deletion is complete, the CSP will send a Conference Deleted (0x004D) message to the host. To delete all conferences, specify 0xFFFF in the Conference ID field. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short ConferenceID; UBYTE ForcedFlag; } XL_ConferenceDeleteRequest;

C Structure Response
typedef struct { unsigned short Status; unsigned short ConferenceID; } XL_ConferenceDeleteRequestAck;

C++ Class
class XLC_ConferenceDeleteRequest : public XLC_OutboundMessage { public: unsigned short getConferenceID() const; void setConferenceID(unsigned short x); UBYTE getForcedFlag() const; void setForcedFlag(UBYTE x); };

C++ Class Response

class XLC_ConferenceDeleteRequestAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getConferenceID() const; void setConferenceID(unsigned short x); ........................................................................................................................................................................................................................................................... 1- 274
Release 8.4.1 ER3, February 2008

Conference Delete Request 0x004C

};

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Description Frame (0xFE) Length, (0x00NN) Message Type (0x004C) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1, 2 3, 4 5 6 7 8, 9 10, 11 12 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0009) Message Type (0x004C) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Conference ID (MSB, LSB) Checksum

Conference ID (MSB, LSB) Number assigned to the conference in the Response to the Conference Create message. NOTE: For this field, the value 0xFFFF has a special meaning (Delete all conferences) Forced Flag 0x00 Graceful deletion The conference will be deleted after all the channels in the conference are released. 0x01 Forced deletion All channels involved in the conference will be released or parked (according to their configured Release Mode) and the conference will be deleted.

Checksum

1- 275
Release 8.4.1 ER3, February 2008

Conference Deleted 0x004D

SwitchKit Name Type Description ConferenceDeleted EXS API and SwitchKit API message Conference Deleted 0x004D NOTE: If you are using the DSP Series 2 card, you will receive a Resource Delete Indication 0x0129 message to indicate a conference has been deleted. This message is sent to the host after a conference on an MFDSP or DSPONE card is deleted (for example, all channels in the conference are released and the DSP resource is freed up). Sent by SwitchKit Code CSP C Structure
typedef struct { unsigned short ConferenceID; } XL_ConferenceDeleted;

C++ Class
class XLC_ConferenceDeleted : public XLC_InboundMessage { public: unsigned short getConferenceID() const; void setConferenceID(unsigned short x); };

Resent in EXS API EXS API Hex Format

This message is resent once after five seconds.

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 Field Description Frame (0xFE) Length (0x0007) Message Type (0x004D) Reserved (0x00) Sequence Number Logical Node ID Conference ID Checksum Byte 0 1, 2 3, 4 5 6 7 8

RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x004D) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

1- 276
Release 8.4.1 ER3, February 2008

Connect 0x0000

Connect 0x0000
SwitchKit Name Type Description Connect EXS API and SwitchKit API message Connect 0x0000 This message instructs the CSP to establish a two-way connection between the two channels specified, for example, Channel A and Channel B. If there is no active call up for Channel B, a seizure will be generated on that channel, and once seize ACKs have been met, the voice path is connected.

NOTE:

This message treats the first span/channel and the second span/channel the same regardless of their inbound or outbound nature. Therefore, the answer supervision mode of only the second span/channel is meaningful in the Connect API message.

Sent by Example Message (Socket Log Output for SwitchKit)

Host For EXS API, the example message below configures the CSP to establish a two-way connection between span 01 channel 01 and span 02 channel 02: For SwitchKit, the socket log output below shows configuration of the CSP, which establishes a two-way connection between span 01 channel 01 and span 02 channel 02:
00 11 00 00 00 00 FF 00 02 0D 03 00 01 01 0D 03 00 02 02

SwitchKit Code

C Structure
typedef struct { unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; } XL_Connect;

C++ Class
class XLC_Connect : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const; void setChannelB(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 277
Release 8.4.1 ER3, February 2008

Connect 0x0000
};

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x0011) Message Type (0x0000) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual Number of AEs to follow 0x02 AEs 0x0D Channel A 0x0D Channel B Byte 0 1, 2 3, 4 5 6 7 8, 9 10,11 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0000) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) See Response Status Values. State (MSB, LSB) If the MSB of the preceding Status field is 0x18 (Invalid Channel B State) or 0x1D (Invalid Channel A State), then this field indicates the component state. If the State value is greater than 0xFF (255), then it is truncated to 0xFF. If the MSB of the preceding Status field is neither 0x18 nor 0x1D, then the value in this field is 0x0000. If the preceding Status field is a positive acknowledgement, this field does not apply. : Checksum 12 Checksum

1- 278
Release 8.4.1 ER3, February 2008

Connect One-Way To Conference 0x004F

SwitchKit Name Type Description ConnectOneWayToConference EXS API and SwitchKit API message Connect One-Way To Conference 0x004F NOTE: If you are using the DSP Series 2 card, use the Resource Connect 0x0127 message to connect to a conference. Use the Connection Type TLV to make a one-way connection. Use this message with the MFDSP or DSP-ONE card to establish a one-way (listen only) connection between the channel specified and the previously created conference specified. The channel should be in one of the following states: idle, inseized, parked, or outseized. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; unsigned short ConferenceID; } XL_ConnectOneWayToConference;

C Structure Response
typedef struct { unsigned short Status; unsigned short Span; UBYTE Channel; } XL_ConnectOneWayToConferenceAck;

C++ Class
class XLC_ConnectOneWayToConference : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); unsigned short getConferenceID() const; void setConferenceID(unsigned short x); };

C++ Class Response

class XLC_ConnectOneWayToConferenceAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x);
...........................................................................................................................................................................................................................................................

1- 279
Release 8.4.1 ER3, February 2008

Connect One-Way To Conference 0x004F

unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x004F) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel : Conference ID (MSB, LSB) The number assigned to the conference in the Response to the Conference Create message. Checksum 1: : AIB Same as message Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0x00NN) Message Type (0x004F) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x1D03 Invalid Channel State: Channel Idle 0x1D09 Invalid Channel State: L3 CLear Wait Also see Common Response Status Values chapter RESPONSE (Gray) Field Description

1- 280
Release 8.4.1 ER3, February 2008

Connect To Conference 0x004E

SwitchKit Name Type Description ConnectToConference EXS API and SwitchKit API message Connect To Conference 0x004E NOTE: If you are using the DSP Series 2 card, use the Resource Connect 0x0127 message to connect to a conference. Use this message to add a channel to a conference on an MFDSP or DSPONE card. The channel to be added to a conference must be in one of the following states: inseized, parked, connected, or outseized. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; unsigned short ConferenceID; } XL_ConnectToConference;

C Structure Response
typedef struct { unsigned short Status; unsigned short Span; UBYTE Channel; } XL_ConnectToConferenceAck;

C++ Class
class XLC_ConnectToConferenceAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

C++ Class Response

class XLC_ConnectToConference : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); unsigned short getConferenceID() const;

1- 281
Release 8.4.1 ER3, February 2008

Connect To Conference 0x004E

void setConferenceID(unsigned short x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x004E) Reserved (0x00) Sequence Number Logical Node ID AIB 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Conference ID (MSB, LSB) The number assigned to the conference in the Response to the Conference Create message. Checksum : : Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0x00NN) Message Type (0x004E) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x1D03 Invalid Channel State: Channel Idle 0x1D09 Invalid Channel State: L3 CLear Wait Also see Common Response Status Values chapter AIB Same as message Checksum RESPONSE (Gray) Field Description

1- 282
Release 8.4.1 ER3, February 2008

Connect One-Way Forced 0x0050

SwitchKit Name Type Description ConnectOneWayForced EXS API and SwitchKit API message Connect One-Way Forced 0x0050 This message establishes a one-way connection between two channels, where Channel A is the source channel (talk only) and Channel B is the destination channel (listen only). With this connection, the CSP does not do any checking on the state of Channel A; it can be in any state. This lessens the degree of call processing required, resulting in a significantly faster call rate. Channel B, however, must be in an acceptable connection state. The connection will only be torn down if Channel B is released by the host, or as a result of a network-initiated release. When performing a Connect One-Way Forced A-to-B on a multi-node system, you must send this message to the node containing the B channel. For SwitchKit: If you use the ConnectOneWayForced message in your call control application, you need to specify which node you want the message to be sent to. You can specify the node within the C Structure field BaseFields Base (NodeID) or within in the C++ Class through inheritance from SKC_Message (getNode, setNode). Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; UBYTE BPad; } XL_ConnectOneWayForced;

C++ Class
class XLC_ConnectOneWayForced : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const; void setChannelB(UBYTE x); UBYTE getBPad() const; void setBPad(UBYTE x);

1- 283
Release 8.4.1 ER3, February 2008

Connect One-Way Forced 0x0050

};

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0050) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Byte 0 1, 2 3, 4 5 6 7 8, 9 10, 11 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0050) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) State (MSB, LSB) If the MSB of the preceding Status field is 0x18 (Invalid Channel B State) or 0x1D (Invalid Channel A State), then this field indicates the component state. If the State value is greater than 0xFF (255), then it is truncated to 0xFF. If the MSB of the preceding Status field is neither 0x18 nor 0x1D, then the value in this field is 0x0000. If the preceding Status field is a positive acknowledgement, this field does not apply. Number of AEs to follow AEs 0x0D Channel A 0x0D Channel B : Channel B Pad Value The db gain/loss adjustment of the signal being transmitted to Channel B. Value dB Gain/Loss 0x00 +3 dB 0x01 0 dB 0x02 2 dB 0x03 3 dB 0x04 4 dB 0x05 6 dB 0x06 9 dB 12 Checksum

Number of ICBs to follow Data (presented in an ICB) 0x03 Extended Data 0x00E1 Generic PPL
: Checksum
...........................................................................................................................................................................................................................................................

1- 284
Release 8.4.1 ER3, February 2008

Connect One-Way Forced 0x0050

1- 285
Release 8.4.1 ER3, February 2008

Connect Tone Pattern 0x002F

SwitchKit Name Type Description ConnectTonePattern EXS API and SwitchKit API message Connect Tone Pattern 0x002F This message instructs the CSP to transmit a call progress pattern ID to the specified channel. The channel must be in any state other than: idle, out of service, or busied out. If you want to be notified with a Call Processing Event message (0x21 - Tone Complete) when tone transmission has stopped, set the Generate Event Flag. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE reserved20[27]; UBYTE CallProgressPatternID; unsigned short NumCycles; UBYTE Flag; UBYTE reserved51[219]; } XL_ConnectTonePattern;

C++ Class
class XLC_ConnectTonePattern : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getCallProgressPatternID() const; void setCallProgressPatternID(UBYTE x); unsigned short getNumCycles() const; void setNumCycles(unsigned short x); UBYTE getFlag() const; void setFlag(UBYTE x) };

1- 286
Release 8.4.1 ER3, February 2008

Connect Tone Pattern 0x002F

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x002F) Reserved (0x00) Sequence Number Logical Node ID AIB (Individual AEs) 0x0D Channel Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x002F) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

Transmit Call Progress Pattern ID NOTE: These are not the same pattern IDs as those used for call progress analysis. 0x00 Silence Tone 0x01 Dial Tone 0x02 Ringback 0x03 Busy 0x04 Reorder 0x05 Warning 0x06 Call Waiting 0x07 ONI Call (Zip Tone) 0x08 ANI Failure (Zip Tone) 0x09 Confirmation Tone 0x0A Recall Dial Tone 0x0B Class of Service, Tone 2 0x0C Class of Service, Tone 3 0x0D Intercept 0x0E Vacant Code 0x0F Reorder-LEC 0x10 No Circuit-LEC 0x11 Reorder-Carrier 0x12 No Circuit-Carrier 0x13 400 Hz continuous tone 0x14 Specialized tone to wait 500 ms then play 480Hz for 800 ms 0x15 Bong Tone (Calling Card Service Prompt Tone) (When specifying the Bong Tone, it will only play once, but not a number of cycles). 0x16-3F User-defined Patterns

1- 287
Release 8.4.1 ER3, February 2008

Connect Tone Pattern 0x002F

Number of Cycles to Transmit, MSB, LSB The value in this field for ringback should be greater than 0x03 and for all others greater than 0x01. The value in this field does not apply for the Dial Tone (0x01), Recall Dial Tone (0x0A), and Bong Tone (0x15), as they have no cycles. Dial Tone and Recall Dial Tone play continuously and Bong Tone plays once. 0x0000 - undefined 0x00000xFFFE Valid numbers of cycles 0xFFFF Continuous (for example, Dial Tone)

Generate Event Flag 0x00 Do not inform the host when the outpulsing of the tone is complete. 0x01 Inform the host with a Call Processing Event message that the outpulsing of the tone is complete. The CSP stops playing the tone only if: - the number of cycles to transmit is reached - the host issues a Collect Digit String message with Configuration Bit 4 set to Cancel Prompting Tone or RAN (0x00) - the host issues a Disconnect Tone Pattern message. A Connect Tone Pattern message does not cancel the outpulsing of call progress tones. However, a Connect With Data message with an action ICB of Free System Resources does cancel outpulsing. For more information, refer to the Connect With Data message.

Checksum

1- 288
Release 8.4.1 ER3, February 2008

Connect Wait 0x0017

SwitchKit Name Type Description ConnectWait EXS API and SwitchKit API message Connect Wait 0x0017 This message instructs the CSP to suspend the processing of an incoming call on a channel. This message may be used by the host as a response to the Request for Service message sent by the CSP. The CSP stops resending the Request for Service message for the channel and waits for a connection management message such as Park Channel, Connect, and so on. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_ConnectWait;

C Structure Response
typedef struct { unsigned short Status; unsigned short Span; UBYTE Channel; } XL_ConnectWaitAck;

C++ Class
class XLC_ConnectWait : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; };

C++ Class Response

class XLC_ConnectWaitAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };
...........................................................................................................................................................................................................................................................

1- 289
Release 8.4.1 ER3, February 2008

Connect Wait 0x0017 EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0017) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel : Checksum : : AIB Same as message Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0x00NN) Message Type (0x0017) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x1D03 Invalid Channel State: Channel Idle 0x1D09 Invalid Channel State: L3 CLear Wait Also see Common Response Status Values chapter RESPONSE (Gray) Field Description

1- 290
Release 8.4.1 ER3, February 2008

Connect With Data 0x0005

SwitchKit Name Type Description ConnectWithData EXS API and SwitchKit API message Connect With Data 0x0005 This message instructs the CSP to connect two channels. This message also supports canceling digit collection, playing of call progress tones, voice path connect functionality, and dynamic configuration of release modes. ISDN If the terminating channel is not in an idle state, after seizure the alerting and connect indications will get propagated to the incoming side and the data specified in this message will get sent to the incoming ISDN channel. You can use this message to pass parameter data for the ACM, ANM, or CON (ITU-TS only) in a connection between an incoming SS7 call (A Party) and another channel. The message carries the B side SDP (Session Description Protocol) information to the CSP in an NPDI Universal ICB and Generic PPL ICB. In a Generic PPL ICB, the Channel Service TLV indicates whether a bearerswitched or bearer-free connection is requested. For a bearer-free connection, the B side connection information is passed in the NPDI Universal ICB from the host. Host The following example message uses the Release Mode Configure ICB in a Connect With Data message to park Channel A (Span 0, Channel 0) and release Channel B (Span 0, Channel 1).
00 0D 00 05 00 00 FF 01 02 0D 03 00 00 00 0D 03 00 00 01 01 01 01 02 02 01 02

SS7

SIP (Call Agent)

Sent by Example Message for EXS API

SwitchKit Code

C Structure
typedef struct { unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; UBYTE ConnectDataType; UBYTE Data[222]; } XL_ConnectWithData;

C++ Class
...........................................................................................................................................................................................................................................................

class XLC_ConnectWithData : public XLC_OutboundMessage { public:

1- 291
Release 8.4.1 ER3, February 2008

Connect With Data 0x0005

unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const; void setChannelB(UBYTE x); UBYTE getConnectDataType() const; void setConnectDataType(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Frame (0xFE) Length (MSB, LSB) 0x00NN Message Type (0x0005) Reserved (0x00) Sequence Number Logical Node ID Field Description Byte 0 1, 2 3, 4 5 6 7 Frame (0xFE) Length (0x0007) Message Type (0x0005) Reserved (0x00) Same Sequence Number Logical Node ID RESPONSE (Gray) Field Description

1- 292
Release 8.4.1 ER3, February 2008

Connect With Data 0x0005

AIB Address Method 0x00 - Individual AEs

8, 9

Status (MSB, LSB) 0x0001 Invalid TLV Data Software cannot find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV Also see Common Response Status Values in the API Reference.

10, 11

State (MSB, LSB) If the MSB of the preceding Status field is 0x18 (Invalid Channel B State) or 0x1D (Invalid Channel A State), then this field indicates the component state. If the State value is greater than 0xFF (255), then it is truncated to 0xFF. If the MSB of the preceding Status field is neither 0x18 nor 0x1D, then the value in this field is 0x0000. If the preceding Status field is a positive acknowledgement, this field does not apply.

12 Number of AEs to follow 0x02 AEs 0x0D Channel A 0x0D Channel B : Connect Data Type 0x01 Use ICBs 0x02 Reserved

Checksum

: :

Number of ICBs to follow (Ignore this field if no ICBs in message.) Data (presented in an ICB) 0x01 Action ICBs 0x01 Free System Resources 0x02 Release Mode Configure 0x02 Data ICBs 0x12 SS7 Parameters 0x17 ISDN Formatted IEs With Event 0x18 ISDN Raw IEs with Event 0x1C SS7 TUP Formatted Fields 0x26 Channel Pad Value 0x03 Extended Data 0x001E Generic PPL 0x0026 Channel Pad Value 0x0033 NPDI Universal ICB Checksum

1- 293
Release 8.4.1 ER3, February 2008

Connect With Pad 0x0003

SwitchKit Name Type Description ConnectWithPad EXS API and SwitchKit API message Connect With Pad 0x0003 This message instructs the CSP to establish a connection between the two channels specified while maintaining the dB gain/loss adjustment specified for the duration of the connection. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; UBYTE APad; UBYTE BPad; } XL_ConnectWithPad;

C++ Class
class XLC_ConnectWithPad : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const; void setChannelB(UBYTE x); UBYTE getAPad() const; void setAPad(UBYTE x); UBYTE getBPad() const; void setBPad(UBYTE x); };

1- 294
Release 8.4.1 ER3, February 2008

Connect With Pad 0x0003

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00nn) Message Type (0x0003) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual Byte 0 1, 2 3, 4 5 6 7 8, 9 10, 11 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0003) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) State (MSB, LSB) If the MSB of the preceding Status field is 0x18 (Invalid Channel B State) or 0x1D (Invalid Channel A State), then this field indicates the component state. If the State value is greater than 0xFF (255), then it is truncated to 0xFF. If the MSB of the preceding Status field is neither 0x18 nor 0x1D, then the value in this field is 0x0000. If the preceding Status field is a positive acknowledgement, this field does not apply. Number of AEs to follow 0x02 AEs 0x0D Channel A 0x0D Channel B 12 Checksum

1- 295
Release 8.4.1 ER3, February 2008

Connect With Pad 0x0003

Channel A Pad Value The dB gain/loss adjustment of the signal being transmitted to Channel A. 0x00 +3 dB Gain/Loss 0x01 0 dB 0x02 2 dB 0x03 3 dB 0x04 4 dB 0x05 6 dB 0x06 9 dB Channel B Pad Value The dB gain/loss adjustment of the signal being transmitted to Channel B. 0x00 +3 dB Gain/Loss 0x01 0 dB 0x02 2 dB 0x03 3 dB 0x04 4 dB 0x05 6 dB 0x06 9 dB Checksum

1- 296
Release 8.4.1 ER3, February 2008

ConnectionStatusMsg

ConnectionStatusMsg
Type: Description EXS SwitchKit API message This message is sent by the Low-Level Communicator (LLC) to an application whenever any application connects to or disconnects from the LLC. These notifications go to applications. All applications connect to LLC. By default, LLC will send ConnectionStatusMsg messages to all applications. To disable this functionality, set SK_DISABLE_CSM =1. NOTE: An application can use this message to determine that a software version mismatch has occured. In this case, an application recieves a ConnectionStatusMsg with status 0x06, which indicates there is an invalid connection. The application needs to manually delete the connection, otherwise, a loop will continue. In CSA, you will receive an error message saying the LLC is a different version of software and you should upgrade CSA for it to work.

This feature is also used, for example, to detect whether an application in a redundant pair disconnects. This includes notification of an LLC or SwitchManager switchover. In a redundant LLC set-up, if the primary LLC fails, a ConnectionStatusMsg is sent, stating that an application with the LLC name of 0 has disconnected. The 0 corresponds to the primary LLC.

There are two types of applications:

Special Applications SwitchManger and Redundant LLC (RLLC) are special applications. SwitchManger always connects to the LLC as the application named 1. RLLC always connects to the LLC as the application named 2. User Applications User applications, including the Converged Services Administrator, connect to the LLC as applications with names greater than or equal to 10. In a redundant LLC set-up, if the primary LLC (PLLC) fails, a ConnectionStatusMsg is sent, stating that an application with the LLC name of 0 has disconnected. The 0 corresponds to the primary LLC. By default Switchkit applications, with the wrong version of software, will cause an error when attempting to connect to the LLC. The connection for this faulty application will be made to the LLC, and LLC will then send a ConnectionStatusMsg with an error code to all registered applications. All registered Switchkit applications will get a status of SK_CSM_NoCompat_App_SW (6) when this occurs. Once the ConnectionStatusMsg had been successfully sent to all registered applications, the LLC will drop the connection, and log the following within the maintenance_llc.log:
1- 297
Release 8.4.1 ER3, February 2008

ConnectionStatusMsg ************************************************************** *********** * Application Connection Failed * * Application cannot remain connected to LLC due to incompatible SK API * software version. * * Application software version:08.02.03 * Switchkit software version:08.03.01 ************************************************************** Sent by C Structure Application
typedef struct { char IPAddress[50]; UBYTE Status; int Name; UBYTE reserved72[4]; } SK_ConnectionStatusMsg; class SKC_ConnectionStatusMsg : public SKC_ToolkitInbound { public: const char *getIPAddress() const; void setIPAddress(const char *x); UBYTE getStatus() const; void setStatus(UBYTE x); int getName() const; void setName(int x); };

C++ Class

Argument Values

The following table shows the possible values for the arguments of this message:

1- 298
Release 8.4.1 ER3, February 2008

ConnectionStatusMsg

Argument

Value
SK_CSM_OtherAppIDDropped SK_CSM_OtherAppIDConnected

Description

Status

Name IPAddress

Indicates the application has disconnected. Indicates another application has connected. This value is only received, if the application is registered for the connection status message. Then, the application will get the connection status message for itself and all other applications that connect to LLC. SK_CSM_AppIDReturnedFromPhantom This is sent when an application reconnects to an LLC, either because it was disconnected and reconnected within the 15 second time-out period, or there was a switchover from the PLLC to the RLLC. SK_CSM_CurrentAppIDConnected The current application has connected to the LLC/ RLLC. SK_CSM_AppDropped_NonCompatSoftware Indicates a SwitchKit user application is trying to connect to an LLC which has a different software version. When a SwitchKit application connects to the LLC, it must have the same software version as the LLC it is connecting to. The LLC name (i.e. integer) associated with The LLC name (i.e. integer) associated with the the application application. IP address of the client that the LLC sees the IP address of the client that the LLC sees the incoming socket connecting from. incoming socket connecting from.

1- 299
Release 8.4.1 ER3, February 2008

CPC Detection 0x0047

Chapter 0 Call Control API Messages

SwitchKit Name Type Description

CPCDetection EXS API and SwitchKit API message CPC Detection 0x0047 This message enables or disables the detection of CPC (Calling Party Control), which is needed on FXO/LS channels. CPC is the means by which the calling end notifies the called end that the established connection is no longer needed. In this case, dialtone is used for notification. This feature can only be activated if the CSP contains an MFDSP or DSPONE card with at least one DSP configured for Call Progress Analysis. When CPC is detected, it is reported to the host in a Call Processing Event message.

Sent by SwitchKit Code

Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE Action; } XL_CPCDetection;

C++ Class
class XLC_CPCDetection : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); };

1- 300
Release 8.4.1 ER3, February 2008

CPC Detection 0x0047

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0047) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs AEs 0x0D Channel : Action 0x01 Enable CPC Detection 0x02 Disable CPC Detection The default time for receiving valid dialtone is 1.5 seconds before the CSP sends the Call Processing Event field value 0x24 (CPC Detected) to the host. To change this value, use the Call Progress Analysis Pattern Configure message. Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0047) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

1- 301
Release 8.4.1 ER3, February 2008

CreateConnection

CreateConnection
Type: Description

EXS SwitchKit API message An application that needs to connect to a specific LLC must issue a function call sk_createConnection(). The function then uses the SK_CreateConnection message to establish the connection between the LLC and requesting application. It is not possible to send the CreateConnection message directly to the LLC.
Important!

Sent by C Structure

Application
typedef struct { UBYTE ConnectionID; char PriHost[30]; char RedHost[30]; unsigned short PriPort; unsigned short RedPort; UBYTE Action; } SK_CreateConnection; class SKC_CreateConnection : public SKC_ToolkitMessage { public: UBYTE getConnectionID() const; void setConnectionID(UBYTE x); const char *getPriHost() const; void setPriHost(const char *x); const char *getRedHost() const; void setRedHost(const char *x); unsigned short getPriPort() const; void setPriPort(unsigned short x); unsigned short getRedPort() const; void setRedPort(unsigned short x); UBYTE getAction() const; void setAction(UBYTE x); };

C++ Class

1- 302
Release 8.4.1 ER3, February 2008

Cross Connect Channel 0x001A

SwitchKit Name Type Description CrossConnectChannel EXS API and SwitchKit API message Cross Connect Channel 0x001A This message makes a connection between two channels data paths. No signaling information can be used to detect either channel releasing. The host must tear the connection down using the Cross Disconnect Channel message. If you cross-connect T1 and E1 channels, the result is automatic PCM conversion (A-law/-law). By default, channels on T1 spans are -law and channels on E1 spans are A-law. To disable conversion, as would be required if you connect through an ISDN D channel or SS7 link, you must configure both channels with the same format using the PCM Encoding Format Configure message. This message is supported by the VDAC-ONE card but not the IP Network Interface Series 2 card. NOTE: When cross-connecting channels across nodes in an CSP system, a separate message must be sent to each channel in the connection.

For example, you would send one message to Node 1: Cross Connect Channel A, B. You would send another message to Node 2: Cross Connect Channel B, A. You can use optional fields for Encoding Format and Pad Value, which are described below the message table. The Encoding Format and Pad Value fields are required for cross-connections involving separate nodes in a multinode system only. Sent by SwitchKit Code Host Configuration
CrossConnectChannel ( Node = integer, SpanA = integer, ChannelA = integer, SpanB = integer, ChannelB = integer, AEncoding = integer, APad = integer, BEncoding = integer, BPad = integer);

C Structure
...........................................................................................................................................................................................................................................................

typedef struct {

1- 303
Release 8.4.1 ER3, February 2008

Cross Connect Channel 0x001A

unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; UBYTE AEncoding; UBYTE APad; UBYTE BEncoding; UBYTE BPad; } XL_CrossConnectChannel;

C++ Class
class XLC_CrossConnectChannel : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const; void setChannelB(UBYTE x); UBYTE getAEncoding() const; void setAEncoding(UBYTE x); UBYTE getAPad() const; void setAPad(UBYTE x); UBYTE getBEncoding() const; void setBEncoding(UBYTE x); UBYTE getBPad() const; void setBPad(UBYTE x);

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x0015) Message Type (0x001A) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs 0x02 AEs 0x0D Channel A 0x0D Channel B : Channel A Encoding Format 0x01 -law 0x02 A-law 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x001A) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 304
Release 8.4.1 ER3, February 2008

Cross Connect Channel 0x001A

Channel A Pad Value NOTE: This is a blind connection and should only be done with spans and channels out of service. The dB gain/loss adjustment of the signal being transmitted to the appropriate channel: 0x00 +3 dB Gain/Loss 0x01 0 dB 0x02 2 dB 0x03 3 dB 0x04 4 dB 0x05 6 dB 0x06 9 dB Channel B Encoding Format 0x01 -law 0x02 A-law Channel B Pad Value NOTE: This is a blind connection and should only be done with spans and channels out of service. The dB gain/loss adjustment of the signal being transmitted to the appropriate channel: 0x00 +3 dB Gain/Loss 0x01 0 dB 0x02 2 dB 0x03 3 dB 0x04 4 dB 0x05 6 dB 0x06 9 dB Checksum

1- 305
Release 8.4.1 ER3, February 2008

Cross Connect Span 0x001C

SwitchKit Name Type Description CrossConnectSpan EXS API and SwitchKit API message Cross Connect Span 0x001C This message connects all data paths on Logical Span ID A to data paths on Logical Span ID B. When in E1 clear channel mode, this message does not connect time slot 16 (channel 30). You must use the Cross Connect Channel message to connect the data paths. Cross-connection of T1 and E1 spans is not supported. Multiframe alignment does not propagate from one side of the connection to the other. NOTE: When cross-connecting channels across nodes in a multinode system, a separate message must be sent to each channel in the connection.

For example, you would send one message to Node 1: Cross Connect Span 0,1. You would send another message to Node 2: Cross Connect Span 1,0. You can use optional fields for Encoding Format and Pad Value, which are described below the message table. The Encoding Format and Pad Value fields are required for cross-connections involving separate nodes in a multinode CSP system only.

Sent by SwitchKit Code

Host Configuration
CrossConnectSpan ( Node = integer, SpanA = integer, SpanB = integer, ChannelAEncoding = integer, ChannelAPad = integer, ChannelBEncoding = integer, ChannelBPad = integer);

C Structure
typedef struct { unsigned short SpanA; unsigned short SpanB; UBYTE ChannelAEncoding; UBYTE ChannelAPad; UBYTE ChannelBEncoding; UBYTE ChannelBPad; } XL_CrossConnectSpan;
...........................................................................................................................................................................................................................................................

1- 306
Release 8.4.1 ER3, February 2008

Cross Connect Span 0x001C C++ Class

class XLC_CrossConnectSpan : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelAEncoding() const; void setChannelAEncoding(UBYTE x); UBYTE getChannelAPad() const; void setChannelAPad(UBYTE x); UBYTE getChannelBEncoding() const; void setChannelBEncoding(UBYTE x); UBYTE getChannelBPad() const; void setChannelBPad(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type, MSB (0x001C) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0C Logical Span A 0x0C Logical Span B : Channel A Encoding Format 0x01 -law 0x02 A-law 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type, MSB (0x001C) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 307
Release 8.4.1 ER3, February 2008

Cross Connect Span 0x001C

Channel B Encoding Format 0x01 -law 0x02 A-law Channel B Pad Value NOTE: This is a blind connection and should only be done with spans and channels out of service. The dB gain/loss adjustment of the signal being transmitted to the appropriate channel: 0x00 +3 dB Gain/Loss 0x01 0 dB 0x02 2 dB 0x03 3 dB 0x04 4 dB 0x05 6 dB 0x06 9 dB

Checksum

1- 308
Release 8.4.1 ER3, February 2008

Cross Disconnect Channel 0x001B

SwitchKit Name Type Description CrossDisconnectChannel EXS API and SwitchKit API message Cross Disconnect Channel 0x001B This message instructs the CSP to disconnect the data paths of the channels specified (for SwitchKit, to disconnect the data paths of the channels that were connected by means of the CrossConnectChannel message). NOTE: When cross-connecting channels across nodes in a CSP system, a separate message must be sent to each channel in the connection.

For example, you would send one message to Node 1: Cross Disconnect Channel (CrossDisconnectChannel) A, B. You would send another message to Node 2: Cross Disconnect Channel (CrossDisconnectChannel) B, A. Sent by SwitchKit Code Host Configuration
CrossDisconnectChannel ( Node = integer, SpanA = integer, ChannelA = integer, SpanB = integer, ChannelB = integer);

C Structure
typedef struct { unsigned short SpanA; UBYTE ChannelA; unsigned short SpanB; UBYTE ChannelB; } XL_CrossDisconnectChannel;

C++ Class
class XLC_CrossDisconnectChannel : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); UBYTE getChannelA() const; void setChannelA(UBYTE x); unsigned short getSpanB() const; void setSpanB(unsigned short x); UBYTE getChannelB() const;
...........................................................................................................................................................................................................................................................

1- 309
Release 8.4.1 ER3, February 2008

Cross Disconnect Channel 0x001B

void setChannelB(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x001B) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow 0x02 AEs 0x0D Channel A 0x0D Channel B : Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x001B) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 310
Release 8.4.1 ER3, February 2008

Cross Disconnect Span 0x001D

SwitchKit Name Type Description CrossDisconnectSpan EXS API and SwitchKit API message Cross Disconnect Span 0x001D This message disconnects all data paths of two spans that were previously connected by means of the Cross Connect Span message (XL_CrossConnectSpan). NOTE: When cross-connecting channels across nodes in a CSP system, a separate message must be sent to each channel in the connection.

For example, you would send one message to Node 1: Cross Disconnect Span (CrossDisconnectSpan) 0,1. You would send another message to Node 2: Cross Disconnect Span (CrossDisconnectSpan) 1,0. Sent by SwitchKit Code Host Configuration
CrossDisconnectSpan ( Node = integer, SpanA = integer, SpanB = integer);

C Structure
typedef struct { unsigned short SpanA; unsigned short SpanB; } XL_CrossDisconnectSpan;

C++ Class
class XLC_CrossDisconnectSpan : public XLC_OutboundMessage { public: unsigned short getSpanA() const; void setSpanA(unsigned short x); unsigned short getSpanB() const; void setSpanB(unsigned short x); };

1- 311
Release 8.4.1 ER3, February 2008

Cross Disconnect Span 0x001D

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x001D) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow 0x02 AEs 0x0C Logical Span A 0x0C Logical Span B : Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x001D) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 312
Release 8.4.1 ER3, February 2008

CSAPPLConfig

CSAPPLConfig
Type Purpose SwitchKit API message This message is used to assign configuration data to the H.323 PPL component, L3P RAS (0x00A0). Application or SwitchManager Configuration
CSAPPLConfig ( Node = integer, Range = 0xFFFF:0xFF - 0xFFFF:0xFF, ComponentID = 0xA0, Entity = 0x01, CSASlot = 0xFF, Protocol = 0x01, ConfigData = byte array);

Sent by SwitchKit Code

C Structure

typedef struct { UBYTE AddrInfo[30]; unsigned short ComponentID; UBYTE Entity; unsigned short CSASlot; unsigned short Protocol; UBYTE ConfigData[216]; } XL_CSAPPLConfig; class XLC_CSAPPLConfig : XLC_OutboundMessage { public:: const UBYTE *getAddrInfo() const ; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); XBYTE getStartSpan() const ; void setStartSpan(XBYTE x) ; UBYTE getStartChannel() const; void setStartChannel(UBYTE x); XBYTE getEndSpan() const; void setEndSpan(XBYTE x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); XBYTE getSpan() const; void setSpan(XBYTE x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getStackID() const; void setStackID(UBYTE x); UBYTE getLinkID() const; void setLinkID(UBYTE x); XBYTE getV5ID() const; void setV5ID(XBYTE x); XBYTE getRouterHandle() const; void setRouterHandle(unsigned short x); 1- 313

C++ Class

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

CSAPPLConfig
unsigned short getComponentID() const; void setComponentID(unsigned short x); UBYTE getEntity() const; void setEntity(UBYTE x); unsigned short getCSASlot() const; void setCSASlot(unsigned short x); unsigned short getProtocol() const; void setProtocol(unsigned short x); const UBYTE *getConfigData() const; UBYTE *getConfigData(); void setConfigData(UBYTE *x) };

1- 314
Release 8.4.1 ER3, February 2008

CSAPPLTimerConfig

CSAPPLTimerConfig
Type Purpose SwitchKit API message This message allows the host to configure PPL timers for the H.323 PPL component, L3P RAS (0x00A0). Application or SwitchManager Configuration
CSAPPLTimerConfig ( Node = integer, Range = 0xFFFF:0xFF - 0xFFFF:0xFF, ComponentID = 0xA0, Entity = 0x01, CSASlot = 0xFF, Protocol = 0x01, TimerType = 0x01, TimerID = integer, TimerValue = integer, );

Sent by SwitchKit Code

C Structure

typedef struct { UBYTE AddrInfo[30]; unsigned short ComponentID; UBYTE TimerType; UBYTE TimerID; unsigned short TimerValue; unsigned short CSASlot; unsigned short Protocol; UBYTE reserved57[213]; } XL_CSAPPLTimerConfig; class XLC_CSAPPLTimerConfig : XLC_OutboundMessage { public:: const UBYTE *getAddrInfo() const ; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); XBYTE getStartSpan() const ; void setStartSpan(XBYTE x) ; UBYTE getStartChannel() const; void setStartChannel(UBYTE x); XBYTE getEndSpan() const; void setEndSpan(XBYTE x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); XBYTE getSpan() const; void setSpan(XBYTE x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getStackID() const; void setStackID(UBYTE x); UBYTE getLinkID() const; 1- 315

C++ Class

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

CSAPPLTimerConfig
void setLinkID(UBYTE x); XBYTE getV5ID() const; void setV5ID(XBYTE x); unsigned short getComponentID() const; void setComponentID(unsigned short x); UBYTE getTimerType() const; void setTimerType(UBYTE x); UBYTE getTimerID() const; void setTimerID(UBYTE x); unsigned short getTimerValue() const; void setTimerValue(unsigned short x); unsigned short getCSASlot() const; void setCSASlot(unsigned short x); unsigned short getProtocol() const; void setProtocol(unsigned short x); };

1- 316
Release 8.4.1 ER3, February 2008

D Channel Assign 0x00C4

SwitchKit Name Type Description DChannelAssign EXS API and SwitchKit API message D Channel Assign 0x00C4 This message assigns a channel as an ISDN PRI or an ISDN Series 3 D channel or a subrate channel as an ISDN BRI channel. ISDN channels can be assigned as either primary or secondary. Sent by SwitchKit Code Host Configuration In the configuration below you can replace:
PriDChannelSpanID = integer, PriDChannel = integer,

with
SecondaryDChannelSpanID = integer, SecondaryDChannel = integer, DChannelAssign ( Node = integer, Slot = integer, PriDChannelSpanID = integer, PriDChannel = integer, SecondaryDChannelFacility = integer, DChannelType = integer,

C Structure
typedef struct { UBYTE AddrInfo[30]; UBYTE SecondaryDChannelFacility; UBYTE DChannelType; UBYTE Data; } XL_DChannelAssign;

C++ Class
class XLC_DChannelAssign : public XLC_OutboundMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getSecondaryDChannelFacility() const; void setSecondaryDChannelFacility(UBYTE x); UBYTE getDChannelType() const; void setDChannelType(UBYTE x); UBYTE getData() const; void setData(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 317
Release 8.4.1 ER3, February 2008

D Channel Assign 0x00C4

};

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00C4) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs AEs 0x15 ISDN Primary D Channel or 0x16 ISDN Secondary D Channel : Secondary D Channel Facility (See table below) 0x00 Assign primary ISDN PRI D channel 0x01-0x09 Assign secondary ISDN PRI D channel D Channel Type 0x01 ISDN PRI Primary D channel 0x02 ISDN PRI Secondary D channel Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00C4) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, lSB Checksum

Secondary D Channel Facility

The table below shows timeslots on an E1 span that map to logical channels in the CSP. You must assign D channels to timeslot 16 (Channel 30 (0x1E) as noted with shading).You cannot use Channels 30 and 31 for voice/data when configured for ISDN applications.

1- 318
Release 8.4.1 ER3, February 2008

D Channel Assign 0x00C4

Timeslot
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

Logical Channel
31 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 30 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

1- 319
Release 8.4.1 ER3, February 2008

D Channel De-assign 0x00C5

SwitchKit Name Type Description DChannelDeAssign EXS API and SwitchKit API message D Channel De-assign 0x00C5 This message is used by the host to de-assign an ISDN PRI D channel. The D channel may then be re-assigned using the D Channel Assign message. D channel De-assign messages must be sent for each of the D channels (DSOs) making up the Super Rate D channel. The base D channel must be deassigned before any of the others can be de-assigned. Sent by SwitchKit Code Host Configuration
DChannelDeassign ( Node = integer, Span = integer, Channel = integer);

C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_DChannelDeAssign;

C++ Class
class XLC_DChannelDeAssign : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

1- 320
Release 8.4.1 ER3, February 2008

D Channel De-assign 0x00C5

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00C5) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel or 0x23 Slot/Subrate : Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray)

Field Description
Frame (0xFE) Length (0x0007) Message Type (0x00C5) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 321
Release 8.4.1 ER3, February 2008

D Channel Facility List Configure 0x00C6

SwitchKit Name Type Description DChannelFacilityListConfig EXS API and SwitchKit API message D Channel Facility List Configure 0x00C6 This message is used by the host to add or delete spans from the facility list of D channels in NFAS mode. A D channel can control up to 20 spans of NI2 channels and 10 spans for all other channel types. The span where the D channel is assigned is automatically added to the facility list as Facility 0. You do not need to add it to the facility list using this message. Sent by SwitchKit Code Host Configuration
DChannelFacilityListConfig ( Node = integer, Span = integer, Channel = integer, FacilitySpan = integer, Action = integer, FacilityNum = integer);

C Structure
typedef struct { unsigned short Span; UBYTE Channel; unsigned short FacilitySpan; UBYTE Action; UBYTE FacilityNum; } XL_DChannelFacilityListConfig;

C++ Class
class XLC_DChannelFacilityListConfig : public XLC_OutboundMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); unsigned short getFacilitySpan() const; void setFacilitySpan(unsigned short x); UBYTE getAction() const; void setAction(UBYTE x); UBYTE getFacilityNum() const; void setFacilityNum(UBYTE x); };

1- 322
Release 8.4.1 ER3, February 2008

D Channel Facility List Configure 0x00C6

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00C6) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x0D Channel 0x0C Logical Span (See below) : Action 0x01 Add facility 0x02 Delete facility 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00C6) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

Facility Number 0x010x09 Index into the Facility List where the span should be deleted or added 0x010x13 Index into the Facility List where the span should be deleted or added (NI2 channels only) Checksum

Use the Channel and Span address type for this message. The table that follows shows you the format for addressing the span for Facility 0. Repeat the same format for facilities 19 (0x010x09) or 1-19 (0x010x13) for NI2 channels only.
Byte
0 1 2 3 4 5 6 7 8

AIB Field Description

Channel Address Type (0x0D) Data Length (0x03) Data[0] Logical Span ID, MSB Data[1] Logical Span ID, LSB Data[2] Channel Span, Facility 0 Address Type (0x0C) Data Length (0x02) Data[0] Logical Span ID, MSB Data[1] Logical Span ID, LSB

1- 323
Release 8.4.1 ER3, February 2008

D Channel Facility List Query 0x00CB

Chapter 0 Query API Messages

SwitchKit Name Type Description

DChannelFacilityListQuery EXS API and SwitchKit API message D Channel Facility List Query 0x00CB This message is used by the host to request a D channels Facility List.

Sent by SwitchKit Code

Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_DChannelFacilityListQuery;

C Structure Response
typedef struct { unsigned short Status; unsigned short Span; UBYTE Channel; UBYTE FacilitySpan0; UBYTE FacilitySpan1; UBYTE FacilitySpan2; UBYTE FacilitySpan3; UBYTE FacilitySpan4; UBYTE FacilitySpan5; UBYTE FacilitySpan6; UBYTE FacilitySpan7; UBYTE FacilitySpan8; UBYTE FacilitySpan9; } XL_DChannelFacilityListQueryAck;

C++ Class
class XLC_DChannelFacilityListQuery : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

C++ Class Response

class XLC_DChannelFacilityListQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpan() const;

1- 324
Release 8.4.1 ER3, February 2008

D Channel Facility List Query 0x00CB

void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getFacilitySpan0() const; void setFacilitySpan0(UBYTE x); UBYTE getFacilitySpan1() const; void setFacilitySpan1(UBYTE x); UBYTE getFacilitySpan2() const; void setFacilitySpan2(UBYTE x); UBYTE getFacilitySpan3() const; void setFacilitySpan3(UBYTE x); UBYTE getFacilitySpan4() const; void setFacilitySpan4(UBYTE x); UBYTE getFacilitySpan5() const; void setFacilitySpan5(UBYTE x); UBYTE getFacilitySpan6() const; void setFacilitySpan6(UBYTE x); UBYTE getFacilitySpan7() const; void setFacilitySpan7(UBYTE x); UBYTE getFacilitySpan8() const; void setFacilitySpan8(UBYTE x); UBYTE getFacilitySpan9() const; void setFacilitySpan9(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00CB) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00CB) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

AIB Address Method 0x00 - Individual AEs Number of AEs AEs 0x0D Channel 0x0C Logical Span (See below)

AE 0x0D Channel : Checksum

Response continued below. Facility 0 Span ID This field represents a span that the specified D channel is controlling. The response contains 10 of these fields, one for each facility (09). The value for a facility that is not configured is 0xFF.

1- 325
Release 8.4.1 ER3, February 2008

D Channel Facility List Query 0x00CB

: : :

: Facility 9 Span ID Checksum

The Channel and Span address type is used for this message. The table that follows shows you the format for addressing the span for Facility 0. Repeat the same format for facilities 18.
Byte
0 1 2 3 4 5 6 7 8 9 10

AIB Field Description

Address Method (0x00) No of Address Elements (0x0A) Channel AE: Address Type (0x0D) Data Length (0x03) Data[0] Logical Span ID, MSB Data[1] Logical Span ID, LSB Data[2] Channel Span, Facility 0 Address Type (0x0C) Data Length (0x02) Data[0] Logical Span ID, MSB Data[1] Logical Span ID, LSB

1- 326
Release 8.4.1 ER3, February 2008

DeviceServerEx

DeviceServerEx
Type Purpose

SwitchKit API message Use the SK_DeviceServerEx message to configure the H.323 IP Signaling Series 3 card. This message is used by the CSA to configure the H.323 IP Signaling Series 3 card. Its configuration syntax corresponds to the message fields of the XL_DeviceServerConfigure and XL_IPCallServerConfigure messages. Host, via CSA configuration or SwitchManager configuration file.

Description

Sent by

1- 327
Release 8.4.1 ER3, February 2008

DeviceServerEx Arguments

The following table shows the arguments you can change:

Arguments ObjectType ID CallServerID Slot ConfigTag CompatFlat PollInterval AllowedMissedPolls Port PrimaryCSPort SecondaryCSPort IpAddress PrimaryCSIpAddress SecondaryCSIpAddress DeviceType Platform

Description 0x0020 Device Server ID The LNI of the CSP Matrix Series 3 Card Slot for the Device Server ignored by SMgr any number see the ServerConfig message see the ServerConfig message Device Server IP Port Port for CSP Matrix Series 3 Card to listen on Port for CSP Matrix Series 3 Card to listen on IP at Device Server IP at CSP Matrix Series 3 Card IP at CSP Matrix Series 3 Card 0x01 See the DeviceServerConfig message by clicking below: Matrix Configure 0x007D

IPDCUsage

See the DeviceServerConfig message by clicking below: Matrix Configure 0x007D

DSInterfaceSupport

See the DeviceServerConfig message by clicking below: Matrix Configure 0x007D

Configuration

DeviceServerEx (
ObjectType = integer, Id = integer,

1- 328
Release 8.4.1 ER3, February 2008

DeviceServerEx
CallServerId = integer, Slot = integer, ConfigTag = integer, CompatFlag = integer, PollInterval = integer, AllowedMissedPolls = integer, Port = integer, PrimaryCSPort = integer, SecondaryCSPort = integer, IpAddress = string, PrimaryCSIpAddress = string, SecondaryCSIpAddress = string, DeviceType = integer, Platform = integer, IDDCUsage = integer, DSInterfaceSupport = BYTE ARRAY);

1- 329
Release 8.4.1 ER3, February 2008

Diagnostics Indication 0x0045

SwitchKit Name Type Description DiagnosticsIndication EXS API and SwitchKit API message Diagnostics Indication 0x0045 This message sends information to the host about a specific module to help diagnose protocol/system problems. Use the ISDN Interface Configure message options bitmask entity for enabling/disabling this message.

WARNING
This message is for debugging purposes only. It should not be sent during live call processing. Use the ISDN Interface Configure message to enable/disable diagnostics.
Sent by SwitchKit Code CSP C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE DiagnosticsType; UBYTE Data[222]; } XL_DiagnosticsIndication;

C++ Class
class XLC_DiagnosticsIndication : public XLC_OneChannelMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getDiagnosticsType() const; void setDiagnosticsType(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 330
Release 8.4.1 ER3, February 2008

Diagnostics Indication 0x0045 EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0045) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs AEs 0x0D Channel : Diagnostics Type 0x01 ISDN PRI Cards Raw Layer 3 HDLC frames Data[0]Direction (0= Layer 2 to Layer 3, 1= Layer 3 to Layer 2) Data[1]Length Data[2]Start of the HDLC data : Data[n]End of the HDLC data Data Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 11 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0008) Message Type (0x0045) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Reserved Checksum

: :

1- 331
Release 8.4.1 ER3, February 2008

Disconnect Tone Pattern 0x001E

SwitchKit Name Type Description DisconnectTonePattern EXS API and SwitchKit API message Disconnect Tone Pattern 0x001E This message instructs the CSP to terminate call progress tone transmission on the specified channel. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_DisconnectTonePattern;

C++ Class
class XLC_DisconnectTonePattern : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x001E) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x001E) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 332
Release 8.4.1 ER3, February 2008

Distant End Release Mode 0x00B8

SwitchKit Name Type Description DistantReleaseConfig EXS API and SwitchKit API message Distant End Release Mode 0x00B8 This message sets a channels distant end release mode, which determines whether the distant end is released or parked when the connection is terminated. Sent by SwitchKit Code Host Configuration
DistantReleaseConfig ( Node = integer, Range = StartSpan:StartChan - EndSpan:EndChan, ReleaseMode = integer);

C Structure
typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE ReleaseMode; } XL_DistantReleaseConfig;

C++ Class
class XLC_DistantReleaseConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getReleaseMode() const; void setReleaseMode(UBYTE x); };

1- 333
Release 8.4.1 ER3, February 2008

Distant End Release Mode 0x00B8

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00B8) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x01 - Range of AEs Number of AEs to follow 0x02 0x0D Channel (Starting) 0x0D Channel (Ending) : Release Mode 0x01 Park 0x02 Release (Default) Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00B8) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 334
Release 8.4.1 ER3, February 2008

Download Begin BRecord 0x009B

Chapter 0 Configuration API Messages

SwitchKit Name Type Description

DownloadBeginBRecord EXS API and SwitchKit API message Download Begin BRecord 0x009B This message should not be sent by the host to standby CSP 2000 Matrix Cards, since the CSP Matrix Series 3 CardCSP Matrix Series 3 Cards receive their loads from the TFTP download. However, you can use this message to configure active CSP 2000 Matrix Cards.

Sent by SwitchKit Code

Host C Structure
typedef struct { } XL_DownloadBeginBRecord;

C++ Class
class XLC_DownloadBeginBRecord : public XLC_OutboundMessage { public: };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x009B) Reserved (0x00) Sequence Number Logical Node ID Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x009B) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

1- 335
Release 8.4.1 ER3, February 2008

Download Begin SRecord 0x00A2

SwitchKit Name Type Description DownloadBeginSRecord EXS API and SwitchKit API message Download Begin SRecord 0x00A2 This message should not be sent by the host to standby CSP 2000 Matrix Cards, since the CSP 2000 Matrix Cards receive their loads from the TFTP download. However, you can use this message to configure active CSP 2000 Matrix Cards. Sent by SwitchKit Code Host C Structure
typedef struct { } XL_DownloadBeginSRecord;

C++ Class
class XLC_DownloadBeginSRecord : public XLC_OutboundMessage { public: };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A2) Reserved (0x00) Sequence Number Logical Node ID Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00A2) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, lSB Checksum

1- 336
Release 8.4.1 ER3, February 2008

Download BRecord 0x009C

SwitchKit Name Type Description DownloadBRecord EXS API and SwitchKit API message Download BRecord 0x009C This message should not be sent by the host to standby CSP 2000 Matrix Cards, since the CSP Matrix Series 3 Cards receive their loads from the TFTP download. However, you can use this message to configure active CSP 2000 Matrix Cards. Sent by SwitchKit Code Host C Structure
typedef struct { UBYTE Data[253]; } XL_DownloadBRecord;

C++ Class
class XLC_DownloadBRecord : public XLC_OutboundMessage { public: const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 9 : : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x009C) Reserved (0x00) Sequence Number Logical Node ID Number of BRecord Bytes (n) BRecord Byte[0] BRecord Byte[n] Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x009C) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

1- 337
Release 8.4.1 ER3, February 2008

Download Complete 0x00A4

SwitchKit Name Type Description DownloadComplete EXS API and SwitchKit API message Download Complete 0x00A4 This message should not be sent by the host to standby CSP 2000 Matrix Cards, since the CSP Matrix Series 3 Cards receive their loads from the TFTP download. However, you can use this message to configure active CSP 2000 Matrix Cards. Sent by SwitchKit Code Host C Structure
typedef struct { int Timestamp; } XL_DownloadComplete;

C++ Class
class XLC_DownloadComplete : public XLC_OutboundMessage { public: int getTimestamp() const; void setTimestamp(int x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8-11 12 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A4) Reserved (0x00) Sequence Number Logical Node ID Timestamp (See below) Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00A4) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

Timestamp

This field is a long word received Most Significant Byte first, and Least Significant Byte last. It is associated with the newly downloaded system software once it has been validated. This field is used to determine which matrix has the most recent system software in a redundant system when two different system software versions
1- 338

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

Download Complete 0x00A4 are present. In this situation the system software with the highest timestamp will be transferred to the other matrix. As far as the matrices are concerned, the timestamp has nothing to do with time, but it is suggested that the host use a time-related number in this field. The host must guarantee that each new load has a higher timestamp than the previous one or the new load will be overwritten with the system software from the other matrix. The format of the timestamp is number of seconds since January 1, 1970.

1- 339
Release 8.4.1 ER3, February 2008

Download SRecord 0x00A3

SwitchKit Name Type Description DownloadSRecord EXS API and SwitchKit API message Download SRecord 0x00A3 This message should not be sent by the host to standby CSP 2000 Matrix Cards, since the CSP Matrix Series 3 Cards receive their loads from the TFTP download. However, you can use this message to configure active CSP 2000 Matrix Cards. Sent by SwitchKit Code Host C Structure
typedef struct { UBYTE Data[253]; } XL_DownloadSRecord;

C++ Class
class XLC_DownloadSRecord : public XLC_OutboundMessage { public: const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 9 : : : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00A3) Reserved (0x00) Sequence Number Logical Node ID Number of SRecord Bytes (n) SRecord Byte[0] : SRecord Byte[n] Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00A3) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 340
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

SwitchKit Name Type Description DS0StatusChange EXS API and SwitchKit API message DS0 Status Change 0x0042 This message informs the host of the current status of the channel specified. It is sent when the status of a channel has changed. All host applications must be designed to handle this message for out-of-service and in-service conditions. Sent by Resent SwitchKit Code CSP This message is resent once after five seconds. C Structure
typedef struct { BaseFields Base; UBYTE AddrInfo[30]; UBYTE ChannelStatus; UBYTE PurgeStatus; } XL_DS0StatusChange;

C++ Class
class XLC_DS0StatusChange : public XLC_InboundMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); XBYTE getStartSpan() const; void setStartSpan(XBYTE x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); XBYTE getEndSpan() const; void setEndSpan(XBYTE x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); XBYTE getSpan() const; void setSpan(XBYTE x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getChannelStatus() const; void setChannelStatus(UBYTE x); UBYTE getPurgeStatus() const; void setPurgeStatus(UBYTE x); };

Tip for C Programmers To extract the span and channel in the C version of the API, you need to use the following code:
...........................................................................................................................................................................................................................................................

1- 341
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

CASE_DS0StatusChange(ds0) { printf(DS0 Stat Change, Span:%d, Chan:%d, Purge:%X\n, sk_getAIBSpan(ds0->AddrInfo), sk_getAIBChannel(ds0->AddrInfo), ds0->ChannelStatus, ds0->PurgeStatus); return OK; }

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0042) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs or for Line Card Busy: 0x01 - Range of AEs Number of AEs to follow AEs 0x0D Channel or 0x0D Channel (Starting) 0x0D Channel (Ending) : Channel Status 0x00 Purge 0x01 Out of Service 0x02 In Service 0x03 Reserved 0x04 Parked 0x05 Blocked 0x06 Unblocked 0x07 Out-of-Service Maintenance Loopback Purge Reason (See table below) Checksum Byte 0 1, 2 3, 4 5 6 7 8 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x0042) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

: :

1- 342
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042 Purge Reason

Value 0x01 0x02 0x03 0x04 0x05 Reserved Configuration Non-dormant Reserved Disabled While Non-dormant Internal Outseize ACK Timeout Reserved Reserved Reserved Contact Dialogic Tech Support Contact Dialogic Tech Support Contact Dialogic Tech Support Description

If the Channel Status is 0x00 (Purge), consult the table below for the Purge Reason and corrective action. Otherwise, this field is 0x00.
Comments Corrective User Action

Channel B did not respond to connect Nonethe CSP has no control over request from Channel A within 30 the remote channel. seconds. Channel B did not respond to a disconnect request from Channel A within 6 seconds. Reserved The RCM stack is either full or in an incorrect state. Layer 4 did not receive an Outseize Control ACK from Layer 3 within 29 seconds. Nonethe CSP has no control over the remote channel. Contact Dialogic Tech Support Contact Dialogic Tech Support If using PPL for L3, make sure the

0x06

Internal Disconnect ACK Timeout

0x07 0x0A 0x0B

Internal Connect ACK Timeout Invalid RCM Stack FEM Outseize ACK Timeout

Outseize Control ACK is sent from

Layer 3 to Layer 4; otherwise, contact Dialogic Technical Support. Contact Dialogic Tech Support

0x0C

Internal Inconsistency

The RCM stack is in a state inappropriate for the action being processed. Layer 3 did not respond to a clear request within 150 seconds.

0x0D

L3 Clear ACK Timeout

If using PPL for L3, make sure that a Clear ACK is sent from L3 to L4; otherwise, contact Dialogic Technical Support. Contact Dialogic Technical Support. If using PPL for L3, make sure a CONNECT is sent from L3 to L4. Otherwise, contact Dialogic Technical Support.

0x0E 0x0F

L4 Hold ACK Wait Timeout L3 Answer Wait Timeout

Reserved Layer 4 timed-out waiting for a L3 answer event. Default timer: 10 minutes

0x10

L4 Answer Wait Timeout

Layer 4 timed-out while waiting for the Verify answer supervision mode. other party involved in the connection to propagate an answer. Default timer: 10 minutes

0x11 0x12

L4 Recall Wait Timeout L3 Channel Out-of-Service

Timed-out while trying to recall the remote RCM.

Contact Dialogic Tech Support

Channel A did not respond to a None, the CSP has no control over Channel Release Request from the remote channel. Channel B. L4 purges in order to bring the purging timeslot into a known state. Reserved. Contact Dialogic Tech Support One of the terminating channels has Contact Dialogic Tech Support. detected an internal error and has been disabled. It also had its status changed to dead and has been reconfigured to some non-idle state or has been implicated in another purge.

0x13 0x14

Implicated by L3 Implicated by L4

1- 343
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0x15

Description Implicated by LCM

Comments

Corrective User Action

One of the terminating channels has Contact Dialogic Tech Support detected an internal error and has been disabled. It also had its status changed to dead and has been reconfigured to some non-idle state, or has been implicated in another purge. Reserved. Contact Dialogic Tech Support Contact Dialogic Tech Support

0x16 0x17 0x18

Unknown LSM State L3 Not Idle at Switchover

L3 Pre-Answer Disconnect Request Reserved.

Layer 4 is idle and Layer 3 is not idle at Make sure Layer 3 is idle before switchover. This brings the channel into issuing a switchover. a known state. L4 went out of service. Two possible reasons: Contact Dialogic Tech Support Check if the end-point signaling with the CSP properly acknowledged the modification request. (For example, The VDAC-ONE card/IP Network Interface Card is not responding to the a RE-INVITE in SIP networks.) modification request. Contact Dialogic Tech Support The network is not responding to the modification request.

0x19 0x1A

Outpulsed Digits Timeout Channel bearer service modification request failed.

0x1B

Channel bearer service modification request timed out.

Layer 4 did not receive any response to Check if the end-point signaling with modify channel bearer service request the CSP properly acknowledged the from Layer 3 within the allowed time. modification request ((For example, a RE-INVITE in SIP networks.) Contact Dialogic Tech Support

0x1C

Request to retrieve a physical span/ The virtual span/channels request to channel resource denied by the retrieve a physical span/channel internal router. denied by the internal router.

Check if the resource table configuration with internal router is proper. Contact Dialogic Tech Support

01D

Request to retrieve a physical span/ Virtual span/channels request to Contact Dialogic Tech Support channel resource timed out. retrieve a physical span/channel timed out. No response from the internal router within the allowed time. Idle Purge BCC Wait Timeout L4 went out of service. Contact Dialogic Tech Support A create broadcast message was sent Send a Release With Data message to from L4 to BCC trying to create a from the host; otherwise, contact conference and a timeout occurred Dialogic Technical Support. waiting for an acknowledgment. Default timer: 6 seconds

0x1E 0x1F

1- 344
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0x20

Description L5 Release Data Wait Timeout

Comments An ISDN Channel Release Request message was sent to the host and a timeout occurred while waiting for a Release With Data message. Default timer: 20 seconds

Corrective User Action Send a Release With Data message from the host within 20 seconds.

0x21

L3 Remotely Blocked

Layer 4 (L4) purges because it is in a Nonethe CSP has no control over state not ready to receive an Out-ofthe remote channel. Service blocked event from the associated Layer 3 channel. This results in bringing the channel into a known state. Layer 4 purges because a timeout occurred while waiting for DSP resources. Layer 4 purges because a timeout occurred while waiting for the completion of outpulsing digits. Make sure DSP resources are available. Make sure outpulsing digits are available.

0x22

DSP Resource Wait Timeout

0x23

Outpulsing Digits Timeout

0x24

Ring Inaccessible

The node cannot access the EXNET Rectify the hardware problem. ring due to a local EXNET hardware problem. The remote node cannot be accessed Rectify the hardware problem. on the EXNET ring due to an EXNET hardware problem on the remote node. Channel purges because timer expires Contact Dialogic Tech Support before MCC sends Layer 4 a response to the Connect to Conference or Connect One-Way to Conference message. Default timer: 12 seconds Internal routing look up for a physical resource negatively acknowledged. Possibly due to lack of free physical resources. That is, demand for physical resources has exceeded the supply. Internal routing look up for a physical resource timed out. Reserved Reserved Channel purged because span received Carrier Group Alarm (CGA). Check for consistency between actual physical resources and the internal router database configuration. If no such inconsistency is found, add more physical resources. Contact Dialogic Tech Support

0x25

Node Inaccessible

0x26

MCC Response Timeout

0x27

Internal router look up failure

0x28 0x38 0x71 0x72 0x73 0x74

Internal router look up timed out Remote Conferencing Timeout Implicated in Error Detection Configured, Non-Dormant Span Receiving CGA Alarm Disabled While Non-dormant

Contact Dialogic Tech Support Contact Dialogic Tech Support Nonethe CSP has no control over the remote channel.

Layer 3 purges because it is in a state Do not take a channel out-of-service not ready to bring a channel out-ofwhen it is involved in a connection. service. No corrective action is necessary. Sent to host whenever an E1 PPL channel is taken out-of-service with the Service State Configure message.

1- 345
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0x75

Description Internal Outseize ACK Timeout

Comments

Corrective User Action

Layer 3 purges because it did not Verify outgoing start dial type. receive a wink when attempting to busy out a channel. Layer 3 purges because a timeout Contact Dialogic Tech Support occurred while waiting for Layer 4 to be cleared of a call. Layer 3 purges because a timeout Nonethe CSP has no control over occurred while waiting for the channel the remote channel. to be connected. Layer 3 purges because a time-out occurred while waiting for a busy out acknowledgment from Layer 4. Layer 3 purges with an unexpected internal error. Contact Dialogic Tech Support

0x76

Internal Disconnect Clear Wait Timeout Internal Connect Wait Timeout

0x77

0x78

Busy Out ACK Timeout

0x79 0x7A

Internal Inconsistency Layer 4-implicated Layer 3 Purge

Contact Dialogic Tech Support

Layer 4 purge implication message Contact Dialogic Tech Support based upon the current condition of the call stack as well as the associated Layer 3 timeslot. A channel configuration has purged to Nonethis is not an error. allow a new configuration to be assigned. A null outseize instruction was encountered. A null outseize instruction list instruction was encountered. An invalid outseize instruction was encountered. An invalid wink number has been specified in either: Modify Outseize Control message. Modify outseize instruction list. Modify Outseize Control message or programmed outseize instruction list.

0x7B

CFG-implicated Layer 3 Purge

0x7D 0x7E 0x7F 0x80

Null Outseize Control Instruction Encountered Null Outseize Instruction List Instruction Encountered Invalid Outseize Instruction Encountered Invalid Outseize Instruction Data

Modify ICB in Outseize Control message or instruction data byte 1 in the preprogrammed outseize A Scan for Wink N ICB in an Outseize instruction list. The wink number must be from 1 to 8. Control message. A preprogrammed Scan For Wink N outseize instruction.

0x81

No Outseize Data Available

An Outpulse Stage N Address Data instruction has been included in either an Outseize Control message or preprogrammed outseize instructions without corresponding Stage N Address Data.

Include a Stage N Address Data ICB in the Outseize Control message or instruction data in the programmed instructions.

0x82

No Outseize ACK Outstanding

A Send Host ACK instruction was Make sure there is only one Send included in either an Outseize Control Host ACK instruction per Outseize message or a programmed outseize Control or outseize instruction list. instruction list and there are no outstanding outseize instructions. Layer 3 is in a Wait For Host State where answer is not allowed. Modify the Outseize Control message or programmed outseize instruction list to use a Wait for Host Control with Answer Supervision ICB instead of a Wait For Host Control ICB.

0x83

Unexpected Off-hook Detected

1- 346
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0x84 0x85

Description

Comments

Corrective User Action

On-hook Host Control Wait Timeout Layer 3 purged waiting for host control Provide host control within 120 within 120 seconds. seconds. On-hook Host Data Wait Timeout An Outpulse Stage N Address Data instruction has been included in either an Outseize Control message or preprogrammed outseize instructions without corresponding Stage N Address Data within the timer period. Layer 3 purges while waiting for wink from the distant end within the timer period. Layer 3 received a wink that exceeded the maximum allowed wink duration. If this condition happens for the initial wink, glare is declared. Layer 3 failed to get an outpulsing complete message from tone call within the Outpulse Complete Timer. Default timer: 6 seconds. Include a Stage N Address Data ICB in the Outseize Control message or instruction data in the programmed instructions.

0x86

Failure to Receive Wink

Nonethe CSP has no control over the remote channel. If the maximum allowed wink duration is too short, increase it; otherwise, you cannot take action because the CSP does not have control over the remote channel. Modify the Outseize Control message or programmed outseize instructions so that the correct number of digits is being outpulsed, or increase the outpulse complete time. Contact Dialogic Tech Support

0x87

Wink Tolerance Exceeded

0x88

On-hook Outpulse Complete Timeout

0x89 0x8A

Failure to Detect Off-hook Failure to Receive Call Progress Analysis Result

Reserved.

Layer 3 failed to get a call progress Contact Dialogic Tech Support analysis result within the timer period. Default timer: 120 seconds.

0x8B

Failure to Detect Dialtone

Layer 3 failed to get dialtone detection Verify outgoing start dial type. from call progress analysis within the timer period. Default timer: 120 seconds.

0x8C

Off-hook Host Control Wait Timeout Layer 3 purges when a timer expires in Provide host control within timer the off-hook host control wait state. The period. host failed to provide further action within the timer period. Default timer: 120 seconds.

0x8D

Off-hook Host Data Wait Timeout

An Outpulse Stage N Address Data instruction has been included in either an Outseize Control message or preprogrammed outseize instructions without corresponding Stage N Address Data within the timer period. Default timer: 120 seconds

Include a Stage N Address Data ICB in the Outseize Control message or instruction data in the programmed instructions.

0x8E

Invalid Off-hook Outseize Instruction

Layer 3 purged attempting to Scan For Verify the call flow. Wink or Scan For ANI Off-hook because the distant end was already off-hook.

1- 347
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0x8F

Description Off-hook Outpulse Complete Timeout

Comments Layer 3 failed to get an outpulsing complete message from tone control within the timer period. Default timer: 6 seconds.

Corrective User Action Modify the Outseize Control message or programmed outseize instructions so that the correct number of digits is being outpulsed, or increase the outpulse complete time. Modify the Inseize Control message or programmed inseize instruction list. Modify the Inseize Control message.

0x90

Invalid Inseize Instruction Encountered

An invalid inseize instruction was encountered while processing an Inseize Control message or programmed inseize instructions. A null inseize instruction was encountered while processing an Inseize Control message. A Null inseize instruction was encountered while processing an inseize instruction list. A Receive Stage N Address Data instruction was included in either an Inseize Control message or programmed inseize instruction list with inpulsing parameters for stage not configured. Reserved. Reserved. A Receive Stage N Address Data instruction was included in either an Inseize Control message or programmed inseize instruction list with inpulsing parameters for stage not configured.

0x91

Null Inseize Instruction Encountered Null Inseize Instruction List Encountered Initialized Inpulsing Stage Data

0x92

Modify the inseize instruction list with the Inseize Instruction List Configure message. Modify the Inseize Control message or inseize control list so that the correct stage number is specified; or configure the inpulsing parameters with the Inpulsing Parameters Configure message. Contact Dialogic Tech Support Contact Dialogic Tech Support Modify the Inseize Control message or inseize control list so that the correct stage number is specified; or configure the inpulsing parameters with the Inpulsing Parameters Configure message.

0x93

0x94 0x95 0x96

Invalid Inseize Start Dial Signal Invalid Inseize Receive Stage Condition Invalid Inseize Receive Stage Parameters

0x97

No Receiver Request Response

A Receive Stage N Address Data Verify digit receiver resources. instruction was included in either an Inseize Control message or programmed inseize instruction list and Layer 3 has failed to get a response from a digit receiver within the timer period. Layer 3 sent a request for digit Make sure digit collection timers are collection, but failed to get a response set correctly (Inpulsing Parameters within the timer period. Configure message). Layer 3 purges when a timer expires in Provide host control. the Inseize Host Control Wait state. The host failed to provide further action within the specified amount of time. Default timer: 120 seconds.

0x98

No Digits Response

0x99

Inseize Host Control Wait Timeout

0x9A

No Inseize ACK Outstanding

A Send Host ACK instruction has been Make sure there is only one Send included in either an Inseize Control Host ACK instruction per Outseize message or programmed inseize Control or outseize instruction list. instruction list but there are no unacknowledged inseize instructions.

1- 348
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0x9B

Description Function Type Not Supported

Comments

Corrective User Action

Layer 3 requested DSP service but the Make sure a DSP is configured for function type requested is not the function type. available. Reserved. Reserved. State/Event list is null. Contact Dialogic Tech Support Contact Dialogic Tech Support Contact Dialogic Tech Support Check PPL and state/event table list. Check the PPL.

0x9C 0x9D 0x9E 0x9F 0xA0

Suspend Reject Resume Reject PPL Null State/Event List

PPL Invoked For Invalid Trunk Type Reserved. PPL Invalid Event for Decision State PPL is in an internal state, waiting for some event to drive it out to a normal state. It receives an internal event while in the internal state. PPL Timer Expired in Internal State Reserved. PPL Negative Internal State Response

0xA1 0xA2

Contact Dialogic Tech Support

A negative response was received in Make sure the MFDSP is configured an internal state. Layer 3 was for the function type. requesting a DSP service while the service was not available or supported. Reserved. Contact Dialogic Tech Support Contact Dialogic Tech Support Contact Dialogic Tech Support Check the PPL. Make sure there are atomic functions between two states.

0xA3 0xA4 0xA5 0xA6

PPL Not Internal Wait Event

PPL Exceeded Maximum Number The maximum number of PPL of Iterations iterations was exceeded. ISDN Host Call Proceeding Wait Timeout PPL Null Primitive A time-out occurred while in the ins_pass through state. A null primitive was encountered. There is no atomic function between two states.

0xAC Invalid ISUP Data

An API message such as Release with Correct the data in the ICB. Data (0x0036) contains invalid ICB data. The config bytes max offset has been Contact Dialogic Tech Support exceeded. Reserved. Contact Dialogic Tech Support Contact Dialogic Tech Support

0xAF 0xB1 0xB2

Config Byte Max Offset Exceeded Timeout Waiting for Silence in Backward Reception Mode

Timeout Waiting to Receive a Reserved. Forward Tone to Transmit from PPL in Backward Reception Mode Timeout While Waiting to Receive a Reserved. Tone in Backward Reception Mode

0xB3 0xB4

Contact Dialogic Tech Support

Timeout While Waiting for Silence in Timeout occurred while waiting for the Determine cause of sustained signal Forward Reception Mode incoming forward tone to terminate on external termination device. after a backward signal has been sent in the forward reception state machine. Default timer: 10 seconds (R2 timer #4 divided by 2)

1- 349
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value 0xB5

Description

Comments

Corrective User Action

Timeout Waiting to Receive a The termination device that initiated the Determine cause of signal delay on Forward Tone in Forward Reception call has failed to transmit a forward external termination device. Mode tone within the time allowed after transition to the wait for forward tone within the time allowed after a transitioning to the wait for forward tone state in the forward state machine. Default timer: 10 seconds (R2 timer #4 divided by 2) Timeout Waiting to Receive a Backward Tone to Transmit from PPL in Forward Reception Mode The PPL has failed to transmit a Determine cause of failure of PPL to backward signal within the timer period transmit backward signal. after transitioning to the Wait For Backward Signal To Transmit state in the forward reception state machine. Default timer: 10 seconds (R2 timer #4 divided by 2) Received Silence While Waiting for Indicates that the termination device an Event to Transmit a Backward that initiated the call has dropped the Tone in Backward Reception Mode forward signal prior to receiving a backward acknowledgment. Received an Incoming Forward Tone While Waiting to Transmit a Backward Tone in Forward Reception Mode. DSP Release Wait Timeout Indicates a violation of compelled signaling on an incoming call. The termination device is transmitting a forward signal prior to receiving a backward acknowledgment. A DSP resource timed out while attempting to release the resource Determine the cause of signal drop on external termination device.

0xB6

0xB7

0xB8

Determine the cause of failure of external termination device to wait for backward acknowledgment signal. Contact Dialogic Technical Support.

0xCA

0xCB

VDAC purges the channel because VPPL L3 on the VDAC negatively Layer 4 did not release it. acknowledges the Outseize Control message and times out waiting for Layer 4 to release the channel. Since Layer 4 did not release the channel, VDAC purges the channel. Varies by PPL protocol. Varies by PPL protocol. None Varies by PPL protocol. Varies by PPL protocol.

0xCC Layer 3 PPL Purge Error 0xCD Wait for Host Control Timeout 0xCF 0xD4 0xD5 Forced purge for Media Recovery Layer 4 Connect wait timeout Layer 4 Clear wait timeout

0xDA Layer 4 Busy out ACK wait timeout Varies by PPL protocol. 0xDB IP Resource Release Wait Timeout VDAC Resource Release Wait Timeout Contact Dialogic Technical Support

1- 350
Release 8.4.1 ER3, February 2008

DS0 Status Change 0x0042

Value

Description

Comments Could be caused by any of the following: Message size exceeds the maximum IMSG size. NPDI data size exceeds the maximum. Outgoing SIP message size exceeds 1500 Bytes.

Corrective User Action Check the incoming SIP message.

0xDD SIP Internal Error

0xDE VDAC rejected/timeout

The message sent to the VDAC-ONE card was not acknowledged or timed out.

Check the VDAC-ONE card and router configurations.

0xDF

Network error/timeout

The remote SIP entity is not responding Check if the remote side is down. to messages. Check the network.

SIP Socket Open Failure 0xE0 0xE1 Layer 4 response timeout Invalid SDP/NPDI data

The peer entity cannot accept any additional TCP socket connections.
SIP timed out waiting for a response from Layer 4. In call agent mode, the user puts invalid data (typically sdp) in the Connect With Data message The physical span/channel identifier Resolve glare issues between the provided by the host application CSP and the host channel hunting (typically for call gent mode coupling) is and allocation algorithms. in non-idle state in the CSP. or The host supplied physical span channel is not a valid physical VoIP channel.

0xE2

Invalid coupled channel state or Invalid physical channel

0xF7 0xFD 0xFF

Layer 4 Clear Request timeout Call Progress Analysis timeout R2 Cycle Complete timeout

1- 351
Release 8.4.1 ER3, February 2008

DS3 Configure/Query 0x000F

SwitchKit Name Type Description DS3GenericMessage EXS API and SwitchKit API message DS3 Configure/Query 0x000F Use this message to perform the following: Configure Loopback Mode Query Loopback Mode DS3 Framer Configure and Query NOTE: You must take a DS3 (Entity 1) or the DS3 spans (Entity 3) out of service before you can place it into local loop back. The DS3 AIB must always be 0.

Sent by SwitchKit Code

Host Configuration
DS3GenericMessage ( Node = integer, Slot = integer, DS3 = integer, Entity = integer, DataLength = integer, Data = byte array);

C Structure
typedef struct { UBYTE Slot; UBYTE DS3; UBYTE Entity; UBYTE DataLength; UBYTE Data[221]; } XL_DS3GenericMessage;

C Structure Response
typedef struct { unsigned short Status; UBYTE Slot; UBYTE DS3; UBYTE Entity; UBYTE DataLength; UBYTE Data[219]; } XL_DS3GenericMessageAck;

1- 352
Release 8.4.1 ER3, February 2008

DS3 Configure/Query 0x000F C++ Class

class XLC_DS3GenericMessage : public XLC_OutboundMessage { public: UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getDS3() const; void setDS3(UBYTE x); UBYTE getEntity() const; void setEntity(UBYTE x); UBYTE getDataLength() const; void setDataLength(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

C++ Class Response

class XLC_DS3GenericMessageAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getDS3() const; void setDS3(UBYTE x); UBYTE getEntity() const; void setEntity(UBYTE x); UBYTE getDataLength() const; void setDataLength(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Name Frame (0xFE) Length (0x00NN) Message Type (0x000F) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1, 2 3, 4 5 6 7 Frame(0xFE) Length (0x00NN) Message Type (0x000F) Reserved (0x00) Same Number Logical Node ID RESPONSE (Gray) Field Name

1- 353
Release 8.4.1 ER3, February 2008

DS3 Configure/Query 0x000F

MESSAGE (White) Byte : Field Name AIB Address Method 0x00 - Individual AEs Number of AEs AEs 0x32 DS3 Offset This value should always be 0. : Entity The operation to perform on the DS3: 0x01 Loop Back Configure 0x02 Loop Back Query 0x03 DS1 Loop Back Configure (All spans) 0x04 DS3 Framer Configure 0x05 DS3 Framer Query 10 Byte 8, 9

RESPONSE (Gray) Field Name Status (MSB, LSB)

AIB Same as message

1- 354
Release 8.4.1 ER3, February 2008

DS3 Configure/Query 0x000F

MESSAGE (White) Byte : : Data Length Data[0-N] This field is dependent on the entity specified: Entity: 0x01, 0x03: Data[0] Loop Back Mode 0x00 Disable Local Loop Back Disable loop back of received stream to the transmit DS3 stream 0x01 Enable Local Loop Back Enable loop back of received stream to the transmit stream 0x02 Cancel Remote Loop Back Cancel the request for the distant end to loop back its received stream to the transmit stream (CBIT only) 0x03 Request Remote Loop Back Request distant end to loop back its received stream to the transmit stream (CBIT only) Entity: 0x02 Data: No data required Entity: 0x04 - DS3 Framer Configure Data [0] 0x00 - CBIT 0x01 - M13 Entity: 0x05 DS3 Framer Query Data: No data required : Checksum : Field Name Byte : : : Entity

RESPONSE (Gray) Field Name Data Length: Variable Info[0-N] Information returned depends upon the entity specified: Entity: 0x01, 0x03: No information reported. Entity: 0x02: Info[0] Local Loop Back Mode 0x00 Local Loop Back Disabled 0x01 Local Loop Back Enabled Info[1] Remote Loop Back Mode 0x00 Remote Loop Back Requested 0x01 Remote Loop Back Cancelled

When the distant end requests that the CSP be placed into loopback mode, an alarm is sent to the host. The host is responsible for initiating the loopback process.

Entity: 0x04 - DS3 Framer Configure No information reported.

Entity: 0x05 DS3 Framer Query Data[0] 0x00 - CBIT 0x01 - M13 Checksum

1- 355
Release 8.4.1 ER3, February 2008

DSP Cache Modify 0x011A

SwitchKit Name Type Description DSPCacheModify EXS API and SwitchKit API message DSP Cache Modify 0x011A NOTE: This message applies to the DSP Series 2 card only. Use this message to clear either a single file ID (including a file ID for a temporary recording) or all file IDs on the main board cache as well as the cache on all the DSPs. You can also use this message to copy any file residing in cache (playback or recording) to permanent storage on a server. Sent by SwitchKit Code Host Application C Structure
typedef struct { UBYTE Slot; UBYTE reserved18[29]; UBYTE DataType; UBYTE TLVCount; UBYTE Data[220]; } XL_DSPCacheModify;

C++ Class
class XLC_DSPCacheModify : public XLC_OutboundMessage { public: UBYTE getSlot() const ; void setSlot(UBYTE x); UBYTE getDataType() const; void setDataType(UBYTE x); UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 356
Release 8.4.1 ER3, February 2008

DSP Cache Modify 0x011A

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x011A) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0x00NN) Message Type (0x011A) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x0001 Invalid TLV Data Possible reasons for this Nack are as follows: - File ID is not cached. - File cannot be written to the NFS server. This could be due to multiple reasons. - File not present in cache - NFS server not mounted - NFS server is mounted but the file could not be - opened/written (for example, if the share does not - have write permission or the server runs out of space) 0x0003 Invalid number of TLVs There are no TLVs in the message. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV. 0x000D Mandatory TLVs missing One or more mandatory TLVs is missing. Also see Common Response Status Values in the API Reference Number of AEs to follow AE 0x01 Slot : Data Type 0x00 TLVs 10 Checksum RESPONSE (Gray) Field Description

1- 357
Release 8.4.1 ER3, February 2008

DSP Cache Modify 0x011A

: :

Number of TLVs to Follow TLVs 0x05FA Card Object 0x05FF DSP Cache Modify Action If the DSP Cache Modify Action TLV specifies Clear Specific Cache (0x0000), then one or more File ID TLVs (0x05E0) are required. If the DSP Cache Modify Action TLV specifies Copy Specific Cache (0x0002), then the File ID (0x05E0), File Format (0x05E1) and File Location (0x05E2) TLVs are required If the DSP Cache Modify Action TLV specifies Clear All (0x0001), then no other TLVs are required besides 0x05FA Card Object 0x05E0 File ID 0x05E1 File Format 0x05E2 File Location

Checksum

1- 358
Release 8.4.1 ER3, February 2008

DSP Service Cancel 0x00BE

SwitchKit Name Type Description DSPServiceCancel EXS API and SwitchKit API message DSP Service Cancel 0x00BE Use this message to cancel a DSP Service. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE ServiceType; UBYTE reserved48[222]; } XL_DSPServiceCancel;

C++ Class
class XLC_DSPServiceCancel : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getServiceType() const; void setServiceType(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00BE) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1, 2 3, 4 5 6 7 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00BE) Reserved (0x00) Same Sequence Number Logical Node ID

1- 359
Release 8.4.1 ER3, February 2008

DSP Service Cancel 0x00BE

AIB Address Method 0x00 - Individual AEs Number of AEs AE 0x0D Channel

8, 9 10

Status MSB, LSB Checksum

Service Type 0x01 DTMF Receiver 0x02 Energy Detection 0x03 CPA Receiver 0x04 Coin Tone Receiver 0x14 DTMF and Dial Pulse Receiver 0x15 Dial Pulse Receiver 0x16 DTMF and Dial Pulse Receiver with Termination of Tone/Announcement 0x17 Dial Pulse Receiver with Termination of Tone/Announcement 0x81 DTMF Receiver, Matrix (Based RFC 2833 Collection) 0xC1 DTMF Receiver, Matrix (Based on SUBSRIBE/NOTIFY) 0xE1 DTMF Receiver with Termination of Tone/Announcement : Checksum

1- 360
Release 8.4.1 ER3, February 2008

DSP Service Request 0x00BD

SwitchKit Name Type Description DSPServiceRequest EXS API and SwitchKit API message DSP Service Request 0x00BD Use this message to allocate a DSP service on the specified channel. DSP services supported are: DTMF Reception Energy Detection Call Progress Analysis Reception Coin Tone Reception (DSP-ONE Only) After this message is sent the CSP sends the Call Processing Event (0x2E) message to report the occurrence of a corresponding Event on the specified channel. However, if the DSP service type is Call Progress Analysis (0x03) the CSP answers with a Call Progress Analysis Result (0x34) message.

NOTE: Sent by SwitchKit Code Host C Structure

Ringback is detected on the fourth cycle of ringback/silence.

typedef struct { unsigned short Span; UBYTE Channel; UBYTE ServiceType; UBYTE Data[222]; } XL_DSPServiceRequest;

C++ Class
class XLC_DSPServiceRequest : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getServiceType() const; void setServiceType(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 361
Release 8.4.1 ER3, February 2008

DSP Service Request 0x00BD

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x00BD) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Service Type 0x01 DTMF Receiver 0x02 Energy Detection 0x03 Call Progress Analysis Receiver 0x04 Coin Tone Receiver 0x14 DTMF and Dial Pulse Receiver 0x15 Dial Pulse Receiver 0x16 DTMF and Dial Pulse Receiver with Termination of Tone/Announcement 0x17 Dial Pulse Receiver with Termination of Tone/Announcement 0x81 DTMF Receiver, Matrix Based RFC 2833 collection 0xC1 DTMF Receiver, Matrix Based on SUBSCRIBE/NOTIFY 0xE1 DTMF Receiver with Termination of Tone/Announcement Byte 0 1, 2 3, 4 5 6 7 8, 9 10 Frame (0xFE) Length (0x0007) Message Type (0x00BD) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x0002 DSP Receiver Request Timeout Checksum RESPONSE (Gray) Field Description

1- 362
Release 8.4.1 ER3, February 2008

DSP Service Request 0x00BD

Data[0 . . . ] The meaning of the Data fields depends on the Service Type. See below. 0x01 0x16 0x17 0x81 0xE1 DTMF Receiver (0x01) and DTMF and Dial Pulse Receiver with Termination of Tone/Announcement Dial Pulse Receiver with Termination of Tone/Announcement DTMF Receiver, Matrix Based RFC 2833 Collection DTMF Receiver with Termination of Tone/Announcement The DTMF receiver data instructs the CSP to attach a digit receiver to the specified channel and to start collecting digits. The call must be in a state other than idle, out of service, or busied out. The CSP sends Call Processing Event messages with event digits for every digit collected. If an error condition occurs, the CSP sends a Call Processing Event message with the Status field indicating the error. The host application is responsible for instructing the CSP to release the digit receiver when either the receiver is finished collecting digits or when an error condition occurs. The host accomplishes the release by sending a DSP Service Cancel message. If the call is disconnected, the CSP releases the digit receiver. Data[0,1] Digit Timer The maximum amount of time to wait for the digit. The following values disable this timer: 0xFFFF 0x0000 0x0001 0x0002 Data[2] Configuration Bits (0 = disabled, 1 = enabled) Bit 0 Report the digit at its falling edge (when the first digit is released). If the bit is not set the digit will be reported at its rising edge (when the digit is first entered). Bit 1 Ignore # character as first digit. Bit 2 Report digit duration (the amount of time the digit has been pressed). Valid only if Configuration Bit Number 0 is 1. Bits 37 Reserved, must be 0.

Data[3,4] Minimum Receive Digit Duration Timer Valid timer values: 0x00000xFFFE The minimum amount of time for a digit to be present before it is detected and validated. If you send the values 0x0000 through 0x0002, the CSP automatically sets the time to 0x0003. Note: The Minimum Receive Digit Duration Timer field is not valid for dial pulse detection. For DTMF detection, you may set either the Digit Timer or the Minimum Digit Duration timer to 0xFFFF, but not both. If you set both timers to 0xFFFF, this message cannot detect digits. Data[5] Termination Digit for Playback/Tone Generation 0xFF Any DTMF termination digit for terminating playback/tone generation Note: Data[5] used with Service Type 0xE1, 0x16 and 0x17

1- 363
Release 8.4.1 ER3, February 2008

DSP Service Request 0x00BD

0x02 Energy Detection Data[0] Sensitivity Level The loudness is measured by the energy level present for white noise (constant energy) at a specified dBm level, ranging from 0 dBm (loudest) to -30 dBm (quietest). A sensitivity level of 0 dBm, the least sensitive, would be used in a case where there is a high level of background noise expected. A sensitivity level of -30 dBm, the most sensitive would be used if there is little background noise expected. 0x00 0 dBm 0x01 05 dBm 0x02 10 dBm 0x03 15 dBm 0x04 20 dBm 0x05 25 dBm 0x06 30 dBm Data[1] Reporting Mode 0x01 Report Initial Energy Detection Only 0x02 Report All Energy Threshold Crossings Data[2,3] Scan Duration The scan duration must be expressed in 20 ms increments (10 ms units). For example: 0x0002 = 20ms 0x0004 = 40 ms 0x0006 = 60 ms, etc. Odd increments are rounded down (for example, 0x0003 = 20ms). For more information on energy detection, refer to the API Developers Guide: Overview. Data[4,5] Completion Timer The maximum amount of time to scan for energy. The following values disable this timer: 0xFFFF 0x0000 0x0001 0x0002 0x03 Call Progress Analysis Receiver Allows the host to perform interactive CPA on a channel. Data[0] CPA Class 0x00 North American Default 0x01 Dialtone 0x02 CPC Detection 0x03 Energy Detection 0x04 Coin Tone Receiver Data[0,1] Completion Timer The maximum amount of time to scan for Coin Tones. If the completion timer expires, the CSP releases the Coin Tone receiver. This field may be set to 0xFFFF to disable the timer. : Checksum

1- 364
Release 8.4.1 ER3, February 2008

DSP SIMM Configure 0x00C0

SwitchKit Name Type Description DSPSIMMConfig EXS API and SwitchKit API message DSP SIMM Configure 0x00C0 Use this message to configure a SIMM on a DSP card. Each SIMM is populated with four DSPs. The host can specify the function to be downloaded to each DSP. You must take a SIMM out of service before sending this message. After receiving an Acknowledgment to the DSP SIMM Configure message, bring the SIMM back in service. On the DSP-ONE card, each DSP can only handle one function, and four DSPs are configured at the same time. On the DSP Series 2 card, each DSP can handle multiple functions, so the DSP Chip AIB (0x22) is used to configure individual DSP chips. NOTE: When configuring DSP cards for MFR2 signaling, each card that contains MFR2 receivers must also have MFR2 backward and forward transmitters. If MFR2 Receivers only are present, an incoming call causes an alarm that specifies DSP Function Not Configured and the MFR2 receivers are not used.

Sent by Example Message (Socket Log Output for SwitchKit) SwitchKit Code

Host Application 00 0F 00 C0 00 00 FF 00 01 12 02 01 01 01 01 01 01

Configuration
DSPSIMMConfig ( Node = integer, Slot = integer, SIMM = integer, DSPChip = integer, DSP0Func = integer, DSP1Func = integer, DSP2Func = integer, DSP3Func = integer);

C Structure
typedef struct { UBYTE AddrInfo[30]; UBYTE DSP0Func; UBYTE DSP1Func; UBYTE DSP2Func; UBYTE DSP3Func;
...........................................................................................................................................................................................................................................................

1- 365
Release 8.4.1 ER3, February 2008

DSP SIMM Configure 0x00C0

} XL_DSPSIMMConfig;

C++ Class
class XLC_DSPSIMMConfig : public XLC_SlotMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getDSPChip() const; void DSPChip(UBYTE x); UBYTE getDSPSlot() const; void setDSPSlot(UBYTE x); UBYTE getDSPSIMM() const; void setDSPSIMM(UBYTE x); UBYTE getSIMM() const; void setSIMM(UBYTE x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getDSP0Func() const; void setDSP0Func(UBYTE x); UBYTE getDSP1Func() const; void setDSP1Func(UBYTE x); UBYTE getDSP2Func() const; void setDSP2Func(UBYTE x); UBYTE getDSP3Func() const; void setDSP3Func(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00C0) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x12 DSP SIMM 0x22 DSP Chip (DSP Series 2 card only) : : : : : Function 1 Function 2 Function 3 Function 4 Checksum 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00C0) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB

1- 366
Release 8.4.1 ER3, February 2008

DSP SIMM Configure 0x00C0 Slot Number The slot numbers are as follows: CSP 2090: 0x000x0F - Physical slot number of the DSP card CSP 2040: 0x000x03 - Physical slot number of the DSP card The SIMM numbers are as follows: DSP-ONE Card: 0x000x03 DSP Series 2 Card: 0x00 or 0x01 On the DSP Series 2 card, each field configures a function on a single chip on a DSP. On the DSP-ONE card, each field configures a function on an entire DSP. DSP Series 2 Function 1 = RCV 0 Function 2 = TXMT 0 Function 3 = RCV 1 Function 4 = TXMT 1 DSP-ONE Function 1 = DSP 0 Function 2 = DSP 1 Function 3 = DSP 2 Function 4 = DSP 3 Function Types 0x00 - No Function Type Tone Reception 0x01- DTMF -law 0x02 - MFR1 -law 0x03 - DTMF A-Law 0x04 - MFR1 A-Law 0x05 - MFR2 A-Law 0x06 - MFR2 -Law 0x07 - CPA A-Law 0x08 - CPA -Law 0x09 - E1 Dial Pulse (DSP-ONE only) 0x0A - Energy Detection 0x0E - Coin Detection -Law (DSP-ONE only) 0x0F - Coin Detection A-Law (DSP-ONE only)

SIMM Number

Function

1- 367
Release 8.4.1 ER3, February 2008

DSP SIMM Configure 0x00C0 Tone Generation DSP Series 2 0x30 - Universal Tone Generation -Law 0x31 - Universal Tone Generation A-Law DSP-ONE 0x10 - DTMF -Law 0x11 - DTMF A-Law 0x12 - MFR1 -Law 0x13 - MFR1 A-Law 0x14 - CPT4 -Law 0x15 - CPT4 A-Law 0x16 - MFR2 Forward A-Law 0x17 - MFR2 Forward -Law 0x18 - MFR2 Backward A-Law 0x19 - MFR2 Backward -Law 0x1A - Bong Tone -Law 0x1B - Bong Tone A-Law Fax 0x32 - Send/Receive Fax File Playback / Record (DSP Series 2 Only) 0x1D - File Playback / Record Conferencing DSP Series 2 0x21 - Monitor 0x22 - Unified 0x23 - DTMF-Clamped * * This option is for backward compatibility. With the DSP Series 2 card you can create a Unified Conference with DTMF Clamping enabled, which is the recommended method DSP-ONE 0x1E - Standard -Law 0x1F - Standard A-Law 0x20 - Mixed 0x21 - Monitor 0x22 - Unified 0x23 - DTMF-Clamped
...........................................................................................................................................................................................................................................................

1- 368
Release 8.4.1 ER3, February 2008

DSP SIMM Configure 0x00C0 NOTE: You cannot configure a VRAS SIMM. Miscellaneous 0x33 - Echo Cancel (DSP Series 2 Only) 0x34 - Positive Voice Detection/Answering Machine Detection (PVD/AMD) (DSP Series 2 Only) Frequency Shift Keying 0x35 - Transmit FSK only (DSP Series 2 Only) 0x36 - Transmit and Receive FSK (DSP Series 2 Only) Default Function Types on the DSP Series 2 card
Module Number 0 0 0 0 1 1 1 1 DSP Number 0 1 2 3 0 1 2 3 Rcv 0 DTMF -law (0x01) DTMF -law (0x01) CPA -law (0x08) File Playback/Record (0x1D) DTMF -law (0x01) DTMF -law (0x01) MFR1 -law (0x02) MFR1 -law (0x02) Txmt 0 Universal -law (0x30) Universal -law (0x30) Universal -law (0x30) Not allowed (0x00) Universal -law (0x30) Universal -law (0x30) Universal -law (0x30) Universal -law (0x30) Rcv 1 DTMF -law (0x01) DTMF -law (0x01) CPA -law (0x08) File Playback/Record (0x1D) DTMF -law (0x01) DTMF -law (0x01) MFR1 -law (0x02) MFR1 -law (0x02) Txmt 1 Universal -law (0x30) Universal -law (0x30) Universal -law (0x30) Not allowed (0x00) Universal -law (0x30) Universal -law (0x30) Universal -law (0x30) Universal -law (0x30)

Configuration Options on the DSP Series 2 Card

The following table shows configuration options for function types on the DSP Series 2 card.
Rcv 0 Any Tone Receiver Function File Record or Playback T.30 Fax Txmt 0 Rcv 1 Any Tone Receiver Function File Record or Playback T.30 Fax Echo Cancel Any of the Valid Conferencing Types Txmt 1 Universal Tone Generator Not allowed (0x00) Not allowed (0x00) Not allowed (0x00) Not allowed (0x00) Universal Tone Generator Not allowed (0x00) Not allowed (0x00) Echo Cancel Not allowed (0x00) Any of the Valid Not allowed Conferencing Types (0x00)

1- 369
Release 8.4.1 ER3, February 2008

DSP SIMM Configure 0x00C0

Configuration FSK Options on the DSP Series 2 Card

The following table shows configuration options for the FSK function types on the DSP Series 2 card.
Rcv 0 Any Tone Receiver Function Transmit and Receive FSK (0x36) Txmt 0 Transmit FSK Only (0x35) Not allowed (0x00) Rcv 1 Any Tone Receiver Function Transmit and Receive FSK (0x36) Txmt 1 Transmit FSK Only (0x35) Not allowed (0x00)

Default Function Types on the DSP-ONE Card

For more information, please refer to the DSP Resources of the Developers Guide: Overview. The table below shows the default SIMM and DSP configurations.
DSP 0 SIMM 0 0x01 -law DTMF Rec 0x10 -law DTMF Gen 0x02 -law MFR1 Rec 0x01 -law DTMF Rec DSP 1 0x01 -law DTMF Rec 0x12 -law MFR1 Gen 0x02 -law MFR1 Rec 0x01 -law DTMF Rec DSP 2 0x01 -law DTMF Rec 0x14 -law CPT4 Gen 0x02 -law MFR1 Rec 0x01 -law DTMF Rec DSP 3 0x01 -law DTMF Rec 0x08 -law CPA Rec 0x02 -law MFR1 Rec 0x01 -law DTMF Rec

SIMM 1

SIMM 2

SIMM 3

1- 370
Release 8.4.1 ER3, February 2008

DynamicConfig

DynamicConfig
Type Purpose

EXS SwitchKit API message Use the SK_DynamicConfig message to dynamically update the CSP configuration without restarting the SwitchManager. This message includes an argument, ConfigMode, which determines whether the specified file content will be saved by SwitchManager for future reconfiguration. When SwitchManager receives a DynamicConfig message, it will send the configuration referenced in the message to the CSP immediately. Those messages are maintained on the CSP. The filename must be relative to the SwitchManager process. Converged Services Administrator or Application The following table shows the user modifiable arguments for this message:
Description This enables or disables writing the content of the specified file into the current configuration file used by Switch Manager. The options are: SK_CONFIGSWITCH_APPEND - 0x00 SK_CONFIGSWITCH_REPLACE - 0x01 SK_CONFIGSWITCH_REPLACE_AND_SEND - 0x02 SK_CONFIGSWITCH_APPEND_NOSEND - 0x03 SK_CONFIGSWITCH_SEND_NOAPPEND - 0x04

Description

Sent by Arguments

Argument ConfigMode

Filename

The filename of the file containing the configuration information to parse and send. Location should be relative to SwitchManagers installation directory.
typedef struct { UBYTE ConfigMode; char Filename[230]; } SK_DynamicConfig; typedef struct { int Status; } SK_DynamicConfigAck; class

C Structure

C Structure Response

C++ Class

SKC_DynamicConfig : public SKC_ToolkitMessage {

1- 371
Release 8.4.1 ER3, February 2008

DynamicConfig
public: UBYTE getConfigMode() const; void setConfigMode(UBYTE x); const char *getFilename() const; void setFilename(const char *x); };

C++ Class Response

class SKC_DynamicConfigAck : public SKC_ToolkitAck { public: int getStatus() const; void setStatus(int x); const UBYTE *getReserved() const; UBYTE *getReserved(); void setReserved(UBYTE *x); };

1- 372
Release 8.4.1 ER3, February 2008

E1 Span Configure 0x00D8

SwitchKit Name Type Description E1SpanConfig EXS API and SwitchKit API message E1 Span Configure 0x00D8 This message allows the host to configure the transmission format, line length, and SA bits of an E1 span. NOTE: Before changing span configuration, Dialogic ALWAYS RECOMMENDS that you de-assign the spans, assign them again and then send the new span configuration.

Sent by Example Message

Host The following sample message configures an E1 span with the default coding method, signaling method, E1 Layer I management. CRC-4 and FEBE error checking are configured. The default line length, SA Registers, and TS 16 Register are also configured. 00 0F 00 D8 00 FF FF 00 01 0C 02 01 23 E8 00 F8 D0

SwitchKit Code

Configuration
E1SpanConfig ( Node = integer, Span = integer, Format = integer, LineLength = integer, SARegisters = integer, TS16Registers = integer);

C Structure
typedef struct { unsigned short Span; UBYTE Format; UBYTE LineLength; UBYTE SARegisters; UBYTE TS16Registers; } XL_E1SpanConfig;

C++ Class
class XLC_E1SpanConfig : public XLC_SpanMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getFormat() const; void setFormat(UBYTE x); UBYTE getLineLength() const;
...........................................................................................................................................................................................................................................................

1- 373
Release 8.4.1 ER3, February 2008

E1 Span Configure 0x00D8

void setLineLength(UBYTE x); UBYTE getSARegisters() const; void setSARegisters(UBYTE x); UBYTE getTS16Registers() const; void setTS16Registers(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00D8) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0C Logical Span Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00D8) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

1- 374
Release 8.4.1 ER3, February 2008

E1 Span Configure 0x00D8

Format This field is a bit mask. The meaning of each bit is described below. Unless otherwise stated, 0 = Disabled, 1 = Enabled. 0x01 - default for the CSP Coding Method Bit 0 0 Alternate Mark Inversion (AMI) 1 High-Density Bipolar Three-Bit Substitution (HDB3) (Default) Error Checking Bit 1 Enable CRC-4 Cyclic Redundancy Check Bit 2 Enable FEBE (Far-End Block Error) Enables the use of E-bits in the CRC-4 multiframe alignment signal for the automatic reporting of a CRC error received during the previous multiframe. Signaling Method Bit 3 0 Channel Associated Signaling (Default) In CAS mode, in-band line signaling for voice channels is carried in timeslot 16. 1 Clear Channel In Clear Channel mode, in-band line signaling is not transmitted in timeslot 16. Bit 4 Transmit all zeroes Bit 5 0 E1 Layer I management (Default) 1 Euro-ISDN E1 Layer I management For Euro-ISDN compliant E1, see Notes 4 and 5. Bit 6 0 E1 Layer I management (Default) 1 Austel-ISDN E1 Layer I management For Austel-ISDN compliant E1, see Notes 4 and 6. Bit 7 Reserved, must be 0.

Line Length 0x00 G.703 ITU-T (75 ohm) (Default) 0x04 G.703 ITU-T (120 ohm)

1- 375
Release 8.4.1 ER3, February 2008

E1 Span Configure 0x00D8

SA Registers This field is a bit mask. The meaning of each bit is described below. Unless otherwise stated, 0 = Disabled, 1 = Enabled. The default for all bits is 1. See Note 3. Bits 02 Bit 3 Bit 4 Bit 5 Bit 6 Bit 7 Reserved (must be 0) Value to which all bits in SA Bit 4 Register should be set. Value to which all bits in SA Bit 5 Register should be set. Value to which all bits in SA Bit 6 Register should be set. Value to which all bits in SA Bit 7 Register should be set. Value to which all bits in SA Bit 8 Register should be set.

TS 16 Register This field is a bit mask. The meaning of each bit is described below. Unless otherwise stated, 0 = Disabled, 1 = Enabled. The default for all bits is 1. See Note 3. Bits 03 Bit 4 Bit 5 Bit 6 Bit 7 Reserved (must be 0) Value to which spare bit x1 in frame 0 of timeslot 16 should be set. Reserved (must be 0) Value to which spare bit x3 in frame 0 of timeslot 16 should be set. Value to which spare bit x4 in frame 0 of timeslot 16 should be set.

Checksum

NOTES 1. To configure a single node for greater than 64 spans, please contact Dialogic technical support. 2. Note that the Dialogic message bit-numbering format is 07, while the SA Register and TS 16 Register formats are 18. Therefore, bit 3 of the host message format is bit 4 of the SA Register and TS 16 Register formats, and so on. 3. This message is backward-compatible to previous software releases. 4. Refer to ITU-T Recommendation G.704 more details on programming SA bits and spare timeslot 16 bits. 5. To use Euro-ISDN Layer 1, you must use an SE1LC Rev. B11 or greater. For more information, refer to the appropriate Hardware Product Descriptions. 6. For Euro-ISDN compliant E1, set the following: (Bit 0 = 1) Line format to HDB3 (Bit 1 = 1) CRC (Bit 2 = 1) FEBE (Bit 3 = 1) E1 clear Channel (Bit 5 =1) Euro-ISDN Layer I Line length to G.703 7. For Austel-ISDN compliant E1, set the following: (Bit 0 = 1) Line format to HDB3 (Bit 1 = 1) CRC (Bit 2 = 1) FEBE (Bit 3 = 1) E1 clear Channel (Bit 6 = 1) Austel-ISDN Layer I Line length to G.703
...........................................................................................................................................................................................................................................................

1- 376
Release 8.4.1 ER3, February 2008

E1 Span Configure 0x00D8 Default E1 Format The table below shows the default format for E1 [Link] must enable Clear Channel signaling to use timeslot 16 (Channel 30) as a voice channel or for out-of-band signaling (for example, an ISDN application). NOTE: Clear Channel signaling must be enabled to use timeslot 16 (channel 30) as a D channel in ISDN applications.

Timeslot 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

Channel 31 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 30 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

Description Alarms and framing

Voice channels

In-band line signaling (CAS)

Voice channels

1- 377
Release 8.4.1 ER3, February 2008

E1 Span Query 0x00DB

SwitchKit Name Type Description E1SpanFormatQuery EXS API and SwitchKit API message E1 Span Query 0x00DB Use this message to retrieve the transmission format and line length of an E1 span. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; } XL_E1SpanFormatQuery;

C Structure Response
typedef struct { unsigned short Status; unsigned short Span; UBYTE Format; UBYTE LineLength; UBYTE Slot; UBYTE Offset; UBYTE SARegisters; UBYTE TS16Register; } XL_E1SpanFormatQueryAck;

C++ Class
class XLC_E1SpanFormatQuery : public XLC_OutboundMessage { public: unsigned short getSpan() const; void setSpan(unsigned short x); };

C++ Class Response

class XLC_E1SpanFormatQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getFormat() const; void setFormat(UBYTE x); UBYTE getLineLength() const; void setLineLength(UBYTE x);
...........................................................................................................................................................................................................................................................

1- 378
Release 8.4.1 ER3, February 2008

E1 Span Query 0x00DB

UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getOffset() const; void setOffset(UBYTE x); UBYTE getSARegisters() const; void setSARegisters(UBYTE x); UBYTE getTS16Register() const; void setTS16Register(UBYTE x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00DB) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0C Logical Span : Checksum Response continued below. : Format This field is a bit mask. The meaning of each bit is described below. Unless otherwise stated, 0 = Disabled, 1 = Enabled. Coding Method Bit 0 0 Alternate Mark Inversion (AMI) 1 High Density Bipolar 3 (HDB3) Error Checking Bit 1 CRC-4 Enabled Bit 2 FEBE Enabled Signaling Method Bit 3 Clear Channel Bit 4 Transmit all zeroes Bit 5 0 E1 Layer I management (Default) 1 Euro-ISDN E1 Layer I management Bits 67 Reserved 10 AIB Same as message Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00DB) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB,LSB

1- 379
Release 8.4.1 ER3, February 2008

E1 Span Query 0x00DB

Line Length 0x00 G.703 ITU-T (75 Ohm) (Default) 0x04 G.703 ITU-T (120 Ohm) Line Card Slot Number Span Offset SA Register Contents This field is a bit mask. The meaning of each bit is described as follows. Unless otherwise stated, 0 = Disabled, 1 = Enabled. Bits 02 Bit 3 Bit 4 Bit 5 Bit 6 Bit 7 Reserved (must be 0) Value to which all bits in SA Bit 4 Register are set. Value to which all bits in SA Bit 5 Register are set. Value to which all bits in SA Bit 6 Register are set. Value to which all bits in SA Bit 7 Register are set. Value to which all bits in SA Bit 8 Register are set.

: : :

TS 16 Register Contents This field is a bit mask. The meaning of each bit is described below. Unless otherwise stated, 0 = Disabled, 1 = Enabled. Bits 03 Bit 4 Bit 5 Bit 6 Bit 7 Reserved (must be 0) Value to which spare bit x 1 in frame 0 of timeslot 16 is set. Reserved (must be 0) Value to which spare bit x 3 in frame 0 of timeslot 16 is set. Value to which spare bit x 4 in frame 0 of timeslot 16 is set.

Checksum

NOTES 1. The Dialogic message bit-numbering format is 07, while the SA Register and TS 16 Register formats are 18. Therefore, bit 3 of the host message format is bit 4 of the SA Register and TS 16 Register formats, and so on. 2. This message is backward-compatible to previous software releases. If using a System Software 3.X Version 3.09 or earlier, the SA Register and TS 16 Register bits will be set to the default (1), and an E1 Span Query message will return a value of 0xF8 for the SA Register byte and 0xDO for the TS 16 Register byte.

1- 380
Release 8.4.1 ER3, February 2008

EXNET Ring Configure 0x0074

SwitchKit Name Type Description RingConfig EXS API and SwitchKit API message EXNET Ring Configure 0x0074 Use this message to configure the EXNET ring. The configuration includes: Logical Ring ID EXNET-ONE Card Diagnostics Prepare For Addition Expand Ring Loop Back Port Add Node Sent by SwitchKit Code Host Configuration
RingConfig ( Node = integer, Slot = integer, Ring = integer, Entity = integer, Data = byte array);

C Structure
typedef struct { UBYTE AddrInfo[30]; UBYTE Entity; UBYTE Data[222]; } XL_RingConfig;

C++ Class
class XLC_RingConfig : public XLC_OutboundMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getEntity() const; void setEntity(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };
...........................................................................................................................................................................................................................................................

1- 381
Release 8.4.1 ER3, February 2008

EXNET Ring Configure 0x0074 Overview of message The following table provides an overview of this message. The table following it, provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8, 9 10 : : : : Entity Data : Checksum Field Description Frame (0xFE) Length (0x0007) Message Type (0x0074) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0074) Reserved (0x00) Sequence Number Logical Node ID AIB (starting with byte 0)

EXS API Hex Format Detailed

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0074) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1, 2 3, 4 5 6 7 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0074) Reserved (0x00) Same Sequence Number Logical Node ID

1- 382
Release 8.4.1 ER3, February 2008

EXNET Ring Configure 0x0074

AIB Address Method 0x00 - Individual AEs

8, 9

Status MSB, LSB If the MSB of this field is 0x50 (NACK), the LSB indicates the NACK reason. 0x47 Invalid Ring Loop Timing This value is returned when trying to set a node to be master-configurable, if the ring timing has already been derived. 0xC0 Action Denied A value of Action Denied (0xC0) is returned if the user is trying to set an EXNET-ONE card.

Number of AEs to follow AEs 0x01 Slot to configure these entities: 0x01 Logical Ring ID 0x04 EXNET T-ONE Card Diagostics 0x05 Prepare for Addition 0x06 Expand Ring 0x07 Loopback Port 0x08 Add Note

Checksum

OR 0x1A EXNET Ring to configure these entities: 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x09 0x0A : Transmit Mode Number of Packets EXNET-ONE Card Diagnostics Prepare For Addition Expand Ring Loop Back Port Add Node Master-configurable Ring Mode

Entity 0x01Logical Ring ID 0x02Transmit Mode 0x03Configure Number of Packets 0x04EXNET-ONE Card Diagnostics 0x05Prepare For Addition0x06Expand Ring 0x07Loop Back Port 0x08Add Node0x09Master-configurable 0x0ARing Mode Data

1- 383
Release 8.4.1 ER3, February 2008

EXNET Ring Configure 0x0074

0x01 Assign Ring Data[0] Logical Ring ID De-assigning an EXNET Ring Use the values below to de-assign a specific ring or all rings on a node: 0x02 Configure Transmit Mode Data[0] Transmit Mode 0x00 Receive Only 0x01 Transmit and Receive 0x03 Configure Number of Packets Data[0] Number of Packets 0x01 - No longer used. 0x03 - No longer used. 0x04 - Four packets (E1, J1, VDAC-ONE, IP Network Interface Series 2, and PCI H.100 EXNET Connect nodes). 0x04 EXNET-ONE Card Diagnostics Data[0] EXNET-ONE Card Diagnostics 0x00 Reserved 0x01 Non-Forced*, Internal Loop Back 0x02 Non-Forced*, External** Loop Back 0x03 Forced, Internal Loop Back 0x04 Forced, External** Loop Back *The Non-Forced mode is used to prevent execution of EXNET-ONE Card Diagnostics procedure while EXNET Ring is up and running. Performing EXNET-ONE Card Diagnostics will take the EXNET Ring out of service. **The External Loop Back mode can be used when both I/O ports are externally looped back with fiber optic cabling. 0x05 Prepare For Addition There is no data associated with this entity. 0x06 Expand Ring There is no data associated with this entity. 0x07 Loop Back Port Node ID of the neighbor CSP node. This message must be sent to the node that will loopback its A port. The neighbor node will automatically loopback B port. Data[0] 0x00 Logical Node ID of node whose B port will be looped back. 0x08 Add Node There is no data associated with this entity.

1- 384
Release 8.4.1 ER3, February 2008

EXNET Ring Configure 0x0074

0x09 Master-configurable The value of this field indicates whether or not a node is allowed to become the EXNET Ring Master. Valid entries for these fields, based on the value of the Entity field value 0x09, are as follows: Data[0] Allow Master Arbitration Flag. 0x00 Do not allow this node to participate in EXNET Ring Master Arbitration. 0x01 Allow this node to participate in EXNET Ring Master Arbitration. (Default for CSP 2090 and CSP 2040 nodes) 0x0A Ring Mode The Ring Mode entity configures the Enhanced Fault Tolerance Ring Mode. Data[0] Ring Mode 0x00 Reserved 0x01 Enhanced Fault Tolerance Ring Mode This mode adds enhanced Single Ring Redundancy with seamless switchover support, run-time software link validation, enhanced live node insertion, and overall improved performance and stability. This mode is recommended for homogenous second generation EXNET rings.

Checksum

Field AIB Entity Data[0] Logical Ring ID

Field Value to Deassign Field Value to Deassign a Specific Ring All Rings Slot # 0x01 (Assign Ring) 0xFF 0xFF

1- 385
Release 8.4.1 ER3, February 2008

EXS Node Configure 0x007F

SwitchKit Name Type Description NodeConfig EXS API and SwitchKit API message EXS Node Configure 0x007F Use this message to configure entities in a node. Sent by SwitchKit Code Host Configuration
NodeConfig ( Node = integer, Entity = integer, DataLen = integer, Data = byte array);

C Structure
typedef struct { unsigned short Entity; UBYTE DataLen; UBYTE Data[250]; } XL_NodeConfig;

C Structure Response
typedef struct { unsigned short Status; unsigned short Entity; UBYTE DataLength; UBYTE Data[248]; } XL_NodeConfigAck;

C++ Class
class XLC_NodeConfig : public XLC_OutboundMessage { public: unsigned short getEntity() const; void setEntity(unsigned short x); UBYTE getDataLen() const; void setDataLen(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

C++ Class Response

class XLC_NodeConfigAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x);
...........................................................................................................................................................................................................................................................

1- 386
Release 8.4.1 ER3, February 2008

EXS Node Configure 0x007F

unsigned short getEntity() const; void setEntity(unsigned short x); UBYTE getDataLength() const; void setDataLength(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0xNNNN) Message Type (0x007F) Reserved (0x00) Sequence Number Logical Node ID Entity 0x0001 0x0002 0x0003 0x0004 0x0005 0x0006 Number of Timeslots Reserved Number of EXNET Connect Channels Clock Master Master on Multiple Ring Configure CTNETREF/PCI H.100 Field Description Byte 0 1, 2 3, 4 5 6 7 8, 9 10, 11 Frame (0xFE) Length (0xNNNN) Message Type (0x007F) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Entity RESPONSE (Gray) Field Description

10 11

Data Length Data The meaning of this field depends on the value of the Entity field. 0x0001 Number of Timeslots Data Length: 0x02 The value of this word-length field represents the number of timeslots assigned for CSP Conferencing. The valid entry for this field is as follows: Data[0,1] 0xFFFF Assign all unused timeslots 0x0002 Unused

12 13

Data Length Data The meaning of these fields depends on the value of the Entity field in the message. 0x0001 Number of Timeslots Valid entries for these fields based on the Entity field value 0x01 are as follows: Data Length: 0x02 Data[0,1] Number of Timeslots Allocated for CSP Conferencing Conferencing (MSB, LSB) 0x02 Unused

Checksum

1- 387
Release 8.4.1 ER3, February 2008

EXS Node Configure 0x007F

0x03 Number of EXNET Connect Channels Data Length: 0x03 Data[0, 1] Span (MSB, LSB) All spans 0xFFFF Data[2] Number of Channels 0x18 - 24 (T1) 0x20 - 32 (E1) Note: You must de-assign spans before modifying the number of channels per span. 0x04 Clock Master Data Length: 0x03 Data[0] Slot Number Data[1] Bus Master 0x00 Not SCbus clock master/H.100 Slave to clock A 0x01 Become SCbus clock master/H.100 primary clock masterdriving clock A 0x02 H.100 secondary clock master driving clock A 0x03 H.100 slave to clock B 0x04 H.100 primary clock master driving clock B 0x05 H.100 secondary clock master driving clock B Data[2] Speed 0x00 4 MHz 0x01 2 MHz (Reserved) 0x02 8 MHz Example Data[2] corresponds to the local bus speed. Value 0x00 corresponds to SCSA compatibility mode speed for PCI/H.100 card. 0x05 Master on Multiple Ring Configure Indicates whether or not a node is allowed to become the EXNET Master of multiple rings. Data Length: 0x01 Data[0] Master on Multiple Ring Flag 0x01 Allow this node to be Master on more than one ring simultaneously. 0x00 Do not allow this node to be Master on more than one ring simultaneously. (Default) 0x06 CTNETREF Data[0] Slot Number : Checksum

1- 388
Release 8.4.1 ER3, February 2008

EXS Node Configuration Query 0x007E

SwitchKit Name Type Description NodeConfigQuery EXS API and SwitchKit API message EXS Node Configuration Query 0x007E Use this message to query various configuration entities in a node. Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Entity; UBYTE DataLen; UBYTE Data[250]; } XL_NodeConfigQuery;

C Structure Response
typedef struct { unsigned short Status; unsigned short Entity; UBYTE DataLength; UBYTE Data[248]; } XL_NodeConfigQueryAck;

C++ Class
class XLC_NodeConfigQuery : public XLC_OutboundMessage { public: unsigned short getEntity() const; void setEntity(unsigned short x); UBYTE getDataLen() const; void setDataLen(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

C++ Class Response

class XLC_NodeConfigQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getEntity() const; void setEntity(unsigned short x); UBYTE getDataLength() const; void setDataLength(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x);

1- 389
Release 8.4.1 ER3, February 2008

EXS Node Configuration Query 0x007E

};

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8, 9 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x007E) Reserved (0x00) Sequence Number Logical Node ID Entity MSB, LSB 0x0001 Number of Timeslots 0x0002 Reserved 0x0004 Clock Master 0x0005 Master on Multiple Ring Configure 0x0006 - CTNETREF Data Length Data 0x01 Number of Timeslots Data[0,1] Number of Timeslots assigned for CSP Conferencing (Enter 0xFFFF to assign all unused timeslots) 14 Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x007E) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

10 11

10, 11 12 13

Entity (MSB, LSB) Data Length Data 0x01 Number of Timeslots Data[0,1] Number of timeslots assigned Data[2,3] Number of timeslots that are actually allocated Checksum

1- 390
Release 8.4.1 ER3, February 2008

EXS Node Configuration Query 0x007E

0x04 Clock Master Data[0] Slot Number Data[1] Configured Bus Master 0x00 PCI H.100 EXNET Connect is configured to be slave to clock A of H.100 local bus. 0x01 H.100 primary clock master driving clock A PCI H.100 EXNET Connect is configured to be H.100 local bus master driving clock A. 0x02 H.100 secondary clock master driving clock. This is clock A. 0x03 H.100 slave to clock B 0x04 H.100 primary clock master driving clock B 0x05 H.100 secondary clock master driving clock B Data[2] Configured Speed 0x00 4 MHz [SCSA compatibility mode] EXNET Connects are configured at this bus speed. Lower 16 data lines of H.100 bus are configured at this bus speed. 0x02 8 MHz [Full H.100 mode] All 32 data lines of H.100 bus are configured at this bus speed. Data[3] Actual Bus Master 0x00 H.100 Slave to clock A. EXNET Connect actual state is not as local bus master. PCI H.100 EXNET Connect actual state is slave to clock A of H.100 local bus. 0x01 H.100 primary clock master driving clock. A PCI H.100 EXNET Connect actual state is H.100 local bus master driving clock A. 0x02 H.100 secondary clock master driving clock A 0x03 H.100 slave to clock B 0x04 H.100 primary clock master driving clock B 0x05 H.100 secondary clock master driving clock B 0x06 H.100 bus not available Data[4] Actual Speed 0x00 4 MHz [SCSA compatibility mode] EXNET Connects are at this bus speed. Lower 16 data lines of H.100 bus are at this bus speed. 0x02 8 MHz [Full H.100 mode] All 32 data lines of H.100 bus are at this bus speed.

1- 391
Release 8.4.1 ER3, February 2008

EXS Node Configuration Query 0x007E

0x05 Master On Multiple Ring Configure The value of this field indicates whether or not a node is allowed to become the EXNET Master of multiple rings. Data[0] Master on Multiple Ring Flag 0x00 Do not allow this node to be Master on more than one ring simultaneously (Default) 0x01 Allow this node to be Master on more than one ring simultaneously. 0x06 CTNETREF Data[0] Slot Number (Indicates slot number of the board that is queried.) Data[1] CTNETREF Drive/Receive 0x00 Receive. Indicates the board is configured to receive the CTNETREF signal from other boards on the H.100 bus. 0x01 Drive Data[2] CTNETREF Speed 0x00 - 2.048 MHz 0x01 - 1.54 MHz 0x02 - 8 kHz : Checksum

1- 392
Release 8.4.1 ER3, February 2008

Fault Log Query 0x0086

SwitchKit Name Type Description FaultLogQuery EXS API and SwitchKit API message Fault Log Query 0x0086 This message should be sent by the host if it receives a Card Status Report message or a response to a Card Status Query message with the Faults Logged bit set. Faults are queried for the slot specified. The host receives separate responses for each fault logged. There are two types of logs: a fault log containing a log that can be cleared after it is reported by setting the Action field to 0x02. The response data should be reported to Dialogic Technical Support for evaluation. The host can also send this message to the active or standby CSP 2000 Matrix Card. Sent by SwitchKit Code Host C Structure
typedef struct { UBYTE AddrInfo[30]; UBYTE Action; } XL_FaultLogQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE AddrInfo[30]; UBYTE NumFaults; UBYTE FaultNumber; char FaultBuffer[80]; } XL_FaultLogQueryAck;

C++ Class
class XLC_FaultLogQuery : public XLC_OutboundMessage { public: const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getModule() const; void setModule(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); };

1- 393
Release 8.4.1 ER3, February 2008

Fault Log Query 0x0086 C++ Class Response

class XLC_FaultLogQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); const UBYTE *getAddrInfo() const; UBYTE *getAddrInfo(); void setAddrInfo(UBYTE *x); UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getModule() const; void setModule(UBYTE x); UBYTE getNumFaults() const; void setNumFaults(UBYTE x); UBYTE getFaultNumber() const; void setFaultNumber(UBYTE x); const char *getFaultBuffer() const; void setFaultBuffer(const char *x); };

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0086) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AEs 0x01 Slot or 0x42 VoIP Module : Action 0x01 Return Fault Log 0x02 Return Fault Log, then clear Fault Log 0x03 Return Stack Trace Checksum 10 Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0086) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB If the value of this field is a positive acknowledgment (0x0010), then the Fault Data bytes apply. If the value of this field is not a positive acknowledgment (0x0010), then the Fault Data bytes are not reported and the length is 0x07. AIB (starting with Byte 0)

1- 394
Release 8.4.1 ER3, February 2008

Fault Log Query 0x0086

Response continued below. : Fault Data The response data varies depending on the type of fault log queried. 0x01 or 0x02 Fault Log Data[0] Number of Faults Indicates the total number of faults in the log. Data[1] Fault Number The first response is the number of the last fault logged. The last response is fault Number 1. Data[2+] Data A null-terminated text string with a maximum of 128 bytes. If the text string is less, it will be terminated with 0x0A. 0x03 Fault Log and Trace Data[0] Reserved (0x00) Data[1] Reserved (0x00) Data[2+] A NULL terminated ASCII string, followed by the stack pointer when the fault occurred, followed by a trace of the stack. : Checksum

NOTES: 1. Faults are logged as NULL terminated readable text strings. The host will receive a message for each fault in the log. 2. When in any state other than active, the only valid slot is the matrix that the message is sent to. All requests for other slots will receive a response status of negative acknowledgment.

1- 395
Release 8.4.1 ER3, February 2008

Filter/Timer Configure 0x0012

SwitchKit Name Type Description FilterTimerConfig EXS API and SwitchKit API message Filter/Timer Configure 0x0012 This message is used to adjust trunk and line signaling filters and timers. Typically, it is only required when the trunk or line that the CSP is connected to is not operating to line interface specifications. All timers and filters are set to default values based on industry specifications when the channel trunk type is configured. To query the timers and filters use the Channel Parameter Query message. NOTE: Use this message to configure the PPL timers for all ST1LC line cards. You cannot use the PPL Timer Configure message with the ST1LC line cards.

Sent by Overview of message

Host The following table provides an overview of this message. The table following it, provides the detail for each byte. Configuration
FilterTimerConfig ( Node = integer, Range = StartSpan:StartChan - EndSpan:EndChan, Type = integer, FilterID = integer, Value = integer);

SwitchKit Code

C Structure
typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE Type; UBYTE FilterID; unsigned short Value; } XL_FilterTimerConfig;

C++ Class
class XLC_FilterTimerConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const;
...........................................................................................................................................................................................................................................................

1- 396
Release 8.4.1 ER3, February 2008

Filter/Timer Configure 0x0012

void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getType() const; void setType(UBYTE x); UBYTE getFilterID() const; void setFilterID(UBYTE x); unsigned short getValue() const; void setValue(unsigned short x); };

Overview of Message
MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : : : : : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0012) Reserved (0x00) Sequence Number Logical Node ID AIB (starting with byte 0) Filter/Timer Type Filter/Timer ID Value (MSB, LSB) Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0012) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0012) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x01 - Range of AEs Number of AEs to follow 0x02 AEs 0x0D Channel (Starting) 0x0D Channel (Ending) Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0012) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB)

1- 397
Release 8.4.1 ER3, February 2008

Filter/Timer Configure 0x0012

Filter/Timer Type 0x01 Signal Scanning Filter 0x02 Signal Scanning Timer 0x03 Transmit Signaling Timer

Checksum

Filter/Timer ID This field indicates the specific timer or filter. The meaning of the ID number depends on the value of the Filter/Timer Type field. Valid entries for this field are listed below by Filter/Timer Type field value: 0x01 Signal Scanning Filter 0x01 Preseize 0x02 Inseize 0x03 Modified Incoming Release 0x04 Modified Outgoing Release 0x05 Normal Incoming Release 0x06 Normal Incoming Release with Flash 0x07 Normal Outgoing Release 0x08 Normal Outgoing Release with Flash 0x09 Post Inseize Acknowledgment 0x0A Outseize Acknowledgment 0x0B Outseize Answer 0x0C Outseize Dial Signal End 0x0D First Release 0x0E ANI Request Off-hook

1- 398
Release 8.4.1 ER3, February 2008

Filter/Timer Configure 0x0012

0x02 Signal Scanning Timer 0x01 Inseize Complete 0x02 Post Inseize Complete 0x03 Start Normal Outgoing Release 0x04 Start Normal Incoming Release 0x05 Outseizure Acknowledgment 0x06 Outseizure Answer 0x07 Guard Timeout 0x08 Release 0x09 Glare Detection 0x0A Minimum Flash 0x0B Maximum Flash 0x0C Start Dial Minimum Wink 0x0D Start Dial Maximum Wink 0x0E Minimum Delay Dial Signal 0x0F Maximum Delay Dial Signal 0x10 Post Start Dial Signal Outpulse Delay 0x11 Wink 2 Minimum Receive Duration 0x12 Wink 2 Maximum Receive Duration 0x13 Wink 2 Minimum Post Outpulse Delay 0x14 Wink 2 Maximum Post Outpulse Delay 0x15 Wink 2 Maximum Receive Detection 0x16 Wink 3 Minimum Receive Duration 0x17 Wink 3 Maximum Receive Duration 0x18 Wink 3 Minimum Post Outpulse Delay 0x19 Wink 3 Maximum Post Outpulse Delay 0x1A Wink 3 Maximum Receive Detection 0x1B Wink 4 Minimum Receive Duration 0x1C Wink 4 Maximum Receive Duration 0x1D Wink 4 Minimum Post Outpulse Delay 0x1E Wink 4 Maximum Post Outpulse Delay 0x1F Wink 4 Maximum Receive Detection 0x20 Wink 5 Minimum Receive Duration 0x21 Wink 5 Maximum Receive Duration 0x22 Wink 5 Minimum Post Outpulse Delay 0x23 Wink 5 Maximum Post Outpulse Delay 0x24 Wink 5 Maximum Receive Detection 0x25 Wink 6 Minimum Receive Duration 0x26 Wink 6 Maximum Receive Duration 0x27 Wink 6 Minimum Post Outpulse Delay 0x28 Wink 6 Maximum Post Outpulse Delay 0x29 Wink 6 Maximum Receive Detection 0x2A Wink 7 Minimum Receive Duration 0x2B Wink 7 Maximum Receive Duration 0x2C Wink 7 Minimum Post Outpulse Delay 0x2D Wink 7 Maximum Post Outpulse Delay 0x2E Wink 7 Maximum Receive Detection 0x2F Wink 8 Minimum Receive Duration 0x30 Wink 8 Maximum Receive Duration 0x31 Wink 8 Minimum Post Outpulse Delay 0x32 Wink 8 Maximum Post Outpulse Delay

1- 399
Release 8.4.1 ER3, February 2008

Filter/Timer Configure 0x0012

0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x3A 0x3B 0x3C 0x3D 0x3E 0x3F

Wink 8 Maximum Receive Detection Post ANI Off-hook Outpulse Delay Maximum Receive ANI Off-hook Request Detection Maximum Receive Dialtone Detection MFR1 Minimum Receive KP Duration MFR1 Minimum Receive Digit Duration MFR1 Maximum Receive KP Duration MFR1 Minimum Receive Interdigit Duration MFR1 Maximum Receive Interdigit Duration DTMF Maximum Receive 1st Digit Detection DTMF Minimum Receive Digit Duration DTMF Minimum Receive Interdigit Duration DTMF Maximum Receive Interdigit Duration

0x03 Transmit Signal Timer 0x01 Wink Duration 0x02 Flash Duration 0x03 Primary Outseizure Signal 0x04 Outseize Signaling Complete 0x05 Delay Dial Signal Start 0x06 Fixed Pause 0x07 Timed Answer 0x08 Ringing On Duration 0x09 Ringing Off Duration 0x0A Wink 1 Minimum Transmit Delay 0x0B Wink 2 Minimum Transmit Delay 0x0C Wink 2 Maximum Transmit Delay 0x0D Wink 2 Transmit Duration 0x0E Wink 3 Minimum Transmit Delay 0x0F Wink 3 Maximum Transmit Delay 0x10 Wink 3 Transmit Duration 0x11 Wink 4 Minimum Transmit Delay 0x12 Wink 4 Maximum Transmit Delay 0x13 Wink 4 Transmit Duration 0x14 Wink 5 Minimum Transmit Delay 0x15 Wink 5 Maximum Transmit Delay 0x16 Wink 5 Transmit Duration 0x17 Wink 6 Minimum Transmit Delay 0x18 Wink 6 Maximum Transmit Delay 0x19 Wink 6 Transmit Duration 0x1A Wink 7 Minimum Transmit Delay 0x1B Wink 7 Maximum Transmit Delay 0x1C Wink 7 Transmit Duration 0x1D Wink 8 Minimum Transmit Delay 0x1E Wink 8 Maximum Transmit Delay 0x1F Wink 8 Transmit Duration 0x20 MFR1 Transmit KP Duration 0x21 MFR1 Transmit Digit Duration 0x22 MFR1 Transmit Inter-digit Duration 0x23 DTMF Transmit Digit Duration 0x24 DTMF Transmit Inter-digit Duration : : Value (MSB, LSB) Filter/Timer length in 10 ms units. Checksum

1- 400
Release 8.4.1 ER3, February 2008

Flash Timing Configure 0x0016

SwitchKit Name Type Description FlashTimingConfig EXS API and SwitchKit API message Flash Timing Configure 0x0016 Use this message to enable or disable flash detection and propagation on a channel or range of channels. Sent by SwitchKit Code Host Configuration
FlashTimingConfig ( Node = integer, Range = StartSpan:StartChan - EndSpan:EndChan, FlashMode = integer);

C Structure
typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE FlashMode; } XL_FlashTimingConfig;

C++ Class
class XLC_FlashTimingConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getFlashMode() const; void setFlashMode(UBYTE x); };

1- 401
Release 8.4.1 ER3, February 2008

Flash Timing Configure 0x0016

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0016) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x01 Range of AEs Number of AEs to follow AEs 0x0D Channel (Starting) 0x0D Channel (Ending) : Flash Mode 0x00 Flash Timing OFF 0x01 Flash Timing ON, propagate Flash to distant end 0x02 Flash Timing ON, send Call Processing Event message to the host. 0x03 Flash Timing ON, send Call Processing Event message to the host and propagate Flash to distant end. Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0016) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

1- 402
Release 8.4.1 ER3, February 2008

ForceGroupState

ForceGroupState
Type Purpose EXS SwitchKit API message This message causes the LLC to take action on all of the channels within the group specified by the ChannelGroup field. This will only affect channels not currently owned or watched by another application. SwitchKit Application The following table shows the arguments you can change:

Sent by Arguments

Argument
ChannelGroup action

Description
The name of the group this action should be performed on. The state the LLC is requesting this channel be put into. Values for ForceGroupState actions:

SK_OUT_OF_SERVICE =0x0F SK_IN_SERVICE =0xF0

int status This is a response argument. The values are:

SK_INVALID_GROUP - No valid channel group was found. OK - Success Response Arguments

Argument
ChannelGroup int status

Description
The name of the group this action should be performed on. The values for this argument are:

SK_INVALID_GROUP - No valid channel group was found. OK - Success

1- 403
Release 8.4.1 ER3, February 2008

ForceGroupState C Structure
typedef struct { char ChannelGroup[50]; unsigned short Action; UBYTE reserved69[4]; } SK_ForceGroupState; typedef struct { char ChannelGroup[50]; int Status; UBYTE reserved71[4]; } SK_ForceGroupStateAck; class SKC_ForceGroupState : public SKC_ToolkitMessage { public: const char *getChannelGroup() const; void setChannelGroup(const char *x); unsigned short getAction() const; void setAction(unsigned short x); };

C Structure Response

C++ Class

C++ Class Response

class SKC_ForceGroupStateAck : public SKC_ToolkitAck { public: const char *getChannelGroup() const; void setChannelGroup(const char *x); int getStatus() const; void setStatus(int x); };

1- 404
Release 8.4.1 ER3, February 2008

Generate Call Processing Event 0x00BA

Chapter 0 Call Control API Messages

SwitchKit Name Type Description

GenerateCallProcessingEvent EXS API and SwitchKit API message Generate Call Processing Event 0x00BA Use this message to instruct the CSP to generate a call processing event on the specified channel. To generate external host PPL events, use the PPL Event Request message.

Sent by Switchkit Code

Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE Event; } XL_GenerateCallProcessingEvent;

C++ Class
class XLC_GenerateCallProcessingEvent : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getEvent() const; void setEvent(UBYTE x); };

1- 405
Release 8.4.1 ER3, February 2008

Generate Call Processing Event 0x00BA

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x00BA) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Event 0x01 Answer Call (Generate appropriate signaling to return answer to the incoming call) This event might not be necessary if PPLevREQ(ANM) is sent. 0x02 Flash (Generate flash signaling to the incoming call) 0x11 Transmit Offhook 0x12 Transmit Idle Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x00BA) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, LSB Checksum

1- 406
Release 8.4.1 ER3, February 2008

Generic Card Configure 0x0122

SwitchKit Name Type Description GenericCardConfigure EXS API and SwitchKit API message Generic Card Configure 0x0122 Use this message for a variety of card configuration options. DSP Series 2 Card For the DSP Series 2 card, use this message to configure the following: Card-level Defaults Alarms NFS location and Vocabulary Index File Sequence Number Size (8-bit or 16-bit) Advanced Conferencing Features T.30 Fax Parameters Positive Voice Detection/Answering Machine Detection Echo Cancellation Parameters Dial Pulse Detection Parameters Sent by Related API Message SwitchKit Code Host Application Generic Card Query C Structure
typedef struct { UBYTE Slot; UBYTE reserved18[29]; UBYTE DataType; UBYTE TLVCount; UBYTE Data[221]; } XL_GenericCardConfigure;

C Structure Response
typedef struct { unsigned short Status; UBYTE reserved6[13]; UBYTE TLVCount; UBYTE Data[250]; } XL_GenericCardConfigure;

1- 407
Release 8.4.1 ER3, February 2008

Generic Card Configure 0x0122

C++ Class
class XLC_GenericCardConfigure : public XLC_OutboundMessage { public: UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getDataType() const; void setDataType(UBYTE x); UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

C++ Class Response

class XLC_GenericCardConfigureAck : public XLC_OutboundMessage { public: unsigned short getStatus() const void setStatus(unsigned short x) UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x) ;

1- 408
Release 8.4.1 ER3, February 2008

Generic Card Configure 0x0122

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0122) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0x00NN) Message Type (0x0122) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) 0x0001 Invalid TLV Data Software can't find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0002 Invalid Data Type 0x0003 Invalid number of TLVs There are no TLVs in the message. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV 0x000D Mandatory TLVs missing One or more mandatory TLVs are missing Also see Common Response Status Values. Number of AEs to follow AE 0x01 Slot : : Data Type 0x00 TLVs Number of TLVs to Follow : : TLVs Checksum 10 Number of TLVs to Follow RESPONSE (Gray) Field Description

1- 409
Release 8.4.1 ER3, February 2008

Generic Card Configure 0x0122

TLVs Mandatory TLV: 0x05FA Card Object* 0x0000 - General Card Configuration 0x0001 - Conferencing Parameters 0x0003 - Alarm Configuration 0x0004 - DSP Series 2 Fax Parameters Query 0x0005 - Echo Cancel 0x0006 - Pvd/AMD Parameters 0x0007 - Dial Pulse Detection Parameters Optional TLVs: 0x05DC File Management Configuration (mandatory for initial configuration, optional after that) 0x05DD Server Address (mandatory for initial configuration of NFS, optional after that) 0x05DF Vocabulary Index File (mandatory for initial configuration of NFS, optional after that) 0x05EF Alarm Threshold Configure (up to 16) 0x05F0 DSP 2 Main Board Memory Alarm Threshold Configure (up to 2) 0x05F1 DSP Temporary Memory Alarm Threshold Configure (up to 2) 0x05F4 Statistics Update Timer 0x0600 NFS User Group ID 0x0601 NFS Poll Retries 0x0619 PVD Parameters 0x0620 AMD Parameters 0x061B AMD Reports 0x0640 Matrix/Host Sequence Number Size* 0x0750 Dial Pulse Detection Parameters - This TLV is sent to configure the Dial Pulse Detection Parameters (0x0007). See 0x05FA Card Object TLV above. * Use mandatory Card Object TLV 0x05FA (with Object ID 0x0000) and optional Matrix/Host Sequence Number Size TLV 0x0640 to select an 8 or 16 bit Sequence Number as follows: 0x00 - 8 bit 0x01 - 16 bit The following optional TLVs set the card-level defaults: 0x0607 Output Gain Control (default 0db) 0x0608 Noise Gating Enable (default disabled) 0x0609 Noise Gate Parameters 0x060A Echo Suppression Enable (default disabled) 0x060B Echo Suppression Parameters 0x060C Automatic Gain Control Enable (default disabled) 0x060D Automatic Gain Control Input Level 0x060E Automatic Gain Control Parameters 0x060F Conference Failure Behavior 0x0000 - General Card Configuration 0x0001 - Conferencing Parameters

0x0003 - Alarm Configuration

1- 410
Release 8.4.1 ER3, February 2008

Generic Card Configure 0x0122

0x0005 - Echo Cancel 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 0x0004 - DSP Series 2 Fax Parameters Query 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 0x0648 Receive Resolution Type 0x0648 Receive Resolution Type 0x0649 Receive Encoding Type 0x064B Receive Bad Line 0x064C Receive Page Size 0x0651 Receive Enable ECM 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 : Checksum

1- 411
Release 8.4.1 ER3, February 2008

Generic Card Query 0x0123

SwitchKit Name Type Description GenericCardQuery EXS API and SwitchKit API message Generic Card Query 0x0123 Use this message to query various card configuration settings. NOTE: If you send too many TLVs in one message and exceed the allowable message length, you receive a Memory Allocation Failure NACK. DSP Series 2 Card For the DSP Series 2 card, use this message to query the following: Card-level Defaults Alarm settings NFS location and Vocabulary Index File Sequence Number Size (8-bit or 16-bit) Advanced Conferencing Features T.30 Fax Parameters Echo Cancel Parameters Dial Pulse Detection Parameters Sent by Related API Message SwitchKit Code Host Application Generic Card Configure C Structure
typedef struct { UBYTE Slot; UBYTE reserved18[29]; UBYTE DataType; UBYTE TLVCount; UBYTE Data[221]; } XL_GenericCardQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE reserved6[13]; UBYTE TLVCount; UBYTE Data[250]; } XL_GenericCardQueryAck;

C++ Class
class XLC_GenericCardQuery : public XLC_OutboundMessage { public:
...........................................................................................................................................................................................................................................................

1-412
Release 8.4.1 ER3, February 2008

Generic Card Query 0x0123

UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getDataType() const; void setDataType(UBYTE x); UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x) };

C++ Class Response

class XLC_GenericCardQueryAck : public XLC_OutboundMessage { public: unsigned short getStatus() const void setStatus(unsigned short x) UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x) ;

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 Frame (0xFE) Length (0x00NN) Message Type (0x0123) Reserved (0x00) Sequence Number Logical Node ID Field Description Byte 0 1, 2 3, 4 5 6 7 Frame (0xFE) Length (0x00NN) Message Type (0x0123) Reserved (0x00) Same Sequence Number Logical Node ID RESPONSE (Gray) Field Description

1-413
Release 8.4.1 ER3, February 2008

Generic Card Query 0x0123

AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot

8, 9

Data Type 0x00 TLVs

Status (MSB, LSB) 0x0001 Invalid TLV Data Software cannot find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0002 Invalid Data Type 0x0003 Invalid number of TLVs There are no TLVs in the message. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV 0x000D Mandatory TLVs missing One or more mandatory TLVs are missing Also see Common Response Status Values.

Number of TLVs to Follow

1-414
Release 8.4.1 ER3, February 2008

Generic Card Query 0x0123

TLVs Mandatory 0x05FA Card Object (must be the first TLV in the Message) 0x0000 - General Card Configuration 0x0001 - Conferencing Parameters 0x0003 - Alarm Configuration 0x0004 - DSP Series 2 Fax Parameters Query 0x0005 - Echo Cancel 0x0006 - PVD/AMD Parameters 0x0007 - Dial Pulse Detection Parameters Other optional TLVs depend on the Card Object queried. 0x0000 - General Card Configuration 0x0640 Matrix/Host Sequence Number Size 0x0001 - Conferencing Parameters 0x060D Automatic Gain Control Input Level 0x060F Conference Failure Behavior 0x0003 - Alarm Configuration 0x0617 Alarm Threshold Query 0x0004 - DSP Series 2 Fax Parameters Query To query multiple parameters use the following: 0x066D Fax Configuration Query Type 0x0001 - T.30 control parameters 0x0002 - Receive parameters 0x0004 - Transmit parameters To query individual Fax parameters: 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 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

TLVs Mandatory 0x05FA Card Object (always the first TLV in the Response) Other TLVs returned depend on the Card Object queried, as follows: 0x0000 - General Card Configuration 0x05DC File Management Configuration 0x05DD Server Address 0x05DF Vocabulary Index File 0x05F3 Vocabulary Index Read Information 0x0600 NFS User Group ID 0x0601 NFS Poll Retries 0x061C Server State 0x0001 - Conferencing Parameters 0x0607 Output Gain Control (Default is 0db) 0x0608 Noise Gating Enable (default is Disabled) 0x0609 Noise Gate Parameters 0x060A Echo Suppression Enable 0x060B Echo Suppression Parameters 0x060C Automatic Gain Control Enable 0x060E Automatic Gain Control Parameters 0x0003 - Alarm Configuration 0x0618 Alarm Threshold Enabled Report 0x05EF Alarm Threshold Configure 0x0004 - DSP Series 2 Fax Parameters Query For 0x066D Fax Configuration Query Type TLV Query Type: 0x0001 - T.30 control parameters 0x0642 T.30 Control Parameter Max Value 0x0643 T.30 Control Parameter Transmit Level 0x0644 T.30 Control Parameter ECM Enabled Query Type: 0x0002 - Receive parameters 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

1-415
Release 8.4.1 ER3, February 2008

Generic Card Query 0x0123

0x0664 Transmit Enable CNG 0x0666 Transmit Timeout 0x0668 Transmit dbm Level 0x066A Transmit Terminal ID 0x066C Fax Processing Events Set Register 0x0005 - Echo Cancel 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

Query Type: 0x0004 - Transmit parameters 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 For other Individual Parameter TLVs: Same as sent. 0x0005 - Echo Cancel Same as sent. 0x0006 - PVD/AMD Parameters Same as sent.

0x0006 - PVD/AMD Parameters 0x0619 PVD Parameters 0x0620 AMD Parameters 0x0007 - Dial Pulse Detection Parameters 0x05FA Card Object : Checksum :

Checksum

1-416
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

SwitchKit Name Type Description GELConfigQuery EXS API and SwitchKit API message Generic Event Logger Configure/Query 0x003D The Generic Event Logger (GEL) records system application and software debug events in the CSP. The GEL provides more debug data than the current fault log and online diagnostics. This message lets you control the Generic Event Logger (GEL). Every card that supports GEL has two buffers. One buffer stores LOGF/LOGB entries, and the other stores LOGT entries. LOGF enters seven data fields of ULONG type and an 80 character descriptor field to the LOGF/LOGB buffer. All data fields are user defined. LOGB puts a memory dump from a user defined address into the LOGF/ LOGB buffer. The user also defines the size of the memory dump and a descriptive string of up to 20 characters. LOGT places a user-defined 20 character descriptive string into the LOGT buffer. NOTE: This message is for debugging purposes only and should not be used until you contact technical support. Also, this message reduces system performance. Dialogic recommends using this message in test systems only.

Sent by SwitchKit Code

Host Configuration
GELConfigQuery ( Node = integer, Slot = integer, Action = integer, DataLength = integer, Data = byte array);

C Structure
typedef struct { UBYTE Slot; UBYTE Action; UBYTE DataLength; UBYTE Data[221]; } XL_GELConfigQuery;

C Structure Response
typedef struct { unsigned short Status; UBYTE Slot;

1- 417
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

UBYTE Data[221]; } XL_GELConfigQueryAck;

C++ Class
class XLC_GELConfigQuery : public XLC_OutboundMessage { public: UBYTE getSlot() const; void setSlot(UBYTE x); UBYTE getAction() const; void setAction(UBYTE x); UBYTE getDataLength() const; void setDataLength(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

C++ Class Response

class XLC_GELConfigQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); UBYTE getSlot() const; void setSlot(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

1- 418
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x003D) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot : Action 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x09 0x0A 0x0B 0x0C 0x0D : Set control mask Set Buffer Full option Start logging* Pause logging* Clear log Get logger status Get control mask Get Event buffer data Get Trace buffer data Get Module names Stop Write Telnet IP Print enable Telnet IP Print disable Same as message Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x00NN) Message Type (0x003D) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) See information below this table

*The Start (0x03) and Pause logging (0x04) actions have a global effect. That is, if the AIBs Slot Number field is 0xFF, the actions start or pause all card Generic Event loggers. : : : Data[0] Data Length Field Data[1] Data fields (see table below) Checksum : : Response Data[0] (See table below) Checksum

1- 419
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

Response Status Continued Below

If the message contains invalid fields, the CSP returns a NACK, but the following are some specific reasons for NACKs to this message. If you try to configure the logger or retrieve the buffer before pausing the logger, then the CSP responds with a NACK. This NACK specifies that the logger is not in a valid state. The following NACKs are used: 0x14 Message Invalid for Current CSP 2000 Matrix Card State The CSP Matrix Series 3 Card is not in a state to accept this message. 0x74 Invalid Card Type Incorrect card type for attempted operation. 0x20 Invalid Action Value Invalid decision parameter action value was received. 0x61 Invalid Slot The slot specified is not valid for the message sent. 0x99 Invalid Configuration Request Configuration request is invalid. 0x17 Invalid Data Type Returned in response to a message with invalid data parameters.

1- 420
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

Data
Below is the data associated with each of the above actions. 0x01 Set control mask Use this Action to define the control masks for each module. Data Length: n Data[0] Module ID 1 Bit Mask 4 bytes: 0 1 2 3 : Data[n] Module ID n Bit Mask 4 bytes: 0 1 2 3

Response Data

0x01 For Set control mask Data[0] Paused Mask [4 bytes] for module ID 1 Data[1] Paused Mask [4 bytes] for module ID 2 : Data[31] Paused Mask [4 bytes] for module ID 32

0x02 Set Buffer Full option

Use this Action to set up the Buffer Full option. When you use the Stop option, the buffer stops recording information once it is full. The Wrap option, once the buffer is full, the buffer begins to overwrite the earliest data. Data Length: 0x01 Data: 0x00 Stop (stops the buffer when it is full) 0x01 Wrap (wraps to beginning, overwriting oldest data when buffer is full) 0x03 Start logging* Use this Action to set up the buffer to turn on after a reset or not. If you want the buffer to start logging after a reset, send this Action with a data of 0x01. If you do not want the buffer to turn on after a reset, send the data 0x00. Data Length: 0x01 Data: 0x00 Stop (Do not continue logging to buffer after reset) 0x01 Start (Continue logging to buffer after reset) *If the slot number in the AIB is FF, then this message starts the loggers on all system cards that support GEL.

1- 421
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

Data
0x04 Pause logging* Use this message to stop logging to a buffer. Send this message again to unpause logging to a buffer. Data Length: 0x00 Data: NA *If the slot number in the AIB is FF, then this message pauses the loggers on all system cards that support GEL. 0x05 Clear log Use this Action when you want to remove all entries from a log. Data Length: 0x00 Data: NA 0x06 Get logger status Use this Action to receive a report on the status of a buffer. Data Length: 0x00 Data: NA

Response Data

0x06 For Get logger status Data[0] Data[1] Data[2] Data[3] Data[4] Number of Events in buffer Number of Blocks in buffer Number of Trace records in buffer Number of Records skipped Buffer Full action 0 stop logging when full 1 wrap buffer Data[5] Logger state 0 Paused 1 Logging Data[6] Buffer state 0 Available 1 Full Data[7] Percent of LOGF/LOGB buffer remaining Data[8] Max. LOGF/LOGB buffer size (MSB) Data[9] Max. LOGF/LOGB buffer size (LSB) Data[10] Maximum LOGT records (MSB) Data[11] Maximum LOGT records (LSB)

1- 422
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

Data
0x07 Get control mask Use this Action to find out the control masks of a buffer. Data Length: 0x00 Data: NA

Response Data
0x07 For Get control mask Data[0] Module ID 1 (MSB) Data[1] Module ID 1 (LSB) Bit Mask [paused] 4 bytes 0 1 2 3 Bit Mask[enabled] 4 bytes 0 1 2 3 : Data[n] Module ID n (MSB) Data[n+1]Module ID n (LSB) Bit Mask [paused] 4 bytes 0 1 2 3 Mask [enabled] 4 bytes 0 1 2 3

0x08 Get Event buffer data Send this message to retrieve the information in the Event buffer and have it dumped to the file specified. Use Data[0] to tell the computer to either append the file you give and put the new information at the end, or to overwrite the existing file. To stop the dump, you need to send the Stop Write (0x0B) Action. Data Length: n Data[0] Write permission 0 append 1 overwrite Data[1] First character [Path/Filename] : Data[n] NULL termination

1- 423
Release 8.4.1 ER3, February 2008

Generic Event Logger Configure/Query 0x003D

Data
0x09 Get Trace buffer data Send this message to retrieve the information in the Trace buffer and have it dumped to the file specified. Use Data[0] to tell the computer to either append the file you give and put the new information at the end, or to overwrite the existing file. To stop the dump, you need to send the Stop Write (0x0B) Action. Data Length: n Data: Data[0] Write permission 0 append 1 overwrite Data[1] First character[Path/Filename] : Data[n] NULL termination

Response Data

0x0A Get Module Names Use this Action to find out the names of a module. Data Length: 0x00 Data: NA

0x0A For Get Module Names Data[0] Module name 1 [12 characters] Data[1] Module name 2 [12 characters] : Data[31] Module name 32 [12 characters]

0x0B Stop Write Use this Action to stop writing from a buffer to a file. Data Length: n Data[0] First character [Path/Filename] : Data[n] NULL termination

1- 424
Release 8.4.1 ER3, February 2008

GenerateLogMsg

GenerateLogMsg
Type Description

EXS SwitchKit API message This message is used by the functions sk_logMessage( ) and sk_logMessageOnConnection() to log a message at specified level. This message does not have a response.

Sent by C Structure

Function sk_logMessage()
typedef struct { } SK_GenerateLogMsg; class SKC_GenerateLogMsg : public SKC_AdminMessage { public: };

C++ Class

1- 425
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

SwitchKit Name Type Description GenericReport EXS API and SwitchKit API message Generic Report 0x0046 This message is generated in response to the following Query Types sent in the System Configuration Query message: 0x04 - Active Conference IDs 0x05 - Channel State 0x08 - DS1 Trunk MIB Report 0x0A - Resource Usage 0x0B - DS3 Trunk MIB Report 0x10 - Detailed Conference Information 0x13 - Conference Speakers 0x14 - Conferencing Features 0x15 - Child Conference Information 0x16 - Child Conference IDs 0x18 - Cache File Query NOTE: The AIB and Number of Resources fields apply only if the Report Type field is Resource Usage (0x0A) In SwitchKit If you want to get this report, you must register for it by calling the sk_msgRegister function with the parameter, SK_RESOURCE_UTIL_REPORT. Sent by Example Message (Socket Log Output for SwitchKit) CSP In the following socket log output/example message, the Generic Report contains resource usage data for Slot 9.
00 63 00 46 00 00 ff 0a 00 01 01 01 09 04 00 26 03 01 02 00 02 48 c0 00 00 01 c0 03 00 02 63 00 00 00 00 00 05 00 05 9e 00 00 03 26 00 05 00 08 8c 00 00 00 04 00 01 01 00 02 08 00 00 f4 84 01 00 5c 05 03 20 00 00 f4 84 09 00 5c 05 01 00 11 02 00 05 03 00 0f 04 01 30 05 00 34 06 00 47 07 00 26 32 04 3d

1- 426
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

Switchkit Code

C Structure
typedef struct { UBYTE ReportType; UBYTE Data[252]; } XL_GenericReport;

C++ Class
class XLC_GenericReport : public XLC_InboundMessage { public: UBYTE getReportType() const; void setReportType(UBYTE x); const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

Overview of message

The following table provides an overview of this message. The table following it provides the detail for each byte.
RESPONSE (Gray) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0x0005) Message Type (0x0046) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 : : : : : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0046) Reserved (0x00) Sequence Number Logical Node ID Report Type AIB (Individual AEs) 0x01 Slot Number of Resources Data [0] : Checksum

NOTE: The AIB and Number of Resources fields apply only if the Report Type is 0x0A.

1- 427
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

EXS API Hex Format Detailed

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 8 Field Description Frame (0xFE) Length (0xNNNN) Message Type (0x0046) Reserved (0x00) Sequence Number Logical Node ID Byte 0 1, 2 3, 4 5 6 7 8 Report Type 0x04 - Active Conference IDs 0x05 - Channel State 0x08 - DS1 Trunk MIB Report 0x0A - Resource Usage 0x0B - DS3 Trunk MIB Report 0x10 - Detailed Conference Information 0x13 - Conference Speakers 0x14 - Conferencing Features Configuration 0x15 - Child Conference Information 0x16 - Child Conference IDs 0x18 - Cache File Query AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x01 Slot : : Number of Resources Data The data depends upon the Report Type 0x04 Active Conference IDs Data[0,1] Number of conference IDs to report (up to 50 per message) Data[2,3] First Conference ID Data[4,5] Second Conference ID : : RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0005) Message Type (0x0046) Reserved (0x00) Same Sequence Number Logical Node ID Checksum

NOTE: The AIB and Number of Resources fields apply only if the Report Type is Resource Usage (0x0A). :

1- 428
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

0x05 Channel State Data 06 is an AIB indicating the first channel to be reported: Data[0] Address Method (0x00) Individual AEs Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x0D, Channel) Data[3] Data Length (0x03) Data[4] Logical Span ID, MSB Data[5] Logical Span ID, LSB Data[6] Channel Data[7] Number of channels reported (1-32) Data[8] First channels current L4 state. (Repeated for each channel.) The following are Layer 4 state values: 0x00 Out-of-Service 0x01 Incoming Call 0x02 Wait For CSA in Incoming Call State 0x03 In Service Idle 0x04 Incoming Call, Wait for L5 0x05 Outgoing Call, L3 Outseize Wait 0x06 Wait For CSA in Incoming Call Wait for Host State 0x07 Answered 0x08 L4 Clear ACK Wait, L3 Disconnect Received 0x09 L3 Clear Wait 0x0A Busied out 0x0B Outgoing Call Cut-thru 0x0C Wait for CSA in Incoming Alerted State 0x0D Wait for CSA in Incoming in Answered State 0x0E Incoming Call Alerted 0x0F L3 Clear Wait 0x10 Wait for CSA in Outgoing Cut-thru 0x11 Wait for CSA in Outgoing Alerted State 0x12 L4 Clear ACK Wait, L3 Clear Received 0x13 Outgoing Call Alerted 0x14 L4 Clear ACK Wait, L5 Clear Received 0x15 L5 Release Wait 0x16 Incoming Call, L4 Clear ACK Wait (Park Processing) 0x17 Incoming Call Alerted, L4 Clear ACK Wait (Park Processing) 0x18 Answered, L4 Clear ACK Wait (Park Processing) 0x19 Outgoing Alerted, L4 Clear ACK Wait (Park Processing) 0x1A Outgoing Cut-thru, L4 Clear ACK Wait (Park Processing) 0x1B Wait for CSA (Call Service Ack) for Internal Routing Data[9] First channels current L3 state as viewed by L4 (Repeated for each channel.) The following are the Layer 3 state values relevant to Layer 4: 0x00 Out-of-Service 0x01 In Service 0x02 Maintenance 0x03 In Service Blocked 0x04 Unblocked : :

1- 429
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

0x08 - DS1 Trunk MIB Report Data 0-5 is an AIB: Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x0C) Data[3] Data Length (0x02) Data[4-5] Logical Span Data [6-9] Errored seconds Data [10-13] Severly errored seconds Data [14-17] Severly errored framing seconds Data [18-21] Unavailable seconds Data [22-25] Controlled slip seconds Data [26-29] Path code violations Data [30-33] Line code violations Data [34-37] Line errored seconds Data [38-41] Bursty errored seconds Data [42-45] Degraded minutes Data [46-49] Time elapsed Data [50-53] Interval number 0x0A Resource Usage Resource ID 0x00 Memory Data[0] Length Data[1] Number of regions configured on the card Data[2] Number of partitions configured on the card Data[3] Region ID of Nth region Data[4-7] Size of the region in bytes Data[8-11] Number of bytes used from the region Data [12] Partition ID of Nth partition Data[13-16] Size of the partition in bytes Data[17-20] Used bytes of partition : Data[:] Region ID of Nth region(1 byte) Data[:] Size of the Nth region in bytes (4 bytes) Data[:] Number of bytes used from the Nth region(4 bytes) Data [:] Partition ID of 1st partition (1 byte) Data[:] Size of the 1st partition in bytes (4 bytes) Data[:] Used bytes of 1st partition (4 bytes) : Data [:] Partition ID of Nth partition (1 byte) Data[:] Size of the Nth partition in bytes (4 bytes) Data[:] Used bytes of Nth partition (4 bytes) Resource ID 0x01 MCB Data[0] Length Data[0] Message buffer usage Resource ID 0x02 CPU Usage Level 1 Data[0] Length Data[1-4] Time in milliseconds covering this report Data[5] Number of tasks reported Data[6] Logical task ID (idle task only 0x00) Data[7] Percentage of time usage for task (integer part) Data[8] Percentage of time usage for task (decimal part)
...........................................................................................................................................................................................................................................................

1- 430
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

Resource ID 0x03 CPU Usage Level 2 Data[0] Length Data[1-4] Time in milliseconds covering this report Data[5] Number of tasks reported Data[6] Logical task ID Data[7] Percentage of time usage for task (integer part) Data[8] Percentage of time usage for task (decimal part 0x0B DS3 Trunk MIB Report Type Data 0-5 is an AIB: Data[0] Address Method (0x00) Data[1] Number of Address Elements (0x01) Data[2] Address Type (0x32) Data[3] Data Length (0x02) Data[4] Slot Number Data[5] DS3 Offset Data[6] Alarm Status A bit mask indicating what alarm is being sent and received on the DS3: Bit 0: Receiving Red Bit 1: Receiving RAI Bit 2: Receiving Loss of Signal (LOS) Bit 3: Receiving Out of Frame (OOF) Bit 4: Receiving AIS Bit 5: Sending AIS Bit 6: Sending RAI Bit 7: Reserved

Data[7-10] Code Violations Near End Line (CV-L) Data[1114] Errored Seconds Near End Line (ES-L) Seconds containing one or more BPVs or EXZs defects. Data[1518] Severely Errored Seconds Near End - Line (SES-L) Seconds during which BPVs plus EXZs exceed 44. Data[1922] Code Violations Near End Path (CVP-P) Data[2326] Errored Seconds Near End Path (ESP-P) Seconds containing one or more p-bit parity errors or SEF defects Data[2730] Severely Errored Seconds Near End -Path (SESP-P) Seconds during which p-bit parity errors exceed 44 or one or more SEF defects Data[31-34] Unavailable Seconds Near End - Path (UASP-P) Data[3538] Code Violations Near End - Path (CVCP-P) Data[3942] Errored Seconds Near End Path (ESCP-P) Seconds containing one or more c-bit parity errors or SEF defects. Data[4346] Severely Errored Seconds Near End - Path (SESCP-P) Seconds during which c-bit parity errors exceed 44 or one or more SEF defects. Data[47-50] Unavailable Seconds Near End - Path (UASCP-P) Data[5154] SEF/AIS Seconds Near End Path (SAS-P) Seconds containing one or more SEF defects. Data[5558] Code Violations Far End Path (CVCP-PFE) Data[59-62] Errored Seconds Far End Path (ESCP-PFE) Data[63-66] Severely Errored Seconds Far End - Path (SESCP-PFE) Data[67-70] Unavailable Seconds Far End Path (UASCP-PFE) Data[71-74] SEF/AIS Seconds Far End Path (SASCP-PFE) Data[75-78] Time Elapsed since the counters were last cleared ........................................................................................................................................................................................................................................................... Data[79-82] Interval Number (number of reports sent including this one)
Release 8.4.1 ER3, February 2008

1- 431

Generic Report 0x0046

0x10 Detailed Conference Information Data[0,1] Conference ID Data[2] Number of Channel Block's Data[3] Block Number Data[4] Node ID Data[5] DSP Card Slot Data[6] Module ID Data[7] DSP Number Data[8] Conference Number Data[9] Conference Type Data[10] Broadcast Enabled Data[11, 12] Number of Channels Allocated Data[13,14] Total Number of participant's Data[15] Tone Attached Data[16,17] Tone ID Data[18] VRA Attached Data[19] Marked for Deletion Data[20] Recording Data[21-32] Spare Bytes Data[33,34] Number of Participant's in block Data[35,36] Logical Span for Participant Number 1 Data[37] Logical Channel for Participant Number 1 Data[38] Leg value is 1 for 1-Way Listen-Only Connected Channels Leg value is 2 for 2-Way Connected Channels Leg value is 3 for 1-Way Talk-Only Connected Channels Data[39,40] Logical Span for Participant Number 2 Data[41] Logical Channel for Participant Number 2 Data[42] 1 or 2 legs for Participant Number 2 Data[ ] Continue with a list of span's and channels Data[159,160] Logical Span for Participant Number 32 Data[161] Logical Channel for Participant Number 32 Data[162] 1 or 2 legs for Participant Number 32 0x13 Conference Speakers (Parent Conference) Data[0-5] Conference ID AIB Data[6, 7] Data[8] Data[9] Data[10-13] Data[14, 15] Data[16] Data[17] Data[18-21] Data[22, 23] Data[24] Data[25] Data[26-29] Speaker #1 Span Speaker #1 Channel Speaker #1 Average Signal Magnitude Speaker #1 Active Speaking Time (5 ms increments) Speaker #2 Span Speaker #2 Channel Speaker #2 Average Signal Magnitude Speaker #2 Active Speaking Time (5 ms increments) Speaker #3 Span Speaker #3 Channel Speaker #3 Average Signal Magnitude Speaker #3 Active Speaking Time (5 ms increments)

1- 432
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

0x13 Conference Speakers (Child Conference) If conference speaker information is queried for child conference, the report data will be in the following format. Data[0-7] Child Conference ID AIB Data[8-9] Speaker #1 Span Data[10] Speaker #1 Chan Data[11] Speaker #1 Energy Level (dBm) Data[12-15] Speaker #1 Active Speaking Time Data[16-17] Speaker #2 Span Data[18] Speaker #2 Chan Data[19] Speaker #1 Energy Level (dBm) Data[20-23] Speaker #2 Active Speaking Time Data[24-25] Speaker #3 Span Data[26] Speaker #3 Chan Data[27] Speaker #1 Energy Level (dBm) Data[28-31] Speaker #3 Active Speaking Time 0x14 Conferencing Features (Parent Conference) If a conference ID is queried, the Report data is in the following format: Data[0-5] Conference ID AIB Data[6-7] DTMF Clamping Enabled Data[8-9] Output Gain Data[10-11] Noise Gating Enabled Data[12-13] Noise Gating Time Constant Data[14-15] Max Noise Level Data[16-17] Noise Gating Sensitivity Data[18-19] Echo Suppression Enable Data[20-21] Echo Return Loss Data[22-23] AGC Enable Data[24-25] AGC Input Level Data[26-27] AGC Time Constant Data[28-29] Conference Failure Behavior Data[30-31] Input Gain Data [32-33] Transit Connection Mode If a channel is queried the Report data is in the following format: Data[0-6] Channel AIB Data[7-8] DTMF Clamping Enabled Data[9-10] Output Gain Data[11-12] Noise Gating Enabled Data[13-14] Noise Gating Time Constant Data[15-16] Max Noise Level Data[17-18] Noise Gating Sensitivity Data[19-20] Echo Suppression Enable Data[21-22] Echo Return Loss Data[23-24] AGC Enable Data[25-26] AGC Input Level Data[27-28] AGC Time Constant Data[29-30] Conference Failure Behavior Data[31-32] Channel Input Gain
...........................................................................................................................................................................................................................................................

1- 433
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

0x14 Conferencing Features (Child Conference) If parameters are queried for child conference, the report data will be in the following format. Data[0-7] Child Conference ID AIB Data[8-9] DTMF Clamping Enabled Data[10-11] Output Gain Data[12-13] Noise Gating Enabled Data[14-15] Noise Gating Time Constant Data[16-17] Max Noise Level Data[18-19] Noise Gating Sensitivity Data[20-21] Echo Suppression Enable Data[22-23] Echo Return Loss Data[24-25] AGC Enable Data[26-27] AGC Input Level Data[28-29] AGC Time Constant Data[30-31] Conference Failure Behavior Data [32-33] Input Gain Data [34-35] Transit Connection Mode

If parameters are queried for a particular channel connected to a conference/child conference, the report data will be in the following format. Data[0-6] Channel AIB Data[7-8] DTMF Clamping Enabled Data[9-10] Output Gain Data[11-12] Noise Gating Enabled Data[13-14] Noise Gating Time Constant Data[15-16] Max Noise Level Data[17-18] Noise Gating Sensitivity Data[19-20] Echo Suppression Enable Data[21-22] Echo Return Loss Data[23-24] AGC Enable Data[25-26] AGC Input Level Data[27-28] AGC Time Constant Data[29-30] Conference Failure Behavior Data[31-32] Channel Input Gain

1- 434
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

0x15 Detailed Child Conference Information Data[0-1] Parent Conference ID Data[2-3] Child Conference ID Data[4] Number of Channel Blocks Data[5] Block Number Data[6] Node ID Data[7] DSP Card Slot Data[8] Module ID Data[9] DSP Number Data[10] Conference Number Data[11] Conference Type Data[12] Broadcast Enabled Data[13-14] Number of Channels Allocated Data[15-16] Total number of participants Data[17] Tone attached Data[18,19] Tone ID Data[20] VRA Attached Data[21] Marked for Deletion Data[22] Recording Data[23-34] Spare Bytes Data[35-36] Number of Participants in Block Data[37-38] Logical Span for Participant #1 Data[39] Logical Chan for Participant #1 Data[40] 1 or 2 legs for Participant #1 . . . . . . Data[161-162] Logical Span for Participant #32 Data[163] Logical Chan for Participant #32 Data[164] 1 or 2 legs for Participant #32

1- 435
Release 8.4.1 ER3, February 2008

Generic Report 0x0046

(0x16) Child Conference IDs Information Report type Data[0-5] Data[6-7] Conference ID AIB Number of child conferences Ids to report (Up to 50 per message) Data[8-9] First Child Conference ID Data[10-11] Second Child Conference ID Data[12-13] Third Child Conference ID . . Data[106-107] Fiftieth Child Conference ID 0x18 Cache File Query Report type If the Cache File ID information is queried, the report data will be in the following format. Data[0] Slot Number The following data is returned to the DSP Series 2 card main board cache and for each DSP chip. Data[1] DSP Module Number 0x00, 0x01, 0xFF Data[2] DSP Chip Number 0x00, 0x01, 0x02, 0x03, 0xFF Data[3-6] File ID Data[7] File Status 0x00 - Absent 0x01 - Present Data[8] Encoding Format 0x00 - A-law 0x01 - Mu-law Data[9] File Format 0x00 - raw (packed raw binary data) 0x01 - vox 0x02 - wav Data[10-13] File Size (in bytes) Note: Data[8-13] is valid only if Data[7] File Status is set to 0x01 : Checksum

1- 436
Release 8.4.1 ER3, February 2008

GenericLLCReport

GenericLLCReport
Type Description

SwitchKit API message This message reports the status of LLC entities to applications that have registered for it. In particular it will report the status of the LLC socket connections, LLC to LLC redundancy status, and the service state of channels groups being watched by an application. LLC to applications that have registered for it using the SK_ msgRegister() function with the parameter SK_GENERIC_LLC_REPORT.
typedef struct { unsigned short DataSize; UBYTE ReportType; UBYTE TLVCount; UBYTE Data[249]; } SK_GenericLLCReport; class SKC_GenericLLCReport : public SKC_ToolkitMessage { public: unsigned short getDataSize() const; void setDataSize(unsigned short x); UBYTE getReportType() const; void setReportType(UBYTE x); UBYTE getTLVCount() const; void setTLVCount(UBYTE x) ; const UBYTE *getData() const; UBYTE *getData(); void setData(UBYTE *x); };

Sent by

C Structure

C++ Class

Arguments

The following table shows the arguments sent by the LLC:

Argument DataSize ReportType TLVCount data Description Number of bytes of the data. Type of GenericLLCReport Number of TLVs in the data. Data bytes

1- 437
Release 8.4.1 ER3, February 2008

GenericLLCReport Report Types

The following report types are used in the GenericLLCReport message.

Report Type SK_NSR_CHANGE SK_NSQ_CHANGE SK_PM_CHANGE SK_SOCKET_CHANGE SK_SSC_UPDATE SK_LINK_UP SK_LINK_DOWN SK_GROUP_WATCHER_STATUS SK_CHANNEL_RANGE_STATUS SK_LLC_REDUNDANCY TLVs Value 0x01 (not currently used) 0x02 (not currently used) 0x03 0x04 (not currently used) 0x05 0x06 0x07 0x08 0x09 0x0b

Several different TLVs can be reported within the GenericLLCReport: SK_LLCREDSTATE_TLV (0x0004) SK_LLCREDSTATE_TLV (0x0005) SK_LLCREDSETTINGS_TLV (0x0006) SK_POLL_DATA_TLV (0x1000) Sk_IPV4_TLV (0x1001) SK_ROUTING_TLV (0x1002) Sk_LNI_TLV (0x1003) SK_CHANNEL_GROUP_TLV (0x1004) SK_CHANNEL_RANGE_TLV (0x1005)

Report Type: SK_LLC_REDUNDANCY

A GenericLLCReport of report type, SK_LLC_REDUNDANCY is generated and sent to registered applications by the active LLC when: An application connects The LLC changes redundancy states An LLCQuery of type SK_LLC_REDUNDANCY_QUERY_TLV is sent to the active LLC.

The standby LLC sends reports under the same circumstances. However, because only the active LLC can communicate with the
...........................................................................................................................................................................................................................................................

1- 438
Release 8.4.1 ER3, February 2008

GenericLLCReport

standby LLC, the primary LLC (PLLC) to redundant LLC (RLLC) link must be in SK_LINK_UP state for the application to receive the reports. If the PLLC to RLLC link is in state SK_LINK_DOWN, no responses from the standby LLC will be seen.
Possible TLV Combinations

Report Type

LLCREDTYPE_TLV 1

LLCREDSTATE_TLV 1

LLCREDSETTINGS_TLV 1

SK_LLC_Redundancy

TLV Syntax

The TLVs described in this section are used with the SK_LLC_REDUNDANCY report type in a GenericLLCReport message. SK_LLCREDTYPE_TLV (0x0004) SK_LLCREDSTATE_TLV (0x0005) SK_LLCREDSETTINGS_TLV (0x0006)

1- 439
Release 8.4.1 ER3, February 2008

GenericLLCReport SK_LLCREDTYPE_TLV (0x0004) Description Tag Length Value Byte (Value) Data[0, 1] = 0x0004 (SK_LLCREDTYPE_TLV) Data[2, 3] = 0x0001 Data[4] = Type 0x01 - LLC was started as primary 0x02 - LLC was started as redundant (with -r) SK_LLCREDSTATE_TLV (0x0005) Description Tag Length Value Byte (Value) Data[0, 1] = 0x0005 (SK_LLCREDSTATE_TLV) Data[2, 3] = 0x0002 Data[4] = LLC state 0x00 - Transient or Unknown 0x01 - Active 0x02 - Standby Data [5] = LLC to LLC Redundant Link State 0x06 - RLink Up (PLLC to RLLC communication possible) 0x07 - Rlink Down (PLLC to RLLC communication not possible) SK_LLCREDSETTINGS_TLV (0x06) Description Tag Length Byte (Value) Data[0, 1] = 0x0006 (SK_LLCREDSETTINGS_TLV) Data[2, 3] = 0x0012

1- 440
Release 8.4.1 ER3, February 2008

GenericLLCReport

Description Value

Byte (Value) IP Address of the Host this message came from (presumably the Active LLC) Data [4] = First octet of Host IP address Data [5] = Second octet of Host IP address Data [6] = Third octet of Host IP address Data [7] = Fourth octet of Host IP address IP of the Primary LLC's listening socket Data [8] = First octet of PLLC IP address Data [9] = Second octet of PLLC Host IP address Data [10] = Third octet of PLLC Host IP address Data [11] = Fourth octet of PLLC IP address Listening Port of the Primary LLC Data [12, 13] = PLLC Port IP of the Redundant LLC's listening socket Data [14] = First octet of RLLC IP address Data [15] = Second octet of RLLC Host IP address Data [16] = Third octet of RLLC Host IP address Data [17] = Fourth octet of RLLC IP address Listening Port of the Redundant LLC Data [18, 19] = RLLC PortSwitchback mode as defined by Primary Host Data [20] = mode 0x00 - Primary LLC preferred 0x01 - Manual

Report Types

The TLVs in this section are used to report the status of the LLC socket connections. SK_PM_CHANGE SK_SSC_UPDATE SK_LINK_UP SK_LINK_DOWN

These report types are unsolicited messages that report the status of socket connections between the LLC and its devices, in particular, devices that share a logical node but are on unique logical links (i.e. direct connections to the SS7 for TCAP). The following list describes the conditions that will cause the LLC to send these reports within the GenericLLCReport:

1- 441
Release 8.4.1 ER3, February 2008

GenericLLCReport

SK_PM_CHANGE
Sent when the first poll is received by the LLC for a CSP Matrix Series 3 Card. Also sent any time a value changes in the Poll. The UpdatedFieldBits field indicates which fields have changed since the last poll.

SK_SSC_UPDATE
Sent when an application issues an AddLLCCard. An SSC_UPDATE may be generated if the LLC already knew about the device and the LLC is currently connected to the active device within that node. In other words, if the Link is considered to be up.

SK_LINK_UP
Sent to indicate that there is a connection to the active device for this node and the device is ready to be configured. This will be sent if this is a new condition (i.e. the LLC was not previously connected to the active Device).

SK_LINK_DOWN
Sent to indicate that there is NO connection to the active Device for a node. This will be sent if this is a new condition (that is, we were previously connected to the active Device). Important!

Performing an AddLLCCard will result in an SK_SSC_UPDATE with the last poll from the active Device, if the LLC is currently connected to the Device in the active state.

1- 442
Release 8.4.1 ER3, February 2008

GenericLLCReport SK_POLL_DATA_TLV (0x1000) Description Tag Length Value Byte (Value) Data[0, 1] = 0x1000 (SK_POLL_DATA_TLV) Data[2, 3] = 0x000b Data[4] = StatusData Data[5,6] = SystemType Data[7] = MatrixSide Data[8] = MatrixState Data[9] = AdjMatrixState Data[10] = StatusBits Data[11,12] = Actual Logical Node ID Data[13, 14] = UpdatedFieldBits

SK_IPV4_TLV (0x1001) Description Tag Length Value Byte (Value) Data[0, 1] = 0x1001 (SK_IPV4_TLV) Data[2, 3] = 0x0004 Data[4] = First octet of IP address (hexadecimal) Data[5] = Second octet of IP address (hexadecimal) Data[6] = Third octet of IP address (hexadecimal) Data[7] = Fourth octet of IP address (hexadecimal)

SK_ROUTING_TLV (0x1002) Description Tag Length Value Byte (Value) Data[0, 1] = 0x1002 (SK_ROUTING_TLV) Data[2, 3] = 0x0004 Data[4,5,6,7] = Routing ID

SK_LNI_TLV (0x1003) Description Tag Length Value Byte (Value) Data[0, 1] = 0x1003 (SK_LNI_TLV) Data[2, 3] = 0x0002 Data[4,5] = Requested Logical Node ID

1- 443
Release 8.4.1 ER3, February 2008

GenericLLCReport Report Types

The TLVs in this section are used to report the service state of channel groups being watched by an application. SK_GROUP_WATCHER_STATUS SK_CHANNEL_RANGE_STATUS

Report Type

SK_CHANNEL_GROUP_TLV 1

SK_CHANNEL_RANGE_TLV

SK_GROUP_WATCHER_ STATUS SK_CHANNEL_RANGE_ STATUS

SK_CHANNEL_GROUP_TLV (0x1004)

In the event that the environment variable SK_CHANNEL_RECOVERY_METHOD=0x03 (All_OUT_OF_SERVICE) is set or a ForceGroupState message is received, the LLC has the ability to take entire groups of channels inservice and out-of-service. In the event that this occurs a "master" application can be created that monitors this behavior by registering for GenericLLCReports and parsing a new report type within it called SK_GROUP_WATCHER_STATUS.
Description Tag Length Value Byte (Value) Data[0, 1] = 0x1004 (SK_CHANNEL_GROUP_TLV) Data[2, 3] = 0x0034 Data[4] = Status 0x00 Not Watched 0x01 Watched Data[5] Reserved (Not Used) Data [6,56] = Group (null terminated string) SK_CHANNEL_RANGE_TLV (0x1005)

In the event that the environment variable SK_CHANNEL_RECOVERY_METHOD=0x03 (All_OUT_OF_SERVICE) is set or a ForceGroupState message is
...........................................................................................................................................................................................................................................................

1- 444
Release 8.4.1 ER3, February 2008

GenericLLCReport

received, the LLC has the ability to take entire groups of channels inservice and out-of-service. In the event that this occurs a "master" application can be created that monitors this behavior by registering for GenericLLCReports and parsing a new report type within it called SK_CHANNEL_RANGE_STATUS.

Description Tag Length Value

Byte (Value) Data[0, 1] = 0x1005 (SK_CHANNEL_RANGE_TLV) Data[2, 3] = 0x0009 Data[4,5] = Start Span Data[6] =Start Channel Data[7,8] = End Span Data[9] = End Channel Data[10] = Status 0xF0 SK_IN_SERVICE 0x0F SK_OUT_OF_SERVICE Data[11,12] = Reserved (Not Used)

Possible TLV Combinations Report Type SK_PM_CHANGE SK_SSC_UPDATE SK_LINK_UP SK_LINK_DOWN SK_LNI_TLV 1 1 1 1 SK_POLL_DATA_TLV 1 1 0 0 SK_IPV4_TLV 1 1 * **

* A Report Type will contain at least one of these TLVs. The CSP Matrix Series 3 Card represented by the first TLV in a series will always indicate the current Active. ** A Report Type will contain at least one of these TLVs. When a series of TLVs is sent by the LLC, the order of the TLVs is irrelevant. When the link is down the LLC does not know which is Active or not.

1- 445
Release 8.4.1 ER3, February 2008

HexTool

HexTool
Type Purpose

SwitchKit API message Use the SK_HexTool message to send a configuration file directly to a specific slot in a node. This message sends a config file containing EXS API to a specific slot. The *.cfg file is resent whenever required, based on the configuration setting for the card in the designated slot. CSA or SwitchManager The following table shows the user modifiable arguments of this message:
Arguments Slot CfgFile CSAFilename Descriptions The slot number the file is destined for. The filename of the file to parse and send. The maximum size of the CfgFile name is 160 bytes. Internally used by CSA.

Description

Sent by Arguments

Configuration

HexTool (
Node = integer, Slot = integer, CfgFile = quoted string ConnectionID = integer);

C Structure

typedef struct { UBYTE Slot; char CfgFile[100]; char CSAFilename[100]; } SK_HexTool; class SKC_HexTool : public SKC_DummyMessage { public: UBYTE getSlot() const; void setSlot(UBYTE x); const char *getCfgFile() const; void setCfgFile(const char *x); const char *getCSAFilename() const; void setCSAFilename(const char *x); };

C++ Class

1- 446
Release 8.4.1 ER3, February 2008

HexTool

1- 447
Release 8.4.1 ER3, February 2008

HostAlarm

HostAlarm
Type Description

SwitchKit API message Use the SK_HostAlarm message to allow SwitchKit applications to generate alarms or events that can be sent to other SwitchKit applications. Receiving applications, such as SNMP processes will be able to register to receive this class of message. Application The following table shows the arguments you can change:

Sent by Arguments

Argument AppName

Description A text string used to uniquely identify the application sending the message. (ASCII String 64 characters maximum) This is the number of seconds since January 1 1970. This field will contain the IP Address of the host system where the problem originated See Table 1:Alarm Types See Table 2: Alarm Sub-types/Probable Cause See Table 3:Alarm Severity The number of data items associated with this message SeeTable 4: TLV Data Types

AlarmTime IPAddrofSender

AlarmMajor AlarmSubType AlarmSeverity TLVCount TLVData Configuration C Structure

Syntax, if able to send, is through SMgr

typedef struct { UBYTE IPAddrofSenderSize; UBYTE reserved5[12]; char AppName[64]; int AlarmTime; UBYTE IPAddrofSender[4]; UBYTE AlarmMajor;

1- 448
Release 8.4.1 ER3, February 2008

HostAlarm
UBYTE AlarmSubType; UBYTE AlarmSeverity; UBYTE TLVCount; UBYTE TLVData[177]; } SK_HostAlarm;

C Structure Response

typedef struct { int Status; UBYTE reserved21[4]; } SK_HostAlarmAck; class SKC_HostAlarm : public SKC_ToolkitMessage { public: UBYTE getIPAddrofSenderSize() const; void setIPAddrofSenderSize(UBYTE x); const char *getAppName() const; void setAppName(const char *x); int getAlarmTime() const; void setAlarmTime(int x); const UBYTE *getIPAddrofSender() const; UBYTE *getIPAddrofSender(); void setIPAddrofSender(UBYTE *x); UBYTE getAlarmMajor() const; void setAlarmMajor(UBYTE x); UBYTE getAlarmSubType() const; void setAlarmSubType(UBYTE x); UBYTE getAlarmSeverity() const; void setAlarmSeverity(UBYTE x); UBYTE getTLVCount() const; void setTLVCount(UBYTE x); const UBYTE *getTLVData() const; UBYTE *getTLVData(); void setTLVData(UBYTE *x); }; class SKC_HostAlarmAck public: int getStatus() const void setStatus(int x) }; : public SKC_ToolkitAck {

C++ Class

C++ Class Response

Table 1:Alarm Types Name Communications Alarm Type Value as Defined SK_COMMUNICATIONS 1 Description An alarm of this type is principally associated with the procedures and/or processes required to convey information from one point to another.
1- 449
Release 8.4.1 ER3, February 2008

HostAlarm

Name QOS Alarm Type

Value as Defined
SK_QUALITYOFSERVICE

Description 2 An alarm of this type is principally associated with degradation in the quality of a service. An alarm of this type is principally associated with a software or processing fault. An alarm of this type is principally associated with an equipment fault An alarm of this type is principally associated with a condition relating to an enclosure in which the equipment [Link]

Processing Error Alarm Type

SK_PROCESSINGERROR 3

Equipment Alarm Type Environmental Alarm Type

SK_EQUIPMENT 4
SK_ENVIRONMENTAL 5

Table 2: Alarm Sub-types/Probable Cause Name Adapter error Application subsystem failure: Value as Defined SK_ADAPTERERROR 1 SK_APPLICATIONSUBSYSTEMFAIL URE 2 A failure in an application subsystem has occurred (an application subsystem may include software to support the Session, Presentation or Application layers) The available transmission bandwidth has decreased An error occurred while attempting to establish a connection A communication protocol has been violated Description

Bandwidth reduced Call establishment error Communications protocol error

SK_BANDWIDTHREDUCED 3 SK_CALLESTABLISHMENTERROR 4 SK_COMMUNICATIONPROTOCOLE RROR 5

Communications subsystem failure

SK_COMMUNICATIONSUBSYSTEM FAILURE 6

A failure in a subsystem that supports communications over telecommunications links, these may be implemented via leased telephone lines, by X.25 networks, token-ring LAN, or otherwise

1- 450
Release 8.4.1 ER3, February 2008

HostAlarm

Name Configuration or customization error:

Value as Defined SK_CONFIGURATIONORCUSTOMIZ ATIONERROR 7

Description A system or device generation or customization parameter has been specified incorrectly, or is inconsistent with the actual configuration A system or network component has reached its capacity or is approaching it 9 An error has caused data to be incorrect and thus unreliable A Central Processing Unit has issued an unacceptable number of instructions to accomplish a task An internal error has occurred on a dataset or modem The quality or reliability of transmitted data has decreased 13 A problem in a DTE-DCE interface, which includes the interface between the DTE and DCE, any protocol used to communicate between the DTE and DCE and information provided by the DCE about the circuit

Congestion:

SK_CONGESTION

Corrupt data:

SK_CORRUPTDATA

CPU cycles limit exceeded Dataset or modem error Degraded signal DTE-DCE interface error:

SK_CPUCYCLESLIMITEXCEEDED 10 SK_DATASETORMODEMERROR 11 SK_DEGRADEDSIGNAL 12

SK_DTEDCEINTERFACEERROR

Enclosure door open

SK_ENCLOSUREDOOROPEN

Equipment malfunction

SK_EQUIPMENTMALFUNCTION 15 SK_EXCESSIVEVIBRATION 16

An internal machine error has occurred for which no more specific Probable cause has been identified Vibratory or seismic limits have been exceeded The format of a file (or set of files) is incorrect and thus cannot be used reliably in processing

Excessive vibration:

File error:

SK_FILEERROR

Fire detected Flood detected

SK_FIREDETECTED SK_FLOODDETECTED 19

1- 451
Release 8.4.1 ER3, February 2008

HostAlarm

Name Framing error

Value as Defined SK_FRAMINGERROR 20

Description An error in the information that delimits the bit groups within a continuous stream of bits

Heating/ventilation/ cooling system problem Humidity unacceptable I/O device error Input device error LAN error Leak detected: Local node transmission error: Loss of frame

SK_HEATORVENTORCOOLSYSTEM PROBLEM SK_HUMIDITYUNACCEPTABLE 22 SK_INPUTOUTPUTDEVICEERROR 23 SK_INPUTDEVICEERROR SK_IANERROR 25 26 24 The humidity is not within acceptable limits An error has occurred on the I/O device An error has occurred on the input device An error has been detected on a local area network A leakage of (non-toxic) fluid or gas has been detected An error occurred on a communications channel between the local node and an adjacent node An inability to locate the information that delimits the bit grouping within a continuous stream of bits An error condition in which no data is present on a communications circuit or channel A supply of needed material has been exhausted

SK_LEAKDETECTED

SK_LOCALNODETRANSMISSIONER ROR 27 SK_LOSSOFFRAME 28

Loss of signal

SK_LOSSOFSIGNAL

Material supply exhausted

SK_MATERIALSUPPLYEXHAUSTED 30

Multiplexer problem Out of memory Output device error Performance degraded

SK_MULTIPLEXERPROBLEM SK_OUTOFMEMORY 32

An error has occurred while multiplexing communications signals There is no program-addressable storage available.

SK_OUTPUTDEVICEERROR

An error has occurred on the output device Service agreements or service limits are outside of acceptable limits

SK_PERFORMANCEDEGRADED 34

1- 452
Release 8.4.1 ER3, February 2008

HostAlarm

Name Power problem Pressure unacceptable Processor problem Pump failure

Value as Defined SK_POWERPROBLEM 35 36

Description There is a problem with the power supply for one or more resources A fluid or gas pressure is not within acceptable limits An internal machine error has occurred on a Central Processing Unit Failure of mechanism that transports a fluid by inducing pressure differentials within the fluid 39 The number of items to be processed (configurable or not) has exceeded the maximum allowable

SK_PRESSUREUNACCEPTABLE SK_PROCESSORPROBLEM SK_PUMPFAILURE 38 37

Queue size exceeded

SK_QUEUESIZEEXCEEDED

Receive failure Receiver failure Remote node transmission error Resource at or nearing capacity Response time excessive

SK_RECEIVEFAILED SK_RECEIVERFAILED

40 41 An error occurred on a communication channel beyond the adjacent node The usage of a resource is at or nearing the maximum allowable capacity
The elapsed time between the end of an inquiry and beginning of the answer to that inquiry is outside of acceptable limits The number of repeat transmissions is outside of acceptable limits

SK_REMOTENODETRANSMISSIONE RROR 42 SK_RESOURCEATORNEARINGCAP ACITY 43

SK_RESPONSETIMEEXCESSIVE 44

Retransmission rate excessive Software error

SK_RETRANSMISSIONRATEEXCESSIVE 45

SK_SOFTWAREERROR

A software error has occurred for which no more specific Probable cause can be identified A software program has abnormally terminated due to some unrecoverable error condition An error has occurred within a software program that has caused incorrect results A storage device has very little or no space available to store additional data
1- 453

Software program abnormally terminated Software program error

SK_SOFTWAREPROGRAMABNORM ALLYTERMINATED 47 SK_SOFTWAREPROGRAMERROR 48 SK_STORAGECAPACITYPROBLEM 49

Storage capacity problem

........................................................................................................................................................................................................................................................... Release 8.4.1 ER3, February 2008

HostAlarm

Name Temperature unacceptable Threshold crossed Timing problem

Value as Defined SK_TEMPERATUREUNACCEPTABL E 50 SK_THRESHOLDCROSSED SK_TIMINGPROBLEM 52 51

Description A temperature is not within acceptable limits A limit (configurable or not) has been exceeded A process that requires timed execution and/or coordination cannot complete, or has completed but cannot be considered reliable 53 A leakage of toxic fluid or gas has been detected

Toxic leak detected Transmit failure Transmitter failure Underlying resource unavailable Version mismatch

SK_TOXICLEAKDETECTED SK_TRANSMITFAILURE 54

SK_TRANSMITTERFAILURE

55 An entity upon which the reporting object depends has become unavailable There is a conflict in the functionality of versions of two or more communicating entities which may affect any processing involving those entities A node's license verification failed. An attempt was made to add a duplicate node to the LLC's node list. A node was added to the LLC's node list. Initiates a severity level of SK_INFORMING. A node was removed from the LLC's node list. Initiates a severity level of SK_INFORMING

SK_UNDERLYINGRESOURCEUNAV AILABLE 56 SK_VERSIONMISMATCH 57

License verification failure Node in use Node created

SK_LICENSE 58 SK_NODE_IN_USE 59 SK_NODE_CREATED 60

Node removed

SK_NODE_REMOVED 61

1- 454
Release 8.4.1 ER3, February 2008

HostAlarm Table 3:Alarm Severity Name Cleared Value as Defined SK_CLEARED 1 Description The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below). The Indeterminate severity level indicates that the severity level cannot be determined. The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored. 6 The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored. The Minor severity level indicates the existence of a nonservice affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object. 3 The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious serviceaffecting fault.

Indeterminate Major

SK_INDETERMINATE 2 SK_MAJOR 5

Critical

SK_CRITICAL

Minor

SK_MINOR

Warning

SK_WARNING

Table 4: TLV Data Types Name DisplayString Value as Defined SK_TLV_DISPLAYSTRING 1 Description ASCII text string. Characters greater then or equal to 0x20 and characters less then 0x7e, 64 characters max. Integer field

Integer

SK_TLV_INTEGER 2

1- 455
Release 8.4.1 ER3, February 2008

HostAlarm

Name IpAddress

Value as Defined SK_TLV_IPADDRESS 3

Description This application-wide type represents a 32-bit internet address. It is represented as an OCTET STRING of length 4, in network byte-order. This data type is used to model media addresses. For example, an ethernet address would be represented as a string of 6 octets.

PhysicalAddress

SK_TLV_PHYSICALADDRESS 4

1- 456
Release 8.4.1 ER3, February 2008

IgnoreChanGroup

IgnoreChanGroup
Type Description

SwitchKit API message This message is used by the function sk_ignoreChanGroup() if an application calls for that function. Function sk_ignoreChanGroup
typedef struct { } SK_IgnoreChanGroup; class SKC_IgnoreChanGroup : public SKC_AdminMessage { public: };

Sent by C Structure

C++ Class

1- 457
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Configure 0x0028

SwitchKit Name Type Description InpulsingParametersConfig EXS API and SwitchKit API message Inpulsing Parameters Configure 0x0028 The Inpulsing Parameters Configure message allows the host to configure inpulse data collection parameters on specified channels. Use inpulse parameters when data is collected by means of an Inseize Control instruction. Call setup inpulsing parameters define the address signaling type, number of digit strings, and collection method used during call setup. The CSP supports four different inpulsing stages, and each stage is defined as either one or two digit strings. When instructing the CSP to collect address signaling information that is typically presented with in-band dual frequency tones, the host must specify a preprogrammed inpulsing stage that describes how to perform the digit collection. Each channel has four inpulsing stages that can be preprogrammed. The inpulsing stage configuration options include: the address signaling type (DTMF, MFR1, MFR2), the number of strings (1 or 2), and the string collection method (fixed number digits, KP/ST framed, compelled). Sent by Example Message (Socket Log Output for SwitchKit) Host The following socket log output/example message shows data being sent from the host to the CSP to configure inpulse data collection parameters on span 0x00, channels 0x00 - 0x17. The stage number being configured is 0x01 and the number of digit strings in the stage is 0x01. The stage complete timeout is three seconds and the address signaling type is DTMF. This message collects seven digits. 00 1a 00 28 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 00 17 01 01 01 2c 01 01 07 01 07 SwitchKit Code Configuration
InpulsingParametersConfig ( Node = integer, Range = StartSpan:StartChan - EndSpan:EndChan, Stage = integer, NumDigitStrings = integer, StageCompleteTimeout = integer, AddrSignallingType = integer, String1Method = integer, String1Data = integer, String2Method = integer, String2Data = integer);
...........................................................................................................................................................................................................................................................

1- 458
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Configure 0x0028 C Structure

typedef struct { unsigned short StartSpan; UBYTE StartChannel; unsigned short EndSpan; UBYTE EndChannel; UBYTE Stage; UBYTE NumDigitStrings; unsigned short StageCompleteTimeout; UBYTE AddrSignallingType; UBYTE String1Method; UBYTE String1Data; UBYTE String2Method; UBYTE String2Data; } XL_InpulsingParametersConfig;

C++ Class
class XLC_InpulsingParametersConfig : public XLC_ChanRangeMessage { public: unsigned short getStartSpan() const; void setStartSpan(unsigned short x); UBYTE getStartChannel() const; void setStartChannel(UBYTE x); unsigned short getEndSpan() const; void setEndSpan(unsigned short x); UBYTE getEndChannel() const; void setEndChannel(UBYTE x); UBYTE getStage() const; void setStage(UBYTE x); UBYTE getNumDigitStrings() const; void setNumDigitStrings(UBYTE x); unsigned short getStageCompleteTimeout() const; void setStageCompleteTimeout(unsigned short x); UBYTE getAddrSignallingType() const; void setAddrSignallingType(UBYTE x); UBYTE getString1Method() const; void setString1Method(UBYTE x); UBYTE getString1Data() const; void setString1Data(UBYTE x); UBYTE getString2Method() const; void setString2Method(UBYTE x); UBYTE getString2Data() const; void setString2Data(UBYTE x); };

1- 459
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Configure 0x0028

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x0028) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x01 - Range of AEs Number of AEs to follow AEs 0x0D Channel (Starting) 0x0D Channel (Ending) : : : Stage Number Inpulsing Stage number to configure (14) Number of Digit Strings Number of digit strings in stage (12) Stage Complete Time Out (MSB, LSB) The maximum amount of time from the detection of the first digit until all digits have been collected for the [Link] first digit must be detected or the receive first digit timer must expire before this timer is active. See the Timer Conversion Table Address Signaling Type The address signaling type must be the same for both strings within a stage, but may differ between stages. 0x01 DTMF 0x02 MFR1 0x03 MFR2 0x04 Reserved 0x05 Dial Pulse Byte 0 1, 2 3, 4 5 6 7 8, 9 10 RESPONSE (Gray) Field Description Frame (0xFE) Length (0x0007) Message Type (0x0028) Reserved (0x00) Same Sequence Number Logical Node ID Status (MSB, LSB) Checksum

1- 460
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Configure 0x0028

String 1: Collection Method 0x01 Fixed Number of Digits 0x02 Use Termination Digit 0x03 Use KP/ST Signals; Do Not Send To Host KP and ST signals (ST, STI, STII, STIII) are not included in the string sent to the host in the Request For Service message. This method is only valid for MFR1 signaling. 0x04 Reserved 0x05 Compelled This method is only valid for MFR2 signaling. 0x06 Use KP/ST Signals; Include in Digit String KP and ST signals (ST, STI, STII, STIII) will be included in the string sent to the host in the Request For Service message. This method is only valid for MFR1 signaling. 0x07 Compelled KP (MF-MDR1) The KP and ST digits will not be included in the string that is reported to the host. 0x08 Fixed or Indefinite Number of Digits If the first digit detected is zero, the Indefinite Number of Digits method is used and the Completion Timer or Interdigit Timer is used (whichever expires first) to terminate digit collection. If the first digit collected is not zero, the Fixed Number of Digits method is used. This method is used to help facilitate collecting digit strings on channels that process national and international calls. String 1: Collection Data Data is dependent on the value of the String Collection Method. Fixed Number of Digits Digit Count (0x000x64). Set this value to 0xFF if you want the CSP to continue requesting Forward R2 signals until no more are received. This option is valid for MFR2 only. Use Termination Digit Digit Value (0x000x0F) Use KP_ST Signals No data (0x00) Compelled Digit Count (0x000x64). Set this value to 0xFF if you want the CSP to continue requesting Forward R2 signals until no more are received. This option is valid for MFR2 only. String 2: Collection Method If only one string is being collected, enter 0x00 for this field. String 2: Collection Data If only one string is being collected, enter 0x00 for this field. : Checksum

1- 461
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Configure 0x0028

Default Inpulse Parameters

The number of strings for each stage for each span listed below is 1. T1 Spans The information for each stage is identical.
Stages 14
Stage Complete Timer 12,000 ms Address Signaling Type MFR1 Collection Method Use KP_ST, KP, and ST digits not reported to host.

E1 Spans
Stage 1
Stage Complete Timer 12,000 ms Address Signaling Type MFR2 Collection Method Collection Data Compelled 0x03 (Area Code)

Stage 2
Stage Complete Timer 12,000 ms Address Signaling Type MFR2 Collection Method Collection Data Compelled 0x0A (CLI, Calling Line ID)

Stage 3
Stage Complete Timer 12,000 ms Address Signaling Type MFR2 Collection Method Collection Data Compelled 0x07 (Called Party Address)

Stage 4
Stage Complete Timer 12,000 ms Address Signaling Type MFR2 Collection Method Collection Data Compelled 0x01 (Group 2 Category Digit)

1- 462
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Query 0x0089

SwitchKit Name Type Description InpulsingParametersQuery EXS API and SwitchKit API message Inpulsing Parameters Query 0x0089 This host uses this message to query the inpulsing parameters configured on the specified channel. The response from the CSP reports four two-string stages, even if there is no configuration for a stage (which is reported as 0x00). Sent by SwitchKit Code Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; } XL_InpulsingParametersQuery;

C Structure Response
typedef struct { unsigned short Status; unsigned short Stage1Timer; UBYTE Stage1Strings; UBYTE Reserved1; UBYTE Stage1String1Type; UBYTE Stage1String1Method; UBYTE Stage1String1MethodData; UBYTE Reserved11; UBYTE Stage1String2Type; UBYTE Stage1String2Method; UBYTE Stage1String2MethodData; UBYTE Reserved12; unsigned short Stage2Timer; UBYTE Stage2Strings; UBYTE Reserved2; UBYTE Stage2String1Type; UBYTE Stage2String1Method; UBYTE Stage2String1MethodData; UBYTE Reserved21; UBYTE Stage2String2Type; UBYTE Stage2String2Method; UBYTE Stage2String2MethodData; UBYTE Reserved22; unsigned short Stage3Timer; UBYTE Stage3Strings; UBYTE Reserved3; UBYTE Stage3String1Type; UBYTE Stage3String1Method; UBYTE Stage3String1MethodData; UBYTE Reserved31;
...........................................................................................................................................................................................................................................................

1- 463
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Query 0x0089

UBYTE Stage3String2Type; UBYTE Stage3String2Method; UBYTE Stage3String2MethodData; UBYTE Reserved32; unsigned short Stage4Timer; UBYTE Stage4Strings; UBYTE Reserved4; UBYTE Stage4String1Type; UBYTE Stage4String1Method; UBYTE Stage4String1MethodData; UBYTE Reserved41; UBYTE Stage4String2Type; UBYTE Stage4String2Method; UBYTE Stage4String2MethodData; UBYTE Reserved42; } XL_InpulsingParametersQueryAck;

C++ Class
class XLC_InpulsingParametersQuery : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); };

C++ Class Response

class XLC_InpulsingParametersQueryAck : public XLC_AcknowledgeMessage { public: unsigned short getStatus() const; void setStatus(unsigned short x); unsigned short getStage1Timer() const; void setStage1Timer(unsigned short x); UBYTE getStage1Strings() const; void setStage1Strings(UBYTE x); UBYTE getReserved1() const; void setReserved1(UBYTE x); UBYTE getStage1String1Type() const; void setStage1String1Type(UBYTE x); UBYTE getStage1String1Method() const; void setStage1String1Method(UBYTE x); UBYTE getStage1String1MethodData() const; void setStage1String1MethodData(UBYTE x); UBYTE getReserved11() const; void setReserved11(UBYTE x); UBYTE getStage1String2Type() const; void setStage1String2Type(UBYTE x); UBYTE getStage1String2Method() const; void setStage1String2Method(UBYTE x); UBYTE getStage1String2MethodData() const; void setStage1String2MethodData(UBYTE x); UBYTE getReserved12() const; void setReserved12(UBYTE x); unsigned short getStage2Timer() const; void setStage2Timer(unsigned short x);

1- 464
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Query 0x0089

UBYTE getStage2Strings() const; void setStage2Strings(UBYTE x); UBYTE getReserved2() const; void setReserved2(UBYTE x); UBYTE getStage2String1Type() const; void setStage2String1Type(UBYTE x); UBYTE getStage2String1Method() const; void setStage2String1Method(UBYTE x); UBYTE getStage2String1MethodData() const; void setStage2String1MethodData(UBYTE x); UBYTE getReserved21() const; void setReserved21(UBYTE x); UBYTE getStage2String2Type() const; void setStage2String2Type(UBYTE x); UBYTE getStage2String2Method() const; void setStage2String2Method(UBYTE x); UBYTE getStage2String2MethodData() const; void setStage2String2MethodData(UBYTE x); UBYTE getReserved22() const; void setReserved22(UBYTE x); unsigned short getStage3Timer() const; void setStage3Timer(unsigned short x); UBYTE getStage3Strings() const; void setStage3Strings(UBYTE x); UBYTE getReserved3() const; void setReserved3(UBYTE x); UBYTE getStage3String1Type() const; void setStage3String1Type(UBYTE x); UBYTE getStage3String1Method() const; void setStage3String1Method(UBYTE x); UBYTE getStage3String1MethodData() const; void setStage3String1MethodData(UBYTE x); UBYTE getReserved31() const; void setReserved31(UBYTE x); UBYTE getStage3String2Type() const; void setStage3String2Type(UBYTE x); UBYTE getStage3String2Method() const; void setStage3String2Method(UBYTE x); UBYTE getStage3String2MethodData() const; void setStage3String2MethodData(UBYTE x); UBYTE getReserved32() const; void setReserved32(UBYTE x); unsigned short getStage4Timer() const; void setStage4Timer(unsigned short x); UBYTE getStage4Strings() const; void setStage4Strings(UBYTE x); UBYTE getReserved4() const; void setReserved4(UBYTE x); UBYTE getStage4String1Type() const ; void setStage4String1Type(UBYTE x); UBYTE getStage4String1Method() const; void setStage4String1Method(UBYTE x); UBYTE getStage4String1MethodData() const; void setStage4String1MethodData(UBYTE x); UBYTE getReserved41() const; void setReserved41(UBYTE x); UBYTE getStage4String2Type() const; void setStage4String2Type(UBYTE x); UBYTE getStage4String2Method() const; ........................................................................................................................................................................................................................................................... 1- 465
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Query 0x0089

void setStage4String2Method(UBYTE x); UBYTE getStage4String2MethodData() const; void setStage4String2MethodData(UBYTE x); UBYTE getReserved42() const; void setReserved42(UBYTE x); };

EXS API Hex Format

MESSAGE Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x0004) Message Type (0x0089) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 Frame (0xFE) Length (0x0037) Message Type (0x0089) Reserved (0x00) Same Sequence Number Logical Node ID Status MSB, lSB RESPONSE Field Description

RESPONSE continued below. 10-13 Stage 1 Stage Complete Timer, MSB Stage Complete Timer, LSB Number of Digit Strings Reserved (0x00)

1- 466
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Query 0x0089

14-17

String 1

Address Signaling Type 0x01 DTMF 0x02 MFR1 0x03 MFR2 0x05 Dial Pulse NOTE: These values are identical for each field labeled Address Signaling Type Collection Method 0x01 Fixed Number of Digits 0x02 Use Termination Digit 0x03 Use KP_ST Signals, KP and ST digits not reported to host. 0x05 Compelled 0x06 Use KP digit and any ST digit, KP, and ST digits are reported to host. NOTE: These values are identical for each field labeled Collection Method String Collection Data The value of the String Collection Data field depends on the value of the Collection Method field. Fixed Number of Digits: Digit Count Use Termination Digit: Digit Value Use KP_ST 0x0B (ST digit) Compelled Digit Count NOTE: These values are identical for each field labeled String Collection Data Reserved (0x00)

18-21

String 2

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

22-25

Stage 2

Stage Complete Timer, MSB Stage Complete Timer, LSB Number of Digit Strings Reserved (0x00)

26-29

String 1

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

30-33

String 2

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

34-37

Stage 3

Stage Complete Timer, MSB Stage Complete Timer, LSB Number of Digit Strings Reserved (0x00)

1- 467
Release 8.4.1 ER3, February 2008

Inpulsing Parameters Query 0x0089

38-41

String 1

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

42-45

String 2

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

46-49

Stage 4

Stage Complete Timer, MSB Stage Complete Timer, LSB Number of Digit Strings Reserved (0x00)

50-53

String 1

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

54-57

String 2

Address Signaling Type Collection Method String Collection Data Reserved (0x00)

Checksum

1- 468
Release 8.4.1 ER3, February 2008

Inseize Control 0x002B

SwitchKit Name Type Description InseizeControl EXS API and SwitchKit API message Inseize Control 0x002B Use this message to control incoming call setup during real-time call processing on a specified channel. Instructions and data are passed in this message in the form of Information Control Blocks (ICBs). You can preprogram a list of instructions using the Inseize Instruction List Configure message and initiate them by sending the Inseize Control message with an ICB of Use Instruction List. The system does not replace the default instruction list with the list you specify with the Use Instruction List ICB. The system concatenates the list you specify in this message to the default list. An instruction that is not carried out is reported via a negative acknowledgment. A positive acknowledgment is reported only if you include a Send Host Acknowledgment Action ICB in the message. Related Messages Inseize Instruction List Configure 0x0029 (InseizeInstrListConfig) Call Control Instructions Query 0x0087 (CallControlInstructionQuery)

Sent by SwitchKit Code

Host C Structure
typedef struct { unsigned short Span; UBYTE Channel; UBYTE ICBCount; UBYTE ICBData[222]; } XL_InseizeControl;

C++ Class
class XLC_InseizeControl : public XLC_OneChannelOutbound { public: unsigned short getSpan() const; void setSpan(unsigned short x); UBYTE getChannel() const; void setChannel(UBYTE x); UBYTE getICBCount() const; void setICBCount(UBYTE x); const UBYTE *getICBData() const; UBYTE *getICBData(); void setICBData(UBYTE *x); };
...........................................................................................................................................................................................................................................................

1- 469
Release 8.4.1 ER3, February 2008

Inseize Control 0x002B

EXS API Hex Format

MESSAGE (White) Byte 0 1, 2 3, 4 5 6 7 : Field Description Frame (0xFE) Length (0x00NN) Message Type (0x002B) Reserved (0x00) Sequence Number Logical Node ID AIB Address Method 0x00 - Individual AEs Number of AEs to follow AE 0x0D Channel : : Number of ICBs to follow (Ignore 10 Checksum Byte 0 1, 2 3, 4 5 6 7 8, 9 RESPONSE (Gray) Field Description Fram