Home

Print - Dialogic

1. eese nennen nnn 209 ENS eese esee esee ese esee esee sessi sese esee sees 209 Usingilabpddermo GE 211 EJ 212 lapddemo An LEE 212 lapddemo configuration file 213 Parameters and associated values sssssssssssssssssese mnes 213 Message exchange rules emnes hee hes hesesnesne nena 213 lapddemo structure and coding features oooccccccccccccncnncnnnncnnnncnnnncnnnncnnnnnnnnnrnnnnnnnnnns 215 13 dectrace Stack traffic analysis tool oooonononocnoronnoracnnnacnnnacnnracnnracnnracaneananes 217 dectrace overview sssssssssssssssssssese see seen tnan esee esee tems esee ese sese te see se sese nen 217 Usirg dectrace oss doce oe 218 dectrace cCormpilation esee see esee emen heme tese nemen enn 218 dectrace MNES Ai 219 Creating a log file for dectrace cece een nee nee e nee need 219 Messages decoded by dectrace cece enter e nena enne 221 QO 931 0 932 message ee 221 Information elemaents oie tit eerte e 223 Samiple dectrace oUtput i accepte ere ek ER dees ease need REN REN7R VR E ENER REENEN SEHR ceeds 225 14 itrace Stack traffic analysis tOOl ooococnonocnonacnnracnnnacnnracnnnacnnrannnracanracanracanes 227 ILTACO OVervlew m 227 USing Itrace c voice tote eot ege t lla crol aleta nk ota ea ode eran 227 itrace files nA A eure M LEE 228 itrace examples eet even dus chee even sven xr x re ERR ANEN ERE e xim chive XR Ere ERES E 228 Example EE 228 Example 23 2 EES 228 15 Events reasons and e
2. eese 168 application development 16 AT amp T 4ESS layer 3 timer defaults 250 AT amp T E10 layer 3 timer defaults 245 Australian Telecom 1 layer 3 timer defaults siiicar nerenin n neonka 247 B B channels eoe rin cet ka 31 basic rate interface BRI 9 board mitialtzation 20 C Call dearing eset ee eeeeeee ees 38 call collteion cee ese ene eaeeaeeaeeaeeas 37 charging type values 183 clear code values sssus 180 clear colltsion esses 39 connection Des 34 creating transparent IEs 235 D D channel backup 254 255 D channels cceccecceseeeeeaeeaeeaeeaeeaees 31 data linke i2 cidos 41 42 dectrace nens 204 compilation cece eee eee e eee eee 205 creating a log file 206 decoded messages 207 BUCS Kew 206 sample output eee ee ee eee 212 USING E 205 demonstration programS seeeceeceee 15 dectrace overview ussse 204 isdndemo overview 185 itrace overview essen 214 lapddemo overview 197 277 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual E endpoint ID values 184 error cause va lues eee eee es 182 Eurol SDN layer 3 timer defaults 244 events a RES 23 F facility
3. ACU CONN RS protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro OAI MED el IC P N T T nnma orm MN uzo nN 4am o Se Acu conn rs a connected nb x Acu conn rs connected nb size Filling order 4 Acu conn rs a connected sub x Acu conn rs connected sub size Filling order 5 Acu conn rs a date time X x 138 mzoma Z z 4 DO unz uog NOOrF 4 Message primitives Macro numa orm NM Z uzo vnm OS e DS PrmaneD 442 mzoma Z z d4 DO nnZzuUUu SS Acu conn rs a display Acu conn rs display size Filling order 3 Acu conn rs a display list x x Acu_conn_rs_a_ext_parms Acu_conn_rs_a_facility xX X X X X Acu conn rs facility size Filling order 2 Acu conn rs a layer 1 info Acu conn rs a pcs user x Acu conn rs pcs user size Filling order 6 Acu conn rs a ss cnip name x Acu conn rs ss cnip name size Filling order 7 Acu conn rs a tsp ie list X X IX IX X IX X IX IX X X X X X Acu conn rs tsp ie list size Filling order 8 Acu conn rs a uui x xX X X X x Acu conn rs uui size Filling order 1 Acu conn rs charging Acu conn rs charging available Acu conn rs charging multi Acu conn rs charging period Acu conn rs charging type 139 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn
4. Filling order Some pointer and size macros must be assigned values in sequence so that the IEs in outgoing messages are ordered correctly If macros must be filled out in order the filling order is specified in the protocol variants table of the message primitive For example when creating an ACU ALERT RQ message the application must call the Acu alert rq a uui and Acu alert rq uui size macros before calling the Acu alert rq a display and Acu alert rq display size macros In the protocol variants table the Acu alert rq a uui and Acu alert rq uui size macros are marked Filling order 1 The Acu alert rq a display and Acu alert rq display size macros are marked Filling order 2 The variants under which each macro is supported Note Not all macros or macro combinations are supported for every variant Macros supported under E10 are also supported under AT amp T SEO A short description of the macro The Q 931 information element in which the assigned value appears Note Some macros do not map directly to any information element and several macros are not currently used at all They are included in the reference table for informational purposes only ACU ALERT IN This topic describes e ACU ALERT IN protocol variants e ACU ALERT IN macro descriptions and Q 931 IE Purpose Indicates an alert Conn id An allocated call 69 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU ALERT IN p
5. r RELEASE COMP T TIMER T 2 s t TIMER T 1 s FE AE AE FE FE FE AE FE AE FE FE E FE AE FE FE FE FE AE FE AE FE FE E FE AE FE AE FE FE FE FE AE FE AE E FE FE FE AE FE FE E FE AE FE AE EE EEE EEE Cause Dir Command S i K Send CALL PROCEEDING after receiving a SETUP K o C Send CONNECT after sending CALL PROCEEDING E o T Start timer T after receiving a CONNECT T SL D Send a DISCONNECT when timer T expires D 2 R Send a RELEASE after receiving DISCONNECT R m pa Send a RELEASE COMP after receiving RELEASE lapddemo structure and coding features The main function in lapddemo c accepts and parses the command line options reads the configuration file and establishes the data link At this point the program can either send a SETUP message to the trunk if you type S or wait for messages from the line Note The SETUP message sent by lapddemo contains the following information elements only bearer capability channel ID calling number and called number Some switch variants may require additional information elements If a Q 931 message is received the program decodes information from the message such as the protocol discriminator for example Q 931 CC the call reference value and the message type for example SETUP It responds with an appropriate message specified in the configuration file For example after receiving a SETUP message it sends an ALERTI NG message 215 Dialogic amp NaturalAccess ISDN Mes
6. ACU CONN RS macro descriptions and Q 931 IE Macro Acu conn rs a connected nb Acu conn rs connected nb size Filling order 4 Acu conn rs a connected sub Acu conn rs connected sub size Filling order 5 Acu conn rs a date time Acu conn rs a display Acu conn rs display size Filling order 3 Acu conn rs a display list Acu conn rs a ext parms Acu conn rs a facility Acu conn rs facility size Filling order 2 Acu conn rs a layer 1 info Acu conn rs a pcs user Acu conn rs pcs user size Filling order 6 Acu conn rs a ss cnip name Acu conn rs ss cnip name size Filling order 7 Acu conn rs a tsp ie list Acu conn rs tsp ie list size Filling order 8 142 Description Pointer to and size of buffer containing connected number Pointer to and size of buffer containing connected subaddress Pointer to date time Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to structure containing layer 1 information Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and si
7. ACU message structure A Contains data for message sa1Aq azis ISDN MESSAGE is defined as follows typedef struct ISDN MESSAGE nai_t nai Network access interface index ay ent_id_t from_ent Message source s ent_id_t to_ent Message destination EE Destination Service Access Point a union cc EEG Onna c Connection identifier for the ACU layer sell je cia Call Reference value for the NS layer Not used add t ces Connection Endpoint suffix DL later upper half add t tei Terminal Endpoint ID DL layer lower half Not used Seet ic eet Physical layer channel identifier Not used add code_t code Primitive code unique only between two entities WORD inf0 Information location 0 SS WORD infi Information location 1 Mi WORD inf2 Information location 2 WORD inf3 Information location 3 wf WORD inf4 Information location 4 WORD data_size Size of data to follow WORD nfas group NFAS group number sull DWORD userid User ID ISDN MESSAGE Building ACU message structures The NMS ISDN protocol stack must be in ACU stack mode to send ACU messages To learn how to place the stack in this mode see Initializing ISDN protocol stack instances Before sending an ACU message the application creates a message structure containing the ACU message data When this structure and its substructures reaches the ISDN protocol stack the
8. Acu facility a called address Acu facility a calling nb Acu facility calling nb size Acu facility a calling nb2 Acu facility calling nb2 size Acu facility a display Acu facility display size Acu facility a display list Acu facility a ext parms Acu facility a facility Acu facility facility size Acu facility a pcs user Acu facility pcs user size Acu facility a q931 Acu facility q931 size Acu facility action Acu facility button nb Acu facility button type Acu facility call appear Acu facility code Acu facility ext parms lIgth 156 Description Pointer to buffer containing called address Pointer to and size of buffer containing the calling number Pointer to and size of buffer containing second calling number Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing I SDN facility information optional Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Action See Action code values for a list of valid values Voice button number Voice button type Call appearance Facility code See Facility code values for a list of valid values To
9. Acu restart q931 size Acu restart size Acu restart a q931 V N 6 OAI pPrm uouc N T T ACU RESTART IN macro descriptions and Q 931 IE Macro Description RESTART for the e B channel Acu_restart_ pref e Interface Acu_restart_int_id NAI Acu restart b chan B channel Acu restart q931 size Reserved for future use Acu restart size Size of structure Acu restart a q931 Reserved for future use K T Q D T O A S P 1 R I l N 6 E W G S 0 A A S 7 N X X x x X X x x Q 931 IE Channel identification Channel identification Channel identification N A N A N A 169 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU_SERVICE_CO This topic describes e ACU SERVICE CO protocol variants e ACU SERVICE CO macro descriptions and Q 931 IE Purpose Indicates that a SERVICE ACKNOWLEDGE message has been received Conn id Unused ACU SERVICE CO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E N D E V H A N K T Q D T E 1 Il M T N K U T O A S P 1 S 0 2 S S 6 G S T R I l N 6 S l T E W G S O E A A S 7 L N 1 Acu_service_pref x interface Acu service pref X X X x x B channel Acu service int id x X x x Acu service b chan x X X X Acu service status x X x x Acu service action type x X x x Acu service q931 size Acu service
10. The following sample code illustrates how the application processes an incoming ISDN event from the on board protocol stack through the Natural Access event mechanism cta ret ctaWaitEvent ctaqueuehd amp cta event CTA WAIT FOREVER if cta ret SUCCESS printf isdnproc ctaWaitEvent failure d x n EcL TEL EL me continue We have an event switch on the type switch cta event id case ISDNEVN_RCV_MESSAGE LES Pick up the ISDN PACKET structure isdnpkt isdnmsg ISDN PACKET adi event buffer ISDN MESSAGE amp isdnpkt message SE Extract information from the ISDN incoming packet message isdnmsg code sender isdnmsg from ent recipient isdnmsg to ent CRN isdnmsg add conn id ey SCH Br The fields in the received ISDN MESSAGE structure contain the following information ISDN MESSAGE Value in ACU stack mode field nai Specifies the network access identifier NAI of the trunk that the message concerns from ent ENT CC Indicates that the message was sent from call control layer ACU to ent ENT APPLI Indicates that the message was sent to an application to sapi ACU SAPI conn id Contains the connection ID of the call that the message concerns code Specifies the primitive of the message for example ACU CONN IN infO infl inf2 Reserved for internal data relay inf3 inf4 Value in LAPD stack mode Specifies the network access identifier N
11. a nai g grp c clrf where Option Meaning Default a nai Decodes only the messages on the All NAIs specified NAI b brdno Decodes only the messages from or to All boards board brdno c cirf Decodes only the messages with call All call references reference clrf d tmask Provides a decoding mask for Q 931 TIME STAMP MESSAGE decoding See tmask values CALL REF IE IE CONT ISDN MSG f srcfile Specifies the file to be decoded agerror log g grp Decodes only the messages for the All NFAS groups specified NFAS group The following table lists the valid tmask values Mask Mnemonic Description 8000 BUFFER Prints the whole hexadecimal buffer 2000 PROTOCOL DISC Decodes the protocol discriminator 217 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Mask 1000 0800 0400 0200 0100 0080 0008 0004 0002 Mnemonic CALL REF MESSAGE INFO ELEM INFO ELEM CONT DATA LINK TIME STAMP ISDN_MSG ACU_MSG TRACE_PH Using dectrace Perform the following steps to run dectrace Step Action 1 Run dectrace Description Decodes the call reference Decodes the message type Decodes the information element ID Decodes the data contents of the IE Decodes the commands or events at the DL interface Includes a time stamp before the messages Decodes the ISDN messages Decodes the ACU messages Decodes PH primitives Run agtrace or itr
12. 0 imsg nfas group 0 When using ACU all messages should be directed to ENT ACU and the ACU SAPI within it The from ent field should always be ENT APPLI nf imsg from ent ENT APPLI imsg to ent ENT CC imsg to sapi ACU SAPI The connection ID is the logical connection number 54 Function reference For ACU the lowest unused connection ID value must be used E imsg add conn id myGetLowestConnectionId Build the contents of the message for place call release call etc This should fill the idata with the message contents and return the used part of the data buffer in the datasize argument and the code for the requested function ACU CONN RQ ACU CLEAR RQ etc e myBuildMessage mycode idata amp datasize amp code imsg datasize datasize imsg code code Add an ISDN specific user ID to identify this message if it fails uA imsg userid myGetNextMessageId ret isdnSendMessage ctahd amp imsg idata datasize IE set SUCCESS ctaGetText ctahd ret errortext 40 printf SEND FAIL s mg id x n errortext imsg userid return MY ERROR SEND FAILED myWaitForEvent ctahd amp event if event value SUCCESS ctaGetText ctahd event value errortext 40 printf SEND FAIL s mg id x n errortext imsg userid return MY ERROR SEND FAILED isdnSetMsgCapture Sends tracing messages to the oammon monitor scr
13. Charging multiplier Charging period Charging type See Charging type values for a list of valid values Charging value number of units Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Network provided clear cause value See Network provided clearing cause values for a list of valid values Network provided clear cause location Q 931 IE Not used Facility PCS User Does not map to an IE User user Does not map to an IE Not used Not used National facility National facility Not used Not used Cause Cause 91 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Q 931 IE Acu_clear_co_pcs_user_protocol Protocol discriminator for the pcs_user PCS user information element See PCS user information elements for more information on this IE Acu_clear_co_ret_code Return code See Clear code values for a Does not list of valid values map to an IE Acu clear co total cost Complete charging information sent by the Not used network optional Acu clear co uui protocol UUI protocol discriminator value See UUI User protocol discriminator values for a list of User valid values Acu clear co x display nb Number of present occurrences Display Acu clear co x display size i Size of occurrence i optional Display Acu clear co x display total size Total size of the stor
14. Macro orm MN ISO CC IO el Dm az lt ost aal rz mazon ZDS DA numa Hrm Hoc Acu conn co call ref length x If the network side initiates the call it does not receive the call reference value with this primitive Acu conn co call ref value x If the network side initiates the call it does not receive the call reference value with this primitive Acu conn co charging Acu conn co charging available Acu conn co charging multi Acu conn co charging period Acu conn co charging type Acu conn co charging value Acu conn co connected nb pres x Acu conn co connected nb screen x Acu conn co connected nb type x Acu conn co connected sub odd even x Acu conn co connected sub type x Acu conn co data chani X X X IX X IX X x x Acu conn co data chant excl Acu conn co data chani nai Acu conn co data chani nb 106 Quo nnZzUvUU d OO cd Macro Acu conn co data chani tab i Acu conn co data chani tab nai i Acu conn co date available Acu conn co day Acu conn co ext parms lgth Acu conn co ext parms nb Acu conn co hour Acu conn co minute Acu conn co month Acu conn co pcs user protocol Acu conn co redir nb pres Acu conn co redir nb reason Acu conn co redir nb screen Acu conn co redir nb type Acu conn co second Acu conn co service Acu conn co signal val Acu conn co ss cnip name active Acu conn co ss cnip name pres Acu conn co uui protocol nnma E ND E V 1 MTN 02 S S 6 l x x
15. REASON CALL PICKUP Call pickup REASON CALL FORWARDING UNCONDITIONAL Call forwarding unconditional Location values The following table lists the valid location values for ACU ALERT IN ACU ALERT RO ACU CALL PROC IN ACU CALL PROC RQ ACU CLEAR IN ACU CONN IN ACU CONN RQ ACU PROGRESS IN ACU PROGRESS RQ and ACU SETUP REPORT IN messages These values are defined in isdnval h Location Description LOC USER Default if partner equip argument User passed to isdnStartProtocol is EQUIPMENT NT LOC PR LOCAL USER Private network serving the local user LOC NETWORK Default if partner equip Location network SWD argument passed to isdnStartProtocol is EQUIPMENT TE LOC TRANSIT NET Transit network LOC PU REMOTE USER Public network serving the remote user LOC PR REMOTE USER Private network serving the remote user BEYOND IWP Default for DMS variant Network beyond interworking point UUI protocol discriminator values The following table lists the valid UUI protocol discriminator values for ACU ALERT RO ACU CLEAR CO ACU CLEAR RQ ACU CLEAR RS ACU CONN CO ACU CONN IN 186 Data types and constants in primitives ACU CONN RQ ACU CONN RS ACU SETUP REPORT IN ACU USER INFO IN and ACU USER INFO RQ messages These values are defined in isdnval h UUI protocol discriminator Description UUI USER SPF default for HKG User specific coding variant UUI_OSI OSI UUI X244 Rec X 244 UUI SYSTEM MANAG
16. Service client side object handle ES CTA EVENT The CTA EVENT structure informs the application which event occurred on which context and provides additional information specific to the event The event s prefix relates the event to a specific NMS library of functions The following table shows some of the available prefixes This I ndicates prefix CTAEVN A Natural Access event NCCEVN An NCC service event ADIEVN An ADI service event ISDNEVN An NMS ISDN event OAMEVN An OAM service event HSWEVN An OAM Hot Swap event CLKEVN An OAM clock management event The CTA EVENT structure fields are used as follows Field Description id Contains an event code defined in the library header file All NMS ISDN events are prefixed with ISDNEVN for example ISDNEVN SOMETHING HAPPENED ctahd Contains the context handle returned from ctaCreateContext timestamp Contains the time when the event was created in milliseconds since midnight January 1 1970 modulo 49 days The resolution for board events is 10 milliseconds 23 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Field Description userid Contains the user supplied ID This field is unaltered by Natural Access and facilitates asynchronous programming Its purpose is to correlate a context with an application object and context when events occur size Indicates the size bytes of the area pointed to by buffer If the buffer is NULL this field
17. Total size of the stored strings Display Acu alert in x display type i Type of display i Display Acu alert in x p display i Pointer to occurrence i Display ACU ALERT RQ This topic describes e ACU ALERT BO protocol variants e ACU ALERT RO macro descriptions and Q 931 IE Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to 0 Purpose Sends an alert message Conn id An allocated call 75 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU ALERT RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro MS 442 E D 1 M 0 S vnm EK OAI D WO 4 E S S E Del E P Pm 32 Oe Z z d4 UO OC Kal sl 3 ON Li cl Acu alert rq a display Acu alert rq display size Filling order 2 Acu alert rq a display list X x Acu alert rq a ext parms Acu alert rq a pcs user x Acu_alert_rq_pcs_user_size Filling order 3 Acu alert rq a ss cnip name x Acu alert rq ss cnip name size Filling order 4 Acu alert rq a tsp ie list X X X X X X X X X X X X X x Acu alert rq tsp ie list size Filling order 5 Acu alert rq a uui X x X x x Acu_alert_rq_uui_size Filling order 1 Acu_alert_rq_data_chani X X X X X X X X X X x x X Acu_alert_rq_data_chani_excl X X X X X X X X
18. and call parameters are unique for each D channel and must be configured separately To invoke two separate instances of the demonstration program to call each other invoke one instance for each trunk Set up one to place calls and the other to receive calls Make sure to include the n lowercase option to configure one instance as the NT side For example isdndemo b 0 n p 20 isemeclsas 9 L a 20 9 10 isdndemo compilation isdndemo is supplied in executable form as well as source code To recompile isdndemo enter one of the following commands Operating system Directory Command Windows nms ctaccess demos isdndemo nmake UNIX opt nms ctaccess demos isdndemo make For more information see the readme file that came with the NMS ISDN software package isdndemo files isdndemo consists of the following files File Description isdndemo cpp Program initialization and some utility functions isdndemo h Header file for the isdndemo program 201 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual File Description BChannel cpp Implementation of appropriate classes Call cpp Context cpp DChannel cpp NAI cpp Timer cpp Using NFAS with isdndemo You can use isdndemo to demonstrate placing and receiving calls on trunks in non facility associated signaling NFAS mode To do this use the following option to specify the NFAS group number g group number Use this option in place of the a opt
19. o outlines O channel p protocol 198 Meaning Specifies the NFAS group number Use this option instead of the a option to run in NFAS configuration mode Specifies the time in milliseconds to wait after releasing an outbound call before placing the next one Displays log statistics Statistics are logged to either e isdndemo bBaA log where B is the board number and A is the NAI number or e isdndemo_bBgG log where B is the board number and G is the NFAS group number The log file used depends on whether the trunk is part of an NFAS group If the trunk is part of an NFAS group isdndemo_bBgG log is used If the trunk is not part of an NFAS group isdndemo bBaA log is used Specifies statistics logging time in seconds Runs ISDN protocol stack as NT not as TE Specifies the number of lines on which to place outbound calls Specifies the first B channel on which outbound calls are placed For example if O is set to 10 and o is set to 5 outbound calls are placed on channels 10 through 14 Specifies the protocol variant to run See Protocol option allowed values for a list of valid values Receives a buffer with a message containing raw Q 931 version of the message Runs the demonstration program in localhost Demonstrates the transparent IE sending feature Builds a codeset 7 IE user specific IE and attaches it to the next ACU CLEAR CO Connect message Defaults Non NFAS configurat
20. 45 ISDN MESSAGE SEFUCEUFG 2 nee iret enn aa iet tote ete Me eto t ota e ba aA ne toe ba vetet dta 45 ISDN PACKET SLtr CEUFe s euet rore et tex Ra eh a ER A NEEN 46 ISDN PROTOCOL PARMS LAPD structure ssssssssssss menm enne 46 ISDN PROTOCOL PARMS Q931CC structure 47 ISDN PROTOCOL PARMS CHANNELIZED structure sss 48 8 Function reterence ENEE KENE E ENEE ENEE ENEE ER EEN ER REENEN ENEE ENER EN ENEE ENEE E NEEN 49 Function summary ire extent hx xem eee abe iE Vee a neck a axe ee RR 49 Using the function reterence ran aa mese esee esee esee 49 Isdnbeleasebutter 2 cee T AET 50 isdnSendMessage ike cede xm eves ERE avn ERe Sad ave ERR re ERR ant ee 52 ISAnSetMsgCaptUrS cita EET 55 El EE 57 isdnStopProtocol eR eek Ee Pee cece ENNEN de inve kr eee ER 64 9 Message primitives ENEE ER REENEN ENEE E REENEN ENER EN ENEE ENER E ENEE ENEE ENER E ERR EEN 66 Overview of message primitives ssssssssssssssss memes 66 ROGER Tell e 66 AGU primitives surmmoary oscar eter ibi 67 Using the ACU message reference menses esee enne 68 ACULATER TS INA diario rar PER PORE EU A A eee a 69 ACU ALERT IN protocol variants memes mene 70 ACU ALERT IN macro descriptions and OO31IE nn na nan 72 ACU ALERT RQ nice Ier RR a 75 ACU ALERT BO protocol variants eeen ierann Hee mene 76 ACU ALERT BO macro descriptions and OO31lIE rra ranas 77 ACU CALLID Nie ERR Er Re RE IRR ai 80 ACU CALLID IN protocol varian
21. ACU CLEAR IN ACU CLEAR RQ ACU CLEAR RS ACU CONN CO ACU CONN IN ACU CONN RQ ACU CONN RS ACU D CHANNEL STATUS IN ACU D CHANNEL STATUS RQ ACU DIGIT IN Description Indicates an alert Sends an alert message Delivers a callid or reports a failure to an application Indicates incoming call proceeding information receipt of SETUP ACK CALL PROCEEDI NG messages Requests events indicating the progress of a call Confirms that the call has been released Indicates the release of a call Requests release of a call Indicates a response to a release indication Indicates a call connection confirmation Signals an incoming call Requests establishment of an outgoing call Answers an incoming call Indicates status of D channel Requests status of the D channel Receives called number digits in overlap receiving mode 67 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Message type ACU_DIGIT_RQ ACU_ERR_IN ACU FACILITY IN ACU FACILITY RQ ACU NOTIFY IN ACU NOTIFY RQ ACU PROGRESS IN ACU PROGRESS RQ ACU RESTART IN ACU SERVICE CO ACU SERVICE IN ACU SERVICE RQ ACU SETUP ACK IN ACU SETUP REPORT IN ACU TRANSFER CO ACU TRANSFER RQ Description Requests called number digits in overlap receiving mode Indicates an error Indicates a specific facility Requests a specific facility Indicates that a NOTIFY message was received Requests that a NOTIFY message be sen
22. ACU CONN RQ This topic describes e ACU_CONN_RQ protocol variants e ACU CONN RQ macro descriptions and Q 931 IE Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to O Purpose Requests establishment of an outgoing call Conn id A currently unused ID ACU CONN RO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides 125 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rq a called nb Acu conn rq called nb size Filling order 1 Acu conn rq a called nb sub Acu conn rq a called nb sub size Filling order 9 Acu conn rq a calling nb Acu conn rq calling nb size Filling order 2 Acu conn rq a calling nb2 Acu conn rq calling nb2 size Filling order 3 Acu conn rq a calling nb sub Acu conn rq a calling nb sub size Filling order 10 Acu conn rq a calling name Acu conn rq calling name size Acu conn rq a display Acu conn rq display size Filling order 7 Acu conn rq a display list Acu conn rq a ext parms Acu conn rq a facility Acu conn rq facility size Filling order 6 Acu conn rq a layer 1 info 126 numa orm BET vnm oz lt QAI Prm uc 2 pDMIOA zZ z d4 x Lafe As um ZS 00 N O Oo bi cd Message primitives Macro 4 E ND EVHANKT QD T E 11 MT NKUTOA
23. ACU FACILITY RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table TE indicates the TE side only and x indicates both NT and TE sides 157 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro numa orm Nr Z Acu facility a called address Acu facility a calling nb Acu facility calling nb size Filling order 2 Acu facility a calling nb2 Acu facility calling nb2 size Filling order 3 Acu facility a display Acu facility display size Filling order 4 Acu facility a ext parms Acu facility a facility Acu facility facility size Filling order 1 Acu facility a pcs user Acu facility pcs user size Filling order 5 Acu facility a tsp ie list TE Acu facility tsp ie list size Filling order 6 Acu facility button nb Acu facility button type Acu facility call appear Acu facility code TE Acu facility conn id Acu facility ext parms Igth 158 ISO Nm az lt DS Prm uc 442 gt mMAIOR GUTE ano nnZzuvUu zl OO Oo bi cd Message primitives Macro 4 E N D E V H A NK T QD T E 1 MT N K U T O A S P 1 S O 2 S S 6 G S T R I N 6 S l T E WG S 0 E A A S 7 L N 1 Acu_facility_ext_parms_nb Acu_facility_module_nb Acu_facility_pcs_user_protocol x Acu facility service Acu facility switchhook Acu facility x display nb Acu facility x display size i Acu facility x display total size Acu
24. Acu call proc rq ext parms nb Acu call proc rq progress description Acu call proc rq progress ind nb Acu call proc rq progress location Acu call proc rq x display nb Acu call proc rq x display size i Acu call proc rq x display total size Acu call proc rq x display type i Acu call proc rq x p display i 88 Description Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use 0 Channel ID i NAI i Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Description for information element 0 See Progress description values for a list of valid values Number of progress indication information elements Location of information element O See Location values for a list of valid values and default setting information Number of present occurrences Size of occurrence i optional Total size of the stored strings Type of display i Pointer to occurrence i Q 931 IE Channel identification Channel identification Channel identification Channel identification Channel identification Not used Not used Progress indicator Progress indicator Progress indicator Display Display Display Display Display ACU CLEAR CO This topic describes e ACU CLEAR CO protocol variants e ACU CLEAR CO macro descriptions and Q 931 IE Pur
25. CAU NUM CHANGED CAU NON SEL CAU DEST OOF CAU INV 188 Description Unallocated number No route to transit network No route to destination Channel unacceptable Call awarded and delivered in an established channel Normal call clearing User busy No user responding No answer from user Call rejected Number changed Non selected user clearing Destination out of order Invalid number format Network provided clearing cause CAU FAC RE CAU RES TO SE CAU NORMAL UNSPEC CAU NO CIRC CHAN CAU NET OOF CAU TEMP FAIL CAU CONG CAU ACC INF DISC CAU NOT AVAIL CAU RES UNAVAIL CAU QOF UNAVAIL CAU FAC NOT SUB CAU BC NOT AUT CAU BC NOT AVAIL CAU SERV NOTAVAIL CAU BC NOT IMP CAU CHT NOT IMP CAU FAC NOT IMP CAU RESTR BC CAU SERV NOT IMP CAU INV CRV CAU CH NOT EX CAU CALL ID NOT EX Data types and constants in primitives Description Facility rejected Response to STATUS ENQUI RY Normal unspecified No circuit or channel available Network out of order Temporary failure Switching equipment congestion Access information discarded Requested circuit or channel not available Resource unavailable Quality of service unavailable Requested facility not subscribed Bearer capability not authorized Bearer capability not presently available Service or option not available Bearer capability not implemented Channel type not implemented Requested facility not implemented Only re
26. CTAERR INVALID STATE An ISDN protocol stack instance is not started on the specified context or an instance is starting or stopping on the context ISDNERR INVALID BUFFER The buffer submitted is not valid Events None Details This function informs the stack that the application has finished processing an event buffer described by the CTA EVENT buffer and size fields and is returning the buffer to the NMS ISDN API The event ID for ISDN events is ISDNEVN RCV MESSAGE The application must return every event buffer to the NMS ISDN API as soon as possible or the API times out and stops passing events to the application Example DWORD sample process events CTAHD ctahd CTA_EVENT event ISDN MESSAGE imsg TSDNEPACKHE Ape BYTE datar DWORD et char errortext 40 define EVENT_CODE from code from lt lt 8 code pe Protocol already Started Application may have sent messages to stack EA pa Application waiting for events SS myWaitForEvent ctahd amp event Got event ISDN RCV MESSAGE If the event value field is not SUCCESS then the event was not received successfully E if event value SUCCESS ctaGetText ctahd event value errortext 40 printf RCV FAIL s n errortext return MY ERROR RCV FAILED NOTE all asynchronous events have the msg userid field is ISDN USERID ASYNC ES ipkt ISDN PACKET event gt buffer imsg
27. MODEM SERVICE Modem data service 182 Service AUDIO 7 SERVICE X25 SERVICE X25 PACKET SERVICE VOICE SERVICE VOICE GCI SERVICE RAW TELEPHONY SERVICE VOICE TRANS SERVICE V110 SERVICE V120 SERVICE VIDEO SERVICE TDD SERVICE DATA HO SERVICE DATA H11 SERVICE DATA H12 SERVICE DATA MULTIRATE SERVICE DATA 128KBS SERVICE NO B CHAN SERVICE FAX RELAY SERVICE DATA RELAY SERVICE DATA 56KBS RELAY SERVICE Data types and constants in primitives Description 7 kHz audio service X 25 circuit mode service X 25 packet mode service Voice service Voice service on GCI bus Raw telephony service on GCI bus no MPH_B_INIT_RQ generated no B channel driver is associated Transparent voice service V 110 service V 120 service Video service TDD service Data using HO 384 kbits s channel service PRI only Data using H11 1536 kbits s channel service Data using H12 1536 kbits s channel service Data using multirate 2 30x64 kbits s channel service Data using 2x64 kbits s channel service BRI only No B channel service bearer independent calls QSIG only G3 facsimile service for use with physical relay process Data service for use with physical relay process Data at 56 kbit s service for use with physical relay process 183 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Service DATA TRANS RELAY SERVICE MODEM RELAY SERVICE X25 R
28. Power transfer B and D channel MUX I SDN carriers ISDN is transmitted over standard T1 and El carriers T1 and El trunks are typically four wire digital transmission links T1 trunks are used mainly in the United States Canada Hong Kong and Japan El trunks are used in most of the rest of the world Data on a trunk is transmitted in channels Each channel carries information digitized at 64000 bits per second b s Primary rate interface PRI For primary rate ISDN T1 trunks carry 24 channels E1 trunks carry 32 channels The channels are usually used as follows e Ona Tl trunk 23 of the 24 channels carry data voice audio data and or video signals These channels are called bearer channels B channels e Onan El trunk 30 of the 32 channels are B channels e OnaTlorEl trunk one channel carries signaling information for all B channels This is called the D channel The following illustration shows a T1 trunk standard configuration B channels D channel for these channe B channels D channel for these channels Ti AG 4040 T board B channels D channel for these channe trunks BC anneis D channel for these channe In setups with multiple T1 ISDN trunks a non facility associated signaling NFAS configuration is sometimes used In this configuration the D channel on one of the ISDN trunks carries signaling for all channels on several other trunks This leaves channel 24 free on each of the other trunks to be
29. Step Action 1 Run agtrace with mask 801000 to enable the ISDN protocol stack messages to be passed to oammon 2 Run itrace to enable or disable messages to and from entities in the entity list string Note itrace can be run at any time of execution Message logging is changed dynamically 227 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual itrace file itrace is supplied in executable format and is located in one of the following directories Operating system Directory Windows nms bin itrace exe UNIX opt nms bin itrace itrace examples Example 1 Enable messages between ENT_APPLI and ENT_CC on board 0 nai 1 agtrace 801000 0 Start tracing itrace off 0 1 Disaple all USM stack traffic on board 0 nai dis itrace on 0 1 AC Enable logging messages between A and C entities on board 0 nai 1 A ENT APPLI application entity and Wu jur e AE UA Cono gene Steen Example 2 Enable messages and buffers between ENT DL D and ENT PH D on board O nai 1 NFAS group 0 agtrace 801000 0 Stare tracing iras ort 0 15 O Dasable alls SID stack ati cm onboard nai 1 NFAS group 0 itrace on 0 1 Dd 0 Enable logging messages between D and d entities on board 0 nai 1 NFAS group 0 228 15 Events reasons and errors NMS ISDN events The following events are specific to NMS ISDN Examine the reason code or error code stored in the value field of the event for more information about the
30. The following code shows how to modify the NSF IE using the defined macro unsigned char p ext data char nsf if nsf p_ext_data Acu_conn_rgq_a_ext_parms Acu_conn_rq_ext_parms_nb Acu conn rq ext parms lgth Acu ext spf fac ie size Acu ext id ACU EXT SPF FAC IE Acu ext lgth Acu ext spf fac ie size Acu ext spf fac ie net id lgth strlen 288 Acu ext spf fac ie net id type ACU NATIONAL NETWORK ID TYPE memcpy Acu ext spf fac ie net id 288 strlen 288 Acu ext spf fac ie action ACU SPF FAC BINARY Acu ext spf fac ie param fld OxFF Acu ext spf fac ie serv feature ACU FAC FEATURE Acu ext spf fac ie facility coding ACU FAC BN ANI PREFERRED 272 22 Encoding and decoding the Precedence Level I E Precedence Level I E structure The precedence level information element Precedence Level IE selects a precedence level and reservation in the Digital Subscriber Signaling System No 1 DSS1 This IE is supported only for the ANSI T1 607 ISDN variant The application can encode the Precedence Level IE when placing calls or decode the Precedence Level IE when receiving calls This enables the application to use the algorithm described in ANSI T1 619 to preempt the calls The following structure defines the Precedence Level IE struct acu ext precedence level struct u4_acu ext_hdr hdr Extension header pad4 uchar level precedence level 0 4
31. This primitive must be sent to the ACU SAPI MGT SAPI rather than the ACU SAPI To do so specify ACU SAPI MGT in the to sapi field in the outgoing ACU MESSAGE structure Purpose Inquires the status of the D channel Conn id Any connection ID ACU D CHANNEL STATUS RO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides E N D E 1 M T O 2 S IS l Macro Vv H N N K T 6 G T numa Prmauncecp Ppmzoma SZ PSP D WO uuouz uug NOOF 4 X x lt x lt x lt x lt x lt x lt Acu_d_channel_state x x x x x x x Acu_d_channel_nb x 148 Message primitives ACU D CHANNEL STATUS RQ macro descriptions and Q 931 IE Macro Description Q 931 IE Acu_d_channel_state State of D channel Does not map to an IE 0 OFF 1 ON Acu d channel nb Equivalent to B channel Does not map to an IE number for DPNSS only ACU DIGIT IN This topic describes e ACU DIGIT IN protocol variants e ACU DIGIT IN macro descriptions and Q 931 IE Purpose Receives called number digits in overlap receiving mode Conn id An allocated call ACU DIGIT IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table NT NT side only TE TE side only and x both NT and TE sides Macro 4 E N DE V H AN KT Q E 1 MT NK UT OA S S O 2 I S S 6 G ST RI I S l
32. User specified parms CTA_EVENT event DWORD GIES char errortext 40 unsigned nai unsigned j ISDN PROTOCOL PARMS Q931CC parms memset parms 0 sizeof parms parms size sizeof ISDN PROTOCOL PARMS Q931CC nai 0 J 05 parms nfas group 0 parms services_list j ACU FAX SERVICE ACU VOICE SERIVCE ACU lot SES EE parms services list parms services list NOTE The last service MUST contain ACU NO SERVICE SH i j j j ret isdnStartProtocol ctahd ISDN PROTOCOL Q931CC ISDN OPERATOR NI2 COUNTRY USA ISDN PARTNER NT nai amp parms 63 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual if ret SUCCESS ctaGetText ctahd ret errortext 40 printf START FAIL s n errortext return MY ERROR START FAILED myWaitForEvent ctahd amp event if event value SUCCESS ctaGetText ctahd event value errortext 40 printf START FATL sXn errortext return MY ERROR START FAILED return SUCCESS isdnStopProtocol Shuts down a previously started ISDN protocol stack instance and releases all on board resources and buffers used by the protocol stack instance Prototype DWORD isdnStopProtocol CTAHD ctahd Argument Description ctahd Context handle associated with a D channel returned by ctaCreateContext Return values Return value Description SUCCESS CTAERR_INVALID_CTAHD The context handle is invalid CTAERR_INV
33. and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of transparent IE buffer Voice button number Voice button type Call appearance Facility code See Facility code values for a list of valid values Connection ID Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Voice module number Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Requested service See Service values for a list of valid values Voice switchhook Q 931 IE Not used Facility PCS user Does not map to an IE Not used Not used Not used Facility Not used Not used Not used Not used PCS user Not used Not used Macro Description Acu facility x display nb Number of present occurrences Acu facility x display size i Size of occurrence i optional Acu facility x display total size Total size of the stored strings Acu facility x display type 1 Type of display i Acu facility x p display Pointer to occurrence i ACU NOTIFY IN This topic describes e ACU NOTIFY IN protocol variants e AC NOTIFY IN macro descriptions and Q 931 IE Purpose Indicates that a NOTIFY message was received Conn id An allocated call ACU NOTIFY I
34. e The LAPD service access point SAP for layer 2 protocols providing direct access to the D channel e The ACU SAP for access to a simplified abstraction of the Q 931 ISDN D channel layer 3 message protocols e An ISDN primary and basic rate trunk interface which is channelized and integrated with the NaturalCallControl API This manual describes how to build applications that interface with the ISDN protocol stack at layers 2 and 3 For information on building applications that are integrated at higher layers see the Dialogic NaturalAccess ISDN Software Developer s Manual This document is for developers of ISDN applications in C who are programming at the messaging level The developer should be experienced with ITU Q 931 ISDN call control messages and call states The developer should also be familiar with Natural Access basic telephony concepts and the C programming language Terminology Note The product to which this document pertains is part of the NMS Communications Platforms business that was sold by NMS Communications Corporation NMS to Dialogic Corporation Dialogic on December 8 2008 Accordingly certain terminology relating to the product has been changed Below is a table indicating both terminology that was formerly associated with the product as well as the new terminology by which the product is now known This document is being published during a transition period therefore it may be that some of t
35. 5ESS Incoming calls barred DMS 4ESS 5ESS Network provided clearing cause CAU DEST ADD MISSING CAU RESTART CAU TIMER 300 CAU TIMER 302 CAU TIMER 303 CAU TIMER 304 CAU TIMER 308 CAU TIMER 309 CAU TIMER 310 CAU TIMER 316 CAU TIMER 317 CAU TIMER 318 CAU TIMER 319 CAU TIMER 399 Clear code values Data types and constants in primitives Description Destination address missing and direct call not subscribed DMS Call clearing due to restart procedure Call clearing due to internal timer 300 expiration Call clearing due to internal timer 302 expiration Call clearing due to internal timer 303 expiration Call clearing due to internal timer 304 expiration Call clearing due to internal timer 308 expiration Call clearing due to internal timer 309 expiration Call clearing due to internal timer 310 expiration Call clearing due to internal timer 316 expiration Call clearing due to internal timer 317 expiration Call clearing due to internal timer 318 expiration Call clearing due to internal timer 319 expiration Call clearing due to internal timer 399 expiration The following table lists the valid clear code values for ACU CLEAR CO and ACU CLEAR IN messages These values are defined in isdnacu h Clear code ACURC BUSY ACURC NOPROCEED ACURC NOANSWER ACURC NOAUTOANSWER Description Busy No proceed indication dial tone No answer No auto answer tone detected 191 Dialo
36. Acu conn in dest call appear 115 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn in ext parms lgth Acu conn in ext parms nb Acu conn in interworking Acu conn in parity Acu conn in pcs user protocol Acu conn in ph rate Acu conn in progress descr x i Acu conn in progress description Acu conn in progress ind nb Acu conn in progress loc x i Acu conn in progress location Acu conn in redir nb plan Acu conn in redir nb pres Acu conn in redir nb reason Acu conn in redir nb screen Acu conn in redir nb type Acu conn in semi permanent circuit Acu conn in sending complete Acu conn in service Acu conn in service list id 116 numa orm N Z eg CC IO el Dm oz c DS Prm uc SE mzom z z 7 d4 Lafe Es um 00 N O Oo bi cd Message primitives Macro 4 E NDEV HA NK TI QDT E 11 MT NKUTOA SP 1 S 02 S S6 GS TRI I N 6 S l T E W GSO E A A S 7 L N 1 Acu conn in ss cnip name active X Acu conn in ss cnip name pres x Acu conn in stop bits Acu conn in syn asyn Acu conn in user rate Acu conn in uui protocol Acu conn in x display nb X X X X X IX x x X Acu conn in x display size i X X XX X x x Acu conn in x display total size X X X X X X X Acu conn in x display type i X X X X X x x Acu conn in x p display i X X x x x x X ACU CONN IN macro descriptions and Q 931 IE Macro Description Q 931 IE Acu_conn_in_a_called_nb Pointer to the
37. Acu conn in orig called nb size Acu conn in orig called nb type Acu conn in orig line info Acu conn in a pcs user Acu conn in pcs user size Acu conn in a ph num Acu conn in a q931 Acu conn in q931 size Acu conn in a redir nb Acu conn in redir nb size Acu conn in a ss cnip name Acu conn in ss cnip name size Acu conn in a uui Acu conn in uui size Acu conn in call ref length Acu conn in call ref value Acu conn in called nb plan 114 numa orm N Z BET vnm oz lt OAI Prm uc SE mzom z z 7 d4 Lafe Es um 00 N O Oo bi cd Message primitives Macro 4 END EVHA NKT QD T E 1 MT NK UT OA SP 1 S 02S S6 GS T RI I N 6 S l T E W GSO E A A S 7 L N 1 Acu conn in called nb sub odd even x Acu conn in called nb sub type x Acu conn in called nb type X X X X X X x X x x Acu_conn_in_calling_nb2_pres x Acu conn in calling nb2 screen x Acu conn in calling nb2 type Acu conn in calling nb plan X X X x X Acu_conn_in_calling_nb_pres X X X X X IX X X X X xX x X Acu conn in calling nb screen X X X X IX X X X X X X x X Acu conn in calling nb sub odd even x Acu conn in calling nb sub type X X X Acu conn in calling nb type X X X X X X X X x X x x Acu_conn_in_chani_nai Acu_conn_in_data_bits Acu_conn_in_data_chani X X X X X IX X X X X X X X x Acu_conn_in_data_chani_ excl Acu_conn_in_data_chani_nb Acu_conn_in_data_chani_tab Acu conn in data chani tab nai
38. Acu digit rq display size Filling order 2 zl E OD ki 4 151 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E N DE VH AN KT Q D E 1 MT N K UT OA S P S O 2 S S 6 G S T RI N S l U E WG S E A A S L N 1 Acu digit rq a tsp ie list X x X X X X Acu digit rq tsp ie list size Filling order 3 Acu digit rq type X X X x TE Acu digit rq digit plan X x X X TE Acu digit rq sending complete X X X X X X X x Acu_digit_rq_x_display_nb Acu digit rq x display size i Acu digit rq x display total size Acu digit rq x display type i Acu digit rq x p display i ACU DIGIT RQ macro descriptions and Q 931 IE Macro Description Q 931 IE Acu digit rq a digit Address and size of digit string Called party Acu digit rq digit size number Filling order 1 Acu digit rq a display Pointer to and size of buffer Display Acu digit rq display size containing ISDN display Filling order 2 information optional Acu digit rq a tsp ie list Pointer to and size of Does not map to Acu digit rq tsp ie list size transparent IE buffer an IE Filling order 3 Acu digit rq type Called number type Called party number 152 zl OO Oo Hi cd Macro Description Acu digit rq digit plan Called number plan Acu digit rq sending complete Requests that sending complete information element be sent Acu digit rq x display nb Number of present occurrences Acu digit rq x display size i Size of occurrence i o
39. Acu progress in ext parms nb Acu progress in pcs user protocol Acu progress in progress descr x i Acu progress in progress description Acu progress in progress ind nb Acu progress in progress loc x i 166 Description Data channel to use B1 B2 D Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use O Channel ID i NAI i Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Description for information element i See Progress description values for a list of valid values Description for information element 0 See Progress description values for a list of valid values Number of progress indication information elements Location of information element i See Location values for a list of valid values Q 931 IE Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Not used Not used PCS user Progress indicator Progress indicator Progress indicator Progress indicator Macro Acu progress in progress location Acu progress in signal val Acu progress in x display nb Acu progress in x dis
40. Charging multiplier T Q D T A S P 1 N 6 WG S O A S 7 N Q 931 IE Not used Display Display Not used Facility PCS user Does not map to an IE User user Does not map to an IE Not used 103 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu clear rs charging period Acu clear rs charging type Acu clear rs charging value Acu clear rs ext parms lgth Acu clear rs ext parms nb Acu clear rs pcs user protocol Acu clear rs priority Acu clear rs uui protocol Acu clear rs x display nb Acu clear rs x display size i Acu clear rs x display total size Acu clear rs x display type i Acu clear rs x p display i ACU CONN CO This topic describes Description Charging period Charging type See Charging type values for a list of valid values Charging value number of units Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Primitive priority Values e ACU_PHIGH normal e ACU_PLOW urgent UUI protocol discriminator value See UUI protocol discriminator values for a list of valid values Default UUI 1A5 UUI_USER_SPF for HKG variant Number of present occurrences Size of occurrence i optional Total size of the stored strings Type of display i P
41. E 164 E 163 N PLAN TELEPHONE Telephony not in CEPT N PLAN DATA Data numbering plan CCITT x 121 N PLAN TELEX Telex numbering plan CCITT f 69 N PLAN NATI ONAL National standard numbering plan N PLAN PRIVATE Private numbering plan Screening indicator values The following table lists the valid calling and redirecting number screening indicator values for ACU ALERT IN ACU ALERT RQ ACU CONN IN ACU CONN RQ and ACU SETUP REPORT IN messages These values are defined in isdnval h Screening indicator Description N SCREEN USER PROVIDED Default User provided not screened N SCREEN USER PASSED Default for User provided verified and passed AusTel N SCREEN USER FAILED User provided verified and failed N SCREEN NETWORK PROVIDED Network provided Redirecting reason values The following table lists the valid redirecting reason values for ACU ALERT IN ACU CONN CO ACU CONN IN ACU CONN RQ and ACU SETUP REPORT IN messages These values are defined in isdnval h Redirecting reason Description REASON UNKNOWN Default Unknown REASON CALL FORWARDING BUSY Call forwarding busy 185 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Redirecting reason Description REASON CALL FORWARDING NO REPLY Call forwarding no reply REASON CALL FORWARDING DTE OUT Call forwarding DTE out of order REASON CALL FORWARDING BY CALLED Call forwarding by called equipment REASON CALL TRANSFER Call transfer
42. ISDNERR INVALID OPERATOR ISDNERR INVALID PARTNER ISDNERR INVALID PROTOCOL ISDNERR NAI IN USE ISDNERR PROTOCOL CC FAILURE ISDNERR PROTOCOL DL FAILURE ISDNERR PROTOCOL NS FAILURE ISDNERR PROTOCOL PH FAILURE 230 Hexadecimal 0x00071022 0x00071017 0x00071014 0x00071016 0x00071012 0x00071013 0x00071011 0x00071015 0x0007101D 0x0007101B 0x0007101C 0x0007101A Decimal 462882 462871 462868 462870 462866 462867 462865 462869 462877 462876 462875 462874 Description A message buffer is too large The ISDN library used is incompatible with the run file The country specified is invalid for the network operator specified The HDLC controller number specified is invalid The network operator specified is not supported by the run file partner equip specified in isdnStartProtocol is not supported by the run file The protocol parameter is not supported by the run file Another thread or process has already started a protocol for the same network access identifier The call control parameters are invalid The data link parameters are invalid The network signaling parameters are invalid The physical layer parameters are invalid Events reasons and errors NMS ISDN errors NMS ISDN functions can return the following error code Error Hexadecimal Decimal Description ISDNERR INVALID BUFFER 0x00070303 459523 The buff
43. Q 921 specification send DL DA RQ to the stack with a pointer to the data e If the packet is unacknowledged send DL U DA RQ to the stack with a pointer to the data No confirmation is returned in response to either of these requests The following illustration shows the sequence of messages sent between the trunk the stack and the application when the application sends a message across an established data link Trunk Stack Application DL DA RQ or Message DL U DA RQ Time Time Time When a packet is received from the remote party the stack sends one of the following messages to the application e DL DA IN if the packet is acknowledged e DL U DA IN if the packet is unacknowledged The application does not confirm receipt of a packet The following illustration shows the sequence of messages sent between the trunk the stack and the application when the application receives a message across an established data link Trunk Stack Application DL DA IN or Message DL U DA IN Time Time Time If the data link is broken while NMS ISDN is in DATA LINK ESTABLISHED state the stack sends DL REL IN to the application NMS ISDN returns to the IDLE state 44 7 Messaging API data structures Overview of API data structures NMS ISDN uses data structures to configure the ISDN protocol stack send messages to the protocol stack and receive messages from the protocol stack This topic describes the NMS ISDN data stru
44. SDN call control state machine The following illustration shows the NMS ISDN call control state machine ACU CONN IN ACU CLEAR CO ACU CLEAR CO ACU CONN RQ ACU CLEAR CO acy CLEAR_CO ACU_CLEAR_RQ ACU_CLEAR_RQ AWAITING CLEARANCE A WAIT ACU_CLEAR_IN OUTGOING ACU_CONN_RS ACU_CLEAR_CO Y ACU_CLEAR_RQ ACU_CLEAR_IN ACU CLEAR IN ACU CLEAR IN AWAITING CONNECT ACU CLEAR RQ ACU CONN CO ACU CONN CO 35 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Receiving inbound calls When a call SETUP message is detected on the trunk an ACU CONN IN is sent to the application from sender ENT CC Receipt of ACU CONN IN triggers a state transition from the NULL state to the WAIT INCOMING state The application decodes the message and obtains the calling number and called number The application then decides to accept or reject the call based on the value of the called number Accepting the call To accept the call the application builds a connect response message ACU CONN RS and sends it to the ISDN protocol stack The event ACU CONN CO confirms that the call has been established The stack switches to its ACTIVE state where the application processing takes place Note Applications with DSP resources that are not connected to a B channel connect calls when they receive connection indications The following illustration shows the default sequence
45. See Calling party Number type values for a list of number valid values Default N TYPE UNKNOWN Default for the 4ESS and VN6 variants N TYPE NATIONAL Calling number plan See Plan Calling party values for a list of valid values number Default N PLAN UNKNOWN Default for VN6 and AusTel variants N PLAN ISDN Calling number presentation Calling party Allowed values include number N PRES ALLOWED Presentation allowed default N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Calling number screening Calling party indicator See Screening indicator number values for a list of valid values Default N SCREEN USER PROVIDED N SCREEN USER PASSED for AusTel Called subaddress odd even Valid Calling party values include subaddress SUBADDRESS ODD Odd number of address signals SUBADDRESS EVEN Even number of address signals 133 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rq calling nb sub type Acu conn rq calling nb type Acu conn rq charging rq Acu conn rq data bits Acu conn rq data chani Acu conn rq data chani excl Acu conn rq data chani nai Acu conn rq data chani nb Acu conn rq data chani tab Acu conn rq data chani tab nai Acu conn rq ext parms lgth 134 Description Calling subaddress number type Valid values include SUBADDRESS TYPE NSAP NSAP SUBADDRESS TYPE USER User sp
46. T E W G E AA L N 1 Acu digit in a digit X x TE NT X x x Acu digit in digit size Acu digit in a display X x TE NT X X x Acu digit in display size Acu digit in a display list X X NT X x x Acu digit in a q931 X x TE NT X x x Acu digit in q931 size Acu digit in digit type X X X X X D P N S S Noor 149 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu_digit_in_digit_plan Acu_digit_in_sending_complete Acu_digit_in_x_display_nb Acu digit in x display size i Acu digit in x display total size Acu digit in x display type i Acu digit in x p display i 4 E N DE VH A E 1 MT N K U S O 2 S S 6 G S S l T E L 1 x x x x TE x x TE x x TE X x ITE x x TE x x TE ACU_DIGIT_IN macro descriptions and Q 931 IE Macro Acu_digit_in_a_digit Acu_digit_in_digit_size Acu_digit_in_a_display Acu_digit_in_display_size Acu_digit_in_a_display_list Acu_digit_in_a_q931 Acu_digit_in_q931_size Acu_digit_in_digit_type Acu_digit_in_digit_plan Acu_digit_in_sending_complete 150 Description Address and size of digit string Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to and size of buffer containing raw data of incoming Q 931 message Called number type Called number plan 442 NT NT NT NT NT NT Indicates if the sending complete information e
47. Value Description ACU QSIG PINX NB UNKNOWN Unknown party number type of nb field is meaningless ACU QSIG PINX NB PUBLIC Public party number ACU QSIG PINX NB PRIVATE Private party number qsig source type of nb field The qsig source type of nb field in ISDN PROTOCOL PARMS Q931CC is used when the application is designed for a Q SIG private ISDN exchange PINX Each node in a Q SIG network has an address This field is used with gsig source party nb type and qsig source addr to specify the address of the node The qsig source type of nb field specifies the type of public or private PINX number If qsig source party nb type is set to ACU QSIG PINX NB PUBLIC the following values are valid for qsig source type of nb Value Description ACU QSIG PINX PUB NB UNKNOWN Public or private unknown number ACU QSIG PINX PUB NB INTERNATI ONAL Public international number ACU QSIG PINX PUB NB NATIONAL Public national number ACU QSIG PINX PUB NB NETWORK SPFC Public network specific number ACU QSIG PINX PUB NB SUBSCRIBER Public subscriber number ACU QSIG PINX PUB NB ABBREVIATED Public or private abbreviated number 245 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual If qsig source party nb type is set to ACU QSIG PINX NB PRIVATE the following values are valid for qsig source type of nb Value ACU QSIG PINX PRIV NB UNKNOWN ACU QSIG PINX PRIV NB LEVEL2 REGIONAL ACU QSIG PINX PRIV NB LEVEL1 REGIONAL A
48. When the stack s syntax checking mechanism is disabled the stack does not perform syntax checking on transparent IEs It is the application s responsibility to build the transparent IEs according to the specifications for the variant the application is using The application should not use the transparent IE method and the macro method to access the same IE in the same ACU message For example if the application sets the macros for the called party number and includes the called party number IE IE ID 0x70 in the transparent IE buffer in the same ACU message both IEs are present in the final SETUP message Certain information elements are automatically generated by the stack in Q 931 messages The stack checks to see if any of the transparent IEs sent to it correspond to these information elements If it finds a transparent IE equivalent for an automatically generated information element it uses the transparent I E instead See the following table for a list of IEs automatically generated by the stack The transparent IE buffer must not be null terminated When calculating the size of a transparent IE buffer do not include a null terminator The following table lists IEs automatically generated by the stack Name Applies to variant bc All variants IIc All variants except HKT NTT QSI SWD hlc All variants except E10 cause All variants chan id All variants The transparent E must be formatted correctly as shown in the followin
49. X X X X X X x x Acu progress rq progress description X X X X X X X X X x x x x Acu progress rq progress location X X X X X X XX X X X x X x ACU PROGRESS RQ macro descriptions and Q 931 IE Macro Description Q 931 IE Acu progress rq a tsp ie list Pointer to and size of transparent IE Does Acu progress rq tsp ie list size buffer not map to an IE Acu progress rq cause Cause value Cause Acu progress rq cause location Cause location Cause Acu progress rq progress description Description for information element 0 Progress See Progress description values for a indicator list of valid values Acu progress rq progress location Location of information element 0 See Progress Location values for a list of valid values indicator and default setting information ACU RESTART IN This topic describes e ACU RESTART IN protocol variants e ACU RESTART IN macro descriptions and Q 931 IE Purpose Indicates that a RESTART ACKNOWLEDGE message has been received Conn id Unused 168 ACU RESTART IN protocol variants Message primitives The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E N D E E 1 l M T S O 2 S S S l Acu_restart_pref X x x RESTART for the B channel Acu restart pref X RESTART for the interface Acu restart int id X X X X x Acu restart b chan X X X X x
50. X X X X X X X X X x Acu call proc in data chant excl Acu call proc in data chani nai Acu call proc in data chani nb Acu call proc in data chani tab i Acu call proc in data chani tab nai i Acu call proc in ext parms Ilgth Acu call proc in ext parms nb Acu call proc in progress descr x i Acu call proc in progress description X X X X Acu call proc in progress ind nb X x X x Acu call proc in progress loc x i Acu call proc in progress location X X X X Acu call proc in signal val x Acu call proc in x display nb x x x x x x x Acu call proc in x display size i X X x X X x x 82 Quo nnZzUvUU d OO cd Message primitives Macro 4 E ND EV HA NKT QD T E 11 MTN KUTOA SP 1 S02 S S6 GS TRI I N 6 S l T EWGSO E AA S7 L N 1 Acu call proc in x display total size X X X X X X x Acu call proc in x display type i D X X X X x x Acu call proc in x p display i X X X X X X x ACU CALL PROC IN macro descriptions and Q 931 IE Macro Description Q 931 IE Acu_call_ proc_in_a_display Pointer to and size of Display Acu call proc in display size buffer containing ISDN display information optional Acu call proc in a display list Pointer to display Display structure Acu call proc in a ext parms Pointer to buffer Not used containing extended parameters Acu call proc in a facility Pointer to and size of Facility Acu call proc in facility size buffer containing ISDN facility information optional Acu c
51. by the value in this field determines a particular element of the ACU layer s behavior The values are defined as follows Value Description ACU SEND Q931 BUFFER If this bit is set the stack sends a whole received Q 931 message to the application along with the ACU primitive ACU SEND D CHANNEL STATUS CHANGE If this bit is set when the status of the D channel changes an ACU D CHANNEL STATUS IN primitive is automatically sent to the application indicating the change The Acu d channel state in this primitive indicates the status of the channel 0 OFF 1 2 ON ACU SEND UNKNOWN FACILITY If this bit is set the stack sends the application an ACU FACILITY IN message containing the whole Q 931 buffer with the unknown facility IE Setting this flag automatically enables the NS ACCEPT UNKNOWN FAC IE behavior bit ACU BEHAVIOUR NIL This is the default value corresponding to the behavior of the ACU entity if neither of the previous bits are set If acu behaviour is set to O or not set at all the ISDN protocol stack behaves as if the ACU BEHAVIOUR NIL bit is set ns behaviour field The ns behaviour field in ISDN PROTOCOL PARMS Q931CC determines which automatic responses the NS layer makes Refer to isdnparm h for more details The bit settings in this field are ignored when the protocol stack is started in channelized stack mode Each bit set by the value in this field determines a particular element of the NS layer s behavior T
52. bytes alignment ay Call control behaviour WORD in_calls_behaviour Incoming calls behaviour jul WORD out calls behaviour Outgoing calls behaviour Network signaling behavior A WORD ns behaviour Automatic call unit behaviour WORD acu behaviour BYTE qsig source party nb type Used for network node addressing in SS DA BYTE qsig source type of nb Used for network node addressing in SS SCH BYTE qsig source addr CC OSIG MX ADDR SIZE41 BYTE aoc s presubscribed On Off ON indicates na presubscribes to service G BYTE aoc d presubscribed On Off ON indicates na presubscribes to service pu BYTE aoc e presubscribed On Off ON indicates na presubscribes to service SC BYTE bpad2 1 Padding for 8 bytes alignment E WORD nfas_group NFAS group number if duplicate NAI values BYTE bpad3 2 Padding for 8 bytes alignment ECH WORD rful Reserved for future use MUST BE O0 WORD rfu2 Reserved for future use MUST BE O0 WORD w2pad 2 Padding for 8 bytes alignment EH ISDN PROTOCOL PARMS Q931CC ISDN PROTOCOL PARMS CHANNELIZED structure ThelSDN PROTOCOL PARMS CHANNELI ZED data structure configures the protocol stack So it is accessible to the Natural Call Control NCC service A pointer to this structure is passed as an argument to isdnStartProtocol The structure is identical to the ISDN PROTOCOL PARMS Q931CC structure 48 8 Function reference Function su
53. can hold an event specific value buffer Points to data returned with the event The field contains an application process address The event s size field contains the actual size of the buffer value Provides a reason code or an error code This is an event specific value objHd Contains the call handle if the event concerns a particular call If the event concerns the line and not a particular call objHd is ctaWaitEvent Receiving messages from the NMS ISDN protocol stack When an NMS ISDN protocol stack message is received an ISDNEVN RCV MESSAGE event occurs The buffer field in the CTA EVENT structure is a pointer to an ISDN PACKET structure This structure contains e An ISDN MESSAGE structure that contains the message and other data e A data area that contains the message header The following illustration shows the structure of this message packet ISDN PACKET structure ISDN MESSAGE structure Contains o primitive eg ACU CONN IN o data size size q o other data CTA EVENT structure Includes o buffer pointer to ISDN PACKET o other data ata area Contains message header seii Bak l After receiving and processing the data within the CTA_EVENT event buffer the application must use isdnReleaseBuffer to free the buffer as quickly as possible Otherwise the ISDN interface times out and stops passing events to the application 24 Messaging API programming model
54. code values 181 France VN6 layer 3 timer defaults 243 function reference cccec eee eee eae eaeees 48 function summary esses 48 H Hong Kong Telephone layer 3 timer defaults eeu rera eese 248 I in calls behaviour field 226 inbound calls cesses 35 initialization tasks sssssss 27 initializing ISDN protocol stack instances LE 32 INS 1500 NTT layer 3 timer defaults 249 ISDN eiii 5 ISDN call control state machine 34 ISDN Cariers e 8 ISDN functional devices and reference BOIS ant eee de 7 ISDN messages 20 ISDN protocol stack instance 33 ISDN protocol stack messages 23 24 ISDN PROTOCOL PARMS CHANNELIZED geg e ocio on dete re a oils 47 ISDN PROTOCOL PARMS LAPD 45 219 ISDN PROTOCOL PARMS Q931CC46 220 isdndemao 5 rere 185 classes iita tx RR 1o RE ER ana 191 compilation eee eee eee 189 DE 189 isdNndemo s sssssssssssrrresssrrrrrrrsersrns 188 program initialization 191 program structure and coding 189 278 Isdnbeleaesebufter errre 49 IsdnGendMeseage een 51 IsdnGetMsotCapture esseere 53 IsdntGtartbrotocol 56 isdnStopProtocol ssessessesss 62 ACES 214 215 K Korean layer 3 timer defaults 251 L LAPD messages 22 LAPD porimttives seer eee 64 lapddemo BEE 197 compila
55. contains SUCCESS Otherwise the event returns another reason code 34 5 Call control ACU configuration Connection I Ds The connection ID is a handle to a call on a B channel It is used to identify the call in all communications between the ACU and the application When an incoming call arrives the protocol stack assigns it a connection ID When the application places a call it assigns a connection ID to the call When a call is disconnected the connection ID is freed The ID can then be assigned to a new call by the protocol stack or the application A different set of connection IDs is available for each D channel Thus a call is identified both by its D channel context and by its connection ID The range of connection IDs available for a trunk is between O and ACU MX CALLS defined in isdnacu h In an NFAS group containing multiple trunks there are ACU MX CALLS connection IDs for each NAI The connection ID and NAI together identify a particular call The connection ID assigned to an incoming call by the protocol stack is the highest available unused value For example if 60 connection IDs are available for a trunk and connection IDs 59 and 58 are already allocated to calls the protocol stack assigns ID 57 to the next call To reduce the chance of collision assign connection IDs beginning with O when placing outgoing calls The application must also keep track of which connection IDs are in use and which are available I
56. digital trunk boards can each support up to four separate D channels Two digital trunk boards can each support up to two separate D channels 31 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual To open D channel contexts under Natural Access use ctaCreateContext followed by ctaOpenServices n each call to ctaOpenServices set stream timeslot and mode to 0 since no DSP processing resources are needed to control the D channel data stream Under Natural Access these values are included in the ctaOpenServices Accessing D channels Once one or more contexts are created for the D channels initialize a separate ISDN protocol stack instance for each context and associate a specific D channel with the context When this is done a D channel is ready to send and receive messages Network access identifiers NAI s A trunk is referred to by its network access identifier NAI When you initialize an ISDN protocol stack instance for a context using isdnStartProtocol specify the NAI of the trunk to associate with the context If duplicate NAI values are defined specify the NFAS group number From then on the application can communicate with the D channel on that trunk through the context handle For example when an event is received the context handle indicates the trunk on which the event occurred Different board types support different numbers of D channels and provide different NAI default values The following
57. display type i 102 OS e NT NT DS E md IDE P 442 mazon Z z 7 d ano nnZzvUu zl OO Oo Hi cd Macro Acu clear rs x p display i Message primitives noma orm NM Z Uzo un m OS e ORI Prm uc AZ mzoma ACU CLEAR RS macro descriptions and Q 931 IE Macro Acu clear rs charging value Acu clear rs a display Acu clear rs display size Filling order 3 Acu clear rs a display list Acu clear rs a ext parms Acu clear rs a facility Acu clear rs facility size Filling order 2 Acu clear rs a pcs user Acu clear rs pcs user size Filling order 4 Acu clear rs a tsp ie list Acu clear rs tsp ie list size Filling order 5 Acu clear rs a uui Acu clear rs uui size Filling order 1 Acu clear rs charging available Acu clear rs charging multi Description Charging value number of units Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of transparent IE buffer Pointer to and size of buffer containing ISDN user to user information optional Charging information available indicator
58. extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and size of transparent IE buffer Pointer to and size of buffer containing ISDN user to user information optional Call clearing cause value to be sent If 0 Normal Clearing 16 is sent Charging information available indicator Charging multiplier Charging period Charging type See Charging type values for a list of valid values Charging value number of units Q 931 IE Display Display Not used Facility PCS user CNIP Does not map to an IE User user Cause Not used Not used Not used 99 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu_clear_rq_ext_parms_lgth Acu clear rq ext parms nb Acu clear rq pcs user protocol Acu clear rq priority Acu clear rq signal val Acu clear rq ss cnip name active Acu clear rq ss cnip name pres Acu clear rq total cost Acu clear rq uui protocol Acu clear rq x display nb Acu clear rq x display size i Acu clear rq x display total size 100 Description Total length of buffer containing extended parameters Numbe
59. facility x display type i Acu facility x p display i ACU FACILITY RQ macro descriptions and Q 931 IE Macro Description Q 931 IE Acu_facility_a_called_address Pointer to buffer containing called Not used address Acu_facility_a_calling_nb Pointer to and size of buffer Not used Acu facility calling nb size containing the calling number Filling order 2 Acu facility a calling nb2 Pointer to and size of buffer Not used Acu facility calling nb2 size containing second calling number Filling order 3 Acu facility a display Pointer to and size of buffer Not used Acu facility display size containing ISDN display information Filling order 4 optional 159 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu facility a ext parms Acu facility a facility Acu facility facility size Filling order 1 Acu facility a pcs user Acu facility pcs user size Filling order 5 Acu facility a tsp ie list Acu facility tsp ie list size Filling order 6 Acu facility button nb Acu facility button type Acu facility call appear Acu facility code Acu facility conn id Acu facility ext parms Igth Acu facility ext parms nb Acu facility module nb Acu facility pcs user protocol Acu facility service Acu facility switchhook 160 Description Pointer to buffer containing extended parameters Pointer to and size of buffer containing I SDN facility information optional Pointer to
60. from the way bits are transferred from machine to machine to the sets of messages computers pass to one another A scheme for communication at a certain level is called a protocol In the late 1970 s the International Standards Organization ISO established the Open Systems Interconnect OSI model for communication ISDN is based on this model In OSI seven separate levels or layers of communication are defined The first three layers called the chained layers are the lowest levels The chained layers are Name Number Description Physical Layer 1 The electrical and mechanical layer Protocols for this layer layer describe on an electrical and mechanical basis the methods used to transfer bits from one device to another One protocol used at this layer is CCITT recommendation 1 430 1 431 Data link Layer 2 The layer above the physical layer Protocols for this layer layer describe methods for error free communication between devices across the physical link One protocol used at this layer is CCITT recommendation Q 921 also known as Link Access Procedures on the D Channel LAPD Network Layer 3 The layer above the data link layer Protocols for this layer layer describe methods for transferring information between computers They also describe how data is routed within and between networks One protocol used at this layer is CCITT recommendation Q 931 Layers higher than these are end to end layers They describe how informatio
61. functions 49 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Prototype The prototype is shown followed by a listing of the function s arguments NMS data types include e WORD 16 bit unsigned e DWORD 32 bit unsigned e INT16 16 bit signed e INT32 32 bit signed e BYTE 8 bit unsigned If a function argument is a data structure the complete data structure is defined Events If events are listed the function is asynchronous and is complete when the DONE event is returned If there are no events listed the function is synchronous Additional information such as reason codes and return values can be provided in the value field of the event Refer to NMS ISDN events and NMS ISDN reasons for information on all NMS ISDN events and reason codes Details Information specific to the operation and use of a function See also Functions related to the function being described Example An example code fragment The notation indicates additional code that is not shown isdnReleaseBuffer Returns an event buffer to the NMS ISDN API Prototype DWORD isdnReleaseBuffer CTAHD ctahd void buffer Argument ctahd buffer Description Context handle associated with a D channel returned by ctaCreateContext Pointer to the event buffer Return values Return value Description SUCCESS CTAERR INVALID CTAHD The context handle is invalid 50 Function reference Return value Description
62. gang AE break IS RECEDENCE level d lfb d chg d NI 2 X X X X domain 0x 06X n p gt level Patio p gt change p gt net_id p net id p net id p net id p gt domain OxOF OxOF OxOF OxOF of OF CR Sio m qu t lt EXT gt UNKNOWN id 0x 04X n Acu ext id p ext data Acu ext lgth Move to the next parameter 275 23 Index A action code values ene eeees 182 ACU message reference 66 ACU ALERT IN sem 67 ACU ALERT RO 73 acu behaviour field 230 ACU CALL PROC IN eese 78 ACU CALL PROC RO 82 ACU CALLID IN mmm 77 ACU CLEAR CO 85 ACU CLEAR IN 88 ACU CLEAR RO 92 ACU CLEAR RE 96 ACU CONN CO 99 ACU_CONN_IN mmm 107 ACU CONN RQ sese 118 ACU CONN RE 130 ACU D CHANNEL STATUS _IN 138 ACU D CHANNEL STATUS RQ 139 ACU DIGIT IN eem 140 ACU DIGIT RQ sse 141 ACU ERR IN 143 ACU FACILITY IN eee 144 ACU FACILITY RO 147 ACU NOTIPYCIN cc cceeeeeeeeeeeeeeeees 151 ACU NOTIFY RO 152 ACU PROGRESS IN sese 153 ACU PROGRESS RQ esse 156 ACU RESTART IN 158 ACU SERVICE CO 159 ACU SERVICE IN eese 160 ACU SERVICE RO 162 ACU_SETUP_ACK_IN esee 163 ACU SETUP REPORT IN 167 ACU TRANSFER CO sess 167 ACU TRANSFER RQ
63. in outgoing voice calls The value of this bit is used by the stack in all stack modes Forces A law specification in the Bearer Capability IE Makes internal assignment in the stack of the D channel to timeslot 31 If this bit is set the call ID returned to the application is the call reference value QSIG only If this bit is set then instead of using explicit call transfer when nccTransferCall is called path replacement is invoked Reserved for test purposes only Forces B channel numbering to be 1 through 30 inclusive QSIG only If this bit is set then calling nccAutomaticTransfer invokes the single step transfer supplementary service If this bit is set to 1 and all other bits in out calls behaviour are set to 0 no messages are sent by the stack during an outgoing call The application must build and send all messages If any of the other bits are set this bit is ignored The stack sends all messages you specify If out calls behaviour is set to O or not set at all the ISDN protocol stack behaves as if all out calls behaviour bits are cleared 241 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual acu behaviour field The acu behaviour field in ISDN PROTOCOL PARMS Q931CC determines what automatic responses the ACU layer makes Refer to isdnparm h for more details The bit settings in this field are ignored when the protocol stack is started in channelized stack mode Each bit set
64. information elements cooocccccccnccncnnnncnnnncnnnnnnnnncnn anna nn rn nr nn seems 250 Structure of user PCS IES E 250 Sending and receiving PCS information elements eee ee eect eee e ee ee teeta need 251 Example Code iesiri i pa i A 252 19 TIMES EE NA Ea aa 253 Timer e EE 253 France VN6 layer 3 timer detaults mne esee 255 Eurol SDN layer 3 timer defaults 0 cece eee eee ener eee nena nena eens nena 256 AT amp T E10 layer 3 timer defaults 2 0 0 0 erent erate nein 257 Nortel DMS 100 layer 3 timer detaults sss memes 258 USA National ISDN 2 layer 3 timer defaults ssssssssssssssm mene 259 Australian Telecom 1 layer 3 timer defaults 0 cece eect m 260 Hong Kong Telephone layer 3 timer defaults ssssssssssssse mene 260 INS 1500 NTT layer 3 timer detaulte mme 262 AT amp T 4ESS layer 3 timer defaults ssssssssssssssssmn mnes 263 Korean and Taiwan layer 3 timer defaults esses nn 263 QSIG layer 3 timer defaults sinarna e e nemen emen eese eene 265 20 NFAS and D channel backKUp cococcococnococnococnnracnnracnnrannnrncnnrncnnrncanrncnnrncnnaneass 266 Non facility associated signaling NFAS Hmmm 266 Setting up and using NFAS ouvir a ne E Re Ea iE a bees ERR EY exe Exc xr EUR od 267 NFAS groups and Hot Swap confiourations mme 267 D channel backup oet ENEE EENS ENEE 267 Setting up D channel backunp mese esee enn esee 268 Handling D channel Tailure emen mem
65. lapddemo options where options are one or more of the command line options described in the lapddemo overview lapddemo sends a SABME message on the trunk to establish the data link Press S The program sends a SETUP message with a called number value a calling number value a B channel number and an encoding flag These values are specified in lapddemo cfg The default values are Called number value 12345 Calling number value 678 B channel number 12 Encoding flag A law If the data link is established the program exchanges Q 931 messages with the remote party as described in the configuration file By default the following exchanges are made If lapddemo SETUP is received Sends an ALERTING message and then a CONNECT message CONNECT ACK is Starts timer T received Timer T expires Sends a DISCONNECT message DISCONNECT is Sends a RELEASE message received 211 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual If lapddemo RELEASE is received Sends a RELEASE COMP message lapddemo compilation lapddemo is supplied in executable form as well as source code If you need to recompile lapddemo enter one of the following commands Operating Directory Command system Windows nms ctaccess demos lapddemo nmake UNIX opt nms ctaccess demos lapddemo make For more information see the readme file that came with the NMS ISDN software package lapddemo files lapddemo c
66. layer 1 information Pointer to the original called number Original called number call forward no reply indicator Boolean Original called number redirection count Original called number plan See Plan values for a list of valid values Q 931 IE Calling party number calling party subaddress Calling party subaddress Calling name Display Display Network specific facility Facility Low layer information Original called number Original called number Original called number Original called number Macro Acu conn in orig called nb pres Acu conn in orig called nb reason Acu conn in orig called nb screen Acu conn in orig called nb size Acu conn in orig called nb type Acu conn in orig line info Acu conn in a pcs user Acu conn in pcs user size Acu conn in a ph num Acu conn in a q931 Acu conn in q931 size Acu conn in a redir nb Acu conn in redir nb size Description Original called number presentation indicator Valid values include N PRES ALLOWED N PRES RESTRICTED N PRES NOT AVAILABLE Original called number redirection reason See Redirecting reason values for a list of valid values Original called number screening indicator See Screening indicator values for a list of valid values Size of the original called number Original called number type See Number type values for a list of valid values Originating line information OxFF means
67. lines In addition to line interfaces these boards also use powerful on board digital signal processing DSP resources that can handle much of the call control and voice processing overhead This topic describes the e NMS ISDN product configurations e NMS ISDN ACU configuration e NMS ISDN LAPD configuration e Reference points supported by NMS ISDN Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual NMS ISDN product configurations You can use NMS ISDN software to access ISDN services in three ways e Configure the NMS ISDN software so an application can perform call control and other operations using the Natural Call Control service This NMS ISDN configuration is called the channelized configuration For more information about this access method see the NMS ISDN for Natural Call Control Developer s Manual e Access ISDN services at the ACU SAPI using the NMS ISDN Messaging API An application can use the API to perform a wide range of Q 931 ISDN D channel functions This NMS ISDN configuration is called the ACU configuration This access method is discussed in this manual e Access ISDN services at the data link layer layer 2 using the NMS ISDN Messaging API An application can send and receive I frame data in LAPD messages This data typically consists of Q 931 messages This NMS ISDN configuration is called the LAPD configuration This access method is discussed in this manual Specify the configuration
68. list size Filling order 12 Acu conn rq a uui Acu conn rq uui size Filling order 5 Acu conn rq auto dial Message primitives Description Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Layer 1 information Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Redirecting number Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and size of transparent IE buffer Pointer to and size of buffer containing ISDN user to user information optional OFF Go off hook only ON Automatically dial number Q 931 IE Display Display Network specific facilities Facility Low layer compatibility PCS user Redirecting number CNIP Does not map to an IE User user Not used 131 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rq call appear Acu conn rq callid rq Acu conn rq called nb plan Acu conn rq called nb sub odd even Acu conn rq called nb sub type Acu conn rq called nb type Acu conn rq calling nb2 pres 132 Description Call appearance Set to 1 to request a
69. mmememememn een 154 ACU FACILITY IN macro descriptions and OO3lIE cece cece etree eee eee eee ea en en es 156 ACU FAGILITY RQ eiecerunt pta Eelere EE 157 ACU FACILITY RO protocol variants ssssssssesssss meme 157 ACU FACILITY RQ macro descriptions and OO32lIE cece cece ee renee ee ee ee ee ea ea en ed 159 ACU NOTIFY LN Ite sene iter eter o Recon is 161 ACU NOTIFY IN protocol variants sssssssss m IIHmmememememe nenne 161 ACU NOTIFY IN macro descriptions and Q 931 IE sss e 162 ACW NOTIFY RO P Y 162 ACU NOTIFY RO protocol variants I mmemememen een 162 ACU NOTIFY RQ macro descriptions and OO3lIE cece ceee cere eee e nent ee ee ee ee teen ens 163 Table Of Contents ACU PROGRESS N xx ex NENNEN ERAN bebe he E I PX ERR EP ERR been 163 ACU PROGRESS IN protocol variants sssssssssee emen 163 ACU PROGRESS IN macro descriptions and Q 931 IE sse 165 SCH PROGRESS RO Ba oreet a HR RR E EUER PEINE E RE 167 ACU PROGRESS BO protocol vartante eee 167 ACU PROGRESS RQ macro descriptions and OO321IE cc ceecee cence cette tees ea eee 168 ACU RESTART Nx i aper iia 168 ACU RESTART IN protocol vartants meme 169 ACU RESTART IN macro descriptions and OO3lIE eeeeeeee ee ee nent eee teen ee ee teen ened 169 ACU SERVICE CO ee E Mere de E D Md LE 170 ACU SERVICE CO protocol variants meme 170 ACU SERVICE CO macro descriptions and Q 931 I
70. mode If the application does not need to modify parameters pass NULL to accept the default settings For ACU all of the services are supported by default TheISDNEVN START PROTOCOL event contains the completion status of the start request If the ISDN protocol stack instance starts successfully the value field in this event contains SUCCESS Otherwise another value appears here See isdnStartProtocol for more information Starting the NOCC TCP Once all ISDN protocol stack instances are created start a NOCC TCP on each B channel context This TCP puts the context in a state where voice or media functions can be used without call control Call nccStartProtocol for each B channel context specifying NOCC in the protname argument 33 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual When nccStartProtocol is called NCCEVN STARTPROTOCOL DONE is returned If the NOCC TCP is started successfully the event value field contains CTA REASON FINISHED Otherwise the value field contains another reason code Stopping an I SDN protocol stack instance Applications call isdnStopProtocol to stop an ISDN protocol stack instance This function shuts down the I SDN protocol stack instance and releases all on board resources and buffers formerly used by the stack instance ThelSDNEVN STOP PROTOCOL event returns the completion status of the stop request If the stack instance stopped successfully the value field in this event
71. no information available Pointer to and size of buffer containing ISDN PCS to user and user to PCS information See PCS user information elements for more information on this IE Alias for Acu conn in a calling nb Pointer to and size of buffer containing raw data of incoming Q 931 message Pointer to and size of buffer containing redirecting number Message primitives Q 931 IE Original called number Original called number Original called number Original called number Original called number Originating line information PCS user Low layer information Does not map to an IE Redirecting number 119 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn in a ss cnip name Acu conn in ss cnip name size Acu conn in a uui Acu conn in uui size Acu conn in call ref length Acu conn in call ref value Acu conn in called nb plan Acu conn in called nb sub odd even Acu conn in called nb sub type Acu conn in called nb type Acu conn in calling nb2 pres 120 Description Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and size of buffer containing ISDN user to user information optional Length of call reference value Call reference value and call reference flag Called number plan See Plan values for a list of valid values Called subaddress odd even Valid
72. of BChannel s functions to indicate a Call change of state to a BChannel object 205 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual BContext BContext objects provide voice playing and ADI timers associated with a physical B channel This object can have a single Call object associated with it A BContext object can be in one of the following three states State Description ST FREE Not associated with any Call object ST USED Associated with a Call object ST CALL Associated with a Call object in the connected state Two different modes for BContext objects determine its behavior Mode Description Outbound Initiates an outbound ISDN call upon entering the ST FREE state It also tries to hang up an existing call after a time interval when in the ST CALL state Inbound Initiates nothing This is passive mode A Call object can use the following BChannel functions to indicate a change of state Function Description get Associate BChannel with a Call object free Disassociate BChannel with a Call object startCall Play voice Call entered connected state stopCall Stop playing voice Call left connected state Timer BContext uses a Timer object to wait for a specific time interval Timer is a utility class that implements a synchronous timer based on the asynchronous ADI timer It has three functions Function Description start Starts the timer for a given time interval or restarts a running tim
73. of them is unused its size field must be set to O Purpose Indicates a response to a release indication Conn id An allocated call ACU CLEAR RS protocol variants The following table lists the variants under which each macro is supported for this primitive In this table NT indicates the NT side only and x indicates both NT and TE sides Macro 4 EN DE V HA N K T Q D T E 1 MT N KU T O A S P 1 S O 2 S S 6 GS T R I N 6 S l T E WG S 0 E A A S 17 L N 1 Acu_clear_rs_charging_value Acu_clear_rs_a_display Acu_clear_rs_display_size Filling order 3 Acu_clear_rs_a_display_list X X Acu_clear_rs_a_ext_parms Acu_clear_rs_a_facility x x x X x Acu_clear_rs_facility_size Filling order 2 101 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E N D E E 1 M T S 0 2S S S l Acu_clear_rs_a_pcs_user Acu_clear_rs_pcs_user_size Filling order 4 Acu_clear_rs_a_tsp_ie_list xX X X X X Acu clear rs tsp ie list size Filling order 5 Acu clear rs a uui x x Acu clear rs uui size Filling order 1 Acu clear rs charging available Acu clear rs charging multi Acu clear rs charging period Acu clear rs charging type Acu clear rs charging value Acu clear rs ext parms Igth Acu clear rs ext parms nb Acu clear rs pcs user protocol Acu clear rs priority Acu clear rs uui protocol Acu clear rs x display nb Acu clear rs x display size i Acu clear rs x display total size Acu clear rs x
74. one or more event queues with ctaCreateQueue Each function call creates a queue and returns a handle Make sure at least one queue is attached to the ADI service manager 3 Creates one or more contexts with ctaCreateContext Each call creates a context and returns a context handle 4 Opens services initialized in Step 1 on the contexts using ctaOpenServices For more information about initializing Natural Access see the Natural Access Developer s Reference Manual Specifying B channel contexts Create a separate context for each B channel your application interacts with To open contexts under Natural Access use ctaCreateContext followed by ctaOpenServices In each call to ctaOpenServices specify the following values Value For B channel contexts set to stream The voice stream or streams for the on board DSPs These streams are Board DSP resource stream AG 2000 BRI MVIP 95 Local stream O All other NMS digital trunk interface MVIP 95 Local stream 16 boards timeslot A base timeslot in stream mode ADI VOICE DUPLEX This mode allows voice inband transmission and reception Do not use modes involving signaling that are defined in the ADI documentation since ISDN signaling is not carried in the B channels Under Natural Access these values are included in the ctaOpenServices Specifying D channel contexts The application must also create a separate context for each D channel with which it will interact Four
75. progress loc lu Acu setup ack in progress location X X X x x x Acu_setup_ack_in_signal_val x Acu setup ack in x display nb X X X X X X x Acu setup ack in x display size i x X x X XX x Acu setup ack in x display total size x X X X X X x Acu setup ack in x display type i x X x X x X x Acu setup ack in x p display i X X X X X X x ACU SETUP ACK IN macro descriptions and Q 931 IE Macro Description Q 931 IE Acu setup ack in a display Pointer to and size of buffer Display Acu setup ack in display size containing ISDN display information optional Acu setup ack in a display list Pointer to display structure Display Acu setup ack in a ext parms Pointer to buffer containing Not used extended parameters Acu setup ack in a facility Pointer to and size of buffer Facility Acu setup ack in facility size containing ISDN facility information optional 176 zl OO Oo Hi cd Macro Acu setup ack in a pcs user Acu setup ack in pcs user size Acu setup ack in a q931 Acu setup ack in q931 size Acu setup ack in cause Acu setup ack in data chani Acu setup ack in data chani excl Acu setup ack in data chani nai Acu setup ack in data chani nb Acu setup ack in data chani tab i Acu setup ack in data chani tab nai i Acu setup ack in ext parms lgth Acu setup ack in ext parms nb Acu setup ack in progress descr x i Acu setup ack in progress description Message primitives Description Pointer to a
76. size Acu service a q931 170 Message primitives ACU SERVICE CO macro descriptions and Q 931 IE Macro Description Q 931 IE Acu service pref Preference Valid values include Channel identification PREF INTERFACE PREF B CHANNEL Acu service int id Interface ID Channel identification Acu service b chan B channel if Acu service pref Channel identification PREF B CHANNEL Acu service status New status Valid values include Change status This IE is B CHAN IN SERVICE not defined in Q 931 B CHAN OUT OF SERVICE Acu service action type Action to be performed Not applicable maintenance only Acu service q931 size Reserved for future use Not applicable Acu service size Size of structure Not applicable Acu service a q931 Reserved for future use Not applicable ACU SERVICE IN This topic describes e ACU SERVICE IN protocol variants e ACU SERVICE IN macro descriptions and Q 931 IE Purpose Indicates that a SERVICE message has been received Conn id Unused ACU SERVICE IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides 171 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu service pref interface Acu service pref B channel Acu service int id Acu service b chan Acu service status Acu service action type Acu service q931 size Acu ser
77. stack rearranges the data into several Q 931 information elements IEs builds a complete Q 931 message with the IEs and sends it to the network The application uses macros to assign values to the fields in the message structure Each macro corresponds to a field in the structure The application uses these macros instead of accessing fields directly because the fields do not correspond to actual C language structure fields and need some simple addressing computation to be reached These macros are defined in isdnacu h See ACU primitives summary for more information about message primitives and macros 20 Messaging API programming model The following sample code shows how to use macros to assign values to fields in an ACU message structure vost busdaccmcoommimaseh arte ostio nmm amr S gErucEe acu conn rs args 9 clica p data struct acu conn rs args Nb UE memset p_data OFF ISDN BUFFER DATA LGTH Fill in two fields using macros Acu conn rs data chani ts T1 El time slot Acu_conn_rs_data_chani_nb 1 Only one B channel User to user information could go here len sizeof struct acu conn rs args AS Certain pointer and size macros must be called in a specific sequence so that the corresponding IEs are filled out in order For details see ACU primitives summary The application also builds an ISDN MESSAGE structure specifying the message primitive and other data as foll
78. system to the public network To learn what approvals you require contact the appropriate regulatory authority in the target country Natural Access Natural Access is a complete development environment for telephony applications It provides a standard set of telephony functions grouped into logical services Natural Access provides functions for telephony related tasks such as call control tone and DTMF tone generation and detection and voice playing and recording Natural Access includes a service that controls switching on H 100 H 110 or MVIP compliant devices You can use this service to make or break connections send patterns and sample data Alternatively you can use the swish standalone utility to control switching interactively or in a batch mode For information about installing and using Natural Access see the Natural Access documentation Developing an NMS ISDN application Perform the following steps to create an NMS ISDN application Step Action Refer to 1 Install digital trunk interface boards in a The board installation manuals system and any other boards you will need in your application 2 Install Natural Access Installing Natural Access 3 Install the NMS ISDN software for each NMS ISDN Installation Manual country or region where your application will be used 4 Edit the system configuration file and the The NMS ISDN Installation Manual board keyword files so they describe all the installation manual
79. takes place when a DISCONNECT message is received by the network directly after it sends a DISCONNECT message to the stack The following illustration shows the sequence of messages exchanged in this situation ACU Q 931 Trunk stack Application The application requests clearing of a i call The request Disc E 5 reaches the trunk Disc Meanwhile an incoming call disconnect arrives Release The trunk senses the collision and sends a Rel Comp release Time Time Time 41 6 Data link operations LAPD NMS ISDN state machine LAPD configuration An application can perform various operations at the data link layer with NMS ISDN software in an LAPD configuration The following illustration shows the NMS ISDN software LAPD configuration state machine DL DA IN DL U DA IN DL EST IN DL EST CO DL EST RQ DATA LINK ESTABLISHED DL REL IN DL DA RQ DL U DA RQ DL REL IN lapddemo the LAPD demonstration program demonstrates LAPD operations using NMS ISDN software NMS ISDN events are generated by the NMS ISDN protocol stack running on the board When an NMS ISDN event occurs the event ID ISDNEVN RCV MESSAGE is returned in the CTA EVENT structure When decoding the message the following information is extracted Item Description LAPD message The message is a single byte code Sender The sender is the ISDN entity that generated the message For layer 2 ISDN call control message
80. the stack if duplicate NAI values are configured Messages built and sent with this demonstration program are based on standard Q 931 specifications Blue Book and may not be accepted or allowed in some switch variants Featured functions isdnReleaseBuffer isdnSendMessage isdnStartProtocol isdnStopProtocol Requirements e One or more digital trunk interface boards e Natural Access e nocc tcp file Usage lapddemo options where options are one or more of the following Option Meaning b boardno Number of the board to use Board numbers are specified in the board keyword file n lapddemo configured for the network terminator NT side a nai Network access identifier NAI g nfas group NFAS group number for duplicate NAI values v verboselevel Verbosity level Valid values are 0 Show no messages 1 Show SETUP messages only 2 Show all ISDN messages Defaults 0 Not specified lapddemo is configured for terminal equipment TE None None 2 209 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Option Meaning Defaults f filename Name of the configuration file to be read This file lapddemo cfg describes the behavior of the program in terms of what Q 931 messages are sent or received Specifications for outgoing calls are not given in the default configuration file You must make additions to this file in order for the demonstration program to achieve the CO
81. uchar Ifo Look Forward Busy MLPP LEB xxx uchar change change value 0 or 1 uchar coding_std coding STD Ue ITU T 2 national a DWORD domain bits 0 23 are MLPP service domain WORD net_id network id 4 decimal digit integer pad2 y Precedence Level IE fields The following tables show the valid settings for the fields of the Precedence Level IE structure e level e Wb e change e coding std e domain e net id level Value Description 0 FLASH OVERRIDE Highest precedence level 1 FLASH 2 IMMEDIATE 3 PRIORITY 4 ROUTINE Lowest precedence level 273 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Ifb Value Description 0 MLPP LFB ALLOWED Look ahead for busy LFB allowed 1 MLPP LFB NOT ALLOWED LFB not allowed 2 IMLPP LFB PATH RESERVED Path reserved change Value Description 0 Precedence level coding privilege can be changed at the network boundaries 1 Precedence level coding privilege cannot be changed at the network boundaries coding_ std Value Description 0 CCITT standardized coding 1 National standard domain MLPP service domain 24 bit pure binary expressing the number that uniquely identifies a customer domain across multiple ISDN networks net id Network identity Each digit is in binary coded decimal representation from 0 to 9 Precedence Level I E examples The following examples show how to encode and decode the Precedence Le
82. used as another B channel Messaging API programming model The following illustration shows a sample NFAS configuration D channels4 D channel for all Four trun 4 B channels Ti AG 4040 T board TE dana trunks 4 B Manne Note NFAS configurations are supported only on T1 trunks For more information about NFAS see Non facility associated signaling NFAS Basic rate interface BRI ISDN is also transmitted over BRI trunks with four wire digital transmission links BRI trunks are used mainly in Europe and Asia and transmit data in 3 channels The three channels are usually used as follows e Two of the channels are B channels carrying voice audio data and or video signals at 64000 b s e One of the channels is a D channel carrying signaling information for the B channels at 16000 b s The following illustration shows a BRI trunk standard configuration BRI trun B channels D channel with signaling for these channels BRI trunk 2 B channels D channel with signaling for these channels AG 2000 BRI board NMS ISDN software NMS ISDN protocol software enables you to write Natural Access applications that communicate with T1 El or BRI trunks to perform voice processing functions and call control using ISDN common channel signaling CCS protocols NMS ISDN software is designed to use one or more NMS digital boards such as the CG 6000C AG 4000 or AG 2000 BRI board as the physical interface to trunk
83. values include SUBADDRESS ODD Odd number of address signals SUBADDRESS EVEN Even number of address signals Called subaddress number type Valid values include SUBADDRESS TYPE NSAP NSAP SUBADDRESS TYPE USER User specified Called number type See Number type values for a list of valid values Second calling number presentation Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Q 931 IE CNIP User user Call reference Call reference Called party number Called party subaddress Called party subaddress Called party number Calling party number Macro Acu conn in calling nb2 screen Acu conn in calling nb2 type Acu conn in calling nb plan Acu conn in calling nb pres Acu conn in calling nb screen Acu conn in calling nb sub odd even Acu conn in calling nb sub type Acu conn in calling nb type Description Second calling number screening indicator See Screening indicator values for a list of valid values Second calling number type See Number type values for a list of valid values Calling number plan See Plan values for a list of valid values Calling number presentation Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRI CTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Calling number screen
84. x x x x X x x D D D D DS BHrm Hoc 432 mzom z z d4 Message primitives Quo nnZzUvUU Noord 107 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E ND EV HAN E 11 MT NK U T S O 2 S S6 GST S l T E L 1 Acu_conn_co_x_display_nb x x X x X X x Acu conn co x display size i X X X x X X x Acu conn co x display total size X x X X X X X Acu conn co x display type i X x X x X X x Acu conn co x p display i X X X X X X X Acu_conn_co_year X X ACU_CONN_CO macro descriptions and Q 931 IE Macro Description Acu conn co a connected nb Pointer to and size of buffer Acu conn co connected nb size containing connected number Acu conn co a connected sub Pointer to and size of buffer Acu conn co connected sub size containing connected subaddress Acu conn co a date time Pointer to date time Pointer to and size of buffer containing ISDN display information optional Acu conn co a display Acu conn co display size Acu conn co a display list Pointer to display structure Pointer to buffer containing extended parameters Acu conn co a ext parms Pointer to and size of buffer containing ISDN facility information optional Acu conn co a facility Acu conn co facility size 108 mzoma zZ z 4 DO nnZzuUu x Q 931 IE Connected party address Connected party subaddress Date time Display Display Not used Fac
85. 0 90 30 10 4 N A 4 120 120 0 0 40 40 120 120 Korean and Taiwan layer 3 timer defaults timer val t kor KOR T LAST Timer index T300 T301 T302 T303 T304 T305 Value network side in Value user side in seconds seconds 1 1 180 N A 15 15 4 4 20 30 30 30 263 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Timer index T306 T307 T308 T309 T310 T312 T313 T314 T316 T317 T318 T319 T320 T321 T322 T HOLD T RETRIEVE 264 Value network side in seconds 30 180 90 40 N A 120 100 30 30 Value user side in seconds N A N A 4 90 45 120 100 QSIG layer 3 timer defaults timer val t qsi QSI T LAST Timer index QSI_T300 QSI_T301 QSI_T302 QSI_T303 QSI_T304 QSI_T305 QSI_T308 QSI_T309 QSI_T310 QSI_T313 QSI_T314 not exposed to the API QSI T316 not exposed to the API QSI T322 Value network side in seconds 1 180 15 20 30 90 30 120 Timers Value user side in seconds 1 180 15 20 30 90 30 120 265 20 NFAS and D channel backup Non facility associated signaling NFAS In setups with multiple T1 ISDN trunks you can set up a single D channel to serve all trunks This configuration is called non facility associated signaling NFAS ISDN is transmitted over standard T1 and El carriers T1 and El trunks are typically four wire digital tr
86. 1CC parameters ThelSDN PROTOCOL PARMS Q931CC structure contains parameters that configure the ISDN protocol stack for Q 931 call control through the ACU Either this structure or ISDN PROTOCOL PARMS LAPD is passed to isdnStartProtocol depending on how the ISDN protocol stack is configured For more information refer to Initializing ISDN protocol stack instances For a definition of the data structure see ISDN PROTOCOL PARMS Q931CC structure Type Parameter DWORD size WORD rate WORD t309 timer val xxx t BYTE services list Description Size of the structure Data rate T309 in use flag indicates if data link release and establish timers are in effect used by D channel backup protocol See D channel backup Timer values by country or operator Services supported on incoming calls Default value Range of values None ISDN RATE 64 ISDN RATE 64K K ISDN RATE 56K 0 0 1 See Timer See Timer overview overview All services All services See services list field 233 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Type WORD timer val t timer val t timer val t WORD WORD BYTE BYTE WORD WORD 234 Parameter max FEC errors t101 t102 t198 tei time assignment tei time removal tei 3 digitstoroute in calls behaviour out calls behaviour Description Default value Maximum 20 number of fr
87. 2 30 64 kbit s channel service Data using 2 64 kbit s channel service BRI only No B channel service bearer independent calls QSIG only G3 facsimile service for use with physical relay process 237 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Service Description DATA RELAY SERVICE Data service for use with physical relay process DATA 56KBS RELAY SERVICE Data at 56 kbit s service for use with physical relay process DATA TRANS RELAY SERVICE Data transparent service for use with physical relay process MODEM RELAY SERVICE Modem data service for use with physical relay process X25 RELAY SERVICE X 25 circuit mode service for use with physical relay process VOICE RELAY SERVICE Voice service for use with physical relay process VOICE GCI RELAY SERVICE Voice service on GCI bus for use with physical relay process NO SERVICE Undefined service The services array must be terminated by NO SERVICE Thus you can specify at most CC MX SERVICES minus one Note The delivery of some of these services may be regulated by local authorities You may be responsible for formally certifying these services in some countries Check with the local authority for more specific information on these limitations in calls behaviour field The in calls behaviour field in ISDN PROTOCOL PARMS Q931CC determines how an incoming call is handled by the ISDN protocol stack Refer to isdnparm h for mor
88. 2 Network terminating equipment class 2 NT2 equipment can support more than one primary rate trunk switch channels between different trunks and take primary synchronization from the T1 or E1 network NT1 Physically terminates the local loop In Europe the NT1 equipment is the network in 1 411 compliant installations In the USA NT1 is often referred to as the CSU a separate device on the customer premises LE Local exchange equipment Note The International Telecommunications Union ITU document 411 defines ISDN user network interface reference configurations In the USA the definition is provided by a number of documents including AT amp T TR 41449 ISDN Primary Rate Interface Specification The interface between each category is called a point e The interface between TE1 and NT2 equipment is the S point e The interface between NT2 and NT1 equipment is the T point e The interface between NT1 and LE equipment is the U point Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual The following illustration shows the component categories and associated reference points ge ITU network ISDN switch Local loop terminator NT1 eressserssesest End user Switching Physical Physical ISDN device termination termination gt MUX ISDN protocol Performance Switching Concentration monitoring Signaling conversion
89. 220 E 238 PCS user information 238 placing and receiving calls 194 plan values ccc eee eee e eee ee eee eee ed 173 Precedence Level IE 260 examples sssssssssssrssssrsssrrsrrrrsrenn 261 fields gg od eee Pre aea ead aes 260 primary rate interface PRI 8 PFiMItiVeS ccc eee eee eee eee ee eeee es 65 progress description values 183 protocol parameter structures 44 Index ISDN PROTOCOL PARMS CHANNELIZE EI Stu Cture soc cies nats Det e mt 47 ISDN PROTOCOL PARMS LAPD SETUCEUFre eoi llos 45 ISDN PROTOCOL PARMS Q931CC SEFUCEUEG acia arder 46 Q RE ER e EE 237 Q 931 data 235 QSIG layer 3 timer defaults 252 qsig source party nb type field 233 qsig source type of nb field 233 R reason codes ccccccccnccnncnnconannnnnnnanannns 216 redirecting reason values 174 S screening indicator values 174 service va lues ccc eceeeeeeeeaeeaeeaeeaes 171 services list feld 224 signal values sese 176 state machine 41 switch Connections sees 29 T Taiwan layer 3 timer defaults 251 MOS isse oc eee a ena eee Ve du 241 transparent IEs 235 236 U USA National ISDN 2 layer 3 timer defaults las 247 user ratevalues 170 UUI protocol discriminator values 175 279
90. A situation may arise when the primary D channel fails and one side of a call in the connected state initiates the disconnect process leaves the connected state immediately before the data link failure is detected in the system At the moment of failure recognition one side is in the connected state while the side that started the disconnect sequence is not in the connected state In this case the state of the first side is preserved The second side receives an ACU CLEAR CO or NCCEVN CALL DISCONNECTED message When the data link is reestablished the first side remains in the connected state The application disconnects and releases this call A similar situation can arise if the primary D channel fails and both sides are in the connected state and their states are preserved but then one side initiates the disconnect process and gets cleared before the data link is reestablished As a result when the data link is reestablished one side remains in the connected state and does not know that the other side has disconnected The application detects this situation disconnects and releases the call Since neither D1 nor D2 can serve as a B channel while designated as a backup D channel an application is not allowed to place a call on a timeslot on a primary or backup channel Both D1 and D2 channels are assigned to the slots number 24 on the corresponding trunks so that the maximum B channel slot number for a trunk with a primary or a backup D
91. ACU_CONN_RS ACU INFORMATION IN and ACU INFORMATION RQ messages These values are defined in isdnacu h Charging type ACUCHARG TYPE FREE OF CHARGE ACUCHARG TYPE CHARGE ON DURATION ACUCHARG TYPE CHARGE ON ANSWER ACUCHARG TYPE CHARGE INCREMENT ACUCHARG TYPE SUB TOTAL CHARGE ACUCHARG TYPE TOTAL CHARGE Endpoint I D values These values are defined in isdnacu h Endpoint ID ACU ACTION NO ENDPOINT ID ACU ACTION SND USID Description Free of charge N A in VN6 FRANCE Charge on duration N A in VN6 FRANCE Charge on answer N A in VN6 FRANCE Charge increment N A in VN6 FRANCE Sub total charge Total charge Description Do not send any endpoint ID ACU CONN RQ SPID was OK send the endpoint ID information 195 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Endpoint ID Description ACU ACTION NO SPID NEGOTIATION SPID negotiation is not supported ACU ACTION INVALID SPID The received SPID is invalid ACU ACTION PROMPT INFO Need a SPID from the terminal ACU INTERPRETER 0 Terminal is selected if it is assigned the indicated TID and USID value ACU INTERPRETER 1 Terminal is selected if it is not assigned the indicated TID but is assigned the indicated USID value 196 11 isdndemo Layer 3 call control isdndemo overview isdndemo uses the NMS ISDN Messaging API to place and receive calls on an ISDN trunk It demonstrates e A digital trunk application that use
92. AI of the trunk that the message concerns ENT DL D Indicates that the message was sent from data link layer ENT APPLI Indicates that the message was sent to an application DL SAPI SIG 1 Specifies the primitive of the message for example DL DA IN Reserved for internal data relay 25 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ISDN MESSAGE Value in ACU stack mode field data size Specifies the size of the message buffer containing data associated with the event if any nfas group Specifies the NFAS group number for the network access identifier NAI Used only if duplicate NAI values are defined userid Not used 26 Value in LAPD stack mode Specifies the size of the message buffer containing data associated with the event if any Specifies the NFAS group number for the network access identifier NAI Used only if duplicate NAI values are defined Not used 4 Initializing a Messaging API application Initialization tasks An NMS ISDN application performs the following initialization tasks e Task 1 Route channel data to on board resources e Task 2 Create contexts for channels e Task 3 Call isdnStartProtocol e Task 4 Starting NOCC TCPs on B channel contexts Task 1 Route channel data to on board resources If necessary the application makes switch connections to route D channel data to the HDLC controller and to route B channel information to DSP r
93. ALID_STATE An ISDN protocol stack instance is e Not started on the specified context handle e Started e Stopped or e n the process of stopping Events Event name Description ISDNEVN STOP PROTOCOL The value field of this event contains the completion status of the protocol stopping operation If the instance stopped successfully the value field contains SUCCESS Otherwise an error appears here 64 Function reference Details This function shuts down a previously started ISDN protocol stack instance and releases all HDLC LAPD or Q 931 ACU resources and buffers associated with the instance When the ISDN protocol is stopped the RESTART procedure is initiated This RESTART procedure implies sending RESTART messages to the remote end a single RESTART for the entire trunk or one RESTART for each B channel depending on the variant and waiting for RESTART ACKNOWLEDGE The ISDN stack waits for each RESTART ACKNOWLEDGE message for 20 seconds before declaring the RESTART procedure failed clearing its part of the state machine and continuing the stopping procedure As a result if the remote end does not respond for example the RESTART procedure is not implemented or the line is down stopping the protocols may take more than 20 seconds up to 8 minutes for variants that do not support RESTART messages for the entire interface A behavior bit NS DISABLE RESTART can be used to disable the RESTART procedure in the stack If
94. Acu_conn_in_dest_call_appear Destination call appearance Not used Acu_conn_in_ext_parms_lgth Total length of buffer containing Not used extended parameters Acu_conn_in_ext_parms_nb Number of parameters in buffer Not used containing extended parameters Acu conn in interworking Interworking indication Not used ON Interworking occurred OFF No interworking Acu conn in parity Parity for V 110 and V 120 Low layer services Available values information include ACU ODD odd parity ACU EVEN even parity ACU NO PARITY no parity 122 Macro Acu conn in pcs user protocol Acu conn in ph rate Acu conn in progress descr x i Acu conn in progress description Acu conn in progress ind nb Acu conn in progress loc x i Acu conn in progress location Acu conn in redir nb plan Acu conn in redir nb pres Acu conn in redir nb reason Description Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Physical rate for all services Description for information element i See Progress description values for a list of valid values Description for information element 0 See Progress description values for a list of valid values Number of progress indication information elements Location of information element i See Location values for a list of valid values Location of information element 0 See Location values for a
95. BO protocol variants e ACU CLEAR RO macro descriptions and Q 931 IE 96 Message primitives Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to O Purpose Requests releasing of a call Conn id An allocated call ACU CLEAR RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table NT indicates the NT side only and x indicates both NT and TE sides E N D E V HAN 1 M N T S 6 T Macro 4 E S 0 2 S K G D IO nnZ2vU NOoOr 4 T S l Prmaune PMAOA SZ PS P Acu clear rq a display Acu clear rq display size Filling order 3 Acu clear rq a display list X X Acu clear rq a ext parms Acu clear rq a facility X X X X x Acu_clear_rq_facility_ size Filling order 2 Acu_clear_rq_a_pcs_user x Acu clear rq pcs user size Filling order 4 Acu clear rq a ss cnip name X Acu clear rq ss cnip name size Filling order 5 Acu clear rq a tsp ie list X X X X X X X X X X x X x Acu clear rq tsp ie list size Filling order 6 Acu clear rq a uui X X X X X x Acu clear rq uui size Filling order 1 97 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E N D E V HA E 1 MT N KU S O 2 S S 6 GS S l T E L 1 Acu_clear_rq_cause X X X X X X x Acu_clear_rq_charging_available NT Acu clear rq charging multi Acu clear r
96. CC parms size sizeof ISDN PROTOCOL PARMS Q931CC parms services list 0 ACU VOICE SERVICE Other services may be added here parms services list 1 ACU NO SERVICE parms acu behaviour ACU SEND Q931 BUFFER isdnstaertProtocol ctahd ISDN _ PROTOCOL 0931CC networkoperator COUNE Ry partner SM nai amp parms Instead of NULL The buffer is not null terminated It cannot be read by functions that expect null termination such as strcpy The total amount of data all buffers including the raw Q 931 data buffer that can be received in an ISDN message is MAX ISDN BUFFER SIZE This value is defined in isdnparm h If the size of incoming data is greater than MAX ISDN BUFFER SIZE the raw Q 931 data buffer is omitted 249 18 Sending and receiving PCS user information PCS user information elements The user to PCS and PCS to user information elements are network specific information elements coded using codeset 6 used to transmit information between the user and a PCS Point de Commande de Service They are used in the French ISDN variant VN6 These information elements can be included in several ISDN message types in the call setup call connected and call disconnection phases Structure of user PCS I Es Each user to PCS and PCS to user information element includes a protocol discriminator field and an information area This information area contains differing amounts of information d
97. CU NOTIFY RQ protocol variants Q 931 IE Connected name Not used Not used Not used Does not map to an IE The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E N D E V H A N K E 11 MT N K U T O S O 2 S S 6 G S T R S l T E E A L 1 Acu_notify_rq_a_tsp_ie_list X Acu notify rq tsp ie list size 162 Z gt s gt H Q D T S P 1 I N 6 G S O S 7 X X Message primitives ACU NOTIFY RO macro descriptions and Q 931 IE Q 931 IE Macro Description Does not map to an IE Acu notify rq a tsp ie list Pointer to and size of transparent IE Acu notify rq tsp ie list size buffer ACU PROGRESS IN This topic describes e ACU PROGRESS IN protocol variants e ACU PROGRESS IN macro descriptions and Q 931 IE Purpose Indicates outgoing call progress information receipt of PROGRESS message Conn id An allocated call ACU PROGRESS IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E ND EV HAN K T QDT E 1 MTN KUTOA SP 1 S O 2 S S6 GS TR N 6 S l T E W GSO E A A S 7 L N 1 Acu_progress_in_a_display X X x X X X X x Acu progress in display size Acu progress in a display list x X x X x x x x Acu progress in a ext parms Acu progress in a facilit
98. CU QSIG PINX PRIV NB PTN SPECIFIC ACU QSIG PINX PRIV NB LOCAL ACU QSIG PINX PRIV NB ABBREVIATED 246 Description Public or private unknown number Private level 2 regional number Private level 1 regional number Private PTN specific number Private local number Public or private abbreviated number 17 Sending and receiving raw Q 931 data Overview of Q 931 data NMS ISDN allows an application to include raw Q 931 data in one or more completely custom built information elements IEs in messages sent to the stack These information elements called transparent IEs are inserted verbatim in the Q 931 message generated by the stack This specification method allows an application access to IEs and fields in IEs that cannot be accessed using the macros associated with ACU messages This method can be used to specify both standard IEs codeset 0 and extensions such as codeset 6 and 7 An application can also access and read the raw data in an incoming Q 931 message rather than reading returned values for specific fields in data structures Creating transparent I Es The application supplies the data in hexadecimal format for the transparent IEs in a buffer referenced in one of the standard ACU messages The following macros refer to the transparent IE buffer Macro Description acumessage tsp ie list size Size of transparent IE buffer in bytes acumessage is a standard ACU message for example ACU CONN RQ For
99. Channel ID i NAI i Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Q 931 IE User user Not used Call reference Call reference Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Not used Not used 73 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu alert in pcs user protocol Acu alert in progress descr x i Acu alert in progress description Acu alert in progress ind nb Acu alert in progress loc x i Acu alert in progress location Acu alert in redir nb plan Acu alert in redir nb pres Acu alert in redir nb reason Acu alert in redir nb screen Acu alert in redir nb type 74 Description Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Description for information element i See Progress description values for a list of valid values Description for information element 0 See Progress description values for a list of valid values Number of progress indication information elements Location of information element i See Location values for a list of valid values Location of information element O See Location values for a list of valid values Redirecting number plan See Plan value
100. DL establishment indication or confirmation is received After a STATUS ENQUIRY is sent Reset When a RESUME ACK or RESUME REJ is received When a SUSPEND ACK SUSPEND BEI is received When a call request packet or DL RELEASE is received When a STAT DISC REL or REL COM is received Value network side in seconds 1 180 15 20 30 30 180 Timers On expiration The call is cleared ACU CLEAR CO is sent to the application ACU CLEAR CO is sent to the application DL RELEASE request is sent to the line STATUS ENQUIRY is submitted Value user side in seconds 1 0 15 10 30 30 255 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Timer index VN6 7308 VN6 T309 VN6 T310 VN6 T312 VN6 T313 VN6 T3141 Value network side in seconds 4 90 20 VN6_T316 not exposed to the API 120 VN6 T317 not exposed to the API 100 VN6 T318 VN6 T319 VN6 T320 VN6 T321 VN6 T322 VN6 T399 30 30 Eurol SDN layer 3 timer defaults popu S cales OUS IP E a Timer index ETS T300 ETS T301 ETS T302 ETS T303 ETS T304 256 Value network side in seconds 1 180 15 20 Value user side in seconds 4 90 60 120 100 10 Value user side in seconds 1 0 15 30 Timer index ETS T305 ETS T306 ETS T307 ETS T308 ETS T309 ETS T310 ET
101. Dialogic Making Innovation Thrive Dialogic NaturalAccess ISDN Messaging API Developer s Manual October 2010 64 0509 02 RevA www dialogic com Table Of Contents 1 Introducton p 1 2 NMS ISDN Messaging API overview eeeeseee esee enne nnn nnne nnne nune nan an 5 Integrated Services Digital Network ISDNI mI mmn menn 5 ISDN protocols and protocol layering ccc ecient meme emen 5 Information exchange between layerS sss eene enne 6 ISDN functional devices and reference points 7 SS DNCE ege Ee D SEED 8 Primary rate interface PRI cesses nee eene heme ee ness 8 Basic rate interface BRI comia k rav ka ERA Di EOD a a VOR VR ada 9 NMS IS DNiSORWANG t 9 NMS ISDN product configurations sssssssssssssssssme mn esee esee enne nnns 10 NMS ISDN ACU configuration cocer tuto teet rede ANE ENEE te adu cx vo DR VE Ro UA RR EO ENN ee 10 NMS ISDN LAPD configuration m mms emen enn enne enne nennen 11 Reference points supported by NMS 1GDN Hmmm nnne 12 NMS ISDN software components sesssssssssssssssessssesee sehen a i Aaa esee enne 13 RECAM lil IIT 14 NMS ISDN function libraries 0 a a tenet nates 14 RUN MOUSE O aN A 15 Board keyword files erriren enian i i a iaka nee arar esee sese esee nne 15 Demonstration programs and utiles 15 Other e el le Le En 16 Natural ee 16 Developing an NMS ISDN
102. E 0 eeeeeee ee ee nent nett teen ee ee ea ea ens 171 AGU SERVICE IN icono orte Beal Siew me rir teres a MEER EDS 171 ACU SERVICE IN protocol variants ssssssssssee meme 171 ACU SERVICE IN macro descriptions and OO31lIE ee ee nett ee ee eee ea ea ened 172 SCH SERVICE RETTEN A aa 173 ACU SERVICE RQ protocol variants cc ceeeceee eee an n renee a 173 ACU SERVICE RQ macro descriptions and Q 931 lE sssssssssssrssrssrrsrrrrrrsrrsrrrrrrsrens 174 ACU SETUP ACK Nini ERE ENER NEEN eda ERR EY IR DEM REG YE 174 ACU SETUP ACK IN protocol variants siirsin atera Hee 175 ACU SETUP ACK IN macro descriptions and OO321IE eerren 176 ACU SETUP REPORT IN ege ERE a 178 ACU TRANSFER CO C hic ett feet eth lata da tia 178 ACU TRANSFER CO protocol variants cece cece eee meme 179 ACU TRANSFER CO macro descriptions and OO321IE eens ee ee eee e ee ee teens 179 ACU TRANS FERRO incita dista 179 ACU TRANSFER BO protocol variants cece eee teeter e eee eee emen 180 ACU TRANSFER BO macro descriptions and Q 931 IE sss 180 10 Data types and constants in primitives KEREN ERER REENEN ERR EE RENE RENE KEEN 181 User rate VallES TD Tr 181 Service Valeria litio 182 Number type values eese esee esee teses esee esee ses esee seen 184 Plan VUE A AER EEN A e aa canes 184 Screening indicator values senem eminens nennen nnn 185 Redirecting reason values eese meses meses esee esee esee 185 Location values 232 sien narr
103. E The event value field contains one of the following reasons or an error code SUCCESS ISDNERR BAD NAI The network access identifier NAI is not valid The NAI must be less than MAX NAI specified in isdnparm h An NAI and NFAS group couple is invalid if the NAI value is not unique in the configuration Details This function enables or disables tracing of messages generated by the ISDN protocol entities named by the entity id string The associated board is indicated by the specified ctahd 56 Function reference When the entity id string contains an asterisk all entities are affected By default tracing is enabled for all entities In order for messages to be sent to the monitor screen the flag passed to oamtrace formerly agtrace must be set to 0x801000 For configurations where all NAI values are unique NMS recommends setting nfas group to 0 Example define TRACE ENABLE dl define TRACE DISABLE 0 DWORD mySetTrace CTAHD ctahd DWORD enable char list DWORD ret CTA_EVENT event char errortext 40 ret isdnSetMsgCapture ctahd enable 0 trace list 0 if ret SUCCESS ctaGetText ctahd ret errortext 40 printf TRACE FAIL s n errrortext return MY ERROR TRACE FAILED myWaitForEvent ctahd amp event if event value SUCCESS ctaGetText ctahd event value errortext 40 printf TRACE FAIL s n errortext return MY ERROR TRACE FAILED void do trace CTA
104. ELAY SERVICE VOICE RELAY SERVICE VOICE GCI RELAY SERVICE NO SERVICE Number type values Description Data transparent service for use with physical relay process Modem data service for use with physical relay process X 25 circuit mode service for use with physical relay process Voice service for use with physical relay process Voice service on GCI bus for use with physical relay process Undefined service The following table lists the valid calling called and redirecting number type values for ACU CONN IN ACU SETUP REPORT IN and ACU ALERT IN messages These values are defined in isdnval h Type Description N TYPE UNKNOWN Default for all variants except Unknown 4ESS VN6 N TYPE INTERNATI ONAL International number N TYPE NATIONAL Default for 4ESS and VN6 National number variants N TYPE NET SPF N TYPE SUBSCRIBER N TYPE LOCAL N TYPE ABBREVIATED Plan values Network specific number Subscriber number AT5 local directory number Abbreviated number The following table lists the valid calling called and redirecting number plan values for ACU ALERT IN ACU CONN IN ACU CONN RQ and ACU SETUP REPORT IN messages These values are defined in isdnval h 184 Data types and constants in primitives Plan Description N PLAN UNKNOWN Default for all Unknown variants except VN6 N PLAN ISDN Default for VN6 and ISDN telephony numbering plan CCITT AusTel variants
105. EMENT Reserved for system management convergence function UU 1A5 default IA5 characters ASCII UUI V120 Rec V 120 UUI Q931 Rec Q 931 Signal values The following table lists the valid signal values in ACU ALERT IN ACU ALERT RQ ACU CALL PROC IN ACU CLEAR IN ACU CLEAR RQ ACU CONN CO and ACU PROGRESS IN messages These values are defined in isdnval h Signal value Description ACUDIAL ON Dial tone on ACURING BACK ON Ring back tone on ACUNET CONGEST ON Network congestion tone on ACUBUSY ON Busy tone on ACUTONES OFF Tones off ACUALERTING OFF Alerting off ACUCREDIT CARD TONE ON Credit card tone on ACUOUT OF RANGE TONE ON Out of range tone on ACUQUEUING TONE ON Queuing tone on 187 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Signal value ACUAUDIBLE TONE ON ACUVISUAL ALERT 1 ON ACUVISUAL ALERT 2 ON ACUSATCOM CALL NOTIFY Description Audible tone on Visual alert 1 on Visual alert 2 on SATCOM call notify Network provided clearing cause values The following table lists the valid network provided clearing cause values for ACU CLEAR CO ACU CLEAR IN and ACU SUSPEND CO messages These values depend upon the variant A list of values derived from various specifications is defined in decisdn h Network provided clearing cause CAU UNALL CAU NOR STN CAU NOR D CAU CH UNACC CAU AWARD CAU NORMAL CC CAU BUSY CAU NO USER RES CAU NO ANSW CAU REJ
106. HD ctahd ehari sac las 2014 Disable sii Ltrscipg First SC mySetTrace ctahd TRACE DISABLE Enable tracing for call control layer and the application Dr sprinti trace list SOS EN TAO ENTTAPEECTI mySetTrace porthd TRACH ENABLE trace list j isdnStartProtocol Starts up an ISDN protocol stack instance on a specified context Prototype DWORD isdnStartProtocol CTAHD ctahd unsigned protocol unsigned netoperator unsigned country unsigned partner equip unsigned nai void parms 57 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Argument ctahd protocol netoperator country partner equip nai parms Description Context handle associated with a D channel returned by ctaCreateContext Stack mode to start protocol instance in e SDN PROTOCOL Q931CC for ACU stack mode e SDN PROTOCOL LAPD for LAPD stack mode e SDN PROTOCOL CHANNELIZED for channelized stack mode Network operator variant to start Refer to Valid netoperator and country combinations Country mode in which the network operator variant starts A variant s behavior can change depending on the country specified Refer to Valid netoperator and country combinations country must be the same for all NAls on a single board Type of equipment connected to the board Refer to partner equip settings Network access identifier NAI of the D channel to link to the protocol stack ins
107. Hrm Hoc ACU CLEAR CO macro descriptions and Q 931 IE Macro Acu clear co a display Au clear co display size Acu clear co a display list 90 Description Pointer to display structure 442 pDMxOA Z z d Pointer to and size of buffer containing ISDN display information optional Q D T S P 1 I N 6 G S O S 7 x x x x x x x x x x x x Q 931 IE Display Display Macro Acu clear co a ext parms Acu clear co a facility Acu clear co facility size Acu clear co a pcs user Acu clear co pcs user size Acu clear co a q931 Acu clear co q931 size Acu clear co a uui Acu clear co uui size Acu clear co charging available Acu clear co charging multi Acu clear co charging period Acu clear co charging type Acu clear co charging value Acu clear co ext parms lgth Acu clear co ext parms nb Acu clear co network cause Acu clear co network cause loc Message primitives Description Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Pointer to and size of buffer containing ISDN user to user information optional Indicates that charging information is available
108. K U T O A S P 1 S 0 2 S S 6 G S T R I I N 6 S I T E W G S 0 E A A S 7 L N 1 Acu transfer status TE TE TE X X Acu transfer callid present Acu transfer callid Acu transfer size TE TE TE X X ACU TRANSFER CO macro descriptions and Q 931 IE Macro Description Q 931 IE Acu transfer status Type of result A value of 0 indicates Facility success and any other value indicates an error If successful an ACU CLEAR IN message may follow depending on the variant Acu transfer callid present A value of 1 indicates that the callid Does not map to field contains valid information an IE Acu transfer callid Information used to identify a call Does not map to an IE Acu transfer size The size of the structure Does not map to an IE ACU TRANSFER RQ This topic describes e ACU TRANSFER BO protocol variants e ACU TRANSFER RO macro descriptions and Q 931 IE Purpose Initiates the transfer of two calls The first call is the call for which this message is sent and the second call is identified by callid 179 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Conn id An allocated call ACU TRANSFER RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table TE indicates the TE side only and x indicates both NT and TE sides Macro 4 E N D E V H A N K T Q D T E 1 I M T N K U T O A S P 1 S O 2 S S 6 G S T R 1 I N 6 S l T E W G S O E A A
109. N NMS ISDN for Natural Call Control NMS ISDN Messaging API NMS ISDN Supplementary Services NMS ISDN Management API NaturalConference Service NaturalFax SAI Service NMS SIP for Natural Call Control NMS RJ 45 interface NMS RJ 21 interface Dialogic terminology Dialogic amp NaturalAccess Dialogic amp NaturalAccess API Dialogic amp NaturalAccess Processing API Dialogic amp NaturalAccess Dialogic amp NaturalAccess Dialogic amp NaturalAccess API Dialogic amp NaturalAccess Dialogic amp NaturalAccess API Dialogic amp NaturalAccess Dialogic amp NaturalAccess Dialogic amp NaturalAccess Dialogic amp NaturalAccess Dialogic amp NaturalAccess Supplementary Services Dialogic amp NaturalAccess Dialogic amp NaturalAccess API Dialogic amp NaturalAccess Dialogic amp NaturalAccess API Dialogic amp NaturalAccess Terminology CX Device Interface API Digital Trunk Monitoring Media Stream Protocol NaturalCallControl API GR303 and V5 Libraries Point to Point Switching Switching Interface API Voice Control Element CAS API ISDN API ISDN API ISDN Messaging API ISDN API ISDN Management API NaturalConference NaturalFax API Universal Speech Access SIP API Dialogic MD1 RJ 45 interface Dialogic MD1 RJ 21 interface Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual F
110. N protocol variants Message primitives Q 931 IE Not used Not used Not used Not used Not used The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro numa orm N72 Uzo Nm OS e QAI prm uoc Acu notify in a connected name X Acu notify in connected name size Acu notify in a ext parms Acu notify in ext parms nb Acu notify in ext parms lgth Acu notify in a q931 x x Acu_notify_in_q931_size 442 P pmzoma Z z 4 Q S I G nnZzuUu NO 0 ki cl 161 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU NOTIFY IN macro descriptions and Q 931 IE Macro Description Acu notify in a connected name Pointer to and size of buffer Acu notify in connected name size containing calling name Acu notify in a ext parms Pointer to buffer containing extended parameters Acu notify in ext parms nb Number of parameters in buffer containing extended parameters Acu notify in ext parms lgth Total length of buffer containing extended parameters Acu notify in a q931 Pointer to and size of buffer Acu notify in q931 size containing raw data of incoming Q 931 message ACU NOTIFY RQ This topic describes e ACU NOTIFY RO protocol variants e ACU NOTIFY RQ macro descriptions and Q 931 IE Purpose Requests that a NOTIFY message be sent Conn id An allocated call A
111. NG meaning that the outgoing call is cleared due to a call collision ACU CLEAR CO Conn Ack ACU CONN CO Incoming call continuation Time Time Incoming call established The ACU CLEAR CO message is relative to the ACU CONN RQ sent by the application The return code field in the primitive s message data is set to ACURC INCOMING meaning that the outgoing call is cleared due to a call collision No answer is sent by the application in response to this ACU CLEAR CO message Call collision at the network level occurs when the stack sends a SETUP message to the trunk directly before receiving a SETUP message from the trunk If the stack is configured as terminal equipment it abandons its call setup attempt and receives the incoming call The following illustration shows the sequence of messages exchanged in this situation ACU Q 931 Trunk stack Application The application requests placement of call 1 The request Setup 1 ACU_CONN_RQ 1 reaches the trunk Setup 2 ACU CONN IN 2 Meanwhile an incoming call arrives call 2 Rel Comp 1 ACU CLEAR CO 1 The trunk senses the collision and clears call Sg 1 Conn Ack 2 ACU CONN CO 2 Call 2 continuation Time Time Time Call 2 established 38 Call control ACU configuration If the ISDN stack is configured as network equipment it continues with its call setup attempt signaling the trunk to release the incoming call The following
112. NNECTED state for outbound calls Functional overview When lapddemo is run it performs the following tasks Task 1 210 Description It parses command line arguments and makes sure all arguments are valid and do not conflict It initializes Natural Access It starts the ISDN protocol stack on the board specified on the command line either as terminal equipment TE or as network equipment NT with the specified network operator variant and country variant It sends a SABME message on the trunk to establish the data link If you type S the program sends a SETUP message to the trunk Otherwise it waits for messages from the line If a Q 931 message is received the program decodes information from the message and responds with an appropriate message specified in the configuration file For example after receiving a SETUP message it may send an ALERTI NG message lapddemo LAPD demonstration program Using lapddemo Perform the following steps to run lapddemo Step 1 Action Set up the board keyword file to describe the board and software configuration For more information see the NMS ISDN Installation Manual and the NMS OAM System User s Manual Run oamsys to initialize your hardware and make your configuration file changes effective If necessary modify the demonstration configuration file lapddemo cfg For more information see lapddemo configuration file Start the demonstration by entering
113. NaturalAccess ISDN Messaging API Developer s Manual Value Protocol 16 QSIG 17 Hong Kong Telephone 20 US National ISDN 2 23 AT amp T 5ESS10 24 AT amp T 4ESS 25 Korea 50 Taiwan 51 DPNSS 52 ANSI T1 607 88 Northern Telecom DMS250 Note Use Eurol SDN for the following countries Austria China Denmark Finland Greece Iceland Ireland Italy Liechtenstein Luxembourg Netherlands Norway Portugal Russia Singapore Spain and Switzerland Using isdndemo Perform the following steps to use isdndemo Step Action 1 Set up the boards in a configuration that allows one trunk to talk with another For example install two boards and connect a cable between their trunk connectors Do not link the boards together over the CT bus For NFAS configurations you can also install a single CG 6000C and connect a cable between two trunk connectors 2 Start oamsys to configure and boot the boards 200 isdndemo Layer 3 call control Step Action 3 Use isdndemo by either invoking an instance of the demonstration program with two active D channels or by invoking two separate instance of the demonstration program to call each other To invoke one instance of the demonstration program with two active D channels using the D option enter isemcalsmo a Y ENSE 20 D 9 1 a 10 If you specify a protocol variant for one D channel the other uses the same variant unless otherwise specified All other parameters such as board NT TE
114. RA 1200 1 2 kbit s CCITT V 6 ACU RA 1200 75 1 2 0 075 kbit s CCITT V 6 and x 1 ACU RA 2400 2 4 kbit s CCITT V 6 and X 1 ACU RA 3600 3 6 kbit s CCITT V 6 ACU RA 4800 4 8 kbit s CCITT V 6 and x 1 ACU RA 7200 7 2 kbit s CCITT V 6 ACU RA 8000 8 kbit s CCITT 1 460 ACU RA 9600 9 6 kbit s CCITT V 6 and x 1 ACU RA 12000 12 kbit s CCITT V 6 181 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Rate Description ACU_RA_14400 14 4 kbit s CCITT V 6 ACU_RA_16000 16 kbit s CCITT 1 460 ACU_RA_19200 19 2 kbit s CCITT V 6 ACU_RA_32000 32 kbit s CCITT 1 460 ACU_RA_38400 38 4 kbit s extended V 14 ACU_RA_38400_NO_ETSI 38 4 kbit s extended V 14 VN3 NON ETSI ACU RA 48000 48 kbit s CCITT V 6 and X 1 ACU RA 56000 56 kbit s CCITT V 6 ACU RA 57600 57 6 kbit s extended V 14 VN3 NON ETSI NON CCITT ACU RA 64000 64 kbit s CCITT 1 460 Service values The following table lists the valid service values for ACU CONN CO ACU CONN IN ACU CONN RQ ACU CONN RS ACU FACILITY IN ACU FACILITY RQ and ACU SETUP REPORT IN messages These values are defined in isdnval h Service Description FAX SERVICE G3 facsimile service FAX 4 SERVICE G4 facsimile service DATA SERVICE Data service DATA GCI SERVICE Data service on GCI bus DATA 56KBS SERVICE Data at 56 kbits s service RAW DATA SERVICE Raw data service on GCI bus no MPH B INIT RQ is generated no B channel driver is associated DATA TRANS SERVICE Transparent data service
115. S 7 L N 1 Acu transfer status Acu transfer callid present TE TE TE X x Acu transfer callid TE TE TE X x Acu transfer size TE TE TE X x ACU TRANSFER RO macro descriptions and Q 931 IE Macro Description Q 931 IE Acu transfer status This field is ignored for this message Does not map to an IE Acu transfer callid present A value of 1 indicates that the callid field Does not map contains valid information If this is true the to an IE callid will represent the second call If the callid field does not contain valid information the second call will be implicitly chosen if allowed by the protocol variant Acu transfer callid Information used to identify a call Facility Acu transfer size The size of the structure Does not map to an IE 180 10 Data types and constants in primitives User rate values The following table lists the valid user rate values for ACU CONN IN ACU CONN RQ ACU CONN RS and ACU SETUP REPORT IN messages These values are defined in isdnacu h Rate Description ACU RA 50 0 050 kbit s CCITT V 6 and X 1 ACU RA 75 0 075 kbit s CCITT V 6 and X 1 ACU RA 75 1200 0 075 1 2 kbit s CCITT V 6 and x 1 ACU RA 100 0 100 kbit s CCITT V 6 and X 1 ACU RA 110 0 110 kbit s CCITT V 6 and X 1 ACU RA 134 0 1345 kbit s CCITT X 1 ACU RA 150 0 150 kbit s CCITT V 6 and X 1 ACU RA 200 0 200 kbit s CCITT V 6 and X 1 ACU RA 300 0 300 kbit s CCITT V 6 and X 1 ACU RA 600 0 6 kbit s CCITT V 6 and x 1 ACU
116. S T312 ETS T313 ETS T316 not exposed to the API ETS T317 not exposed to the API ETS T318 ETS T319 ETS T320 ETS T321 ETS T322 Value network side in seconds 30 30 180 90 40 120 100 30 30 AT amp T E10 layer 3 timer defaults timer val t elO E10 T LAST Timer index E10 T300 E10 T303 E10 T305 E10 T306 Value network side in seconds 2 4 Timers Value user side in seconds 30 0 0 4 90 45 120 100 Value user side in seconds 2 4 257 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Timer index E10 T308 E10 T309 E10 T310 E10 T313 Value network side in seconds 4 90 10 N A E10 T316 not exposed to the API 30 E10 T317 not exposed to the API 120 E10 T321 not exposed to the API 5 E10 TSRV not exposed to the API O Nortel DMS 100 layer 3 timer defaults timer val t dms DMS T LAST Timer index DMS T300 DMS T301 DMS T303 DMS T305 DMS T308 DMS T309 DMS T310 DMS T312 DMS T313 DMS T7316 not exposed to the API DMS T317 not exposed to the API 258 Value network side in seconds 1 180 4 30 4 90 10 6 N A 120 0 Value user side in seconds 4 90 45 4 30 120 60 Value user side in seconds 1 0 30 90 45 120 100 Timer index DMS T321 not exposed to the API DMS T322 DMS T3DW not exp
117. SA COUNTRY FRA COUNTRY AUS COUNTRY AUS COUNTRY BEL COUNTRY GER COUNTRY SWE COUNTRY SGP COUNTRY GBR COUNTRY CHINA COUNTRY EUR COUNTRY HONG KONG COUNTRY KOR COUNTRY JPN COUNTRY TWN NA COUNTRY EUR Function reference Country USA France Australia Australia Belgium Germany Sweden Singapore Great Britain and China COUNTRY EUR includes the following countries Austria Belgium Denmark Finland Germany Greece Iceland Ireland Italy Liechtenstein Luxembourg Netherlands Norway Portugal Russia Spain Sweden Switzerland and the UK Hong Kong Korea Japan Taiwan country is ignored if variant is QSIG Europe The following table shows the ISDN and DPNSS run module files for NMS boards 59 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Board AG except for AG 2000 BRI boards CG 6565 C CG 6060 C ISDN isdngen leo c6565igen dlm c6060igen dlm DPNSS dpnss leo c6565dpnss dlm c6060dpnss dlm For AG 2000 BRI boards the following table shows the valid netoperator values and the corresponding run module file netoperator value ISDN_OPERATOR_ETSI ISDN_OPERATOR_NTT ISDN OPERATOR VN6 partner equip settings Variant ETSI NTT VN6 Run module file brietsi leo brintt leo brivn6 leo Refer to the following table when setting the partner equip argument If board is Connected to network Conn
118. SP 1 S O 2 S S6G ST RI I N 6 S l T E W GSO E A A S 7 L N 1 Acu conn rq a pcs user x Acu_conn_rq_pcs_user_size Filling order 8 Acu_conn_rq_a_redir_nb X X X X Acu_conn_rq_redir_nb_size Filling order 4 Acu_conn_rq_a_ss_cnip_name x Acu_conn_rq_ss_cnip_name_size Filling order 11 Acu conn rq a tsp ie list X X IX IX X X X X x x x x Acu conn rq tsp ie list size Filling order 12 Acu conn rq a uui x x x X X x Acu_conn_rq_uui_size Filling order 5 Acu_conn_rq_auto_dial Acu_conn_rq_call_ appear X X Acu_conn_rq_callid_rq x X Acu_conn_rq_called_nb_plan X X X x X X X x Acu conn rq called nb sub odd even x x Acu conn rq called nb sub type X X X x Acu conn rq called nb type X X X X X x X X X x Acu conn rq calling nb2 pres x Acu conn rq calling nb2 screen x Acu conn rq calling nb2 type x 127 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E N E 1 S 0 2 S Acu_conn_rq_calling_nb_plan X X X Acu_conn_rq_calling_nb_ pres Acu_conn_rq_calling_nb_ screen Acu conn rq calling nb sub odd even Acu conn rq calling nb sub type Acu conn rq calling nb type X X Acu conn rq charging rq Acu conn rq data bits Acu conn rq data chani X X x Acu_conn_rq_data_chani_ excl X X x Acu_conn_rq_data_chani_nai X X x Acu_conn_rq_data_chani_nb X X x Acu_conn_rq_data_chani_tab X X x Acu_conn_rq_data_chani_tab_nai X X x Acu_conn_rq_ext_parms_lgth x Acu conn rq ext parms n
119. T T307 HKT T308 HKT T309 HKT T310 HKT T312 HKT T313 HKT T314 not exposed to the API HKT T316 not exposed to the API HKT T317 not exposed to the API HKT_T318 HKT_T319 HKT_T320 HKT_T321 HKT_T322 Value network side in seconds 1 180 10 20 30 30 180 90 10 120 90 30 30 Timers Value user side in seconds 1 180 15 15 30 90 10 120 100 30 261 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual I NS 1500 NTT layer 3 timer defaults timer val r nttl NIT I LAST Timer index NTT T300 NTT T301 NTT T303 NTT T305 NTT T306 NTT T307 NTT T308 NTT T309 NTT T310 NTT T312 NTT T313 NTT_T314 not exposed to the API NTT_T316 not exposed to the API NTT_T317 not exposed to the API NTT_T318 NTT_T319 NTT T322 NTT T3JA 262 Value network side in seconds 3 180 30 30 180 90 10 120 100 Value user side in seconds 3 0 30 90 45 120 100 50 Timers AT amp T 4ESS layer 3 timer defaults timer val t at4 ATA4 T LAST Timer index AT4_T300 AT4_T303 AT4_T305 AT4_T306 AT4_T308 AT4_T309 AT4_T310 ATA T313 AT4_T316 not exposed to the API AT4_T317 not exposed to the API AT4_T321 not exposed to the API AT4 T3MI1 not exposed to the API Value network side in Value user side in seconds seconds 1 1 4 4 4 4 60 4 4 9
120. TART is sent After a RESTART is received Reset When a REL or REL COM is received When a REL or DISC is received When a RESUME ACK is received When a REL or REL COM is received When a data link establish message is received When an ALERT CONN DISC or PROG is received When CONN ACK is received After last message segment is received On expiration The link is placed in maintenance state and CRVs are released A REL is sent on the line ACU CLEAR CO is sent to the application The call is cleared ACU CLEAR CO is sent to the application The link is placed in maintenance state and CRVs are released All calls are cleared locally A DISC is sent A DISC is sent The incomplete message is discarded A RESTART is sent and the timer is restarted A maintenance indication sent to the application Timer T318 T319 T320 T321 T322 France VN6 layer 3 timer defaults Description Used when the state of the call is suspend request Used when the state of the call is suspend request nternal timer Controls the internal timing of backup D channels Controls the behavior of STATUS ENQUIRY timer val t vn6 VN6 T LAST Timer index VN6 T300 VN6 T301 VN6 T302 VN6 T303 VN6 T304 VN6 T305 VN6 T306 VN6 T307 Started When a RESUME message is sent When a SUSPEND message is sent When a
121. TER 0 Provided parameters are associated with the facility ACU SPF FAC BINARY 1 Use the binary facility 270 Modifying the NSF IE serv feature Setting Value Description ACU FAC SERVICE 1 Service ACU_FAC_FEATURE 0 Feature Facility Coding If serv_feature is set to ACU_FAC_SERVICE then Setting Value Description ACU FAC CPN SID PREFERRED 1 CPN SID preferred ACU FAC BN ANI PREFERRED 2 BN ANI preferred ACU FAC CPN SID ONLY 3 CPN SID only ACU FAC BN ANI ONLY 4 BN ANI only ACU FAC CALL ASSOC TSC 9 Call associated TSC ACU FAC TSC CLEAR RU 10 Notification of call associated TSC clearing or resource unavailable ACU FAC OPERATOR 5 Operator ACU FAC PCCO 6 Pre subscribed common carrier operator If serv feature is set to ACU FAC FEATURE then Setting Value Description ACU FAC SDN 1 ISDN including GSDN ACU_FAC_MEGACOM_800 2 Access to MEGACOM 800 ACU FAC MEGACOM 3 Access to MEGACOM ACU FAC ACCUNET 6 ACCUNET ACU FAC LONG DISTANCE 7 International long distance ACU FAC INTERNATI ONAL 800 8 International 800 ACU FAC ATT MULTIQUEST 16 AT amp T MultiQuest 271 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual param fid Setting Value Description ACU FAC VARI A BILL 6 Vari A Bill flexible billing The NSF IE structure is treated as an extended data structure The acu ext descr structure is placed in the ACU message primitive Refer to the Example to learn how to fill in the structures Example
122. VE REJ Call clearing messages MSG DISCONNECT MSG RESTART MSG RELEASE MSG RESTART ACK MSG RELEASE COMP Miscellaneous messages MSG SEGMENT MSG FACILITY MSG REGISTER MSG NOTIFY MSG STATUS ENQ MSG CONGESTION CTRL MSG INFO MSG STATUS Hexadecimal value Ox2E 0x30 0x31 0x33 0x37 0x45 0x46 0x4D Ox4E Ox5A 0x60 0x62 0x34 Ox6E 0x75 0x79 Ox7B 0x7D Messages not defined in Q 931 Q 932 MSG_SERVICE MSG_SERVICE_ACK 222 OxOF 0x07 Notes Q 931 Q 932 Q 932 Q 932 Q 932 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 932 Q 931 Q 931 Q 931 Q 931 Q 931 According to 235 900 342 5ESS According to 235 900 342 5ESS dectrace Stack traffic analysis tool I nformation elements dectrace decodes all the information element identifiers defined in the Q 931 Q 932 specifications The following table lists the information element identifiers Message Hexadecimal Notes value Single octet information elements IE SHIFT 0x90 All values from 0x90 to Ox9F indicate shift IE MORE DATA OxAO More data IE SENDING COMPL OxA1 Sending complete IE CONG LEVEL OxBO All values from OxBO to OxBF indicate congestion level E REPEAT IND OxDO All values from OxDO to OxDF indicate repeat indicator Variable length information elements IE SEGMENTED 0x00 Segmented message IE BC 0x04 Bearer capability IE CAUSE 0x08 Cause IE CONNECTED OxC Connected par
123. X X x x X Acu alert rq data chani nai Acu alert rq data chani nb X x x x Acu_alert_rq_data_chani_tab X X X x Acu alert rq data chani tab nai Acu alert rq ext parms lgth 76 Macro 4 E N DE V H A E 1 MT N K U S O 2 S S 6 G S S l T E L 1 Acu alert rq ext parms nb Acu alert rq pcs user protocol x Acu alert rq progress descr x i Acu alert rq progress description Acu alert rq progress ind nb Acu alert rq progress loc x i Acu alert rq progress location Acu alert rq signal val Acu alert rq ss cnip name active Acu alert rq ss cnip name pres Acu alert rq uui protocol Acu alert rq x display nb Acu alert rq x display size i Acu alert rq x display total size Acu alert rq x display type i Acu alert rq x p display i ACU ALERT RQ macro descriptions and Q 931 IE Description Acu alert rq a display Pointer to and size of buffer Acu alert rq display size containing ISDN display info Filling order 2 optional 442 Message primitives PMAOA ano ZDS DA nnZzuUU N OO ki Q 931 IE Display 77 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu alert rq a display list Acu alert rq a ext parms Acu alert rq a pcs user Acu alert rq pcs user size Filling order 3 Acu alert rq a ss cnip name Acu alert rq ss cnip name size Filling order 4 Acu alert rq a tsp ie list Acu alert rq tsp ie list size Filling order 5 Acu alert rq a uui Acu alert rq uu
124. Y assignments The default assignments NS_PBX_XY 0 are TE 2 PBX A side X NT gt PBX B side Y Setting this bit changes the assignments to TE gt PBX A side Y NT gt PBX B side X DPNSS only This bit supports the following channel configuration Channel Configuration Configuration 1 2 1 X Y 2 Y X 14 Y X 15 X Y 16 none signaling 17 X Y 18 Y X 30 Y X 31 X Y If this bit is not set all channels have the same configuration as channel 1 If this bit is set all odd channels 1 3 15 17 31 have the same configuration as channel 1 All even channels 2 4 6 14 16 30 have a configuration opposite to that of channel 1 for example Y if channel 1 is X and vice versa If this bit is set the ISDN stack behaves as if none of the other ns_behaviour bits are set If ns behaviour is set to 0 or not set at all the ISDN protocol stack behaves as if the NS IE RELAY BEHAVIOUR bit is set and all other bits are cleared 244 Parameters qsig source party nb type field The qsig source party nb type field in ISDN PROTOCOL PARMS Q931CC is used when the application is designed for a Q SIG private ISDN exchange PINX Each node in a Q SIG network has an address This field is used with qsig source type of nb and qsig source addr to specify the address of the node The qsig source party nb type field specifies the type of PINX node address The following table lists possible values
125. a e duh don Poit a ames etait ae A Sakon Eua 112 ACU CONN IN protocol variants cece terre HH mememememese mne 113 ACU CONN IN macro descriptions and Q 931 IE sss 117 ACULCONN orm EP 125 ACU CONN BO protocol variants memes 125 ACU CONN BO macro descriptions and OO31lIE e 130 ACU CONN RS suo e tea der peter vu teres ld dado Pra exc UR RN RN 138 ACU CONN RS protocol varlante e memes 138 ACU CONN RS macro descriptions and OO321IE e 142 ACU D CHANNEE STATUS IN iei i c repehner are evenness hed eta Henr Ene n RI EE REIN 147 ACU D CHANNEL STATUS IN protocol vartante e 147 ACU D CHANNEL STATUS IN macro descriptions and Q 931 IE sssss 148 ACU D CHANNEL STATUS RO erri er rere rhone ore ne neh Er ree ge e Ran 148 ACU D CHANNEL STATUS RO protocol variants e 148 ACU D CHANNEL STATUS RQ macro descriptions and Q 931 lE eee 149 ACW DIGIT E emm 149 ACU DIGIT IN protocol variants ssssssssssss IH mmememememn een 149 ACU DIGIT IN macro descriptions and OO31IE e 150 ACU DIGIT OL MI 151 ACU DIGIT BO protocol vartante memes 151 ACU DIGIT RQ macro descriptions and Q 931 IE oo e 152 ACU ERRAIN EP ME 153 ACU ERR IN protocol variants ssssssssssssse IH ememememememesen nnn 153 ACU ERR IN macro descriptions and Q 931 IE sss e 154 ACW e H Dep EN EE 154 ACU FACILITY IN protocol variants sssssssssssee HH
126. a exceeds MAX ISDN BUFFER SIZE 53 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Events Event name Description ISDNEVN SEND MESSAGE The event value field contains one of the following reasons or an error code SUCCESS ISDNERR BAD NAI The network access identifier NAI in the message structure is not valid the NAI must be less than MAX NAI specified in isdnparm h or an nfas group and NAI couple is not valid if duplicate NAI values are defined ISDNERR BUFFER TOO BIG The size of the buffer is too large Details This function sends a message with optional attached data to the ISDN subsystem Any ISDN specific command can be sent to any layer of the protocol stack using this function The ISDN MESSAGE structure contains the addressing information for the message The size field of the event contains the user ID for the message as specified in the userid field in ISDN MESSAGE This value is sent to distinguish between multiple messages sent to the protocol stack ISDN USERID ASYNC is reserved for events initiated by the protocol stack If multiple NAI values have not been defined it is recommended to set nfas group to O See also isdnReleaseBuffer Example DWORD sample send message CTAHD ctahd int mycode CTA_EVENT event DWORD ret ISDN MESSAGE imsg 0 code t code unsigned char idata MAX ISDN BUFFER SIZE unsigned datasize Protocol already started SS imsg nai
127. ace to instruct the AG driver to send NMS ISDN protocol stack trace messages to oammon For CG boards run oammon to configure your boards as described in the board keyword file and to enable error logging For AG boards this is done automatically Run the NMS ISDN protocol stack For CG boards use the oammon f command to specify the log file on the command line For AG boards the default name of this file is agpierror log dectrace compilation dectrace is supplied in executable form as well as source code To recompile dectrace enter one of the following commands 218 dectrace Stack traffic analysis tool Operating Directory Command system Windows nms ctaccess demos dectrace nmake UNIX opt nms ctaccess demos dectrace make For more information see the readme file that came with the NMS ISDN software package dectrace files dectrace consists of the following files e dectrace c e dectrace h e decisdn c e decisdn h Creating a log file for dectrace dectrace reads the log file created by oammon agpierror log By default this file does not contain NMS ISDN protocol stack messages To enable oammon to log messages from the stack use either or both of the following utilities Utility Description agtrace agtrace takes as parameters e A bit mask e The board number default 0 e The channel number default 0 To trace the NMS ISDN protocol stack set the 0x80000 bit To enable oammon to display an
128. al the installation manual for your board and the NMS OAM System User s Manual Sending I SDN messages to the stack To send a message to the NMS ISDN protocol stack the application builds two structures Structure Description ISDN MESSAGE In this structure the application specifies the message to be sent using one of the message primitives For more information refer to Overview of message primitives The message primitive appears in the code field in this structure For details about ISDN MESSAGE see ISDN MESSAGE structure A message For messages that require additional data a message structure structure containing the data is sent The data differs for each message optional type For details on each message type see Overview of message primitives The application then calls isdnSendMessage in the NMS ISDN library The ctahd argument in the function call specifies the context of the trunk on which the call is taking place message is a pointer to ISDN MESSAGE pdata is a pointer to the associated message structure if any size is the size of the message structure if any 19 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual The following illustration shows the content and meaning of each of the arguments sent in isdnSendMessage ISDN_MESSAGE structure Contains o primitive e g ACU_CONN_IN o data size size o other data 4 isdnSendMessage ctahd message p data size
129. all proc in a pcs user Pointer to and size of PCS User Acu call proc in pcs user size buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Acu call proc in a q931 Pointer to and size of Does not map to an IE Acu call proc in q931 size buffer containing raw data of incoming Q 931 message 83 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Q 931 IE Acu_call_proc_in_call_ref_length Length of call reference Call reference value Acu_call_proc_in_call_ref_value Call reference value Call reference and call reference flag Acu call proc in cause Cause value Cause Acu call proc in data chani Data channel to use Channel identification B1 B2 D Acu call proc in data chani excl Channel IDs are Channel identification preferred OFF or exclusive ON Acu call proc in data chani nai NAI Channel identification Acu_call_proc_in_data_chani_nb Number of channel IDs Channel identification in the chani list field If no channel IDs use 0 Acu call proc in data chant tab i Channel ID i Channel identification Acu call proc in data chani tab nai i NAI i Channel identification Acu call proc in ext parms lgth Total length of buffer Not used containing extended parameters Acu call proc in ext parms nb Number of parameters Not used in buffer containing extended parameters Acu call p
130. ameter Meaning Allowed values Default ID Called number applies to the SETUP One or more digits 12345 message IA Calling number applies to the SETUP One or more digits 678 message IB B channel applies to the SETUP Decimal value 12 message IE Encoding applies to the SETUP 2 mu law 3 message 3 A law IC Cause applies to the DISCONNECT Decimal value 16 message Message exchange rules Each rule specifies a command for lapddemo to send or a task for lapddemo to perform when certain events happen such as when a message is received or a timer expires Each rule appears on a separate line A rule is formatted as follows cause direction command where cause is a message or event code from the following table Code Message or event S SETUP A ALERTI NG 213 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Code Message or event K CALL PROCEEDING P PROGRESS C CONNECT C CONNECT ACK D DISCONNECT R RELEASE r RELEASE COMP T TI MER T 2 s t TI MER T 1 s direction specifies whether lapddemo performs the response when a message is received a message is sent or a timer expires Indicator Meaning i Incoming message or an expiring timer lapddemo takes the action if message cause is received or timer cause expires O Outgoing message lapddemo takes the action when it sends message cause command is the message for lapddemo to send or the timer for lapddemo to set when cause happ
131. aming errors allowed during the T198 interval Milliseconds 750 of bad framing before disabling sending of D channel packets Milliseconds 50 of good framing before enabling sending of D channel packets Observation 5 period for frame error count TEI time 0 assignment TEI time 0 removal TEI values 0 Number of 0 digits needed to route when using overlap receiving Incoming 0 calls behavior Outgoing calls O behavior Range of values 0 or more ms 0 or more ms 0 or more ms O or more seconds reserved reserved reserved 0 or more See in calls behaviour field See out calls behaviour field Type WORD WORD BYTE BYTE BYTE BYTE BYTE BYTE BYTE Parameter ns behaviour acu behaviour qsig source party nb typ e qsig source type of nb qsig source addr aoc s presubscribed aoc d presubscribed aoc e resubscribed bpad2 1 Description Bits controlling NS automatic responses Bits controlling ACU automatic responses Type of PINX node address Used for network node addressing in supplementar y services Type of public PINX number Used for network node addressing in supplementar y services Node address Availability of Advice of Charge Start of Call supplementar y service Availability of Advice of Charge Start of Call supplementar y service Availability o
132. amp ipkt message data ipkt gt data printf from c code c to c id d len d n 51 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual imsg from ent imsg code imsg to ent Seet ra ll ipkt data len switch EVENT_CODE imsg gt from_ent imsg code case EVENT CODE ENT_ACU CONN COCO Y Call is now connected SCH printf Connected on conn id d n imsq gt add conn_id break case EVENT CODE ENT ACU ACU CLEAR CO Call is now cleared SCH printr CLleared on conn EE E EE break default printf Unprocessed message c c n imsg from ent imsg code break Processing is done release the buffer as soon as possible SEN ret isdnReleaseBuffer ctahd event buffer 1 ret SUCCESS ctaGetText ctahd event value errortext 40 printf RELEASE FAIL s n errortext return MY ERROR RELEASE FAILED isdnSendMessage Sends a message to the ISDN stack with optional attached data Prototype DWORD isdnSendMessage CTAHD ctahd ISDN MESSAGE message void pdata unsigned size Argument Description ctahd Context handle associated with a D channel returned by ctaCreateContext 52 Argument Descr message Pointer to ISDN MESSAGE structure as follows iption typedef struct ISDN MESSAGE Function reference noi t nat Network access interface index y ent_id_t from_ent Me
133. and D channel backup A single NFAS group can contain trunks from multiple boards as shown in the following illustration MVIP bus AG 4000 board 24 B channels NFAS group 2 A TN 24 B channels NFAS group 2 oard TEES T1 23 B channels D channel for trunks in NFAS group 1 trunks 4 B channels NFAS group 1 24 B channels NFAS group 1 23 B channels D channel for trunks in NFAS group 2 AG 4000 T board If the application uses NMS ISDN in a channelized configuration all trunks in an NFAS group must be on the same board An NFAS group cannot contain trunks from multiple boards This restriction does not apply to the ACU configuration or the LAPD configuration Setting up and using NFAS NFAS groups are specified in the board keyword file In the file you specify which trunks on which boards belong to which groups You also specify which trunk in the group will carry the D channel All other trunks are set to Networklnterface T1El x SignalingType RAW so all 24 channels on these trunks can be used as D channels For more information see the NMS ISDN Installation Manual Your Messaging API application initializes just as described in Initialization tasks The only difference is that when the application calls isdnStartProtocol the NAI specified in the call can be greater than 3 The fact that a given trunk is a part of an NFAS group and the D channel resides elsewhere is largely transparent to the application There are t
134. ansmission links Data on a T1 or E1 trunk is transmitted in channels For primary rate ISDN a T1 trunk carries 24 channels An El trunk carries 32 channels With primary rate ISDN the channels are usually used as follows e Ona Tl trunk 23 of the 24 channels carry data voice audio data and or video signals These channels are called bearer channels B channels On an E1 trunk 30 of the 32 channels are bearer channels e OnaTlorEl trunk one channel carries signaling for all B channels This is called the D channel On T1 trunks the D channel is typically carried in channel 24 On E1 trunks channel 16 is used as the D channel The following illustration shows an AG 4040 T standard configuration B channels D channel for these Channel B channels D channel for these channels Ti AG 4040 T board B channels D channel for these channel trunks B channels D channel for these channel NFAS configurations are supported on T1 trunks only In an NFAS configuration trunks are grouped into one or more NFAS groups One of the trunks in each group has a D channel carrying the signaling for all of the B channels on all of the trunks in the group This leaves channel 24 free on all other trunks in the NFAS group This extra channel can be used as another B channel The following illustration shows a sample NFAS configuration B channels D channel for all four truni 4 B channels Ti AG 4040 T board TE danna tuni B cnanne 266 NFAS
135. applicable Not applicable Message primitives Purpose Acknowledges incoming call proceeding information Conn id An allocated call ACU SETUP ACK IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4E NDE V HANK T QD T E11 MT N KUTOA SP 1 S02 S SI 6 GS TRI I N 6 S T EWGSO E A A S7 L N 1 Acu setup ack in a display x X x X XX x x Acu setup ack in display size Acu setup ack in a display list X X X X X X x x Acu setup ack in a ext parms Acu setup ack in a facility X x x Acu_setup_ack_in_facility_size Acu setup ack in a pcs user Acu setup ack in pcs user size Acu setup ack in a q931 X XXX X X IX IX IX X X x X Acu setup ack in q931 size Acu setup ack in cause Acu setup ack in data chani X IX X X X X IX IX IX X X X x x Acu setup ack in data chani excl Acu setup ack in data chani nai x Acu setup ack in data chani nb x Acu setup ack in data chani tab i Acu setup ack in data chani tab nai i Acu setup ack in ext parms lgth 175 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4E NDE VHANKT QD E11 MT NKUT OA SP S02 S SI 6 GS TRI IN S T E WGS E A A S L N 1 Acu setup ack in ext parms nb Acu setup ack in progress descr x i Acu setup ack in progress description X X X x xX X Acu_setup_ack_in_progress_ind_nb xX X X x x x Acu setup ack in
136. application 16 3 Messaging API programming model seseseeee sene annnm nan EEN 17 Natural Access enmvironment sese esee esee esee ese ese enne 17 Natural Access components cece esee esee ese tenes enin esee enne enne 17 Natural Access programming model 17 NMS ISDN Messaging API application overview sessssss HH 18 IIA ZING e Leg e 19 Sending ISDN messages tothestack cece eect eee eee ene eee need 19 Building ACU message structures ieee mese ese esee esie enne nens 20 Sending LAPD messages ecc inire epe EN a ENEE ee ke dk ak Te dpe Exe EN e 22 Receiving events and ISDN protocol stack messages 23 Receiving messages from the NMS ISDN protocol stack 24 4 Initializing a Messaging API application oommccconocnnnncnnnacnnnncnnnncanancnnancnnanonas 27 Initializatlon tasks tiep dias 27 Task 1 Route channel data to on board resources 6 cece eect e tenet eee eee 27 Task 2 Create contexts for channels ccccceee etcetera een ene na eee 28 Task 3 Call isdnStartProtocol ccce gesendet eher ete nemen ee ene din edie 28 Task 4 Start NOCC TCPs on B channel contexte 29 Making switch connections for NMS IDN 29 Initializing Natural Access 31 Specifying B channel contexts sss esee esee esee sehen nnn 31 Specifying D channel contexts see eene 31 Accessing D channels acepte tpe ed NEE SEENEN dade ote ERR NENNEN dete nile Ne ere sie edie 32 Netwo
137. ariants e ACU D CHANNEL STATUS IN macro descriptions and Q 931 IE This message primitive can be returned when e An ACU D CHANNEL STATUS RQ primitive is sent to the stack e The Acu send d channel status change bit is set in the Acu behaviour substructure included in ISDN PROTOCOL PARMS Q931CC This message primitive must be sent to the ACU SAPI MGT SAPI rather than the ACU SAPI To do so specify ACU SAPI MGT in the to sapi field in the outgoing ACU MESSAGE structure Purpose Indicates the status of the D channel Conn id An allocated call ACU D CHANNEL STATUS IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides E N D E I 1 M T 0 2 S S l Macro V H N Q N K T S 6 G T l G numa Prmancp PMAOA SZ PS P noz uug NOOP x lt x lt x lt x lt x lt x lt x lt Acu_d_channel_state x x x x x x x Acu_d_channel_nb x 147 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU D CHANNEL STATUS IN macro descriptions and Q 931 IE Macro Description Q 931 IE Acu_d_channel_state State of D channel Does not map to an IE 0 OFF 1 ON Acu_d_channel_nb Equivalent to B channel number Does not map to an IE for DPNSS only ACU D CHANNEL STATUS RQ This topic describes e ACU D CHANNEL STATUS RQ protocol variants e ACU D CHANNEL STATUS RQ macro descriptions and Q 931 IE
138. as in incoming transparent mode Layer 3 procedures are still in use You can send IEs transparently to the line using a second buffer possibly including unknown or unexpected IEs The NS layer does not consider unknown or unexpected IEs received from the line as erroneous Setting this bit applies when the configuration is ETS EUROPE TE side outgoing call If this bit is set the ISDN stack sends a CONNECT ACK message in response to a received CONNECT message If this bit is set outbound call control messages for example SETUP or PROCEEDI NG contain the NAI in the channel ID IE as defined in the configuration file Use this bit only for US variants This bit applies when the configuration is DMS and USA and for an incoming call When it is set the extension bit in the channel ID s octets 3 3 is set to the value used in the SETUP message for use inside PROCEEDING or ALERT messages Reserved for test purposes only This bit is used to disable the RESTART procedure in the stack If this bit is set the stack does not send RESTART messages when it is stopped but it also does not respond to incoming RESTART messages Do not set this bit unless you are certain that the remote end does not implement the RESTART procedure 243 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Value NS_PBX_XY NS_PBX_XY_ALTERNATE NS_BEHAVIOUR_NIL Description DPNSS only This bit reverses the default X and
139. ate time Date time Macro Acu conn rs ext parms length Acu conn rs ext parms nb Acu conn rs hour Acu conn rs minute Acu conn rs month Acu conn rs p display i Acu conn rs parity Acu conn rs pcs user protocol Acu conn rs ph rate Acu conn rs priority Acu conn rs second Acu conn rs service Message primitives Description Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Hour Minute Month Pointer to occurrence i Parity for V 110 and V 120 services Available values include ACU ODD odd parity ACU EVEN even parity ACU NO PARITY no parity Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Physical rate for all services Answer priority Valid values include ACU PHIGH ACU PLOW Second Agreed service Can be different than the one stored in ACU CONN IN See Service values for a list of valid values Q 931 IE Not used Not used Date time Date time Date time Display Bearer capability PCS user Low layer compatibility Low layer compatibility Date time bc hic Ilc 145 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rs ss cnip name active Acu conn rs ss cnip name pres Acu conn rs stop bits Acu conn rs syn asyn Acu conn rs user rate Ac
140. ation See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Pointer to and size of buffer containing redirecting number Pointer to and size of buffer containing calling name identification presentation CNI P name Z z 4 Dr WO nnz2zUvU NOOrF 4 x Q 931 IE Display Display Not used Facility PCS user Does not map to an IE Redirecting number CNIP Macro Acu alert in a uui Acu alert in uui size Acu alert in alert Acu alert in call ref length Acu alert in call ref value Acu alert in data chani Acu alert in data chani excl Acu alert in data chani nai Acu alert in data chani nb Acu alert in data chani tab i Acu alert in data chani tab nai i Acu alert in ext parms lgth Acu alert in ext parms nb Message primitives Description Pointer to and size of buffer containing ISDN user to user information optional Code indicating which alert was detected Used when the behavior bit CC SEND ALERT IN is used Valid values include ACUAC RING Ring detected ACUAC REMOTE ALERTED Remote equipment alerted Length of call reference value Call reference value and call reference flag Data channel to use B1 B2 D Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani_list field If no channel IDs use 0
141. ation not available Number of stop bits for V 110 and Low layer V 120 services only Available compatibility values include ACU STOP BIT 1 1 stop bit ACU STOP BIT 1 5 1 5 stop bits ACU STOP BIT 2 2 stop bits Synchronous asynchronous for Low layer V 110 and V 120 services compatibility Available values include ACU SYN Synchronous mode ACU ASYN Asynchronous mode Connection ID of the call to be Facility transferred Request transfer ON OFF Facility Requested user rate for V 110 Low layer and V 120 services See User rate compatibility values for a list of valid values UUI protocol discriminator value User to user See UUI protocol discriminator information values for a list of valid values Default UUI_IA5 UUI USER SPF for HKG variant Number of present occurrences Display 137 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Acu conn rq x display size i Size of occurrence i optional Acu conn rq x display total size Acu conn rq x display type i Type of display i ACU CONN RS This topic describes e ACU CONN RS protocol variants e ACU CONN RS macro descriptions and Q 931 IE Total size of the stored strings Q 931 IE Display Display Display Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to 0 Purpose Answers an incoming call Conn id An allocated call
142. b X Acu conn rq ident denied rq Acu conn rq identification denied rq Acu conn rq p display i Acu conn rq parity 128 eg CC IO el Dm oz c QAI Hrm Hoc SE mzom z z d4 x Quo nnZzUvUU d OO cd Message primitives Macro 4 E ND EV HA NK T QD T E 11 MT NK UT OA SP 1 S O 2 S S6G ST RI I N 6 S l T E WGS O0 E A A S 7 L N 1 Acu conn rq pcs user protocol x Acu_conn_rq_ph_rate Acu_conn_rq_priority Acu conn rq progress description X Acu conn rq progress ind nb X Acu conn rq progress location X Acu_conn_rq_redir_nb_plan X X X X Acu_conn_rq_redir_nb_pres X X X X Acu_conn_rq_redir_nb_reason X X X x Acu_conn_rq_redir_nb_screen X X X X Acu_conn_rq_redir_nb_type X X X x Acu_conn_rq_sending_complete X X x X X X X X Acu_conn_rq_service X X X X X X X X x Acu conn rq ss cnip name active x Acu conn rq ss cnip name pres x Acu conn rq stop bits Acu conn rq syn asyn Acu conn rq transfer conn id Acu conn rq transfer rq Acu conn rq user rate 129 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rq uui protocol Acu conn rq x display nb Acu conn rq x display size i Acu conn rq x display total size Acu conn rq x display type i noma orm Nr Z nzu N el D oz c QAI Prmancecp ACU_CONN_ RQ macro descriptions and Q 931 IE Macro Acu_conn_rq_a_called_nb Acu conn rq called nb size Filling order 1 Acu conn rq a ca
143. called number Called party Acu_conn_in_called_nb_size number called party subaddress Acu conn in a called nb sub Pointer to and size of buffer Calling party Acu conn in called nb sub size containing called subaddress subaddress Acu conn in a calling nb Pointer to the calling number Calling party Acu conn in calling nb size number calling party subaddress 117 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn in a calling nb2 Acu conn in calling nb2 size Acu conn in a calling nb sub Acu conn in calling nb sub size Acu conn in a calling name Acu conn in calling name size Acu conn in a display Acu conn in display size Acu conn in a display list Acu conn in a ext parms Acu conn in a facility Acu conn in facility size Acu conn in a layer 1 info Acu conn in a orig called nb Acu conn in orig called nb cfnr Acu conn in orig called nb count Acu conn in orig called nb plan 118 Description Pointer to and size of buffer containing second calling number Pointer to and size of buffer containing calling subaddress Pointer to and size of buffer containing calling name Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to structure containing
144. callid Called number plan See Plan values for a list of valid values Default N PLAN UNKNOWN Default for VN6 and AusTel variants N PLAN ISDN Called subaddress odd even Valid values include SUBADDRESS ODD Odd number of address signals SUBADDRESS EVEN Even number of address signals Called subaddress number type Valid values include SUBADDRESS TYPE NSAP NSAP SUBADDRESS TYPE USER User specified Called number type See Number type values for a list of valid values Default N TYPE UNKNOWN Default for the 4ESS and VN6 variants N TYPE NATIONAL Second calling number presentation Allowed values include N PRES ALLOWED Presentation allowed default N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Q 931 IE Call appearance Does not map to an IE Called party number Called party subaddress Called party subaddress Called party number Calling party number Macro Acu conn rq calling nb2 screen Acu conn rq calling nb2 type Acu conn rq calling nb plan Acu conn rq calling nb pres Acu conn rq calling nb screen Acu conn rq calling nb sub odd even Message primitives Description Q 931 IE Second calling number screening Calling party indicator See Screening indicator number values for a list of valid values Default N SCREEN USER PROVIDED N SCREEN USER PASSED for AusTel Second calling number type
145. channel is 23 If the application attempts to place a call on a D channel timeslot the application receives ACU CLEAR CO or NCCEVN CALL DISCONNECTED with the cause Acu clear co network cause f0 ACU CAUSE ACU BAD ADDRESS 269 21 Modifying the NSF IE NSF IE structure The network specific facilities information element NSF IE indicates which network facilities are being invoked This information element is supported only for the 4ESS variant The following structure defines the NSF IE struct acu ext spf fac ie struct u4 acu ext hdr Par Extension header pad4 uchar net id ACU MX SZ NET ID Network identification array SC uchar net id lgth Length of network identification uchar net id type Type of ID A uchar aceron Parameterized binary indicator uchar serv feature Service feature indicator uchar Tae ley COCEmE YES Tere tiles coding z uchar param fld Parameterized field pad5 y Use the following macro to access the fields of the data structure Acu_ext_spf_fac_ie field NSF IE fields The following tables show the valid settings for the fields of the NSF IE structure The fields included are e net id type e action e Serv feature e param fld net id type Setting Value Description ACU USER SPECIFIED TYPE 0 Net ID type is user specified ACU NATIONAL NETWORK ID TYPE 2 Use the national network net ID type action Setting Value Description ACU SPF FAC PARAME
146. control between two adjacent layers The following illustration shows the message primitives exchanged between layers n 1 Layer n 1 Layer y entity entity Response Confirm Indication n Layer n Layer entity entity ISDN protocol stack making a ISDN protocol stack responding to request request Messaging API programming model Four types of primitives are exchanged between adjacent layers Primitive type Example Description REQUEST RQ ACU CONN RQ A layer issues this type to request a service from the layer directly below it INDICATI ON ACU CONN IN A layer providing a service issues this primitive IN type to notify the layer above it of any specific activity that is related to the service An INDICATION that a layer receives may be the result of an activity performed by the layer directly below it that is related to a REQUEST given by a peer entity RESPONSE RS ACU_CONN_RS A layer issues this primitive type to acknowledge the receipt of an INDICATION from a lower layer CONFIRM CO ACU_CONN_CO A layer providing a requested service issues this primitive type to confirm that the activity completed ISDN functional devices and reference points ISDN equipment is classified into a number of categories by international and United States domestic standards as described in the following table Category Description TE1 ISDN end user terminating equipment class 1 which terminates a single ISDN trunk NT
147. cro Description Q 931 IE Acu_transfer_callid_present A value of 1 indicates that the callid field NA contains valid information Acu_transfer_callid Information used to identify a call NA Acu_transfer_size The size of the structure NA ACU_CALL_PROC_IN This topic describes e ACU_CALL_PROC_IN protocol variants e ACU CALL PROC IN macro descriptions and Q 931 IE Purpose Indicates incoming call proceeding information receipt of SETUP ACK CALL PROCEEDI NG messages Conn id An allocated call ACU CALL PROC IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E ND EV HANK T QD T E 11 MT NKUTOA SP 1 S02 S S6GS TRI N 6 S I T E WGSO0 E A A S 7 L N 1 Acu call proc in a display D X X X X X x x Acu_call_proc_in_display_size Acu_call_proc_in_a_display_list D X X X X x x X Acu call proc in a ext parms Acu call proc in a facility X x x Acu_call_proc_in_facility_size Acu_call_proc_in_a_pcs_user Acu_call_proc_in_pcs_user_size 81 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E ND EV HANK T E 1 MT NK UT OA S O 2 S S 6 GS TRI S l T E W E A A L N T Acu_call_proc_in_a_q931 X X IX X X X X X X X x Acu call proc in q931 size Acu call proc in call ref length x Acu_call_ proc_in_call_ref_value x Acu call proc in cause Acu call proc in data chani X
148. cro Must be set to Acu facility code ACU FAC PCS USER ONLY Acu facility action ACU RQ ACTIVATE The user to PCS information element can be sent only in the user to network direction The PCS to user information element can be sent only in the network to user direction 251 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Therefore the two information elements are never present at the same time in an ISDN message For this reason the same macros are used for both information elements There are no restrictions on the contents of the information area in the user to PCS or PCS to user information elements Non printable characters including 10 can be sent and received However for consistency with other macros and for ease of use the stack automatically adds a XO character at the end of any incoming pcs user information For example if the incoming pcs user information is 0x31 0x32 0x33 representing the number 123 the stack sets the Acu xxx pcs user size macro to 4 and adds a 0x00 byte For outbound pcs user information elements the stack sends the exact number of octets specified by the application in Acu xxx pcs user size For example to send 0x31 0x32 0x33 the application sets Acu xxx pcs user size to 3 Example code The following sample code illustrates how to build a structure containing PCS information prior to sending it void build facility with pcs char buffer int len Sima acu Aere Lue
149. cro for Acu conn rq ident denied rq Pointer to occurrence i Parity for V 110 and V 120 services Available values ACU ODD odd parity ACU EVEN even parity ACU NO PARITY no parity Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Physical rate for all services Phone call priority normal urgent Description for information element 0 See Progress description values for a list of valid values Number of progress indication information elements Location of information element O See Location values for a list of valid values and default setting information Q 931 IE Network specific facilities Facility Facility Display Bearer capability PCS user Low layer compatibility Low layer compatibility Progress indication Progress indication Progress indication 135 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rq redir nb plan Acu conn rq redir nb pres Acu conn rq redir nb reason Acu conn rq redir nb screen Acu conn rq redir nb type Acu conn rq sending complete Acu conn rq service 136 Description Redirecting number plan See Plan values for a list of valid values Default N PLAN UNKNOWN Default for VN6 and AusTel variants N PLAN ISDN Redirecting number presentation Allowed values N PRES ALLOWED Presentation allowed defau
150. cture fields interfacing at ACU SAP isdntype h NMS types definition Basic and derived types Entity identifiers ACU SAP message structure definitions ACU macros to isdnacu h build ACU messages Most definitions appearing in this file apply to ACU configuration only isdnval A Contains definitions to be used both in ACU configuration and in channelized configuration 14 Messaging API programming model The following illustration describes the include file structure used by an application using NMS ISDN in the LAPD configuration isdndef h Event code definitions 4 ISDN API function prototypes isdnparm h Parameter structure definitions Manifest constants for parameter Included by application structure fields interfacing at SAPI SIG for raw LAPD access isdntype h NMS types definition Basic and derived types Entity identifiers 4 isdndl h SAPI SIG configuration for raw LAPD Macros to build LAPD messages Run modules A run module contains the basic low level software that a board requires to support ISDN The module is transferred from the host into on board memory when the board boots Different run modules are supplied for different configurations and are specific to the protocol variant and country The module you use depends upon what board type you are using For more information about run modules see the NMS ISDN Installation Manual Board keyword files Board keyword files contain informati
151. ctures in detail These data structures are defined in the isdnparm h header file Messaging structures The message structures used to convey messages and message data between the ISDN protocol stack and the application are e SDN MESSAGE e SDN PACKET For more information on sending and receiving NMS ISDN messages refer to Sending ISDN messages to the stack and Receiving events and ISDN protocol stack messages Protocol parameter structures Data structures are passed to isdnStartProtocol The parms argument points to one of these parameter structures depending upon the stack mode in which the ISDN protocol stack is running For Specify ACU stack mode ISDN PROTOCOL PARMS Q931CC LAPD stack mode ISDN PROTOCOL PARMS LAPD Channelized stack mode ISDN PROTOCOL PARMS CHANNELIZED Refer to the Message primitives section for more information on the default values of these parameters ISDN MESSAGE structure A pointer to the ISDN MESSAGE structure is passed to isdnSendMessage in the message argument In this structure the application specifies the NAI the NFAS group number if duplicate NAI values are configured and the connection ID of the call that the message concerns The message to be sent expressed using one of the message primitives is also specified The message primitive appears in the code field in this structure For more information refer to the Message primitives section When the ISDN PACKET structure is receiv
152. d Not used Not used Not used Cause PCS user Progress indicator 95 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Q 931 IE Acu_clear_in_progress_ind_nb Number of progress indication Progress information elements indicator Acu_clear_in_progress_location Location of information element 0 See Progress Location values for a list of valid indicator values Acu_clear_in_ret_code Return code See Clear code values for Does not a list of valid values map to an E Acu clear in signal val Signal value See Signal values for a Not used list of valid values Acu clear in ss cnip name active Indicates calling name identification CNIP presentation CNIP supplementary service should be invoked Acu clear in ss cnip name pres Calling name identification CNIP presentation CNI P mode Allowed values N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Acu clear in total cost Alias for charging field Not used Acu clear in x display nb Number of present occurrences Display Acu clear in x display size i Size of occurrence i optional Display Acu clear in x display total size Total size of the stored strings Display Acu clear in x display type i Type of display i Display Acu clear in x p display i Pointer to occurrence i Display ACU CLEAR RQ This topic describes e ACU CLEAR
153. d log the trace use the f option 219 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Utility Description itrace The ISDN stack includes many entities for example layer 1 entities layer 2 entities layer 3 entities management entities timer entities that send debug messages to oammon itrace limits the number of ISDN entities that send debug messages to oammon by default all the entities are enabled itrace takes as arguments a flag on or off board number NAI number and a list of entities from the file isdntype h An exclamation point before the entity list enables the sending of buffers along with the messages For example to prepare an agpierror log for board 0 NAI 1 containing Q 931 buffers enter the following information agtrace 801000 0 WCBS ou 0 db cw itrace on 0 1 Dd and run the application To prepare an agpierror log for board 0 NAI 1 containing only ACU messages enter the following information agtrace 801000 0 uter accola OE itrace on 0 1 AC and run the application The log file is located in the following directory Operating system Directory Windows nms oam log UNI X var opt nms ag Tracing is not recommended when performing heavy load tests The high number of accesses to the log file caused by tracing can dramatically decrease the coprocessor s capability to handle the messages Embedded errors in agpierror log may not be handled correctly by dectrac
154. deas described in this document in marketing collateral produced by or on web pages maintained by Dialogic may infringe one or more patents or other intellectual property rights owned by third parties Dialogic does 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 and no such licenses are provided except pursuant to a signed agreement with Dialogic More detailed information about such intellectual property is available from Dialogic s legal department at 9800 Cavendish Blvd 5th Floor Montreal Quebec Canada H4M 2V9 Dialogic 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 Any use case s shown and or described herein represent one or more examples of the various ways scenarios or environments in which Dialogic amp products can be used Such use case s are non limiting and do not represent recommendations of Dialogic as to whether or how to use Dialogic products Dia
155. dentification Recall facility ETSI Transparent facility for CC amp NS Call appearance request Feature activation request Drop call Feature indication NT gt TE only Send PCS user information only with no other facility request Only for VN6 within ACU FACILITY RQ See PCS user information elements for more information on this IE The following table lists the valid action code values for ACU FACILITY IN ACU SET MODE CO ACU SET MODE RQ ACU TEST CO and ACU TEST RQ messages These values are defined in isdnacu h Action code ACU RQ ACTIVATE ACU RQ CLEAR ACU RQ ENQUIRY Description Activate or register action Deactivate or clear action Inquiry action ACU IN TX Transmission ACU CO ACK Acknowledgement ACU CO REJ Reject Mode code values The following table lists the valid mode code values for the Acu set mode code macro in ACU SET MODE RQ messages These values are defined in isdnacu h 193 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Mode code Description ACU_MODE_NA_OUT_OF_ORDER Allow or forbid calls on NAl given by R msg nai ACU MODE CALL OUT OF ORDER Allow or forbid calls on NAI CONN ID given by R msg nai R msg conn id ACU MODE CHANI OUT OF ORDER Allow or forbid usage of the B channel given by Acu set mode data chani ACU MODE ALL NA OUT OF ORDER Allow or forbid calls on all NAls Error cause values The following table lists the valid error code
156. e Specifies the network access identifier NAI of the destination trunk ENT APPLI Indicates that the message is sent from the application to the stack ENT DL D Indicates that the message is sent to the data link layer DL SAPI SIG 1 Specifies the primitive of the LAPD message for example DL EST RQ Reserved for internal data relay Specifies the size of the message buffer containing data associated with the message if any Specifies the NFAS group number for this network access identifier NAI Used only if duplicate NAI values are defined Not used If necessary the application also builds a message buffer containing data to send 22 Messaging API programming model Receiving events and I SDN protocol stack messages All messages and events are returned to the application through the standard Natural Access event handling mechanism The events returned can be standard Natural Access events events sent by an ISDN protocol stack instance or events specific to any Natural Access extensions They arrive in the form of the standard event data structure typedef struct CTA EVENT DWORD xus Event code and source service ID CTAHD ctahd Context handle rA DWORD timestamp Timestamp A DWORD userid User ID defined by ctaCreateContext DWORD size Size of butter 1f butter NULL ay void but fer Butter pointer ay DWORD value Event status or event specific data SCH DWORD objHd
157. e data link layer are placed in the same event queue as other Natural Access events allowing the user to access ISDN events in the same way that other events are accessed As in other configurations B channel information is routed to the DSP resources through the board s H 100 H 110 or MVIP switch The switch has certain default behavior described in Making switch connections for NMS ISDN Alternatively the switch can be controlled using the Natural Access Switching service Reference points supported by NMS ISDN NMS ISDN supports access across the S and the T reference points as shown by the solid arrows on the upper left of the following illustration At the ACU SAP access to S T is transparent You can configure an ISDN protocol stack to emulate the network by using the partner equip field passed to isdnStartProtocol See Function summary for more details on the parameters available to configure the ISDN protocol stack 12 Messaging API programming model The following illustration shows the reference points supported by NMS ISDN USA network ITU network EQUIPMENT TE Local loop ISDN terminator switch NT1 LE End user Switching Physical Physical ISDN device termination termination MUX ISDN Performance Switching protocol Concentration monitoring Signaling conversion Power transfer B and D channel MUX NMS ISDN software components ISDN is implemented differently around the
158. e details The bit settings in this field regarding call control actions CC SEND ALERT IN CC SEND CALL PROC RQ CC DATA ALERT RQ CC VOICE ALERT RQ CC DATA CONN RS and CC VOICE CONN RS must not be set when the protocol stack is started in channelized stack mode Each bit set by the value in this field determines a particular element of the ISDN protocol stack s behavior The values are defined as follows Value Description Reserved for compatibility with former auto_answer field values ON OFF CC_SEND_ALERT_IN Determines if ACU_ALERT_IN is automatically sent after ACU_CONN_IN If this bit is set the stack generates an ACU_ALERT_IN after sending an ACU_CONN_IN 238 Value CC SEND CALL PROC RQ CC DATA ALERT RQ CC VOICE ALERT RQ CC DATA CONN RS CC VOICE CONN RS CC TRANSPARENT OVERLAP RCV CC TRUNCATE NB CC CALLED NB ABSENT MATCH CC CALL WAITING CC SEND NO CALLED NB CC DISABLE SUPPLEMENTARY SERVICES Parameters Description Determines if CALL PROCEEDING is automatically sent on incoming calls If this bit is set the ACU sends CALL PROCEEDING on an incoming call Otherwise the application must send ACU CALL PROC RQ for CALL PROCEEDING This message is optional Determines if ALERTI NG is automatically sent when a NOT TELEPHONY call arrives If this bit is set the stack sends ALERTING on a NOT TELEPHONY incoming call Determines if ALERTI NG is automatically sent when a TELEPHONY call arrives If
159. e during load tests or if you do not follow the indications about limiting the number of messages or buffers sent to the board monitoring utility When reporting a potential problem in the NMS ISDN stack include the entire agpierror log file Do not use itrace in this case and do not include the output of dectrace 220 Messages decoded by dectrace dectrace decodes ISDN layer 3 messages in accordance with Q 931 Q 932 specifications except where noted Q 931 Q 932 message types dectrace decodes all the messages types defined in the Q 931 Q 932 specifications The following table lists the messages types Message Escape to nationally specific message type MSG ESCAPE Call establishing messages MSG ALERTI NG MSG CALL PROC MSG PROGRESS MSG SETUP MSG CONNECT MSG SETUP ACK MSG CONNECT ACK Call information phase messages MSG USER INFO MSG SUSPEND REJ MSG RESUME D I MSG HOLD MSG SUSPEND MSG RESUME MSG HOLD ACK MSG SUSPEND ACK Hexadecimal value 0x00 0x01 0x02 0x03 0x05 0x07 OxOD OxOF 0x20 0x21 0x22 0x24 0x25 0x26 0x28 0x2D dectrace Stack traffic analysis tool Notes Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 931 Q 932 Q 931 Q 931 Q 932 Q 931 221 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Message MSG RESUME ACK MSG HOLD REJ MSG RETRIEVE MSG RETRIEVE ACK MSG RETRIE
160. e following connections e On each trunk streams and timeslots carrying D channel information to and from the HDLC controller if any must be connected to streams and timeslots accessible by the ISDN protocol stack These connections must be full duplex They must be made before the ISDN protocol stack is initialized Initialization is described in Initializing ISDN protocol stack instances e The streams and timeslots carrying voice information to and from the trunk must be connected to the streams and timeslots carrying voice information to and from the DSP resources The connections must be full duplex The connections differ depending upon whether the Networklnterface T1E1 SignalingType keyword is set to PRI or RAW Specifically if Networkl nterface T1E1 SignalingType RAW no connections are made between the HDLC controller and signaling streams This setting is for trunks that are included in NFAS groups and do not have a D channel in operation For more information about these keywords and about NFAS see the NMS ISDN Installation Manual Connections are listed in MVIP 95 nomenclature unless otherwise specified Note On CG boards the framer signaling is hard wired to the HDLCs Any attempt to switch framer signaling to the HDLCs will fail 29 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual The following table shows the default connections The exact settings depend upon the Networkl nterface T1E1 Signal
161. e meses esee senes 268 21 Modifying the NSF IE cococcococnocncnnconnnrannnracnnrncnnrncnnrncnnrncnnrncnnrncnnrncnnancnnanenas 270 NSF IE SEtEF CEUFG retirer ai rre enn ele bd de Ran E FN SEXE UE E Rn SEN UE M UE EN SRE EE ERR RE Kn RE ed 270 NSF II 270 A O A ats eod as 270 A EE 270 Serv TEACUP fi cm 271 parami m GJ NAA aS 272 Example pk ER EUR REEF REM Yr ER REF RR REP ER Ue Vale eee be vas ER R ERR ERR ERR GE 272 22 Encoding and decoding the Precedence Level IE esee 273 Precedence Level IE structure 273 Precedence Level IE fields ssor eite ee extet e 273 ipm 273 IfD EE 274 Le Elte o O E MIU XI ME Mod Led E Md c Mr tad 274 oll EE 274 domai Me 274 ae EE 274 Precedence Level IE examples c cece eee een neta esee esses 274 vii Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual viii Copyright and legal notices Copyright O 2001 2010 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 furnished for informational use only and are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation or its subsidiaries Dialogic Reasonable effort is made to ensure the accuracy of the information contained in t
162. ecified Calling number type See Number type values for a list of valid values Default N TYPE UNKNOWN Default for the 4ESS and VN6 variants N TYPE NATIONAL Request charging ON OFF Number of data bits for V 110 and V 120 services Available values include ACU DATA BIT 5 5 data bits ACU DATA BIT 7 7 data bits ACU DATA BIT 8 8 data bits Data channel to use B1 B2 D or O for any This is used as an alias for Acu conn rq data chani tab Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use 0 Channel ID NAI Total length of buffer containing extended parameters Q 931 IE Calling party subaddress Calling party number Not used Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Network specific facilities Macro Acu conn rq ext parms nb Acu conn rq ident denied rq Acu conn rq identification denied rq Acu conn rq p display i Acu conn rq parity Acu conn rq pcs user protocol Acu conn rq ph rate Acu conn rq priority Acu conn rq progress description Acu conn rq progress ind nb Acu conn rq progress location Message primitives Description Number of parameters in buffer containing extended parameters Request identity denied ON OFF Alias ma
163. ected to network Acting as a network Acting as a network And NMS ISDN is to run Set partner equip to ACU stack mode LAPD stack mode ACU stack mode LAPD stack mode EQUIPMENT NT EQUIPMENT DCE EQUIPMENT TE EQUIPMENT DTE NMS ISDN also supports DPNSS For DPNSS the designations TE and NT do not apply For the DPNSS implementation TE maps to PBX A and NT maps to PBX B To run PBX A the partner equipment designation is EQUIPMENT NT By default PBX A is assigned to side X and PBX B is assigned to side Y Use the NS behavior bits to modify this setting 60 Return values Return value SUCCESS CTAERR BAD ARGUMENT CTAERR INVALID CTAHD CTAERR INVALID STATE CTAERR OUT OF MEMORY ISDNERR CHANNELIZED ON MULTIPLE BOARDS ISDNERR PROTOCOL NS FAILURE ISDNERR RACE STARTING PROTOCOL Function reference Description protocol argument is invalid or the size field of the parms data structure does not match the size of the structure corresponding to the protocol value Context handle is invalid One of the following conditions exists e The context is not open e An ISDN protocol stack instance is being started on the same context by a previous call e An instance is already started on the context e An instance on the context is in the process of stopping Memory allocation failed on the host machine An NFAS group is defined including multiple boards and an attempt was made to star
164. ed CNIP CNIP User user Display Display Display Display Display Date time Message primitives Purpose Signals an incoming call Conn id A currently unused ID ACU CONN IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E NDEV HANK T QDT E 11 MT NKUTOA SP 1 S 02S S6 GS T RI I N 6 S l T E W GSO E A A S 7 L N 1 Acu_conn_in_a_called_nb X X X X X X X X X X X X X x Acu_conn_in_called_nb_size Acu_conn_in_a_called_nb_sub x X Acu conn in called nb sub size Acu conn in a calling nb X X X X X IX X X X X X X X x Acu conn in calling nb size Acu conn in a calling nb2 x Acu conn in calling nb2 size Acu conn in a calling nb sub x x Acu conn in calling nb sub size Acu conn in a calling name x Acu_conn_in_calling_name_size Acu_conn_in_a_display X X X X x x x x x Acu_conn_in_display_size Acu_conn_in_a_display_list X X X X X X X x X Acu_conn_in_a_ext_parms Acu_conn_in_a_facility x x X x X Acu conn in facility size Acu conn in a layer 1 info Acu conn in a orig called nb X X 113 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn in orig called nb cfnr Acu conn in orig called nb count Acu conn in orig called nb plan Acu conn in orig called nb pres Acu conn in orig called nb reason Acu conn in orig called nb screen
165. ed by the application it contains a pointer to an ISDN MESSAGE structure containing message data For more information see ISDN PACKET structure 45 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ISDN MESSAGE is defined as follows typedef struct ISDN MESSAGE inet e MEA Network access interface index ent_id_t from_ent Message source A ent_id_t to_ent Message destination Mi sapi t to sapi Destination Service Access Point ay union add t Conn id Connection identifier for the ACU layer AJALE CEN Call Reference value for the NS layer Not used z add _t ces Connection Endpoint suffix DL later upper half add t tei Terminal Endpoint ID DL layer lower half Not used add t chani Physical layer channel identifier Not used ay add code_t code Primitive code unique only between two entities ay WORD inf0 Information location 0 SCH WORD infl uniorcmatdonwbocacudonel Mi WORD inf2 Information location 2 WORD inf3 Information location 3 A WORD inf4 Information location 4 Mi WORD data size Size of data to follow WORD nfas_group NFAS group number if multiple NAI values are i if Contigqured ay DWORD userid User ID ISDN MESSAGE ISDN PACKET structure When a message is sent from the protocol stack to the application it is sent in an ISDN PACKET structure This ISDN PACKET structure is contained in the buffer elem
166. ed strings Display Acu clear co x display type i Type of display i Display Acu clear co x p display i Pointer to occurrence i Display ACU CLEAR IN This topic describes e ACU CLEAR IN protocol variants e ACU CLEAR IN macro descriptions and Q 931 IE Purpose Indicates call release Conn id An allocated call ACU CLEAR IN protocol variants The following table lists the variants under which each macro is supported for this primitive In this table TE indicates the TE side only and x indicates both NT and TE sides 92 Macro Acu clear in a display Acu clear in display size Acu clear in a display list Acu clear in a ext parms Acu clear in a facility Acu clear in facility size Acu clear in a pcs user Acu clear in pcs user size Acu clear in a q931 Acu clear in q931 size Acu clear in a ss cnip name Acu clear in ss cnip name size Acu clear in a uui Acu clear in uui size Acu clear in charging Acu clear in charging multi Acu clear in charging period Acu clear in charging type Acu clear in charging value Acu clear in ext parms lgth Acu clear in ext parms nb Acu clear in network cause Acu clear in pcs user protocol Acu clear in progress description nunma orm Mr Z eg CC IO el Dm Message primitives V HA NK T QD T N KU T OA S P 1 6 GS T R I I N 6 T E WG SO E A A S 7 L N 1 x x X x X D X X X X X X D D X X X D TE TE TE 93 Dialo
167. een from the selected ISDN entity on the board associated with the specified context Prototype DWORD isdnSetMsgCapture CTAHD ctahd DWORD enable DWORD nai char entity id string DWORD nfas group Argument Description ctahd Context handle associated with a D channel returned by ctaCreateContext enable Toggle for tracing 1 ISDN protocol entity entity id string generates tracing messages O tracing disabled nai Network access identifier NAI on which to enable or disable tracing 55 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Argument Description entity id string Pointer to the NULL terminated string of one character names of ISDN protocol entities for which tracing is either enabled or disabled according to the enable parameter The entity names are defined in the isdntype h include file nfas group NFAS group number This parameter is used only if duplicate NAI values are defined in the configuration Otherwise NMS recommends setting nfas group to the NAI used to set the capture mask Return values Return value Description SUCCESS CTAERR BAD ARGUMENT The entity string is NULL CTAERR INVALID CTAHD The context handle is invalid CTAERR INVALID STATE An ISDN protocol stack instance e Has not been started on the specified context handle e Is being started by a previous call e Is already started or e Is stopping Events Event name Description ISDNEVN SET MSG CAPTUR
168. ens according to direction command can be any value from the Code column on the previous table The following syntax rules apply in the file e Text between a number sign and the end of a line is ignored by the application e The exclamation point indicates that the following symbol is a parameter e Any line not beginning with a number sign or an exclamation point is a message exchange rule formatted as previously described e cause and command values are case sensitive 214 lapddemo LAPD demonstration program The following code sample shows the lapddemo cfg file included with lapddemo File lapddemo cfg Configuration file for lapddemo TERRE EE EE HEHE HE HE HE HE HE HE FE FE FE FE a a FE aE EE EEE EE EE EEE HE HE EE HE d dt FE E HH Parameters D Called number Applies to the SETUP msg A Calling number Applies to the SETUP msg B B channel decimal value Applies to the SETUP msg E Encoding 2 mu Law 3 A Law Applies to the SETUP msg C Cause decimal value Applies to the DISCONNECT msg HEE EEE HEHE HE HE HE HE HE HE FE FE FE FE AA AAA EEE HE HE HE HE d dd AE Parameter value ID 12345 A 678 B 12 be 16 IE 3 HA aE EE aE aE aE aE aE aE HE aE AE aE aE aa AAA AAA AE E FE FE AE d d EEE Command list S SETUP A ALERTING K CALL PROCEEDING P PROGRESS C CONNECT c CONNECT ACK D DISCONNECT R RELEASE
169. ent of the data structure returned by the function ctaWaitEvent For more information about receiving ISDN messages see Network access identifiers NAIs ISDN PACKET is defined as follows typedef struct ISDN PACKET ISDN_MESSAGE message ISDN message identification information a BYTE data 4 Data included in packet gt 0 ah ISDN_PACKET ISDN PROTOCOL PARMS LAPD structure ThelSDN PROTOCOL PARMS LAPD data structure configures the protocol stack for LAPD A pointer to this structure is passed as an argument to isdnStartProtocol Refer to ISDN PROTOCOL PARMS LAPD parameters for more information on the default values of the parameters in this structure 46 Messaging API data structures The structure is defined as typedef struct ISDN PROTOCOL PARMS LAPD DWORD size Size of this structure timer val ig erol timer wel t t102 timer yal de lo Observation period for Frame error count WORD rate Data rate Em WORD max FEC errors Maximum number of FEC during t198 ay When to assign remove a TEI WORD tei time assignment TEI time assignment at CONFIGURATION NA ACTIVATION or USAGE time isdndl h E WORD tei time removal TEI time removal at NA DEACTIVATION POWER DOWN dlint h E Bera Ee SIL B TEI values 0 S Broadcast Jen Non automatic TEI assignment 32g 3 Automatic TEI assignment Koap BYTE bpad 1 For 8 bytes alignment SCH Size is now 32 bytes nA WORD nfas grou
170. epending on the associated message type For these message The information area of the PCS IEs can consist of types FACILITY As many as 128 octets ALERTI NG As many as 64 octets DISCONNECT PROGRESS RELEASE RELEASE COMPLETE SETUP 250 Sending and receiving PCS user information Sending and receiving PCS information elements An application using the ISDN Messaging API interface can send and receive user to PCS and PCS to user information elements for the VN6 variant only in the following primitives e ACU ALERT IN e ACU ALERT RO e ACU CLEAR IN e ACU CLEAR CO e ACU CLEAR RO e ACU CLEAR RS e ACU CONN CO e ACU CONN IN e ACU CONN RQ e ACU CONN RS e ACU FACILITY IN e ACU FACILITY BO e ACU PROGRESS IN The NMS ISDN stack provides three macros for each primitive for accessing these information elements xxx represents the primitive name such as conn rq Macro Description Acu XXX pcs user size Size of the pcs user information Acu xxx pcs user protocol Protocol discriminator for the pcs user information element can assume the values ACUPCS USER TRANSGROUP ACUPCS USER PUBLIPHONE ACUPCS USER CALL ROUTING ACUPCS USER DIALOGUE Acu XXX a pcs user Address of the pcs user information The application can send pcs user macros in the connected state using the ACU FACILITY RQ primitive In this case in addition to the pcs user macros previously described the following macros must be set Ma
171. er stop Stops running the timer or does nothing if the timer is not active event Passes an ADI timer event to the Timer object event returns true if the Timer object has expired Otherwise it returns false 206 isdndemo Layer 3 call control Processing I SDN call control events An incoming ISDN event is received by the processEvent function of a DChannel object NAI objects are selected based on NAI number The getCall function is then called to get a Call object for the connection ID After a Call object is obtained the message is passed for processing by the processl sdnMessage function Each Call has one NAI object associated with it and each NAI object has a DChannel object associated with it When a Call object needs to send an ISDN message to the stack it uses the sendi sdnMessage function of a DChannel object This process is shown in the following illustration A ns Ey processisdniMessage Ji sendIsdnMessage P CA TS Placing and receiving calls The following illustration shows the object interaction while placing and receiving calls DChannel Call BChannel NAI Timer ACU CONN IN getBChannel ACU CONN RS ACU CONN CO ete CLEAR RS assa o CLEAR CO ZA EVENT P ACU CONN RQ ACU ALERT IN MITT OR CALL PROC IN ACU CONN ACU CONN CO Gg TIMER EVENT ACU CLEAR RQ a ACU_CLEAR_CO 207 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual At the init
172. er submitted is not a valid buffer 231 16 Parameters ISDN PROTOCOL PARMS LAPD parameters ThelSDN PROTOCOL PARMS LAPD structure contains parameters that configure the ISDN protocol stack for LAPD Either this structure or ISDN PROTOCOL PARMS Q931CC is passed to isdnStartProtocol depending upon how the ISDN protocol stack is configured For more information refer to Initializing ISDN protocol stack instances For a definition of the data structure refer to ISDN PROTOCOL PARMS LAPD structure Type Parameter Description Default value Range of values DWORD size Size of the None structure WORD rate Data rate ISDN RATE 64K ISDN RATE 64K ISDN RATE 56K WORD max FEC errors Maximum 20 0 or more ms number of framing errors allowed during the T198 interval timer val t t101 Milliseconds of 750 0 or more ms bad framing before disabling sending of D channel packets timer val t t102 Milliseconds of 50 0 or more ms good framing before enabling sending D channel packets timer val t t198 Observation 5 0 or more period for frame seconds error count WORD tei time assignment TEI time 0 reserved assignment 232 Type Parameter WORD tei time removal BYTE bpad1 2 WORD nfas group Description TEI time removal Padding for 8 byte alignment NFAS group number if duplicate NAI values Parameters Default value Range of values 0 reserved 0 0 0 ON or OFF ISDN PROTOCOL PARMS Q93
173. er type values for a list of party valid values address 143 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn rs connected sub odd even Acu conn rs connected sub type Acu conn rs data bits Acu conn rs data chani Acu conn rs data chani excl Acu conn rs data chani nai Acu conn rs data chani nb Acu conn rs data chani tab i Acu conn rs data chani tab nai i Acu conn rs date available Acu conn rs day 144 Description Connected subaddress odd even Valid values SUBADDRESS ODD Odd number of address signals SUBADDRESS EVEN Even number of address signals Connected subaddress type See Number type values for a list of valid values Number of data bits for V 110 and V 120 services Available values include ACU DATA BIT 5 5 data bits ACU DATA BIT 7 7 data bits ACU DATA BIT 8 8 data bits Data channel to use B1 B2 D or O for any Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use 0 For X25 PACKET services only otherwise unused Channel ID i NAI i ON if the information is available else OFF Day Q 931 IE Connected party subaddress Connected party subaddress Not used Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification D
174. er user UUI protocol discriminator values for a list of valid values Default UU 1A5 UUI USER SPF for HKG variant Number of present occurrences Display 79 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Acu alert rq x display size i Size of occurrence i optional Acu alert rq x display total size Total size of the stored strings Acu alert rq x display type i Type of display i Acu alert rq x p display i Pointer to occurrence i ACU CALLID IN This topic describes e ACU CALLID IN protocol variants e ACU CALLID IN macro descriptions and Q 931 IE Purpose Delivers a callid or reports a failure to an application Conn id An allocated call TE side only ACU CALLID IN protocol variants Q 931 IE Display Display Display Display The following table lists the variants under which each macro is supported for this primitive In this table x indicates TE side only Macro 4 E N DE V H A N K T E 11 M T N K U T O A S O 2 S S 6 G S IT R I S I T E W E A A L N 1 Acu_transfer_status X X X Acu transfer callid present X X X Acu_transfer_callid X X X Acu_transfer_size X X X ACU_CALLID_IN macro descriptions and Q 931 IE Macro Description Acu_transfer_status Type of result A value of 0 indicates success any other value indicates an error 80 Q D T S P 1 N 6 G S 0 S 7 X x X x x x X x Q 931 IE NA Message primitives Ma
175. erlapped sending state Started After a SETUP or DISCONNECT is received After an ALERT is received After a SETUP_ACK is sent After a SETUP is sent After an INFO is sent Reset On expiration When the first The call is cleared message in response to the SETUP or DISCONNECT is sent When a CONN is The call is cleared received When an INFO The call is cleared is received The call is cleared with a REL_COM When a CALL PROC ALERT SETUP ACK or REL COM is received When an INFO A DISC is sent is received 253 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Timer T305 T306 T307 T308 T309 T310 T313 T314 T316 T317 254 Description Disconnection control Call is in disconnect indication Internal timer Release message control Allows the data link to be dropped without losing calls Used to govern the behavior of CALL PROC Controls the behavior of CONN message Future usage for segmented messages RESTART procedure timing Controls the internal clearing of CRVs after a RESTART Started After a DISC is sent After a DISC with progress indicator is received After SUSPEND ACK is sent After a REL is sent After a data link release message is sent After a CALL PROC is received After a CONN is sent After a message segment is received After a RES
176. ert in redir nb screen Acu alert in redir nb type Acu alert in signal val Acu alert in ss cnip name active Acu alert in ss cnip name pres Acu alert in x display nb numa orm Mr Z uzo N cl mm oz c DS Hrm Hoc 442 Message primitives pPMIOA Z z 7 d DO um SS 00 N O Oo H cd 71 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu alert in x display size i Acu alert in x display total size Acu alert in x display type i Acu alert in x p display i 4 EN DE V H A NK E 11 MT N K UT O S O 2 S S 6 G S T R S l T E E A L 1 x x X x x x x X X X X X D x x X X X D X X X X x ACU ALERT IN macro descriptions and Q 931 IE Macro Acu alert in a display Acu alert in display size Acu alert in a display list Acu alert in a ext parms Acu alert in a facility Acu alert in facility size Acu alert in a pcs user Acu alert in pcs user size Acu alert in a q931 Acu alert in q931 size Acu alert in a redir nb Acu alert in redir nb size Acu alert in a ss cnip name Acu alert in ss cnip name size 72 Description Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to and size of buffer containing ISDN PCS to user user to PCS inform
177. esources Certain default connections are made automatically if H 100 H 110 or MVIP switching is not enabled The following illustration shows routing channel data to on board resources NMS board DSP resource B channel DSP resource zs D gt E rg D z B channel D channel carrying signaling for the above B channels 30 gt 000 DD gt mm oo Sa For more information see Making switch connections for NMS ISDN 27 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Task 2 Create contexts for channels The application initializes Natural Access and creates a separate context for each B channel and D channel with which it will interact The following illustration shows creating contexts for channels DSP resource B channel NES DSP resource B channel ponen D NUS D channel Come carrying signaling for the above B channels CU zs Y E eg o 5 2 0 sg D D o zf D gt mm Goo P For more information see Initializing Natural Access Task 3 Call isdnStartProtocol The application uses isdnStartProtocol to initialize ISDN protocol stack instances on each D channel context This function starts up an ISDN protocol stack instance on the D channel context in ACU or LAPD stack mode In the function call the trunk is specified using its network access identifier NAI and if duplicate NAI values are defined the NFAS group number to which th
178. event or about the result of the function s execution For more information about event handling refer to Receiving messages from the NMS ISDN protocol stack Event Hexadecimal Decimal Description ISDNEVN ERROR 0x00072083 1467075 A trunk error occurred ISDNEVN_RCV_MESSAGE 0x00072020 1466976 A message was received from an ISDN trunk ISDNEVN_SEND_MESSAGE 0x00072004 466948 isdnSendMessage completed The value field of this event contains the result of the function call ISDNEVN_SET_MSG_CAPTURE 0x00072082 467074 isdnSetMsgCapture completed The value field of this event contains the result of the function call ISDNEVN_START_PROTOCOL 0x00072001 466945 isdnStartProtocol completed The value field of this event contains the result of the function call ISDNEVN STOP PROTOCOL 0x00070002 21466946 isdnStopProtocol completed The value field of this event contains the result of the function call NMS ISDN reasons The NMS ISDN reason codes in the following table can appear in the value fields of the events listed in the NMS ISDN events table Reason Hexadecimal Decimal Description ISDNERR BAD NAI 0x00071001 462849 The network access identifier NAI in the message structure is not valid The NAI must be less than MAX NAI 229 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Reason ISDNERR BUFFER TOO BIG ISDNERR INCOMPATIBLE LIB ISDNERR INVALID COUNTRY ISDNERR INVALID HDLC CHAN
179. example Acu conn rq tsp ie list size Do not include a null terminator when calculating this value acumessage a tsp ie list Pointer to transparent IE buffer Do not include a null terminator in this string To use transparent lEs the application must disable the stack s syntax checking mechanism To do this set the NS IE RELAY BEHAVIOUR bit in the ns behaviour substructure referenced in the ISDN PROTOCOL PARMS Q931CC structure passed to isdnStartProtocol By default this bit is O The following code fragment shows how to set this bit prior to calling isdnStartProtocol myStartProtocol struct ISDN PROTOCOL PARMS Q931CC parms memset parms 0 sizeof ISDN PROTOCOL PARMS Q931CC parms size sizeof ISDN PROTOCOL PARMS 0Q931CC parms services list 0 ACU VOICE SERVICE Other services may be added here parms services list 1 ACU NO SERVICE parms ns behaviour NS IE RELAY BEHAVIOUR isdnstartProtocol ctahd TSDN PFROTOCOL QJ31CC networkoperator COUNERY parcner SM nai amp parms Instead of NULL ES 247 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Transparent I E formatting rules The following rules apply to transparent IE formatting 248 If the buffer contains more than one IE the IEs must appear in the same order as they appear in the Q 931 message For example the channel ID IE ID 0x18 cannot be followed by bearer capability IE ID 0x04
180. f Advice of Charge Start of Call supplementar y service Padding for 8 byte alignment Default value None None None OFF OFF OFF 0 Parameters Range of values See ns_behaviour field See acu_behaviour field See qsig source party nb typ e field See qsig source type of nb field None ON OFF ON OFF ON OFF 235 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Type Parameter Description Default value Range of values WORD nfas group NFAS group 0 0 255 number if duplicate NAI values BYTE bpad3 2 Padding for8 0 0 byte alignment WORD rful Reserved for O 0 future use WORD rfu2 Reserved for O 0 future use For details on the BYTE field see the NMS ISDN Supplementary Services Developer s Reference Manual Protocol parameter settings The following code segment illustrates the typical settings of the protocol parameter to isdnStartProtocol for application access to ACU SAP memset amp cc_parms 0 sizeof ISDN PROTOCOL PARMS Q931CC cc parms rate ISDN RATE 64K cc parms services list 0 VOICE SERVICE cc parms services list 1 NO SERVICE services list field The services list data field in ISDN PROTOCOL PARMS Q931CC consists of a set of up to CC MX SERVICES elements which together define the set of ACU services required by an instance of the ISDN protocol stack By default all services are accepted If you specify
181. g name identification presentation CNIP supplementary service should be invoked Calling name identification presentation mode Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Number of stop bits for V 110 and V 120 services Available values include ACU STOP BIT 1 1 stop bit ACU STOP BIT 1 5 1 5 stop bits ACU STOP BIT 2 2 stop bits Q 931 IE Redirecting number Redirecting number Sending complete bc llc hic bc llc hic CNIP CNIP Low layer information Message primitives Macro Description Q 931 IE Acu conn in syn asyn Synchronous asynchronous for Low layer V 110 and V 120 services information Available values include ACU SYN Synchronous mode ACU ASYN Asynchronous mode Acu conn in user rate User rate for V 110 and V 120 Low layer services See User rate values information for a list of valid values Acu conn in uui protocol UUI protocol discriminator User user value See UUI protocol discriminator values for a list of valid values Acu conn in x display nb Number of present occurrences Display Acu conn in x display size i Size of occurrence i optional Display Acu conn in x display total size Total size of the stored strings Display Acu conn in x display type i Type of display i Display Acu conn in x p display i Pointer to occurrence i Display
182. g table The multiple octet IEs in a Q 931 message follow an ascending numerical order by IE ID for example octet 1 Single octet IEs can appear at any point in the message In the table u and v represent bits that can be changed by the user IE type I nformation I nformation I nformation element id octet element id octet element id octet 1 2 3 Single octet IE 0xluuuuuuu Not present Not present Sending and receiving raw Q 931 data IE type I nformation I nformation I nformation element id octet element id octet element id octet 1 2 3 Multiple octet IE OxOuuuuuuu Oxvvvvvvvv Follow as many octets as specified in octet 2 Accessing and reading a Q 931 buffer To read the raw data in an incoming Q 931 message the application uses the following macros to access the buffer containing the message acumessage is a standard ACU message for example ACU_CONN_IN For example Acu_conn_in_a_q931 Macro Description acumessage q931 sizel Size of Q 931 buffer in bytes acumessage a q931 Pointer to Q 931 buffer For this data to be available the NS BEHAVIOUR NIL bit must be set in the acu behaviour substructure referenced in the ISDN PROTOCOL PARMS Q931CC structure passed to isdnStartProtocol By default this bit is O The following code fragment shows how to set this bit prior to calling isdnStartProtocol myStartProtocol struct ISDN PROTOCOL PARMS Q931 parms memset parms 0 sizeof ISDN PROTOCOL PARMS Q931
183. gic amp NaturalAccess ISDN Messaging API Developer s Manual Clear code ACURC CONGESTED ACURC INCOMI NG ACURC NOLINE ACURC ERRNUM ACURC INHNUM ACURC 2MNUM ACURC HUNGUP ACURC NETWORK ERROR ACURC TIMEOUT ACURC BAD SERVICE ACURC INTERNAL Facility code values Description GSTN or system is congested Incoming call detected while trying to dial Wrong addressing information or context already used Errored number Inhibited number Too many errored or inhibited numbers Remote has hung up or incident on connection Network has disconnected Timeout error Bad service ID in ACU CONN RQ RS Other internal error The following table lists the valid facility code values for ACU FACILITY RQ ACU FACILITY IN and ACU FACILITY RQ messages These values are defined in isdnacu h Facility code ACU FAC CALL FORWARDING ACU FAC CALL DEFLECTI ON ACU FAC CHARGING ACU FAC CHARGING TOTAL ACU FAC HOLD ACU FAC RETRIEVE ACU FAC ALTERNATE ACU FAC TRF 192 Description Premise transfer Terminal transfer Charging Charging total cost Call hold Call retrieve To and from facility Transfer Facility code ACU FAC THREE PARTY ACU FAC MALICIOUS CALL ID ACU FAC RECALL ACU FAC TRANSPARENT ACU FAC CALL APPEAR ACU FAC FEATURE ACT ACU FAC DROP ACU FAC FEATURE IND ACU FAC PCS USER ONLY Action code values Data types and constants in primitives Description Conferencing Malicious call i
184. gic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E N D E V HANK E 1 MT N KU T O S O 2 S S 6 GS T R S l T E E A L 1 Acu_clear_in_progress_ind_nb x X X X x x Acu_clear_in_progress_location X X X X x x Acu_clear_in_ret_code Acu_clear_in_signal_val Acu_clear_in_ss_cnip_name_active Acu_clear_in_ss_cnip_name_pres x Acu clear in total cost Acu clear in x display nb X X X X X X x Acu clear in x display size i x X X X X x x Acu_clear_in_x_display_total_size x X X X X X x Acu clear in x display type i x x X X x x x Acu clear in x p display i X X X X x x x ACU CLEAR IN macro descriptions and Q 931 IE Macro Description Acu_clear_in_a_display Pointer to and size of buffer Acu_clear_in_display_ size containing ISDN display information optional Acu clear in a display list Pointer to display structure Acu clear in a ext parms Pointer to buffer containing extended parameters Acu clear in a facility Pointer to and size of buffer Acu clear in facility size containing ISDN facility information optional 94 GUTE a no AE Re x Q 931 IE Display Display Not used Facility zl OO Oo bi cd Macro Acu clear in a pcs user Acu clear in pcs user size Acu clear in a q931 Acu clear in q931 size Acu clear in a ss cnip name Acu clear in ss cnip name size Acu clear in a uui Acu clear in uui size Acu clear in charging Acu clear in charging multi Acu c
185. he channelized stack mode see the NMS ISDN for Natural Call Control Developer s Manual Readme file The ASCII text file readme isdn txt contains release information that does not appear in other documentation Consult this file to learn where the NMS ISDN software components are located after installation NMS ISDN function libraries NMS ISDN function libraries run on the host computer The application uses them to interact with ISDN protocol stacks running on a board and to communicate with the NCC service These are dynamic link libraries DLL under Windows and are shared objects under UNIX The libraries have different names under different operating systems Operating Natural Access library name s system Windows isdnapi lib isdnapi dll nccisdn lib nccisdn lib imgtapi lib imgtapi dll Note nccisdn lib nccisdn lib imgtapi lib and imgtapi dll are not in use for layer 3 UNI X libisdnapi so libnccisdn so libimgtapi so Note libnccisdn so and libimgtapi so are not in use for layer 3 Standard NMS ISDN header files required by your applications to communicate with the ISDN protocol stack on the board are also supplied The following illustration describes the include file structure used by an application using NMS ISDN in the ACU configuration isdndef h Event code definitions ISDN API function prototypes isdnparm h Parameter structure definitions Manifest constants for parameter Included by application stru
186. he document However Dialogic does not warrant the accuracy of this information and cannot accept responsibility for errors inaccuracies or omissions that may be contained in this document INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTI ON WITH DIALOGIC PRODUCTS NO LICENSE EXPRESS OR IMPLIED BY ESTOPPEL OR OTHERWISE TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT EXCEPT 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 Due to differing national regulations and approval requirements certain Dialogic products may be suitable for use only in specific countries and thus may not function properly in other countries You are responsible for ensuring that your use of such products occurs only in the countries where such use is suitable For information on specific products contact Dialogic Corporation at the address indicated below or on the web at www dialogic com It is possible that the use or implementation of any one of the concepts applications or i
187. he following table lists the variants under which each macro is supported for this primitive In this table TE indicates the TE side only and x indicates both NT and TE sides Macro 4 E N DE V H A N K TQ D T E 1 I MT N K U T O A S P 1 S 02 S S 6 G S T R I N 6 S l T E WG S O E A A S 7 L N 1 Acu_facility_a_called_address Acu_facility_a_calling_nb Acu_facility_calling_nb_size Acu_facility_a_calling_nb2 Acu_facility_calling_nb2_size Acu_facility_a_display Acu_facility_display_size Acu_facility_a_display_list Acu_facility_a_ext_parms 154 Macro Acu facility a facility Acu facility facility size Acu facility a pcs user Acu facility pcs user size Acu facility a q931 Acu facility q931 size Acu facility action Acu facility button nb Acu facility button type Acu facility call appear Acu facility code Acu facility ext parms Igth Acu facility ext parms nb Acu facility module nb Acu facility pcs user protocol Acu facility service Acu facility switchhook Acu facility x display nb Acu facility x display size i Acu facility x display total size Acu facility x display type i Acu facility p display i numa orm N Z TE TE nZU vnm az lt DS HE Del IC S 442 PMAOA Zz z d Message primitives ano nnZzuvUu zl OO Oo Hi cd 155 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU FACILITY IN macro descriptions and Q 931 IE Macro
188. he former terminology will appear within the document in which case the former terminology should be equated to the new terminology and vice versa Former terminology CG 6060 Board CG 6060C Board CG 6565 Board CG 6565C Board CG 6565e Board CX 2000 Board CX 2000C Board AG 2000 Board AG 2000C Board AG 2000 BRI Board NMS OAM Service NMS OAM System NMS SNMP Natural Access Natural Access Service Fusion ADI Service Dialogic terminology Dialogic amp CG 6060 PCI Media Board Dialogic CG 6060C CompactPCI Media Board Dialogic CG 6565 PCI Media Board Dialogic CG 6565C CompactPCI Media Board Dialogic CG 6565E PCI Express Media Board Dialogic amp CX 2000 PCI Station Interface Board Dialogic amp CX 2000C CompactPCI Station Interface Board Dialogic amp AG 2000 PCI Media Board Dialogic AG 2000C CompactPCI Media Board Dialogic amp AG 2000 BRI Media Board Dialogic amp NaturalAccess OAM API Dialogic NaturalAccess OAM System Dialogic NaturalAccess SNMP API Dialogic NaturalAccess Software Dialogic NaturalAccess Service Dialogic NaturalAccess Fusion VolP API Dialogic NaturalAccess Alliance Device Interface API Former terminology CDI Service Digital Trunk Monitor Service MSPP Service Natural Call Control Service NMS GR303 and V5 Libraries Point to Point Switching Service Switching Service Voice Message Service NMS CAS for Natural Call Control NMS ISD
189. he values are defined as follows Value Description NS NO STATUS ON UNKNOWN IE If this bit is set the stack does not generate a STATUS message when it receives a message containing one or more unknown unrecognized IE s This bit applies only to network variants for which the sending of STATUS under these circumstances is optional 242 Value NS NO STATUS ON INV OP IE NS ACCEPT UNKNOWN FAC IE NS IE RELAY BEHAVIOUR NS SEND USER CONNECT ACK NS EXPLICIT INTERFACE ID NS PRESERVE EXT BIT IN CHAN ID NS NO B CHANNEL MANAGEMENT NS DISABLE RESTART Parameters Description If this bit is set the stack does not generate a STATUS message when it receives a message containing one or more optional IE s with invalid content This bit applies only to network variants for which the sending of STATUS under such circumstances is optional If this bit is set the stack accepts incoming messages containing facility IEs that it does not recognize The stack does not check the IE it operates as if the facility IE is correct If this bit is not set the stack rejects messages containing unknown facility I Es This bit must be set for the bridge calls and notify transfer supplementary services to operate For more information see the NMS ISDN Supplementary Services Developer s Reference Manual This bit applies only when the NS RELAY compile time option is set to ON The stack passes IEs received from the line transparently
190. i size Filling order 1 Acu alert rq data chani Acu alert rq data chani excl Acu alert rq data chani nai Acu alert rq data chani nb Acu alert rq data chani tab Acu alert rq data chani tab nai Acu alert rq ext parms lgth Acu alert rq ext parms nb 78 Description Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and size of transparent IE buffer Pointer to and size of buffer containing ISDN user to user information optional Data channel to use B1 B2 D Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use 0 Channel ID NAI Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Q 931 IE Display Not used PCS user CNIP Does not map to an IE User user Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Not used Not used Macro Acu alert rq pcs user protocol Acu alert rq progress descr x i Acu alert rq progress descri
191. ial stage of the call the Call object associates itself with the BChannel object The B channel number comes when the startCall function is called When a call leaves the connected state the stopCall function is called Then the ISDN call ceases to exist The Call object invokes the free function to free the BChannel object Once free that BChannel object may be used by another call When a BChannel object is in outbound mode it initiates a new call by getting a free Call object getFreeCall and invoking makeCall When the call reaches the connected state a Timer object is started After the timer expires BChannel invokes hangUp to terminate the call In a call collision situation there are two Call objects one inbound one outbound that have invoked get without invoking free In this situation the freeResources function is invoked for the first Call object to disassociate it with the BChannel object The following illustration shows call collision processing DChannel Call 2 BChannel Call collision detected ER ACU CONN RQ PRENNE pU ACU CLEAR peso PEN _CONN_CO 208 12 lapddemo LAPD demonstration program lapddemo overview lapddemo establishes a data link and sends and receives Q 931 messages It demonstrates how e An application accessing the stack at the LAPD interface can establish a data link on an ISDN trunk e To build raw Q 931 messages and send them to the trunk e To access
192. ile NAI NAIs tie together DChannel Call and BChannel objects An NAI object supports a list of Call objects which presents calls associated with a given NAI A Call object can be obtained by its connection ID from getCall The free call with the lowest connection ID can be obtained by invoking the getFreeCall function NAI objects also support a list of BChannels associated with a given NAI These objects can be obtained by their B channel number by invoking getBChannel All Call and BChannel objects are created during the creation of an NAI object Call Call objects implement a reduced version of the NMS ISDN messaging API state machine A Call object can be in one of the following four states State Description ST NULL Free start No real call exists ST AWAITING CONNECT Objects wait for the connection of the call ACU CONN CO ST ACTIVE Call is in the connected state ST AWAITING CLEARANCE Objects wait for the call to be cleared ACU CLEAR CO The following three functions affect the Call object state Function Description processi sdnMessage Processes incoming ACU messages and sends the ACU messages in response A DChannel object associated with the Call object calls this function makecCall Initiates a new outbound call BChannel calls this function hangUp Hangs up a call in the connected state BChannel calls this function A Call object can have a BChannel object associated with it In this case it uses some
193. ility zl E OD kA 4 Macro Acu conn co a pcs user Acu conn co pcs user size Acu conn co a q931 Acu conn co q931 size Acu conn co a redir nb Acu conn co redir nb size Acu conn co a ss cnip name Acu conn co ss cnip name size Acu conn co a uui Acu conn co uui size Acu conn co call ref length Acu conn co call ref value Acu conn co charging Acu conn co charging available Acu conn co charging multi Acu conn co charging period Acu conn co charging type Acu conn co charging value Message primitives Description Pointer to and size of buffer containing ISDN PCS to user and user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Pointer to and size of buffer containing redirecting number Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and size of buffer containing ISDN user to user information optional Length of call reference value Call reference value and call reference flag Charging value number of units Charging information available indicator Charging multiplier Charging period Charging type See Charging type values for a list of valid values Charging value number of units Q 931 IE PCS user Does not map to an IE Redirecting number CNIP User user Ca
194. illustration shows the sequence of messages exchanged in this situation ACU Q 931 The application Trunk stack Application _ requests placement of call 1 The request reaches the trunk Setup 1 ACU CONN RQ 1 Meanwhile an incoming Setup 2 call arrives call 2 The stack automatically clears call 2 Call 2 is never presented to the application Rel Comp 2 ACU CONN CO 1 Call 1 continuation Conn Ack 1 Time Time Time Call 1 established In any situation if the application sends an ACU primitive to the stack while the stack is sending an ACU CLEAR CO message the ISDN stack resends an ACU CLEAR CO message In this case the application receives two ACU CLEAR CO primitives Call clearing To hang up a call the application builds an ACU CLEAR RQ message with the connection ID of the associated call Receipt of an ACU CLEAR CO message confirms that the remote end has hung up The stack returns to its IDLE state The following illustration shows the sequence of messages sent between the ACU and the application when the application initiates a hang up ACU Q 931 Trunk stack Application m Disc ACU CLEAR RQ Release Rel Comp ACU CLEAR CO Time Time Time If the remote end hangs up first the application receives an ACU CLEAR IN message The application responds with an ACU CLEAR RS clearing response message When the application rece
195. ime Date time Date time PCS user Redirecting number Redirecting number Redirecting number Redirecting number 111 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn co second Acu conn co service Acu conn co signal val Acu conn co ss cnip name active Acu conn co ss cnip name pres Acu conn co uui protocol Acu conn co x display nb Acu conn co x display size i Acu conn co x display total size Acu conn co x display type i Acu conn co x p display i Acu conn co year ACU CONN IN This topic describes e ACU_CONN_IN protocol variants Description Second Telephony service requested by the remote See Service values for a list of valid values Signal value See Signal values for a list of valid values Indicates calling name identification presentation CNIP supplementary service should be invoked Calling name identification presentation mode Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available UUI protocol discriminator value See UUI protocol discriminator values for a list of valid values Number of present occurrences Size of occurrence i optional Total size of stored strings Type of display i Pointer to occurrence i Year e ACU CONN IN macro descriptions and Q 931 IE 112 Q 931 IE Date time bc llc hic Not us
196. ing indicator See Screening indicator values for a list of valid values Called subaddress odd even Allowed values include SUBADDRESS ODD Odd number of address signals SUBADDRESS EVEN Even number of address signals Calling subaddress number type Valid values include SUBADDRESS TYPE NSAP NSAP SUBADDRESS TYPE USER User specified Calling number type See Number type values for a list of valid values Q 931 IE Calling party number Calling party number Calling party number Calling party number Calling party number Calling party subaddress Calling party subaddress Calling party number Message primitives 121 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Q 931 IE Acu conn in chani nai NAI Channel identification Acu conn in data bits Number of data bits for V 110 Not used and V 120 services Available values include ACU DATA BIT 5 5 data bits ACU DATA BIT 7 7 data bits ACU DATA BIT 8 8 data bits Acu conn in data chani Data channel to use B1 B2 Channel D identification Acu conn in data chani excl Channel IDs are preferred Channel OFF or exclusive ON identification Acu conn in data chani nb Number of channel IDs in the Channel chani list field If no channel identification IDs use O Acu conn in data chani tab Channel ID Channel identification Acu conn in data chani tab nai NAI Channel identification
197. ingType keyword setting The connections are full duplex Board Setting Default connections Four trunk T1 board PRI Trunk 1 0 0 22 gt 65 0 22 64 0 22 2 for example CG 1 0 22 6060 Trunk 2 4 0 22 gt 65 24 46 64 24 46 gt 5 0 22 Trunk 3 8 0 22 2 65 48 70 64 48 70 gt 9 0 22 Trunk 4 12 0 22 gt 65 72 94 64 72 94 gt 13 0 22 Four trunk T1 board RAW Trunk 1 0 0 23 gt 65 0 23 64 0 23 gt for example CG 1 0 23 6060 Trunk 2 4 0 23 gt 65 24 47 64 24 47 gt 5 0 23 Trunk 3 8 0 23 gt 65 48 71 64 48 71 gt 9 0 23 Trunk 4 12 0 23 gt 65 72 95 64 72 95 gt 13 0 23 Four trunk El board PRI Trunk 1 0 0 29 gt 65 0 29 64 0 29 gt for example CG 1 0 29 6060 Trunk 2 4 0 29 gt 65 30 59 64 30 59 gt 5 0 29 Trunk 3 8 0 29 gt 65 60 89 64 60 89 gt 9 0 29 Trunk 4 12 0 29 gt 65 90 119 64 90 119 gt 13 0 29 Four trunk El board RAW Trunk 1 0 0 30 gt 65 0 30 64 0 30 gt for example CG 1 0 30 6060 Trunk 2 4 0 30 gt 65 31 61 64 31 61 gt 5 0 30 Trunk 3 8 0 30 gt 65 62 92 64 62 92 gt 9 0 30 Trunk 4 12 0 30 gt 65 93 123 64 93 123 gt 13 0 30 30 Initializing a Messaging API application Initializing Natural Access To begin operations the application performs the following steps Step Action 1 Initializes Natural Access services including the ISDN service with ctal nitialize 2 Creates
198. ion 1000 No logging 60 TE T1 boards 24 AT amp T 4ESS El and BRI boards 11 Eurol SDN No extra buffer received inproc No indicator isdndemo Layer 3 call control Option Meaning Defaults T Specifies the timer for the duration of an 15000 outbound call in milliseconds once the call has reached the CONNECTED state v hex mask Controls which information will be printed by 3 isdndemo Possible values 0x01 Program configuration 0x02 Call status messages 0x04 ACU messages 0x08 Call statistics to the screen V Plays voice files in CONNECTED state Does not play voice files For example the following command line specifies USA National ISDN 2 on the second board in a system and places calls on the first 10 channels nsdndemomsbm 1 2 20 9 140 When isdndemo is run with no command line options the program defaults to board O The board number for each board is specified in the system configuration file The program automatically determines the board type and runs one of the following protocols Board type Default protocol T1 AT amp T 4ESS El EurolSDN BRI EurolSDN When no command line options are specified the program assumes that it is not placing any outbound calls but is only accepting inbound calls Protocol option allowed values Value Protocol 3 France Telecom VN6 8 Northern Telecom DMS 100 9 INS 1500 NTT 11 Eurol SDN 15 Australian Telecom 1 199 Dialogic amp
199. ion which specifies the NAI number and is used only with non NFAS configurations isdndemo reads the NFAS configuration for a given group from the OAM database The group number given must correspond to the board where the D channel for the NFAS group is located isdndemo program structure and coding isdndemo is a single threaded C application consisting of global functions and classes The following table lists the global functions found in the isdndemo cpp file Function Description cta error handler Processes Natural Access errors dfprintf dvprintf Provides conditional program output error Provides critical application error notification error cta Provides output of Natural Access codes in text form getACU getACUERR Converts some constants to text form main Provides a program entry point performs processing of program wide command line arguments and initializes Natural Access and program classes readConfig Creates a program object hierarchy based on command line arguments The global classes used with isdndemo are found in several files The following table lists each class along with its associated file and description 202 isdndemo Layer 3 call control Class File Description BChannel BChannel cpp Specifies a context class that represents the ISDN B channel Board Board cpp Provides access to information about NMS boards Call Call cpp Rees an object that represents a single NMS ISDN call Contex
200. is NAI belongs The following illustration shows calling isdnStartProtocol DSP resource B channel NS DSP resource Trunk or NFAS B channel group zm DN a E eg D z NS NMS ISDN D channel protocol carrying signaling for stack Context the above B channels instance NUERA 2 OD seg D DO zs OD P mm Go o P For more information see Accessing D channels 28 Initializing a Messaging API application Task 4 Start NOCC TCPs on B channel contexts The application starts a special no call control trunk control program nocc TCP on each B channel context This program puts the context in a state where voice or media functions can be used without call control The following illustration shows starting NOCC TCPs on B channel contexts DSP resource B channel KN Say NA NE D a E rg D az 20 rvun oco A c D channel al c carrying signaling for stack e s the above B channels stanca For more information see Starting the NOCC TCP Making switch connections for NMS ISDN To enable an application access to ISDN channels several switch connections must be made In the board keyword file if Clocking HBus ClockMode is set to StandAlone these settings are automatically made when the board boots If Clocking HBus ClockMode is set to any other value the application must set these values using the NMS Switching service or swish utility The application must make th
201. is field determines a particular element of the ISDN protocol stack s behavior The values are defined as follows Value Description Reserved for compatibility with former auto_answer field values ON OFF CC_USER_SENDING_COMPLETE If this bit is set the stack does not automatically generate the Sending complete IE Instead the application must request it in ACU_CONN_RQ If the bit is not set the stack generates the sending complete IE automatically in ACU_CONN_RQ only This bit does not affect ACU_DIGIT_RQ The application must specify the Acu_digit_rq_sending_complete field value explicitly 240 Value CC SEND CONN CO ON PROGRESS CC SEND DIGIT CO ON PROGRESS CC USE MU LAW CC USE A LAW CC E1 CONTINUOUS CHANNELS CC SET CALL ID TO CRV CC USE PATH REPLACEMENT CC NETWORK TEST FACILITY CC E1 CONTINUOUS CHANNELS LOGICAL CC USE SINGLE STEP TRANSFER CC BEHAVIOUR NIL Parameters Description If this bit is set the stack sends ACU CONN CO when it receives a PROGRESS message for a VOICE call Otherwise it sends ACU CONN CO when it receives a CONNECT message If this bit is set and the stack receives NS CALL PROC IN before NS SETUP ACK IN it sends ACU DIGIT CO and then ACU CALL PROC IN Otherwise it only sends ACU CALL PROC IN default behavior For Korean operators only If this bit is set the stack sends G711 Mu Law in outgoing voice calls If this bit is cleared the stack sends G711 A Law
202. is not acknowledged within five tries the stack sends a DL REL IN message to the application NMS ISDN remains in the IDLE state The following illustration shows the sequence of messages sent between the trunk the stack and the application when the remote party does not respond to a data link request Trunk Stack Application SABME DL EST RQ No response DL REL IN Time Time Time Responding to a data link establishment request Before a data link is established NMS ISDN is in the IDLE state If the NMS ISDN protocol stack receives a SABME message it automatically responds with a UA message and sends a DL EST IN message to the application The data link is established and NMS ISDN enters the DATA LINK ESTABLISHED state Messages and other information can now be passed across the data link The following illustration shows the sequence of messages sent between the trunk the stack and the application when the stack responds to a data link establishment request Trunk Stack Application SABME UA DL EST IN Time Time Time 43 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Sending messages across an established link Once NMS ISDN is in the DATA LINK ESTABLISHED state the application and the remote equipment can exchange messages To send a packet of data the application sends either of the following messages e fthe packet is acknowledged as defined in the
203. itation effects on your products your business or your intellectual property rights Revision history Revision Release date Notes 9000 6272 25 November 2001 SJC for NACD 2002 1 Beta 9000 6272 26 May 2002 LBG NACD 2002 1 9000 6272 27 November 2002 LBG for Natural Access 2003 1 Beta 9000 6272 28 April 2003 LBG for Natural Access 2003 1 9000 6272 29 December 2003 LBG for Natural Access 2004 1 Beta 9000 6272 30 April 2004 SRR for Natural Access 2004 1 9000 6272 31 November 2004 LBG for Natural Access 2005 1 Beta 9000 6272 32 February 2005 MCM for Natural Access 2005 1 9000 6272 33 October 2005 LBG for Natural Access 2005 1 SP1 9000 6272 34 July 2006 SRG for Natural Access 2005 1 SP2 9000 6272 35 February 2009 DEH for Natural Access R8 1 64 0509 01 October 2009 LBG NaturalAccess R9 0 64 0509 02 Rev A October 2010 LBG NaturalAccess R9 0 4 Last modified 2010 09 20 Refer to www dialogic com for product updates and for information about support policies warranty information and service offerings 1 Introduction The Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual provides e Background information about ISDN e A programming guide to NaturalAccess ISDN Messaging API applications e A summary of functions organized by task e An extensive reference section for functions data structures parameters and codes The NaturalAccess ISDN Messaging product exposes ISDN protocols at three levels
204. ives an ACU CLEAR CO message the clearing is confirmed The stack returns to its IDLE state 39 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual The following illustration shows the sequence of messages sent between the ACU and the application when a hang up is received by the application ACU Q 931 Trunk stack Application Disc ACU CLEAR IN 4 Release ACU CLEAR RS Rel Comp ACU CLEAR CO Time Time Time Clear collision Clear collision can occur when a call clearing request ACU CLEAR RQ and a call clearing indication ACU CLEAR IN for the same call are sent at the same time In this case the application must ignore the ACU CLEAR IN message and continue the call clearing as a normal outgoing call clearing one issued by the application Clear collision can take place at the stack level or at the network level Clear collision at the stack level takes place when a DISCONNECT message is received by the stack directly before it receives an ACU CLEAR RQ message from the application The following illustration shows the sequence of messages exchanged in this situation ACU Q 931 m Trunk stack Application The ACU CLEAR RQ ACU CLEAR IN must be ignored ue ACU CLEAR IN by the application The call clearing Release continues as initiated by the Rel Comp ACU CLEAR CO application Time Time Time 40 Call control ACU configuration Clear collision at the network level
205. l Acu_service_int_id X x x Acu_service_b_ chan x X X Acu service status x X x Acu service action type x X x Acu service q931 size OS e OAL Eed IC P Message primitives Q 931 IE Not applicable Not applicable Not applicable N T T pPMIOA GUTE a no nnZzuvUu zl OO O H cd 173 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu service size Acu service a q931 4 E N D E V H E 1 M T N K S 0O 2 S S 6 G S l Prmancecp sd ed mzoma ZPS P DO uuoz ug Noor ACU SERVICE RQ macro descriptions and Q 931 IE Macro Acu service pref Acu service int id Acu service b chan Acu service status Acu service action type Acu service q931 size Acu service size Acu service a q931 Description Preference Valid values include PREF INTERFACE PREF B CHANNEL Interface ID B channel if Acu service pref PREF B CHANNEL New status Valid values include B CHAN IN SERVICE B CHAN OUT OF SERVICE Action to be performed maintenance only Reserved for future use Size of structure Reserved for future use ACU SETUP ACK IN This topic describes e AC SETUP ACK IN protocol variants e ACU SETUP ACK IN macro descriptions and Q 931 IE 174 Q 931 IE Channel identification Channel identification Channel identification Change status This IE is not defined in Q 931 Not applicable Not applicable Not
206. l t bvl1 BV1 T LAST CAUTION The values of these timers Dr timer val t ets ETS T LAST may be controlled by local Z timer val t qsilost_ T LAST regulatory authorities timer val t swd SWD T LAST changing these values may SR Timer EE EE invalidate regulatory St timer val t vn2 VN2 T LAST approvals Check with the ES timer val t vn3 VN3 T LAST local authority for more SCH timer val t vno VNO T Ee EE specific information on E DES any limitations i ff timer O O Lat IR 24 is more then the rest will align the union on an 8 byte boundary el timers Available services BYTE services list CC MX SERVICES I 47 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual BYTE bpad 2 Padding for 8 bytes alignment my iesaia allie jeil ilg ipia ewe Wal ie laa timer_val_t t198 Observation period for Frame error count WORD max_FEC_errors Maximum number of FEC during t198 a When to assign remove a TEI WORD tei_time_assignment TEI time assignment at CONFIGURATION NA ACTIVATION or USAGE time isdndl h WORD tei_time_removal TEI time removal at NA DEACTIVATION POWER DOWN isdndl h E WORD wpad 3 Padding for 8 bytes alignment E BYTE ECSS I TEI values 0 B Broadcast 163 3 Non automatic TEI assignment 127 Automatic TEI assignment SEH BYTE digitstoroute Number of digits needed to route when using overlap receiving ES BYTE bpadl 4 Padding for 8
207. ladas crimson ol call reference 01 00 flag O 00000101 message type SETUP boce 00 mea 00 croca 00 gt 00000100 IE bearer capability 00000011 length 0x03 octet 3 lll extension bit 00 coding standard CCITT N0000 information transfer capability speech octet 4 225 Dialogic 10 0 BIO 00011000 00000011 0000001 01110000 00000100 000 0000 channel nu 43 67 00000010 00011000 00000011 0000001 45 84 00000001 226 NaturalAccess ISDN Messaging API Developer s Manual extension bit transfer mode circuit mode information transfer rate 64 Kbit s octet 5 extension bit layer 1 id layer 1 id user info layer 1 mu law IE channel identification length 0x03 OCECENS extension bit interface identifier implicitly identified interface type PRI spare bits spare bits pref excl exclusive D channel ind not info channel selection Bl channel Octet 512 extension bit coding standard CCITT number map number channel type B channel ers Ses extension bit channel number 0x01 IE called party number length 0x04 octet 3 extension bit type of number unknown numbering plan unknown octet 4 etc number 12 mber 0x01 DLOuO COMM S cra Or AOS E SO nto call reference 01 00 flag 1 message type CALL PROCEEDING board 00 nai 00 group 00 IE channel identification length 0x03 octet 5 extension bit interface identifier implicitly iden
208. lear in charging period Acu clear in charging type Acu clear in charging value Acu clear in ext parms lgth Acu clear in ext parms nb Acu clear in network cause Acu clear in pcs user protocol Acu clear in progress description Message primitives Description Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Pointer to and size of buffer containing calling name identification presentation CNIP name Pointer to and size of buffer containing ISDN user to user information optional Charging value number of units Charging multiplier Charging period Charging type See Charging type values for a list of valid values Charging value number of units Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Network provided clear cause value See Network provided clearing cause values for a list of valid values Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Description for information element 0 See Progress description values for a list of valid values Q 931 IE PCS user Does not map to an IE CNIP User user Not used Not used Not used Not use
209. lement was received ON OFF KT QD T O A S P 1 RI N 6 E W G S 0 A A S 7 N X X x x x x X x x x x x x x x x x x Q 931 IE Called party number Display Display Does not map to an IE Called party number Called party number Sending complete Message primitives Macro Description Q 931 IE Acu digit in x display nb Number of present occurrences Display Acu digit in x display size i Size of occurrence i optional Display Acu digit in x display total size Total size of the stored strings Display Acu digit in x display type i Type of display i Display Acu digit in x p display i Pointer to occurrence i Display ACU DIGIT RQ This topic describes e ACU DIGIT RO protocol variants e ACU DIGIT RQ macro descriptions and Q 931 IE Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to O Purpose Requests that called digits be sent in overlap receiving mode Conn id An allocated call ACU DIGIT RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table NT NT side only TE TE side only and x both NT and TE sides Macro 4 EN DE V H AN KT Q D E 1 MT N K UT OA S P S O 2 S S 6 G S T RI N S l T E WG S E A A S L N 1 Acu digit rq a digit X x TE NT x x TE x Acu digit rq digit size Filling order 1 Acu digit rq a display TE NT TE
210. list of valid values Redirecting number plan See Plan values for a list of valid values Redirecting number presentation Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Reason for redirection See Redirecting reason values for a list of valid values Message primitives Q 931 IE PCS user Low layer information Progress indicator Progress indicator Progress indicator Progress indicator Progress indicator Redirecting number Redirecting number Redirecting number 123 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn in redir nb screen Acu conn in redir nb type Acu conn in semi permanent circuit Acu conn in sending complete Acu conn in service Acu conn in service list id Acu conn in ss cnip name active Acu conn in ss cnip name pres Acu conn in stop bits 124 Description Redirecting number screening indicator See Screening indicator values for a list of valid values Redirecting number type See Number type values for a list of valid values Semi permanent circuit Indicates if the sending complete information element has been received ON OFF Service requested by the remote See Service values for a list of valid values Service list ID associated with the selected services list Indicates callin
211. ll reference Call reference Not used Not used Not used Not used Not used Not used 109 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu conn co connected nb pres Acu conn co connected nb screen Acu conn co connected nb type Acu conn co connected sub odd even Acu conn co connected sub type Acu conn co data chani Acu conn co data chani excl Acu conn co data chani nai Acu conn co data chani nb Acu conn co data chani tab i Acu conn co data chani tab nai i 110 Description Connected number presentation Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Connected number screening indicator See Screening indicator values for a list of valid values Connected number type See Number type values for a list of valid values Connected subaddress odd even Valid values are SUBADDRESS ODD Odd number of address signals SUBADDRESS EVEN Even number of address signals Connected subaddress type See Number type values for a list of valid values Data channel to use B1 B2 D Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use O Channel ID i NAI i Q 931 IE Connected party address Connected party address Connected part
212. lled nb sub Acu conn rq a called nb sub size Filling order 9 Acu conn rq a calling nb Acu conn rq calling nb size Filling order 2 Acu conn rq a calling nb2 Acu conn rq calling nb2 size Filling order 3 Acu conn rq a calling nb sub Acu conn rq a calling nb sub size Filling order 10 Acu_conn_rq_a_calling_name Acu_conn_rq_calling_name_size 130 Description Pointer to the called number 442 Pointer to and size of buffer containing called subaddress Calling number Second calling number Pointer to and size of buffer containing calling subaddress Pointer to and size of buffer containing calling name PMAOA Z z d4 Dr HO woz uog zl E OD kA 4 Q 931 IE Called party number called subaddress Calling party subaddress Calling party number calling subaddress Second calling party number calling subaddress Calling party subaddress Calling name Macro Acu conn rq a display Acu conn rq display size Filling order 7 Acu conn rq a display list Acu conn rq a ext parms Acu conn rq a facility Acu conn rq facility size Filling order 6 Acu conn rq a layer 1 info Acu conn rq a pcs user Acu conn rq pcs user size Filling order 8 Acu conn rq a redir nb Acu conn rq redir nb size Filling order 4 Acu conn rq a ss cnip name Acu conn rq ss cnip name size Filling order 11 Acu conn rq a tsp ie list Acu conn rq tsp ie
213. logic Dialogic Pro Brooktrout Diva Cantata SnowShore Eicon Eicon Networks NMS Communications NMS stylized Eiconcard SIPcontrol Diva ISDN TruFax Exnet EXS SwitchKit N20 Making Innovation Thrive Connecting to Growth Video is the New Voice Fusion Vision PacketMedia NaturalAccess NaturalCallControl NaturalConference NaturalFax and Shiva among others as well as related logos are either registered trademarks or trademarks of Dialogic Corporation or its subsidiaries Dialogic s trademarks may be used publicly only with permission from Dialogic Such permission may only be granted by Dialogic s legal department at 9800 Cavendish Blvd 5th Floor Montreal Quebec Canada H4M 2V9 Any authorized use of Dialogic s trademarks will be subject to full respect of the trademark guidelines published by Dialogic from time to time and any use of Dialogic s trademarks requires proper acknowledgement Windows is a registered trademark of Microsoft Corporation in the United States and or other countries The names of actual companies and product 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 lim
214. lt N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Reason for redirection See Redirecting reason values for a list of valid values Default REASON UNKNOWN Redirecting number screening indicator See Screening indicator values for a list of valid values Default N SCREEN USER PROVIDED N SCREEN USER PASSED for AusTel Redirecting number type See Number type values for a list of valid values Default N TYPE UNKNOWN Default for the 4ESS and VN6 variants N TYPE NATIONAL Indicates if sending complete information element is generated ON OFF Requested service See Service values for a list of valid values Q 931 IE Redirecting number Redirecting number Redirecting number Redirecting number Redirecting number Sending complete bc hlc llc Macro Acu conn rq ss cnip name active Acu conn rq ss cnip name pres Acu conn rq stop bits Acu conn rq syn asyn Acu conn rq transfer conn id Acu conn rq transfer rq Acu conn rq user rate Acu conn rq uui protocol Acu conn rq x display nb Message primitives Description Q 931 IE Indicates calling name CNIP identification presentation CNIP supplementary service should be invoked Calling name identification CNIP presentation mode Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRI CTED Presentation restricted N PRES NOT AVAILABLE Present
215. mation element Progress 0 See Location values for a list indicator of valid values Acu_setup_ack_in_signal_val Signal value See Signal values Signal value for a list of valid values Acu setup ack in x display nb Number of present occurrences Display Acu setup ack in x display size i Size of occurrence i optional Display Acu setup ack in x display total size Total size of the stored strings Display Acu setup ack in x display type i Type of display i Display Acu setup ack in x p display i Pointer to occurrence i Display ACU SETUP REPORT IN Signals an incoming call that has been rejected or ignored by the ACU because it was not compatible address or service filtering Use the macros associated with ACU CONN IN to access information for this message Conn id A currently unused ID Note The application must not answer this incoming call indication This message is only for informational purposes ACU TRANSFER CO This topic describes e ACU TRANSFER CO protocol variants e AC TRANSFER CO macro descriptions and Q 931 IE Purpose Indicates whether the attempted transfer was successful or not Conn id An allocated call 178 Message primitives ACU TRANSFER CO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table TE indicates the TE side only and x indicates both NT and TE sides Macro 4 E N D E V H A N K T Q D T E 1 M T N
216. mmary The following table summarizes the NMS ISDN Messaging API functions Function Synchronous Description Asynchronous isdnReleaseBuffer Synchronous Indicates that the application has completed processing of an ISDN event buffer isdnSendMessage Asynchronous Sends a message to an ISDN protocol stack instance isdnSetMsgCapture Asynchronous Enables or disables debugging trace information for the selected entity in the protocol stack isdnStartProtocol Asynchronous Initializes an ISDN protocol stack instance on a D channel context isdnStopProtocol Asynchronous Shuts down a previously started ISDN protocol stack instance on a context Using the function reference A prototype of each function is shown with the function description and details of all arguments and return values A typical function description includes Prototype The prototype is shown followed by a listing of the function s arguments NMS data types include e WORD 16 bit unsigned e DWORD 32 bit unsigned e INT16 16 bit signed e INT32 32 bit signed e BYTE 8 bit unsigned If a function argument is a data structure the complete data structure is defined Return The return value for a function is either SUCCESS or an error code For values asynchronous functions a return value of SUCCESS indicates the function was initiated subsequent events indicate the status of the operation Refer to NMS ISDN errors for a listing of all errors returned by NMS ISDN
217. mmediately indicating the operation was initiated The application can then call other functions while Natural Access is processing the command Asynchronous functions return SUCCESS if the function is successfully initiated The execution result arrives later in an event Asynchronous functions that return a non zero value were never initiated Therefore no subsequent events are generated If an asynchronous function fails after being initiated Natural Access delivers a DONE event to the application with an error code in the event value field Synchronous functions indicate completion by sending a return value The return value is either SUCCESS or an error code Refer to the Function summary for a list of all NMS ISDN functions and whether they are synchronous or asynchronous 17 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual NMS ISDN Messaging API application overview An NMS ISDN Messaging API application typically performs the following tasks Initialize Natural Access using Natural Access functions Initialize NMS ISDN NMS ISDN functions protocol stack Establish connection NMS ISDN functions Perform tasks Natural Access functions Stop protocol stack NMS ISDN functions The following table provides a summary of the tasks illustrated In this phase The application Initialize Natural Makes CT bus switch connections to route D channel data to the Access HDLC controller and to r
218. n a display list Acu progress in a ext parms Acu progress in a facility Acu progress in facility size Acu progress in a pcs user Acu progress in pcs user size Acu progress in a q931 Acu progress in q931 size Acu progress in call ref length Acu progress in call ref value Acu progress in cause Description Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN facility information optional Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Length of call reference value Call reference value and call reference flag Cause value Message primitives pmzoma T QD T A S P 1 I I N 6 W Gs O0 A S 7 N x x x x x x Q 931 IE Display Display Not used Facility PCS user Does not map to an IE Call reference Call reference Cause 165 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu progress in data chani Acu progress in data chani excl Acu progress in data chani nai Acu progress in data chani nb Acu progress in data chani tab i Acu progress in data chani tab nai i Acu progress in ext parms lgth
219. n is exchanged and delivered end to end They also define process to process communication and describe application independent user services user interfaces and applications Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual The following illustration shows the hierarchy of layers End to end layers End to 7 end layers U L wm Data link 1 430 BRI and 1 431 Physical PRI protocol Physical Host Host Q 931 protocol Chained Q 921 LAPD protocol layers The functionality provided by a layer includes the services and functions of all of the layers below it A service access point SAP is the point at which a layer provides services to the layer directly above it A unique service access point identifier SAPI is associated with each SAP I nformation exchange between layers Cooperation between entities on the same layer is governed by a peer to peer protocol specific to the layer and the entity To exchange information between two or more layer entities a connection must be established between the layer entities using the protocol of the layer directly below Connections are provided by a layer between two or more SAPs Data message units are conveyed between peer to peer entities at the lowest layer by means of a physical connection Layer n 1 requests services from layer n through primitives These primitives allow the logical exchange of information and
220. nd size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of buffer containing raw data of incoming Q 931 message Cause value Data channel to use B1 B2 D Channel IDs are preferred OFF or exclusive ON NAI Number of channel IDs in the chani list field If no channel IDs use O Channel ID i NAI i Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Description for information element i See Progress description values for a list of valid values Description for information element 0 See Progress description values for a list of valid values Q 931 IE PCS user Does not map to an IE Cause Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Not used Not used Progress indicator Progress indicator 177 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Description Q 931 IE Acu setup ack in progress ind nb Number of progress indication Progress information elements indicator Acu setup ack in progress loc vi Location of information element Progress i See Location values for a list indicator of valid values Acu setup ack in progress location Location of infor
221. nel fails B channel signaling information carried by the channel is transferred to the backup D channel When a transition occurs most stable calls those calls in the active or connected states can be preserved although message associated user to user information MA UUI and both call associated and non call associated temporary signaling connections may be lost There is a small interval controlled by timer T309 after a failure of the LAPD link before the B channels are removed from service If the primary D channel fails and timer T309 is enabled the t309 parameter in the ISDN PROTOCOL PARMS Q931CC structure is set to 1 any calls that are in the connected state at the time of the failure are preserved Any calls that are initiated but have not entered the connected state are cleared Each cleared call receives e ACU CLEAR CO ACU stack mode or e NCCEVN CALL DISCONNECTED channelized stack mode 268 NFAS and D channel backup If the primary D channel fails and timer T309 is disabled the t309 parameter is set to O all initiated calls on both terminal and network sides are cleared with ACU CLEAR CO or NCCEVN CALL DISCONNECTED messages After the data link is reestablished on the backup D channel the application can start placing and receiving new calls If the data link on the backup D channel cannot be established the stack keeps trying to establish the link until one of the D channel s connections is reestablished
222. nnels D channel for all trunks in NFAS group 1 Di 24 B channels NFAS group 1 24 B channels NFAS group 1 B channels backup D channel for all trunks in NFAS group 1 D2 At any point in time only one of the D channels D1 or D2 conveys B channel signaling information The other D channel remains in a standby role and is active at the LAPD layer layer 2 only While the backup D channel is on standby any layer 3 messages received on it are ignored Neither D1 nor D2 can serve as a B channel while designated as a backup D channel Also each D1 D2 pair provides signaling only for the set of B channels assigned to it and cannot backup any other D channel s on a different interface When both D channels are out of service D1 has priority as the channel to carry call control signaling If D1 cannot be established then D2 is chosen Setting up D channel backup The D channel to use as the backup is specified in the configuration file For more information see the NMS ISDN Installation Manual Note Both primary and backup D channels must be defined on the same board and belong to the same NFAS group In order to preserve active call signaling information in the event of the D channel failure the application can enable the t309 parameter defined in ISDN PROTOCOL PARMS Q931CC or ISDN PROTOCOL PARMS CHANNELIZED This parameter enables timer T309 described in the NSF IE structure Handling D channel failure When the primary D chan
223. nt on the remote side of the ISDN trunk has acknowledged a SABME message sent by the ISDN protocol stack and has sent back a UA message indicating that the data link is established DL EST IN Indicates that the NMS ISDN protocol stack has received a SABME message The stack automatically acknowledges the message by sending back a UA message and establishes the data link DL EST RQ Requests that the stack establish a data link The stack transmits a SABME message over the trunk Sent by the application to the NMS ISDN protocol stack DL REL IN If the NMS ISDN software is in the IDLE state this message indicates that an establishment request sent by the NMS ISDN protocol stack was not successfully answered If the software is in the DATA LINK ESTABLISHED state this message indicates that the data link has been broken DL U DA IN Indicates that the trunk from the remote party has received a packet of unacknowledged data 66 Message type Description Message primitives DL U DA RQ Requests that the stack transmit a packet of unacknowledged data Sent by the application to the NMS ISDN protocol stack ACU primitives summary NMS supports the generic ISDN protocol but no longer supports the Omnitel stack The following table summarizes the supported ACU message primitives and indicates which primitives are deprecated Message type ACU ALERT IN ACU ALERT RQ ACU CALLID IN ACU CALL PROC IN ACU CALL PROC RQ ACU CLEAR CO
224. o ated ee uh EE 186 UUI protocol discriminator values Immer nnns 186 Signal Values E 187 Network provided clearing cause VAlUCS ice cece reenter 188 Cle r code valles ta Seu metet Me eos hed eure ort est eile arts 191 Facility Code values esee te eas ashes Maes ai eae eta due ie 192 Action code Values aceti e derer Ure un vert gues Ege veo ee ed curd e vr need ta 193 Mode Code values Suit e de Ee xe ete eta dte edes e ede s dene 193 Error cause VALES ui atta aa oim on era eet em teg e St m eat ee ede n ate f 194 Progress description values mnm esee esee esee enne nnns 194 Charging type Values ii ee Rte E eee A de 195 Endpoint LD Valles ict ro oes or li ch O ed eodem d 195 11 isdndemo Layer 3 call control omcnonocnonocnonacnnracnnracnnrannnracnnracanracanracanencanes 197 EXPO esee mesee esee esee esee esee see esee 197 USING Ee ele DEE 200 isdnidermo compllatlon oot ee cases eee ers 201 E cpu 201 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Using NFAS with Isdndemg meses e nnne nnns 202 isdndemo program structure and codimg mmn 202 isdndemo program Ipitialtzation mmm emen enn 204 isdndermo A ar ERR ERU ARE ERR URN EE PER e EMEN ERE 204 iiia mem MM 204 DChannel EET 204 INA sen EDT 205 Calla E 205 BEE hata I Avec a m ced uuo M uet cob an doa 206 Hire 206 Processing ISDN call control events 207 Placing and receiving call 207 12 lapddemo LAPD demonstration program
225. of messages sent between the ACU and the application for an accepted inbound call The actual messages sent back and forth in response to an incoming call may differ from this example depending upon the settings of the bits in the in calls behaviour substructure This substructure is referenced in the ISDN PROTOCOL PARMS structure passed to isdnStartProtocol For details see ISDN PROTOCOL PARMS Q931CC parameters and ISDN PROTOCOL PARMS LAPD parameters ACU Q 931 Trunk stack Application Setup ACU CONN IN Alert is sent by TE side stacks Alert only NT side stacks send Connect ACU CONN RS call proceeding here instead Conn Ack ACU CONN CO Time Time Time I ncoming calls with overlap receiving mode enabled If overlap receiving mode is enabled when a call arrives the ACU sends an ACU CONN IN message to the application even if the called number the calling number or both are not complete The ACU then sends any additional incoming digits in ACU DIGIT IN messages To enable this mode set the CC TRANSPARENT OVERLAP RCV bit in in calls behaviour This substructure is referenced in the ISDN PROTOCOL PARMS structure passed to isdnStartProtocol For details see ISDN PROTOCOL PARMS Q931CC parameters and ISDN PROTOCOL PARMS LAPD parameters Rejecting the call To reject the call the application builds a clear request message ACU CLEAR RQ and sends it to the protocol stack When the call is released the net
226. ointer to occurrence i e ACU_CONN_CO protocol variants e ACU CONN CO macro descriptions and Q 931 IE Purpose Indicates a call connection confirmation 104 Q 931 IE Not used Not used Not used Not used PCS user Bearer capability User user Display Display Display Display Display Message primitives Conn id An allocated call ACU CONN CO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides E N 1 0 2 Macro nzu H am OZ e OAL Prm uc N T T LO Om P SmnaoOs Zz z d4 a no nnZzUUu Noor Acu conn co a connected nb x X Acu conn co connected nb size Acu conn co a connected sub x x Acu conn co connected sub size Acu conn co a date time X X X x Acu conn co a display X x X X X X X X X x Acu_conn_co_display_size Acu conn co a display list X x X X X X X X x x Acu_conn_co_a_ext_parms Acu conn co a facility X x x X x Acu_conn_co_facility_size Acu conn co a pcs user x Acu_conn_co_pcs_user_size Acu conn co a q931 X X X IX X IX X X X X X X x x Acu conn co q931 size Acu conn co a redir nb X X Acu conn co redir nb size Acu conn co a ss cnip name x Acu_conn_co_ss_cnip_name_size Acu_conn_co_a_uui X X X x X x x X x Acu_conn_co_uui_ size 105 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual
227. on that determines how to set up your boards for use These files also contain country specific information and define what trunks are assigned to which D channels Several example files are included describing ISDN configurations for different boards Use these files to create a file describing your hardware and software setup For details see the NMS OAM System User s Manual Demonstration programs and utilities The following demonstration programs and utilities are included with their source code files and makefiles Program Description isdndemo Communicates with the ISDN stack in the ACU configuration and performs call control lapddemo Illustrates establishing a LAPD data link on an ISDN trunk dectrace Decodes and displays messages sent or received by the NMS ISDN protocol stack that were previously captured in a log file by the oammon utility itrace Acts as a runtime filter for NMS ISDN messages from the stack being captured by the oammon utility 15 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Other components In addition to the NMS ISDN software you need the following components to build an NMS ISDN protocol application e One or more NMS T1 El or BRI trunk interface boards e Natural Access Warning NMS Communications obtains board level approvals certificates for supported countries Some countries require that you obtain system level approvals before connecting a
228. only certain services and an incoming call requests a different service the protocol stack automatically rejects the call The following available services are defined in isdnval h Service Description FAX SERVICE G3 facsimile service FAX 4 SERVICE G4 facsimile service DATA SERVICE Data service DATA GC SERVICE Data service on GCI bus DATA 56KBS SERVICE Data at 56 kbit s service RAW DATA SERVICE Raw data service on GCI bus no MPH B INIT RQ is generated no B channel driver is associated 236 Service DATA TRANS SERVICE MODEM SERVICE AUDIO 7 SERVICE X25 SERVICE X25 PACKET SERVICE VOICE SERVICE VOICE GCI SERVICE RAW TELEPHONY SERVICE VOICE TRANS SERVICE V110 SERVICE V120 SERVICE VIDEO SERVICE TDD SERVICE DATA HO SERVICE DATA H11 SERVICE DATA H12 SERVICE DATA MULTIRATE SERVICE DATA 128KBS SERVICE NO B CHAN SERVICE FAX RELAY SERVICE Parameters Description Transparent data service Modem data service 7 kHz audio service X 25 circuit mode service X 25 packet mode service Voice service Voice service on GCI bus Raw telephony service on GCI bus no MPH B INIT RQ generated no B channel driver is associated Transparent voice service V 110 service V 120 service Video service TDD service Data using HO 384 kbit s channel service PRI only Data using H11 1536 kbit s channel service Data using H12 1536 kbit s channel service Data using multirate
229. onsists of the following files File Description lapddemo c The main application program code isdnlib c A library of functions used by the main program to build correct Q 931 messages lapdlib h The prototypes for the functions contained in isdnlib c plus the definitions of the structures used by those functions decisdn h The definitions used to build Q 931 information elements and messages Can be found in Operating Directory system Windows nms ctaccess demos isdndemo UNIX opt nms ctaccess demos isdndemo lapddemo cfg An example of a configuration file for this demonstration program 212 lapddemo LAPD demonstration program lapddemo configuration file lapddemo reads a configuration file to determine what Q 931 messages to send and how to respond to incoming messages A sample configuration file lapddemo cfg is supplied with the demonstration Specify the configuration file to use with the f filename option Note Specifications for outgoing calls are not given in the default configuration file You must make additions to this file for the demonstration program to achieve the CONNECTED state for outbound calls Two types of information appear in the file e Parameters and associated values e Message exchange rules Parameters and associated values Each parameter appears on a separate line followed by a space and then the assigned value The following parameters can be set in the configuration file Par
230. ormer terminology NMS Mini RJ 21 interface NMS Mini RJ 21 to NMS RJ 21 cable NMS RJ 45 to two 75 ohm BNC splitter cable NMS signal entry panel Video Access Utilities Video Mail Application Demonstration Program Video Messaging Server Interface 3G 324M Interface Dialogic terminology Dialogic MD1 Mini RJ 21 interface Dialogic MD1 Mini RJ 21 to MD1 RJ 21 cable Dialogic amp MD1 RJ 45 to two 75 ohm BNC splitter cable Dialogic amp Signal Entry Panel Dialogic amp NaturalAccess Video Access Toolkit Utilities Dialogic amp NaturalAccess Video Access Toolkit Video Mail Application Demonstration Program Dialogic amp NaturalAccess Video Access Toolkit Video Messaging Server Interface Dialogic amp NaturalAccess Video Access Toolkit 3G 324M Interface 2 NMSISDN Messaging API overview I ntegrated Services Digital Network ISDN Integrated Services Digital Network ISDN is a continually evolving international standard for networking services including voice and non voice services The network is completely digital from one end to the other Voice information is digitized and sent in digital form Signaling information is sent separately from voice information using a method called common channel signaling CCS This topic describes e ISDN protocols and protocol layering e Information exchange between layers I SDN protocols and protocol layering ISDN communications can be described at many levels
231. osed to the API DMS T3MI not exposed to the API DMS T3MB not exposed to the API Value network side in seconds 40 120 5 DMS TSPID not exposed to the 0 API Timers Value user side in seconds 40 120 20 USA National I SDN 2 layer 3 timer defaults timer val EE T_LAST Timer index NI2_T300 NI2_T301 NI2_T302 NI2_T303 NI2_T305 NI2_T306 NI2_T308 NI2_T309 NI2_T310 NI2_T313 Value network side in seconds 1 180 15 5 30 60 4 30 40 4 NI2_T316 not exposed to the API 30 Value user side in seconds 1 0 30 259 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Timer index Value network side Value user side in in seconds seconds NI2 T317 not exposed to the API 20 20 NI2 T321 not exposed to the API 5 40 pn D not exposed to the 0 20 Australian Telecom 1 layer 3 timer defaults timer val t aul AU1 T LAST Timer Index Value network side in Value user side in seconds seconds AU1_T300 1 1 AU1_T302 15 0 AU1_T303 4 15 AU1_T305 30 30 AU1_T306 60 0 AU1_T308 4 4 AU1_T309 2 90 AUT T310 10 0 AUT T312 6 4 AUI T316 not exposed to 30 30 the API AUI T317 not exposed to 25 25 the API AUT T322 4 4 Hong Kong Telephone layer 3 timer defaults timer val t hkt HKT T LAST 260 Timer index HKT T300 HKT T301 HKT T302 HKT T303 HKT T304 HKT T305 HKT T306 HK
232. oute B channel information to DSP resources if necessary Initializes Natural Access services and creates one context for each B channel and D channel Starts the nocc no call control trunk control program TCP on each B channel context Initialize NMS ISDN Calls isdnStartProtocol to start up an ISDN protocol stack protocol stack instance on each D channel context This function also determines whether the stack runs in LAPD ACU or channelized stack mode Establish connection Uses isdnSendMessage to send ACU or LAPD messages to the stack to establish a connection 18 Messaging API programming model In this phase The application Perform tasks Uses functions from Natural Access or from other services to play or record voice generate or detect DTMF tones send and receive faxes and other tasks Disconnect Uses isdnSendMessage to send ACU or LAPD messages to the stack to terminate the connection Stop protocol stack Calls isdnStopProtocol to stop the ISDN protocol stack Initializing boards Before you can run an NMS ISDN application you must initialize and load DSP files trunk control programs TCPs and protocol stack runfiles to your board s The items to load to the boards are specified in board keyword files To load the components to your boards run oamsys the board initialization and monitoring utility To learn how to create a configuration file for your setup see the NMS ISDN Installation Manu
233. ows ISDN MESSAGE Value field nai Specifies the network access identifier NAI of the destination trunk from ent ENT APPLI Indicates that the message is sent from the application to the stack to ent ENT CC Indicates that the message is sent to the call control layer ACU to sapi ACU SAPI Specifies the unique service access point identifier SAPI associated with the ACU service access point SAP conn id Specifies the connection ID of the call that the message concerns code Specifies the primitive of the ACU message for example ACU CONN RQ info infl inf2 Reserved for internal data relay inf3 inf4 data_size Specifies the size of the message buffer containing data associated with message nfas_group Specifies the NFAS group number for this network access identifier NAI Used only if duplicate NAI values are defined userid Not used An application can specify custom information elements containing raw Q 931 data using transparent IEs For details see Overview of Q 931 data 21 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Sending LAPD messages The NMS ISDN stack must be in LAPD stack mode to send LAPD messages To send a LAPD message the application builds an ISDN MESSAGE structure specifying the message primitive and other data as follows ISDN MESSAGE field nai from ent to ent to sapi conn id code infO infl inf2 inf3 inf4 data size nfas group userid Valu
234. p NFAS group number if duplicate NAI values BYTE bpadl 2 For 8 bytes alignment SCH Size is now 32 bytes SEH ISDN PROTOCOL PARMS LAPD ISDN PROTOCOL PARMS Q931CC structure ThelSDN PROTOCOL PARMS Q931CC data structure configures the protocol stack for Q 931 call control A pointer to this structure is passed as an argument to isdnStartProtocol Refer to ISDN PROTOCOL PARMS Q931CC parameters for more information on the default values of the parameters in this structure The structure is defined as typedet struct ISDNSPBOTOCORCPARMS OSSICC DWORD size Ve Sillas o the GESENDET E use Br NAI when interfacing the physical layer Should be the same as the nai ECH WORD rate Data rate ECH WORD t309 T309 in use flag SCH union These structures contain sets of values timer_val_t at5 AT5_T_LAST for ISDN timers The actual set used K timer val t at9 AT9 T LAST depends upon the country variant ECH timer val t dms DMS T LAST specified with the country argument timer val t nil NI1_T LAST in the isdnStartProtocol call The timer val t ni2 NI2 T LAST structures should be set to 0 in f timer val t aul AUI T LAST order to use the built in defaults ECH timer val t hkt HKT T LAST defined by the network signaling ay timer val net NITT_T_LAST layers of the ISDN protocol stack ES timer val t bt2 BT2 T LAST Timers are specified in milliseconds ECH timer va
235. play size i Acu progress in x display total size Acu progress in x display type i Acu progress in x p display i ACU PROGRESS RQ This topic describes Description Location of information element O See Location values for a list of valid values Signal value See Signal values for a list of valid values Number of present occurrences Size of occurrence i optional Total size of the stored strings Type of display i Pointer to occurrence i e ACU PROGRESS RO protocol variants e ACU PROGRESS RQ macro descriptions and Q 931 IE Purpose Indicates progress request Conn id An allocated call ACU PROGRESS RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro Acu progress rq a tsp ie list Acu progress rq tsp ie list size Acu progress rq cause 4 E ND E VH N E 1 MT N K T S O 2 S S 6 G T S l Gell wu KB X x lt x lt x lt x lt x lt x lt x lt x lt Message primitives mzoma Q 931 IE Progress indicator Not used Display Display Display Display Display T Q A S gd W G A N x x x x unz uog NOOF 4 167 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro 4 E NDEVHA NK T QD T E 11 MT N K U T OA SP 1 S O 2 S S6G ST RI I N 6 S I T E WGS 0 E A A S 7 L N 1 Acu progress rq cause location X X IX X X
236. pose Confirms release Conn id An allocated call ACU CLEAR CO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table TE indicates the TE side only and x indicates both NT and TE sides Macro 4 E S S Acu clear co a display Acu clear co display size Acu clear co a display list Acu clear co a ext parms Acu clear co a facility Acu clear co facility size Acu clear co a pcs user Acu clear co pcs user size Acu clear co a q931 x Acu clear co q931 size Acu clear co a uui Acu clear co uui size Acu clear co charging available Acu clear co charging multi Acu clear co charging period orm Mr ID SO vnm V N 6 TE H K G Prm uc N T T Message primitives DMxOA Z z d x Q S l G nnZzvUu zl O Oo Hi cd 89 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro nnma Acu_clear_co_charging_type Acu clear co charging value Acu clear co ext parms lgth Acu clear co ext parms nb Acu clear co network cause x Acu clear co network cause loc x Acu clear co pcs user protocol Acu clear co ret code x Acu clear co total cost Acu clear co uui protocol Acu clear co x display nb Acu clear co x display size i Acu clear co x display total size Acu clear co x display type i Acu clear co x p display i orm Mr ID SO vnm oz lt TE TE OAI B
237. pplication architecture ACU configuration Application NMS ISDN Natural Switching library Access service NENNEN Acewexmande ISDN Other ACU messages sent using events Other events isdnSend Message commands Network layer SDN protocol stack CH c DSP resources H 100 H 110 Data link layer MVIP HDLC D channel data switch Data from B channels Board NMS ISDN LAPD configuration Access at the data link layer is useful if an application must support a private data link protocol or if the user wants to create a complete Q 931 protocol at the application level At this level the messages sent and received by the application constitute LAPD frames The NMS ISDN protocol stack runs in LAPD stack mode as shown in the following illustration 11 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Application NMS ISDN Switching library Natural Access service OT A Context mande 4 1 ISDN Other LAPD frames sent using 9Vents Other events isdnSendMessage commands o o 2 E Su E L z v a S Data link layer Data link layer e em H 100 H 110 MVIP HDLC WD channel data Prine Data from B channels Board In this mode the protocol stack implements ISDN layer 2 functionality No ACU is present Instead the application uses the NMS ISDN Messaging API to send LAPD frames directly to the data link layer layer 2 Events coming from th
238. proc rq x display type i Acu call proc rq x p display i ACU CALL PROC RQ macro descriptions and Q 931 IE Macro Acu call proc rq a display Acu call proc rq display size Filling order 1 Acu call proc rq a display list Acu call proc rq a ext parms Acu call proc rq a pcs user Acu call proc rq pcs user size Filling order 2 Acu call proc rq a tsp ie list Acu call proc rq tsp ie list size Filling order 3 Acu call proc rq data chani uma orm MN uzo Nm Description OS e DS Prmauncp 442 PMAOKA Z z d4 Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing extended parameters Pointer to and size of buffer containing ISDN PCS to user user to PCS information See PCS user information elements for more information on this IE Pointer to and size of transparent IE buffer Data channel to use B1 B2 D Message primitives Dr WO wozug zl E OD kA 4 X x lt Q 931 IE Display Display Not used PCS user Does not map to an IE Channel identification 87 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu call proc rq data chant excl Acu call proc rq data chani nai Acu call proc rq data chani nb Acu call proc rq data chani tab i Acu call proc rq data chani tab nai i Acu call proc rq ext parms Ilgth
239. ption Acu alert rq progress ind nb Acu alert rq progress loc x i Acu alert rq progress location Acu alert rq signal val Acu alert rq ss cnip name active Acu alert rq ss cnip name pres Acu alert rq uui protocol Acu alert rq x display nb Message primitives Description Q 931 IE Protocol discriminator for the pcs_user PCS user information element See PCS user information elements for more information on this IE Description for information element i Progress See Progress description values for a indicator list of valid values Description for information element 0 Progress See Progress description values for a indicator list of valid values Number of progress indication Progress information elements indicator Location of information element i See Progress Location values for a list of valid indicator values and default setting information Location of information element 0 See Progress Location values for a list of valid indicator values and default setting information Signal value See Signal values for a Not used list of valid values Indicates calling name identification CNIP presentation CNIP supplementary service should be invoked Calling name identification CNIP presentation mode Allowed values N_PRES_ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available UUI protocol discriminator value See Us
240. ptional Acu digit rq x display total size Total size of the stored strings Acu digit rq x display type i Type of display i Acu digit rq x p display i Pointer to occurrence i ACU ERR IN This topic describes e ACU ERR IN protocol variants e ACU ERR IN macro descriptions and Q 931 IE Purpose Indicates an error Conn id An allocated call ACU ERR IN protocol variants Message primitives Q 931 IE Called party number Sending complete Display Display Display Display Display The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E N D E V H A N E 3 M T N K U T S 0 2 S S 6 G S T S I T E L 1 Acu err in cause X X X X X X X x x X x X X X x x X x Acu err in diagnostics Dmzoma Z z d4 X Q S I G nnZzuu NOOP 153 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU ERR IN macro descriptions and Q 931 IE Macro Description Q 931 IE Acu_err_in_cause Error cause See Error cause values for Does not map to an IE a list of valid values Acu err in diagnostics Diagnostic Does not map to an IE ACU FACILITY IN This topic describes e ACU FACILITY IN protocol variants e ACU FACILITY IN macro descriptions and Q 931 IE Purpose Indicates a FACILITY message Conn id An allocated call ACU FACILITY IN protocol variants T
241. q charging period Acu clear rq charging type Acu clear rq charging value NT Acu clear rq ext parms lgth Acu clear rq ext parms nb Acu clear rq pcs user protocol X Acu clear rq priority Acu clear rq signal val Acu clear rq ss cnip name active Acu clear rq ss cnip name pres Acu clear rq total cost Acu clear rq uui protocol Acu clear rq x display nb Acu clear rq x display size i Acu clear rq x display total size Acu clear rq x display type i Acu clear rq x p display i 98 442 mazon Zz z 7 d x ano nnZzvUu zl OO Oo Hi cd Message primitives ACU CLEAR RO macro descriptions and Q 931 IE Macro Acu clear rq a display Acu clear rq display size Filling order 3 Acu clear rq a display list Acu clear rq a ext parms Acu clear rq a facility Acu clear rq facility size Filling order 2 Acu clear rq a pcs user Acu clear rq pcs user size Filling order 4 Acu clear rq a ss cnip name Acu clear rq ss cnip name size Filling order 5 Acu clear rq a tsp ie list Acu clear rq tsp ie list size Filling order 6 Acu clear rq a uui Acu clear rq uui size Filling order 1 Acu clear rq cause Acu clear rq charging available Acu clear rq charging multi Acu clear rq charging period Acu clear rq charging type Acu clear rq charging value Description Pointer to and size of buffer containing ISDN display information optional Pointer to display structure Pointer to buffer containing
242. r of parameters in buffer containing extended parameters Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Call clear priority Allowed values include ACU PHIGH normal ACU PLOW urgent Signal value See Signal values for a list of valid values Indicates calling name identification presentation CNIP supplementary service should be invoked Calling name identification presentation CNIP mode Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Pointer to display structure UUI protocol discriminator value See UUI protocol discriminator values for a list of valid values Default UUI IA5 UUI USER SPF for HKG variant Number of present occurrences Size of occurrence i optional Total size of the stored strings Q 931 IE Not used Not used PCS user Low layer compatibility Not used CNIP CNIP Not used User user Display Display Display Message primitives Macro Description Q 931 IE Acu clear rq x display type i Type of display i Display Acu clear rq x p display i Pointer to occurrence i Display ACU CLEAR RS This topic describes e ACU CLEAR RS protocol variants e ACU CLEAR RS macro descriptions and Q 931 IE Note Address parameters must be set according to the filling order If one
243. re invalid ISDNERR PROTOCOL NS FAILURE Network signaling parameters are invalid ISDNERR PROTOCOL PH FAILURE Physical layer parameters are invalid This function starts the specified protocol on the board that is associated with the specified ctahd 62 Function reference The run module is specified in the board keyword file For information refer to the NMS ISDN Installation Manual and the NMS OAM System User s Manual If the parms pointer is NULL the default values for the specified protocol are used It is assumed that an HDLC data stream was connected to the specified HDLC controller during initialization or by explicit switching calls The parameters for the particular selected protocol are found in the parms data structure defined in isdnparm h See also isdnStopProtocol Example 1 DWORD mystartisdn CTAHD ctahd Use defaults CTA_EVENT event DWORD ret char errortext 40 unsigned nai 0 nai 0 ret isdnStartProtocol ctahd ISDN PROTOCOL Q931CC SDN OPERATOR NI2 COUNTRY USA ISDN PARTNER NT nai NULL if ret SUCCESS ctaGetText ctahd ret errortext 40 printft START FAIL sin errortext ji return MY ERROR START FAILED myWaitForEvent ctahd amp event if event value SUCCESS ctaGetText ctahd event value errortext 40 printf START FAIL s n errortext return MY ERROR START FAILED return SUCCESS P Example 2 DWORD mystartisdn CTAHD ctahd
244. rk access identifiers NA 32 Initializing ISDN protocol stack Imstances mme 32 Starting the NOCC TCP ii ip SEN cies ov ENEER ENKER EES NEEN ke dies ENNER NEEN e aka 33 Stopping an ISDN protocol stack Imnstance mmm 34 Table Of Contents 5 Call control ACU configuration eee esee nennen E KEE EE nnne nnn nnn EEN 35 Connection IDs xe xe NENNEN ERR ex xe vh SNE AN DEEN SN SEENEN KEEN xe ER iw Ee ie 35 ISDN call control state machine 35 Receiving inbound call Sas a aa a e A A A e seems mese meses esee esee 36 Accepting the Call ipse en xt pee a Gees es 36 Incoming calls with overlap receiving mode enabled eee e eee eee ee eaten ea eee 36 Rejecting the calla aa ease 36 Placing outbournd calls Sreser aa to 37 Calls Colisi n aee Tr 37 CAMA AN NA A A oes Seatac eee ae 39 Clear coll Oc A Ae eet 40 6 Data link operations LAPD essen nennen enne nn nnne nnne nnn nnn 42 NMS ISDN state machine LAPD configuration ssssssseeen meme 42 Initiating a data link e ERR ENNER EN EXP edie ED ERR RE Tenia RED een Eg 42 Responding to a data link establishment request cece cece eee eee eee eae ee eae ee aes 43 Sending messages across an established Imk sess 44 7 Messaging API data structures EEN ERER REENEN ENEE ENEE ENER EN ENEE ENER E ERR EEN 45 Overview of API data structures 20 0 0 ccc se ee ehe esee enses nme senes 45 Ge Un egen DEE 45 Protocol parameter Structures
245. roc in progress descr x i Description for Progress indicator information element i See Progress description values for a list of valid values Acu call proc in progress description Description for Progress indicator information element O See Progress description values for a list of valid values 84 Macro Acu call proc in progress ind nb Acu call proc in progress loc x i Acu call proc in progress location Acu call proc in signal val Acu call proc in x display nb Acu call proc in x display size i Acu call proc in x display total size Acu call proc in x display type i Acu call proc in x p display i ACU CALL PROC RQ This topic describes Description Number of progress indication information elements Location of information element i See Location values for a list of valid values Location of information element 0 See Location values for a list of valid values Signal value See Signal values for a list of valid values Number of present occurrences Size of occurrence i optional Total size of the stored strings Type of display i Pointer to occurrence i e ACU CALL PROC BO protocol variants e ACU CALL PROC RQ macro descriptions and Q 931 IE Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to O Purpose Requests events indicating the progress of a call Conn id An allocated call Me
246. rotocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro orm NM uzo Nm OS e DS N T T numa HE med oC P mazon GUTE a no AER NO O0 Hm cl x x Acu alert in a display x X x x x x Acu_alert_in_display_size Acu_alert_in_a_display_list Acu_alert_in_a_ext_parms Acu_alert_in_a_facility x X X x Acu_alert_in_facility_ size Acu_alert_in_a_pcs_user x Acu alert in pcs user size Acu alert in a q931 X X X X X X X X X X X X X x Acu alert in q931 size Acu alert in a redir nb x x Acu_alert_in_redir_nb_size Acu alert in a ss cnip name x Acu alert in ss cnip name size Acu alert in a uui X x X Xx X X x Acu_alert_in_uui_size Acu_alert_in_alert Acu alert in call ref length X Acu alert in call ref value X Acu alert in data chani X X X X X X X X X X X X x x Acu_alert_in_data_chani_excl x Acu alert in data chani nai x 70 Macro Acu alert in data chani nb Acu alert in data chani tab i Acu alert in data chani tab nai i Acu alert in ext parms lgth Acu alert in ext parms nb Acu alert in pcs user protocol Acu alert in progress descr x i Acu alert in progress description Acu alert in progress ind nb Acu alert in progress loc x i Acu alert in progress location Acu alert in redir nb plan Acu alert in redir nb pres Acu alert in redir nb reason Acu al
247. rrors KREE KEE ENKE ENKE KREE KREE KREE ERKENNEN ku 229 NMS ISDN events reien anenai i aaa ni a aaa aia ai aAA EAS 229 NMS ISDN PeaSONS EE 229 NMS ISDN CFOs cdc oed nx rne ane RE RE Aie Eam EN ER E spinon vine RR a asinine ua RR HR ERA e 231 16 Parameters omomccnonconconcnncnncnncnncnn cnn cnncn ERR ERR ERR RR nn nn nr anna nrnnrnnrnncnncnncnncnncnncansss 232 ISDN PROTOCOL PARMS LAPD pDarameters eect eee teeter teeta eee teenie nates 232 ISDN PROTOCOL PARMS Q931CC oarameters cora ncnnnn ne 233 Protocol parameter settings c cece eee eese seems messes ene enne 236 Services list field EE 236 in calls behaviour Tel Cisse eii tra pi id ME ada TA Mp a ee Ta 238 out calls behaviour feld ANNE ENNEN meme nennen emen 240 acu behaviour fleld veia ri Fera ver oen Eo dere EE EDI rn EHE Ve REIR EE RR DERE eb deen dened 242 NS DEHAVIOUE Tel e M 242 vi Table Of Contents qsig source party nb wvpefield mms menn 245 gelg source fvpe of nb feld NENNEN ENNER ENEE ronca renis 245 17 Sending and receiving raw Q 931 data omonocccnococnorocnonacnnracnnracnnracnnracanrananes 247 Overview of Q 931 data 247 Creating transparent IES 10 0 EY ERR NENNEN NN ENNEN re E PR DER ee 247 Transparent IE formatting rules mm enm 248 Accessing and reading a Q 931 butter 249 18 Sending and receiving PCS user information eene 250 PCS user
248. rs charging value Acu conn rs connected nb plan Acu conn rs connected nb pres Acu conn rs connected nb screen Acu conn rs connected nb type Acu conn rs connected sub odd even Acu conn rs connected sub type Acu conn rs data bits Acu conn rs data chani Acu conn rs data chani excl Acu conn rs data chani nai Acu conn rs data chani nb Acu conn rs data chani tab i Acu conn rs data chani tab nai i Acu conn rs date available Acu conn rs day Acu conn rs ext parms length Acu conn rs ext parms nb Acu conn rs hour Acu conn rs minute 140 nnma orm N Z nZU un m X X az lt OAI pPrm uc X X X X X X X X X X X X X X X X 422 pDMIOA ZzZ z d4 be As wuoz uoug d OO gt Macro Acu conn rs month Acu conn rs p display i Acu conn rs parity Acu conn rs pcs user protoco Acu conn rs ph rate Acu conn rs priority Acu conn rs second Acu conn rs service Acu conn rs ss cnip name active Acu conn rs ss cnip name pres Acu conn rs stop bits Acu conn rs syn asyn Acu conn rs user rate Acu conn rs uui protocol Acu conn rs x display nb Acu conn rs x display size i Acu conn rs x display total size Acu conn rs x display type i Acu conn rs year nnma orm NM Z BEE vnm X X X X X az lt DS PrmancecpD 442 mzom z z d4 Message primitives x be As nnZzUvUU d OO cd 141 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual
249. rvices are disabled Supplementary service extended data structures in the extended data area are ignored 239 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Value Description CC SET CHAN ID If this bit is set the stack forces the channel ID information element to be present in the first message in response to a SETUP even if the specifications do not consider this mandatory CC BEHAVIOUR NIL If this bit is set to 1 and all other bits in in calls behaviour are set to 0 no messages are automatically sent by the stack in response to an incoming call The application must build and send all messages If any other bits are set this bit is ignored The stack sends all specified messages If in calls behaviour is set to O or not set at all the ISDN protocol stack behaves in one of the following ways depending upon how the partner equipment argument is set in the call to isdnStartProtocol If partner equipment is set The stack behaves as if to EQUIPMENT TE CC SEND CALL PROC RQ is set all other bits cleared EQUIPMENT NT CC VOICE ALERT RQ and CC DATA ALERT RQ are set all other bits cleared When using the 4ESS variant all three bits are set both on the TE side and NT side out calls behaviour field The out calls behaviour field in ISDN PROTOCOL PARMS Q931CC determines how an outgoing call is handled by the ISDN protocol stack Refer to isdnparm h for more details Each bit set by the value in th
250. s LAPD the sender is ENT DL D the data link layer Recipient The recipient is ENT APPLI the application I nitiating a data link Before a data link is established NMS ISDN is in the IDLE state To establish a data link the application sends a DL EST RQ message to the NMS ISDN protocol stack This message requests the ISDN stack to transmit a SABME set asynchronous balanced mode extended message to the trunk NMS ISDN remains in the IDLE state until the request is acknowledged by the remote side of the ISDN trunk If the equipment on the remote side of the ISDN trunk is prepared to complete the data link it acknowledges the SABME message with a UA unnumbered acknowledgement message When the stack receives the UA message it sends a DL EST CO message to the application The data link is established and NMS ISDN enters the DATA LINK ESTABLISHED state Messages and other information can now be passed across the data link 42 Data link operations LAPD The following illustration shows the sequence of messages sent between the trunk the stack and the application when the application requests a data link Trunk Stack Application SABME DL EST RQ UA DL EST CO Time Time Time If the SABME message is not acknowledged the physical link is down or the remote equipment is not prepared to complete the link the stack sends the SABME message four more times at one second intervals If the message
251. s for a list of valid values Redirecting number presentation Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Reason for redirection See Redirecting reason values for a list of valid values Redirecting number screening indicator See Screening indicator values for a list of valid values Redirecting number type See Number type values for a list of valid values Q 931 IE PCS user Progress indicator Progress indicator Progress indicator Progress indicator Progress indicator Redirecting number Redirecting number Redirecting number Redirecting number Redirecting number Message primitives Macro Description Q 931 IE Acu_alert_in_signal_val Signal value See Signal values for a Does not list of valid values map to an LE Acu alert in ss cnip name active Indicates calling name identification CNIP presentation CNIP supplementary service should be invoked Acu alert in ss cnip name pres Calling name identification CNIP presentation CNIP mode Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Acu alert in x display nb Number of present occurrences Display Acu alert in x display size i Size of occurrence i optional Display Acu alert in x display total size
252. s for your boards in the system boards and the NMS OAM System User s Manual 5 Test the hardware installation The board installation manuals 6 Write the application This manual and the Natural Access documentation set 16 Messaging API programming model 3 Messaging API programming model Natural Access environment NMS ISDN applications are built primarily on the Natural Access platform This topic provides background information about Natural Access and summarizes the main elements of the Natural Access environment You must have Natural Access installed on your system to build applications using NMS ISDN For detailed information about Natural Access see the Natural Access Developer s Reference Manual Natural Access components Natural Access telephony functions are divided into groups of logically related functions called services A context organizes services and accompanying resources around a single process A context usually represents an application instance controlling a single telephone call A service can be opened only once on a context An event queue is the communication path from a service to an application A service generates events indicating certain conditions or state changes An application retrieves the events from the event queue Natural Access programming model Natural Access employs an asynchronous programming model to take advantage of concurrent processing When called most functions return i
253. s the layer 3 ISDN signaling interface e How to use the NMS ISDN Messaging API to perform call control on a primary rate ISDN trunk e An application that uses non facility associated signaling NFAS group configurations The program supports multiple T1 El or BRI trunks or NFAS groups You can specify the ISDN country and signaling system variant to use with a command line option The default behavior of the program is to accept inbound calls Outbound calls can be generated by specifying the appropriate command line option Featured functions isdnReleaseBuffer isdnSendMessage isdnStartProtocol Requirements e One or more digital trunk interface boards e Natural Access e nocc tcp file Usage isdndemo options where options are one or more of the following Option Meaning 0 Disables the OAM service Displays the Help screen and terminates a Specifies the network access identifier NAI of the trunk to use b boardno Specifies the board number d dialstring Specifies the digit string to dial D Specifies configurations with two or more D channels per program Any options following D on the command line apply to the next D channel You can use this option several times Defaults OAM service is enabled N A 0 0 1234567 One D channel is assumed 197 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Option 9 group_number time L time n
254. saging API Developer s Manual The state machine takes into consideration only the state of the data link There are only two states idle and data link established The program has no knowledge of the state of a call so it can be configured to break Q 931 message protocol rules for example by sending a SETUP message after receiving a SETUP message It is the user s responsibility to configure the program properly Q 931 messages are built using functions from isdnlib c for example BuildSetup and BuildAlerting lapdlib h contains the prototypes for these functions and the definitions of the structures used by the functions decisdn h contains the defines used to build Q 931 information elements and messages 216 13 dectrace Stack traffic analysis tool dectrace overview dectrace decodes and displays messages sent or received by the NMS ISDN protocol stack that were previously captured in a log file by the board monitoring utility oammon dectrace decodes e Q 931 Q 921 messages sent or received by the stack when the stack is running in any mode e ACU primitives exchanged by the application and the stack when the stack is running in ACU stack mode e Note By default the log file does not contain stack message data To provide data in this file that dectrace can process the agtrace itrace or both utilities must be used For details see Creating a log file for dectrace Usage dectrace f srcfile d tmask b brdno
255. sed to isdnStartProtocol control stack behavior with outgoing calls The following illustration shows the sequence of messages sent between the ACU and the application for an accepted outbound call ACU Q 931 Trunk stack Application 4 Setup ACU_CONN_RQ Call Proc and or Contains the ACU_CALL_PROC_IN provided Progress ACU_PROGRESS_IN Noelia ee Alert ACU ALERT IN sua id Connect ACU CONN CO gen Time Time Time dotted line optional message Call collision Call collision also called glare can occur when a call setup request and an incoming call occur on the same B channel at the same time In this case the terminal side must cancel its outgoing call and accept the incoming call 37 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Call collision can take place at the stack or at the network level Call collision at the stack occurs when a SETUP message is received by the stack directly before it receives an ACU CONN RQ from the application The following illustration shows the sequence of messages sent between the ACU and the application in this situation ACU Q 931 Trunk stack Application The incoming call MUST be accepted instead of continuing the outgoing call Setup ACU CONN RQ ACU CONN IN This is relative to the ACU CONN RQ sent by the application The return code field is set to ACURC INCOMI
256. ssage primitives Q 931 IE Progress indicator Progress indicator Progress indicator Signal value Display Display Display Display Display 85 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU CALL PROC RQ protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro 4 E ND EVHANKT QDT E11 MTN KUTOA SP 1 S O 2 S S6 GS TRI I N 6 S l T E WG SO E A A S 7 L N 1 Acu_call_proc_rq_a_display x Acu call proc rq display size Filling order 1 Acu call proc rq a display list x x x Acu call proc rq a ext parms Acu call proc rq a pcs user Acu call proc rq pcs user size Filling order 2 Acu call proc rq a tsp ie list X X X X X IX IX IX X X X x x Acu call proc rq tsp ie list size Filling order 3 Acu call proc rq data chani X X X X IX X X X X X X x x Acu call proc rq data chani excl X X x Acu call proc rq data chani nai Acu call proc rq data chani nb X X X X IX IX X X x x Acu call proc rq data chani tab i Acu call proc rq data chani tab nai i Acu call proc rq ext parms lgth Acu call proc rq ext parms nb Acu call proc rq progress description X X X X x x Acu call proc rq progress ind nb X X X x x x 86 Macro Acu call proc rq progress location Acu call proc rq x display nb Acu call proc rq x display size i Acu call proc rq x display total size Acu call
257. ssage source rA ent_id_t Jero ses Message destination sapi_t to_sapi Destination Service Access Point xy union add_t conn_id Connection identifier for the ACU layer add E QUE Call Reference value for NS layer Not used rA add t ces Connection Endpoint suffix DL layer upper 1 2 add_t tei Terminal Endpoint ID DL layer lower 1 2 Not used erst 2 ham Physical layer channel identifier Not used mf y ada code_t code Primitive code unique only between 2 entities WORD inf0 Information location 0 SE WORD infi Information location 1 WORD inf2 Information location 2 2 WORD inf3 Information location 3 am WORD inf4 Information location 4 WORD data_size Size of data to follow WORD nfas_group NFAS group number used for configurations A with duplicate NAI values only SCH DWORD userid User ID ISDN MESSAGE pdata Pointer to the message data if any The data is specific to the type of message specified in ISDN MESSAGE size Size of data block referenced by pdata size must match the data size field in the ISDN MESSAGE structure Return values Return value SUCCESS CTAERR BAD ARGUMENT CTAERR INVALID CTAHD Description This return value means any of the following Context handle is invalid e message argument is NULL e pdata is NULL but size is non zero e data size in the message does not match the size parameter e Size of the dat
258. stricted digital bearer capability is available Service or option not implemented Invalid call reference value Identified channel does not exist Call identity does not exist 189 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Network provided clearing cause CAU CALL ID IN USE CAU NO CALL SUSP CAU CALL CLEARED CAU INCOMP DEST CAU INV TN CAU INV MSG CAU MAND IE MISSING CAU MSGT NOT EX CAU MSG NOT COMP CAU IE NOT EX CAU INV IE CONTENTS CAU MSG NOT COMP CS CAU RECOVERY CAU PROTO ERR CAU INTERW CAU PREEMPTI ON CAU PREEMPTION CRR CAU PREC CALL BLK CAU BC INCOMP SERV CAU OUT CALLS BARRED CAU SERV VIOLATED CAU IN CALLS BARRED 190 Description Call identity in use No call suspended The call has been cleared Incompatible destination Invalid transit network selection Invalid message Mandatory information element is missing Message type nonexistent or not implemented Message not compatible with call state or message type not existent Information element nonexistent or not implemented Invalid information element contents Message not compatible with call state Recovery on timer expiration Protocol error I nterworking Preemption 5ESS Preemption circuit reserved for reuse 5ESS Precedence call blocked 5ESS Bearer capability incompatible with service request 5ESS Outgoing calls barred 4ESS 5ESS Service operation violated
259. t Indicates outgoing call progress information receipt of PROGRESS message Indicates progress request Indicates that a RESTART ACKNOWLEDGE message has been received Indicates that a SERVICE ACKNOWLEDGE message has been received Indicates that a SERVICE message has been received Requests that a SERVICE message be sent Acknowledges incoming call proceeding information Signals that the ACU rejected or ignored an incoming call because it was not compatible address or service filtering The application must not answer this incoming call indication This message is only for information purposes Indicates whether or not the attempted transfer was successful Requests the transfer of two calls Using the ACU message reference The topics in this section describe each of the supported ACU message primitives and include the following information 68 I nformation Purpose Conn id Macro Protocol variants Macro descriptions Q 931 IE Message primitives Description A short description of the purpose of each macro Contains the connection I D of the call that the message concerns The macros you can use to specify values for the information elements IEs in outgoing Q 931 messages When the structure and associated substructures containing this data reaches the ISDN protocol stack the stack rearranges the data into several IEs builds a complete Q 931 message with the IEs and sends it to the network
260. t the stack in channelized stack mode NFAS groups are configured and an attempt was made to start the stack using a variant that does not support NFAS An attempt was made to restart the stack directly after stopping it before it was completely stopped The process of stopping the stack can take several seconds 61 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Events Event name ISDNEVN START PROTOCOL Details Description Value field of the received event contains the completion status of the protocol starting operation as follows SUCCESS ISDNERR BAD NAI Network access identifier NAI in the protocol parameters structure is not valid Or if duplicate NAI values are configured the NAI and NFAS group couple is not valid ISDNERR INCOMPATIBLE LIB NMS ISDN library used is incompatible with the run module ISDNERR INVALID COUNTRY Country specified is invalid for the network operator specified ISDNERR INVALID OPERATOR Network operator specified is not supported by the run module ISDNERR INVALID PARTNER partner equip is not supported by the run module ISDNERR INVALID PROTOCOL protocol argument is not supported by the run module ISDNERR NAI IN USE Another thread or process has already started a protocol for the same network access identifier ISDNERR PROTOCOL CC FAILURE Call control parameters are invalid ISDNERR PROTOCOL DL FAILURE Data link parameters a
261. t Context cpp Implements a single threaded program model and a generic mechanism for processing Natural Access events DChannel DChannel cpp Specifies a context class that represents the ISDN D channel NAI NAI cpp Specifies an object that represents board trunks or NAI in NFAS terminology associated with BChannel and Call objects Timer Timer cpp Implements a synchronous timer based on the asynchronous ADI timer The following illustration shows how isdndemo functions and classes are related 1 203 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual isdndemo program initialization The isdndemo program initializes in the following manner Step Action 1 Processes program wide command line arguments such as h and v 2 Sets handler for Natural Access errors to ctaSetErrorHandler 3 Initializes Natural Access using ctal nitialize 4 Initializes any classes that require it 5 Creates DChannel and other objects based on command line arguments 6 Starts main event processing loop All event processing and other activities are performed by the interaction of created objects isdndemo classes This topic describes the following major global classes used in the isdndemo program e Context e DChannel e NAI e Call e BContext e Timer Context This abstract class provides a generic mechanism for event processing Protected constructor Context Context creates a unique Natural Access conte
262. t claras For simplicity let s use a string We could also have used non printable characters here and used memcpy instead of strcpy Gin qe muersoeg pes sux dais stu UE d cH EP NUUS memset p data OFF ISDN BUFFER DATA LGTH Acu facility code ACU FAC PCS USER ONLY Acu facility action ACU RQ ACTIVATE Acu facility pcs user protocol ACUPCS USER TRANSGROUP strcpy Acu facility a pcs user pcs string Acu facility pcs user size strlen pcs string len Acu facility total size RSU 252 19 Timers Timer overview Values are assigned to various ISDN timers for different country variants These timers control the behavior of network signaling layer 3 in the ISDN protocol stack These values are included as timer val t structures in the ISDN PROTOCOL PARMS Q931CC and ISDN PROTOCOL PARMS LAPD structures referenced by isdnStartProtocol The following table summarizes the meanings of the timers The items shown in all capital letters are the names of Q 931 messages For example ALERT refers to the alert message indicating that an incoming call has arrived Timer Description T300 Internal timer Determines the time the stack has to respond to an incoming SETUP or DI SCONNECT For SETUP if none of the in calls behaviour bits are set the application must initiate this response T301 ALERT message timing T302 Overlap receiving timer T303 Setup message timing T304 Control of ov
263. table shows what each board type supports Board type Number of D channels NAI default values Four trunk board As many as 4 O through 3 Two trunk board As many as 2 O through 1 Initializing ISDN protocol stack instances Use isdnStartProtocol to initialize NMS ISDN protocol stack instances Note Once you reference the context in an isdnStartProtocol function call do not reference that context in any other function call except isdnStopProtocol to stop the stack To start up an NMS ISDN protocol stack instance for ISDN ACU call control or LAPD set the protocol partner equip and parms arguments as follows 32 Initializing a Messaging API application protocol Set the protocol argument to Structure Mode ISDN PROTOCOL Q931CC ACU stack mode ISDN PROTOCOL LAPD LAPD stack mode partner equip partner equip indicates the type of equipment connected to the board If the board is And NMS ISDN is to run Set partner equip to in Connected to network ACU stack mode EQUIPMENT NT Connected to network LAPD stack mode EQUIPMENT DCE Acting as network ACU stack mode EQUIPMENT TE Acting as network LAPD stack mode EQUIPMENT DTE parms The parms argument is a pointer to a parameter structure to configure the protocol stack If the application needs to change a parameter pass a pointer to one of the following structures in this call Structure Mode ISDN PROTOCOL PARMS Q931CC ACU stack mode ISDN PROTOCOL PARMS LAPD LAPD stack
264. tal length of buffer containing extended parameters Q 931 IE Not used Not used Not used Not used Not used Not used Facility PCS user Does not map to an IE Not used Not used Not used Not used Facility Not used Message primitives Macro Description Q 931 IE Acu facility ext parms nb Number of parameters in buffer Not used containing extended parameters Acu facility module nb Voice module number Not used Acu facility pcs user protocol Protocol discriminator for the PCS user pcs user information element See PCS user information elements for more information on this IE Acu facility service Requested service See Service Not used values for a list of valid values Acu facility switchhook Voice switchhook Not used Acu facility x display nb Number of present occurrences Not used Acu facility x display size i Size of occurrence i optional Not used Acu facility x display total size Total size of the stored strings Not used Acu facility x display type i Type of display i Not used Acu facility p display i Pointer to occurrence i Not used ACU FACILITY RQ This topic describes e ACU FACILITY BO protocol variants e ACU FACILITY RQ macro descriptions and Q 931 IE Note Address parameters must be set according to the filling order If one of them is unused its size field must be set to O Purpose Requests that a FACILITY message be sent Conn id An allocated call
265. tance Pointer to the parameter block structure required by the protocol e For access to the parameters for NMS ISDN in LAPD stack mode use the ISDN PROTOCOL PARMS LAPD structure as described in ISDN PROTOCOL PARMS LAPD structure e For access to the parameters for NMS ISDN in ACU stack mode use ISDN PROTOCOL PARMS Q931CC as described in ISDN PROTOCOL PARMS Q931CC structure e For access to the parameters for NMS ISDN in Channelized stack mode use the ISDN PROTOCOL PARMS CHANNEL ZED structure as described in ISDN PROTOCOL PARMS CHANNELIZED structure When parms is NULL the default parameters for the protocol are used The default parameters for each protocol enable the required service access points SAPIs For the ACU stack mode all the services are supported by default The size field of the structure must contain the size of the structure Refer to Overview of API data structures for details on the contents of these parameter structures Valid netoperator and country combinations The following table lists the valid netoperator and country combinations 58 netoperator value ISDN OPERATOR ATT 4ESS ISDN OPERATOR ATT 5E10 ISDN OPERATOR NT DMS ISDN OPERATOR NT DMS250 ISDN OPERATOR NI2 ISDN OPERATOR FT VN6 ISDN OPERATOR AUSTEL 1 ISDN OPERATOR ETSI ISDN OPERATOR HONG KONG ISDN OPERATOR KOREA ISDN OPERATOR NTT ISDN OPERATOR TAIWAN ISDN OPERATOR ECMA QSIG ISDN OPERATOR DPNSS Country value COUNTRY U
266. this bit is set the stack sends ALERTING on a TELEPHONY incoming call Determines if NOT TELEPHONY incoming calls are automatically answered If this bit is set the stack sends CONNECT on NOT TELEPHONY incoming calls Determines if TELEPHONY incoming calls are automatically answered If this bit is set the stack sends CONNECT on TELEPHONY incoming calls If this bit is set the stack sends an ACU CONN IN to the application even if not all digits have arrived for example the sending complete IE is not present Additional incoming digits arrive in ACU DIGIT IN messages If this bit is not set then the ACU waits for atleast nb digits to route digits to arrive before sending an ACU CONN IN message to the application Additional digits coming in INFORMATION messages are ignored Meaningful only in buffered Overlap Receiving mode If this bit is set the called number is truncated to the number of digits specified by the nb digits to route configuration field If this bit is set a received incoming call with no called number will match a list with a programmed address If this bit is set the stack supports the call waiting supplementary service When this service is active an incoming call received with a channel ID indicating No channel will be accepted by the stack If this bit is not set then the stack rejects these calls with the appropriate cause value 34 in most cases Not used If this bit is set supplementary se
267. this bit is set the stack does not send RESTART messages when it is stopped but it also does not respond to incoming RESTART messages Do not set this bit unless you are certain that the remote end does not implement the RESTART procedure See also isdnStartProtocol 65 9 Message primitives Overview of message primitives This section describes the types and contents of the messages interchanged between the NMS ISDN protocol stack and the application To send a message to the stack the application specifies the message primitive in the ISDN MESSAGE structure passed to isdnSendMessage For more information refer to Sending ISDN messages to the stack Events received from the stack contain message primitives For more information refer to Network access identifiers NAIs Messages with the prefix ACU_ are valid only when the NMS ISDN software is in its ACU configuration and the protocol stack is in ACU stack mode Messages with the prefix DL are valid only when the NMS ISDN software is in its LAPD configuration and the protocol stack is in LAPD stack mode LAPD primitives The following table summarizes the supported LAPD primitives Message Description type DL DA IN Indicates that the trunk from the remote party has received a packet of acknowledged data DL DA RQ Requests that the stack transmit a packet of acknowledged data Sent by the application to the NMS ISDN protocol stack DL EST CO Indicates that equipme
268. tified interface type PRI spare bits spare bits pref excl exclusive D channel ind not info channel selection Bl channel octet 3 2 extension bit coding standard CCITT number map number channel type B channel OGU OUEST extension bit channel number 0x01 Dao colas ciao OO MO AS COT CERIS OR call reference 01 00 flag 1 message type ALERTING ozu 00 mem 00 cams 00 lt 14 itrace Stack traffic analysis tool itrace overview itrace limits the number of debug ISDN messages sent to oammon The ISDN stack includes many entities for example layer 1 entities layer 2 entities layer 3 entities management entities and timer entities that exchange messages Debug information is sent to oammon when the agtrace bit 0x800000 is set It can be filtered by this utility based on board number NAI number NFAS group number and entity By default all the entities are enabled Usage itrace on off board nai entity list nfas group where Option Meaning on off Logging enabled or disabled board Board number nai Network access identifier NAI entity list String of entity IDs as defined in isdntype h If the string starts with an exclamation point the buffers associated with the messages are sent to the monitoring utility All entities nfas group NFAS group number for configurations with duplicate NAI values Using itrace Perform the following steps to run the itrace utility
269. tion esee 199 configuration file ssuusus 200 MES aaa 200 LAPD primttlves eee 64 EX TN 198 structure and coding features 203 layer 3 call control demonstration program dete desee duae vetu a e des oet Ee s 194 location values ee eae eae eaees 175 M message Drlmilves 64 MESSAGES rra vet 42 messaging API data structures 44 messaging struchures 21 ISDN_MESSAGE 44 ISDN DACKE T sess 45 mode code values tees 182 N Natural Access 18 30 network access identifiers NAIs 31 189 network provided clearing cause values A ti Foe VA Tete did 177 MEAS ide eie deo perdo sepes en 253 254 NMS ISDN errors cence eens 218 NMS ISDN events 216 NMS ISDN Messaging API application OVerview 0 c ccc ece eee eee eae eaeeaeeaeeaeeaeeaes 18 NMS ISDN software 9 ACU Conftgouration sees 10 LAPD configuration ssusse 11 product configurations 9 software components 13 supported reference points 12 NOCE TEP ra r oe Ad 33 non facility associated signaling NFAS EA A T AN 253 254 Nortel DMS 100 layer 3 timer defaults 246 ns behaviour field sssussssse 230 NSF IE lisina liliana 257 example ederet eene 259 fields deg iex xS 257 number type values 173 o out calls behaviour field 228 outbound call 37 P Datameters E 45
270. to use when initializing the ISDN protocol stack as described in Initializing ISDN protocol stack instances NMS ISDN ACU configuration The NMS ISDN ACU configuration allows access to Q 931 layer 3 call control using the NMS ISDN Messaging API The application can send and receive switch and country invariant D channel messages using this interface Access at this level allows you direct control over D channel messages and greater control over the contents of these messages In the ACU configuration one or more instances of the NMS ISDN protocol stack runs on the board one for each D channel The stack runs in ACU stack mode In this mode the protocol stack implements all ISDN layer 2 and layer 3 functionalities The application uses the NMS ISDN Messaging API to command an entity in the stack called the ACU which in turn commands the D channel through the lower ISDN layers Events received by the stack from the D channel are placed in the same event queue as other Natural Access events allowing the application to access ISDN events in the same way that other events are accessed B channel information is routed to the DSP resources through the board s H 100 H 110 or MVIP switch The switch has certain default behavior described in Making switch connections for NMS ISDN The switch can also be controlled using the Natural Access Switching service 10 Messaging API programming model The following illustration shows the NMS ISDN a
271. ts emen 80 ACU CALLID IN macro descriptions and OO31IE ee ececeeee eee eee eee e eee eeeeeeenees 80 ACU CALL PROC N H RES EEN Deva sued ees EY Ik e HENNEN DER Rr TS 81 ACU CALL PROC IN protocol variants ssssssses HH memememenens 81 ACU CALL PROC IN macro descriptions and OO3IIE eect eee eee eee ee aes 83 ACU CALL PROC RQ iii Er ee E REX RR Y REM ER ERR ER IRE SEPT ERR REP 85 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual ACU CALL PROC RO protocol varlanmts mmm 86 ACU CALL PROC RQ macro descriptions and OO321IE eect eee teeta aes 87 ACU GEEARS CO d stehe ote eus Een e EE Mee 89 ACU CLEAR CO protocol Varas xr Ee eer ERR RH ERR ee EN eegen 89 ACU CLEAR CO macro descriptions and OO3lIE rn rra ranas 90 ACU CREAR Ns aient er otra ete eit den dec over eee Atel o 14 one Miri aa t dines aut ote s ds 92 ACU CLEAR IN protocol vartants memes 92 ACU CLEAR IN macro descriptions and Q 931 IE ssssssese nr nn nnnnnrns 94 ACU e td Pad debates tu Uv M VAN celo tius 96 ACU CLEAR RO protocol variants memes memes 97 ACU CLEAR BO macro descriptions and OO321lIE nro r nr nana 99 Ee BEE a eds 101 ACU CLEAR RS protocol variants esssssssssss e mnemememememen een 101 ACU CLEAR RS macro descriptions and OO32lIE e 103 ACU CONN eer DET 104 ACU CONN CO protocol variants e mmemememememen ene 105 ACU CONN CO macro descriptions and Q 931 lE cecece eee e eee eee eee ee teeta eae 108 AGUS CONN NE uen mote
272. ty number IE CALL ID 0x10 Call identity IE CALL STATE 0x14 Call state IE CHANNEL ID 0x18 Channel identification IE FACILITY Ox1C Facility IE PROGRESS IND Ox1E Progress indicator IE NSF 0x20 Network specific facilities IE NOTIFY IND 0x27 Notification indicator IE DISPLAY 0x28 Display 223 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Message IE DATE TIME IE KEYPAD IE INFO RQ IE SIGNAL IE SWITCHHOOK IE FEATURE ACK IE FEATURE IND IE SERVICE PROF IE ENDPOINT ID IE INFO RATE IE END TO END DELAY IE TDSI IE PKT BIN PAR IE PKT WIN SIZE IE PKT SIZE IE MIN THR CLASS IE CONNECTED QSIG IE CALLING IE CALLING SUB IE CALLED IE CALLED SUB IE ORIG CALLED IE REDIRECTING 224 Hexadecimal value 0x29 0x2C 0x32 0x34 0x36 0x38 0x39 Ox3A Ox3B 0x40 0x42 0x43 0x44 0x45 0x46 0x47 0x4C Ox6C 0x6D 0x70 0x71 0x73 0x74 Notes Date time Keypad facility Information request Signal Switchhook Feature activation Feature indication Service profile identification Endpoint identifier Information rate End to end transit delay Transit delay selection and indication Packet layer binary parameters Packet layer window size Packet size Minimum throughput class Connected party number QSIG Calling party number Calling party subaddress Called party number Called party subaddress Original called number Redirecting n
273. u conn rs uui protocol Acu conn rs x display nb Acu conn rs x display size i 146 Description Q 931 IE Indicates calling name CNIP identification presentation CNIP supplementary service should be invoked Calling name identification CNIP presentation CNIP mode Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Number of stop bits for V 110 Low layer and V 120 services Available compatibility values include ACU STOP BIT 1 1 stop bit ACU STOP BIT 1 5 1 5 stop bits ACU STOP BIT 2 2 stop bits Synchronous asynchronous for Low layer V 110 and V 120 services compatibility Available values include ACU SYN Synchronous mode ACU ASYN Asynchronous mode User rate for V 110 and V 120 Low layer services See User rate values for compatibility a list of valid values UUI protocol discriminator value User user See UUI protocol discriminator values for a list of valid values Default UUI 1A5 UUI USER SPF for HKG variant Number of present occurrences Display Size of occurrence i optional Display Message primitives Macro Description Q 931 IE Acu conn rs x display total size Total size of the stored strings Display Acu conn rs x display type i Type of display i Display Acu conn rs year Year Date time ACU D CHANNEL STATUS IN This topic describes e ACU D CHANNEL STATUS IN protocol v
274. umber dectrace Stack traffic analysis tool Message Hexadecimal Notes value IE REDIRECTION 0x76 Redirection number IE TRANSIT SEL 0x78 Transit network selection IE REST IND 0x79 Restart indicator IE LLC Ox7C Low layer compatibility IE HLC 0x7D High layer compatibility IE UU Ox7E User to user information IE ESCAPE OxFF Escape for extension I nformation elements not defined in Q 931 Q 932 IE CHANGE STATUS 0x01 Change status according to 235 900 342 5ESS If the program does not decode the contents of an information element it displays IE ie name NOT DECODED If the program does not decode the contents of one octet inside one information element it displays octet octet number NOT DECODED If dectrace encounters a value in the message type the information element ID or the information element contents that e Is notin accordance with the Q 931 Q 932 specifications except where noted differently it displays RESERVED e t does not recognize it displays UNKNOWN Unknown represents a legal value for several fields Note The presence of RESERVED or UNKNOWN fields in the program output does not necessarily indicate a failure Values that are illegal in the Q 931 Q 932 specification may be legal depending on the variant you are running Sample dectrace output In the following sample of dectrace output text the arrow after the board number shows if the message was received or sent gt 43 61 juo co
275. values for the Acu err in cause macro in ACU ERR IN messages These values are defined in isdnacu h Cause code Description ACUER PRIMITIVE CODE Unknown primitive code ACUER PARAM VAL Invalid parameter ACUER MANDATORY PARAM MISSING Mandatory parameter missing ACUER PARAM TYPE Incorrect parameter type ACUER_PARAM_LGTH Incorrect parameter length ACUER_UNEXPECTED_ PRIMITIVE Unexpected primitive ACUER PRIMITIVE NOT IMPLEMENTED SSDU primitive not implemented ACUER NO TIMER AVAILABLE No more space to allocate new timer cells ACUER CONGESTION Resource congestion Progress description values The following table lists the valid progress description values for ACU ALERT IN ACU ALERT RQ ACU CALL PROC IN ACU CALL PROC RQ ACU CLEAR IN ACU CONN IN ACU CONN RQ ACU PROGRESS IN ACU PROGRESS RQ and ACU SETUP REPORT IN messages These values are defined in isdnval h 194 Progress description NO PROGRESS DESCR PROGRESS DESCR NON END TO END ISDN PROGRESS DESCR CALL RETURNED ISDN PROGRESS DESCR IN BAND NOW Charging type values Data types and constants in primitives Description No progress information to be stored Call is not end to end ISDN further call progress information may be available Call has returned to the ISDN In band information or appropriate pattern now available The following table lists the valid charging type values for ACU_CLEAR_CO ACU_CLEAR_IN ACU_CLEAR_RQ ACU_CLEAR_RS ACU_CONN_CO
276. vel IE Encoding the Precedence Level IE void p data msg buffer int send mlpp 1 Acu ext descr nb Acu ext descr lgth Acu ext descr offset uchar p ext data 0 0 Acu conn rq start ext data Acu ext descr first address uon wot ua Generate MLPP Precedence Level IE A if send mlpp acu ext precedence level p acu ext precedence level p ext data 274 Acu ext descr nb Acu ext descr lgth Acu ext lgth Acu ext id p ext data p gt level Oe eo p gt change Pasco din cans al p gt domain p gt net_id ip sizeof ACU EXT PRECEDENCE LEVEL sizeof 3 Encoding and decoding the Precedence Level IE sizeof acu ext precedence level acu ext precedence level acu ext precedence level PRIORITY level MLPP_LFB_PATH_RESERVED Look Forward Busy Path reserved 0 level privilege may be changed at network boundaries 0 CCITT standard coding 0x123456 Domain is 123456 0x0789 Network identity is 789 Decoding the Precedence Level I E void printExtParameters void p data uchar p_ext_dat for alight ale L a Acu ext descr first address aL lt lt Moa ee desci los abere jJ Process according to parameter type switch Acu ext id case ACU EXI PRECEDENCE LEVELS acu_ext_precedence_level p acu_ext_precedence_level p_ext_data EE EE i break default lose
277. vice size Acu service a q931 4 E N D E V H E 1 I M T N K S 02 S S 6 G S l X X X X X X X X X X X X Hrm Hoc aar mazon Z z 7 d a nNno AER N OO H ACU SERVICE IN macro descriptions and Q 931 IE Macro Acu service pref Acu service int id Acu service b chan Acu service status Acu service action type 172 Description Preference Valid values include PREF INTERFACE PREF B CHANNEL Interface ID B channel if Acu service pref PREF B CHANNEL New status Valid values include B CHAN IN SERVICE B CHAN OUT OF SERVICE Action to be performed maintenance only Q 931 IE Channel identification Channel identification Channel identification Change status This IE is not defined in Q 931 Not applicable Macro Acu service q931 size Acu service size Acu service a q931 Description Reserved for future use Size of structure Reserved for future use ACU SERVICE RQ This topic describes e ACU SERVICE RO protocol variants e ACU SERVICE RQ macro descriptions and Q 931 IE Purpose Requests that a SERVICE message be sent Conn id Unused ACU SERVICE RO protocol variants The following table lists the variants under which each macro is supported for this primitive In this table x indicates both NT and TE sides Macro Acu service pref interface Acu service pref 4 E N D E E 1 M T S O 2 S S S l X B channe
278. wo slight behavioral differences e A maximum of four groups on one board can be defined in the configuration file e The range of connection IDs available for the D channel is higher In an NFAS group containing multiple trunks there will be ACU MX CALLS connection IDs for each NAI NFAS groups and Hot Swap configurations If an NFAS group spans multiple boards in a Hot Swap system and you remove or insert a board while the system is running the NMS ISDN protocol stacks on the other boards are not affected If you remove a board containing only B channels the stack on the D channel board does not detect that the board is missing It is the application s responsibility to detect this change and take appropriate action for example not accessing B channels on that board D channel backup When NFAS is employed the reliability of the signaling performance for the ISDN interfaces controlled by the D channel can be improved by employing a standby D channel the D channel backup The D channel backup feature allows a customer continued access to the ISDN network if one of the D channels fails by transferring most of the signaling information to the backup D channel 267 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual The designated primary D channel labeled D1 is always present on one trunk A backup or standby D channel labeled D2 is present on a different trunk T1 trunks Y AG 4040 T board WE B cha
279. work responds with ACU CLEAR CO 36 Call control ACU configuration The following illustration shows the default sequence of messages sent between the ACU and the application for a rejected inbound call The actual messages may differ depending upon the settings of the bits in in calls behaviour This substructure is referenced in the ISDN PROTOCOL PARMS structure passed to isdnStartProtocol For details see ISDN PROTOCOL PARMS Q931CC parameters and ISDN PROTOCOL PARMS LAPD parameters ACU Q 931 Trunk stack Application Setup ACU CONN IN Alert is sent by TE side stacks Alert only NT side stacks send 4 Disc ACU CLEAR RQ call proceeding here instead Release m Rel Comp ACU CLEAR CO Time Time Time Placing outbound calls The application initiates an outbound call by sending an ACU CONN RQ message to the protocol stack The connection ID is assigned by the user This ID must not currently be in use otherwise the connection request is rejected by the ISDN protocol stack The ACU CONN RQ message must contain the complete called number At this point an ACU CALL PROC IN event or an ACU ALERT IN event can be received from the network These messages indicate that the call is in progress If the call is successfully connected the ACU CONN CO event is received Otherwise a hang up indication ACU CLEAR CO is received Note The bits in out calls behaviour in the ISDN PROTOCOL PARMS structure pas
280. world For this reason NMS provides versions of its ISDN software for different regions Each package for a variant contains the software modules needed to allow a board to communicate on a T1 E1 or BRI trunk in one or more countries using that variant The NMS ISDN software package for a given region contains the following components that are briefly described in this topic e A readme file e NMS ISDN function libraries e Header files e Run modules containing the NMS ISDN protocol stack software and the NMS ISDN management software e Board keyword files e Demonstration programs and utilities with their source code files and makefiles Other components also included are used only when the NMS ISDN protocol stack is running in channelized stack mode The channelized stack mode specific components are e Atrunk control program TCP e Parameter files pf files containing the complete set of NMS ISDN parameters Some parameters in these files are set to values specific to a certain country or region e An nccxisdn par file containing the subset of NMS ISDN parameters that can be changed if desired Two country specific parameter files nccxadicty par and 13 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual nccstartcty par contain parameters that should not be changed These files are used when the protocol stack is in channelized configuration using the NCC service For more information about t
281. xt for each Context class object and its children Every context is then bound to a single event processing queue Context qid Each child class overrides two functions of Context to implement some processing logic e processEvent Process a single event that is passed as an argument e Start Invoked for each Context object just before entering the main processing loop in the Context eventLoop function Each Context object has a unique index Context index that enables the main processing loop to direct an event to the correct context DChannel The DChannel is a key class for all of isdndemo One object of this class is created for each D channel the program uses During object construction one NAI object is created for each trunk that a given D channel supports For a non NFAS configuration only one NAI is created Thus a single call of the DChannel DChannel constructor creates a tree of related objects 204 isdndemo Layer 3 call control DChannel objects perform the following functions in isdndemo e Process incoming ISDN call control messages with the processEvent function Messages are passed to the appropriate Call object for processing e Send ISDN call control messages to the board with sendi sdnMessage DChannel never creates ISDN messages by itself This function is used only by Call objects e Print ACU messages in a form readable to users e Print program operation statistics to the screen and to the log f
282. y X X Acu progress in facility size Acu progress in a pcs user x Acu progress in pcs user size Acu progress in a q931 X X x X X X X x x x Acu progress in q931 size 163 Dialogic amp NaturalAccess ISDN Messaging API Developer s Manual Macro Acu progress in call ref length Acu progress in call ref value Acu progress in cause Acu progress in data chani Acu progress in data chani excl Acu progress in data chani nai Acu progress in data chani nb Acu progress in data chani tab i Acu progress in data chani tab nai i Acu progress in ext parms lgth Acu progress in ext parms nb Acu progress in pcs user protocol Acu progress in progress descr x i Acu progress in progress description Acu progress in progress ind nb Acu progress in progress loc x i Acu progress in progress location Acu progress in signal val Acu progress in x display nb Acu progress in x display size i 164 nnma X orm Mr Z 442 mzomnz eg vnm nz lt QAI Z z d BHrm Hoc X X X X X X X X X X X X X X X X X X X X X X X X be As wuoz uoug d OO gt Macro Acu progress in x display total size Acu progress in x display type i Acu progress in x p display i 4 E ND EV HAN E 1 MT NKU T S O 2 S S6 GST S l T E L 1 x x x X x x X x X x D x X X x ACU PROGRESS IN macro descriptions and Q 931 IE Macro Acu progress in a display Acu progress in display size Acu progress i
283. y address Connected party subaddress Connected party subaddress Channel identification Channel identification Channel identification Channel identification Channel identification Channel identification Macro Acu conn co date available Acu conn co day Acu conn co ext parms lgth Acu conn co ext parms nb Acu conn co hour Acu conn co minute Acu conn co month Acu conn co pcs user protocol Acu conn co redir nb pres Acu conn co redir nb reason Acu conn co redir nb screen Acu conn co redir nb type Message primitives Description ON if the information is available else OFF Day Total length of buffer containing extended parameters Number of parameters in buffer containing extended parameters Hour Minute Month Protocol discriminator for the pcs user information element See PCS user information elements for more information on this IE Redirecting number presentation Allowed values include N PRES ALLOWED Presentation allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Reason for redirection See Redirecting reason values for a list of valid values Redirecting number screening indicator See Screening indicator values for a list of valid values Redirecting number type See Number type values for a list of valid values Q 931 IE Date time Date time Not used Not used Date t
284. ze of transparent IE buffer Q 931 IE Connected party address Connected party subaddress Date time Display Display Not used Facility Low layer compatibility PCS user CNIP Does not map to an IE Message primitives Macro Description Q 931 IE Acu_conn_rs_a_uui Pointer to and size of buffer User user Acu conn rs uui size containing ISDN user to user Filling order 1 information optional Acu conn rs charging Charging value number of Not used units Acu conn rs charging available Charging information available Not used indicator Acu conn rs charging multi Charging multiplier Not used Acu conn rs charging period Charging period Not used Acu conn rs charging type Charging type See Charging type Not used values for a list of valid values Acu conn rs charging value Charging value number of Not used units Acu conn rs connected nb plan Connected number plan See Plan Connected values for a list of valid values party address Acu conn rs connected nb pres Connected number presentation Connected Allowed values party N PRES ALLOWED Presentation 9d dress allowed N PRES RESTRICTED Presentation restricted N PRES NOT AVAILABLE Presentation not available Acu conn rs connected nb screen Connected number screening Connected indicator See Screening indicator party values for a list of valid values address Acu conn rs connected nb type Connected number type See Connected Numb

Print - Dialogic

Contents

Download Pdf Manuals

Related Search

Related Contents