-
Notifications
You must be signed in to change notification settings - Fork 16
/
inap.db
11590 lines (11051 loc) · 422 KB
/
inap.db
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
June 2008 U16SSS
www.dialogic.com
Dialogic® SS7 Protocols
INAP Programmer's Manual
2
Copyright© 1998-2008 Dialogic Corporation. All Rights Reserved. You may not reproduce this document in whole or in part without
permission in writing from Dialogic Corporation at the address provided below.
All contents of this document are 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 the 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 CONNECTION WITH DIALOGIC® PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED,
BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS 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 ideas 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.
Dialogic, Dialogic Pro, Brooktrout, Cantata, SnowShore, Eicon, Eicon Networks, Eiconcard, Diva, SIPcontrol, Diva ISDN, TruFax,
Realblocs, Realcomm 100, NetAccess, Instant ISDN, TRXStream, Exnet, Exnet Connect, EXS, ExchangePlus VSE, Switchkit, N20,
Powering The Service-Ready Network, Vantage, Making Innovation Thrive, Connecting People to Information, Connecting to Growth and
Shiva, among others as well as related logos, are either registered trademarks or trademarks of Dialogic. 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. Other names of actual
companies and products mentioned herein are the trademarks of their respective owners.
This document discusses one or more open source products, systems and/or releases. Dialogic is not responsible for your decision to
use open source in connection with Dialogic products (including without limitation those referred to herein), nor is Dialogic responsible
for any present or future effects such usage might have, including without limitation effects on your products, your business, or your
intellectual property rights.
Publication Date: June 2008
Document Number: U16SSS, Issue 12
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
3
Contents
Revision History...........................................................................................................5
1 About this Publication.........................................................................................7
1.1 Introduction...........................................................................................................................7
1.2 Abbreviations.........................................................................................................................8
1.3 Related Documentation............................................................................................................9
1.4 Feature Overview....................................................................................................................9
2 General Description...........................................................................................11
2.1 Module Overview..................................................................................................................11
2.2 INAP Functional Entity Addressing...........................................................................................12
2.3 INAP Application Context Handling..........................................................................................13
2.4 Module Dimensions...............................................................................................................13
2.5 Module Requirements............................................................................................................13
3 INAP Module User Interface..............................................................................15
3.1 Introduction.........................................................................................................................15
3.2 Dialog Primitive Types...........................................................................................................16
3.3 Service Component Primitives................................................................................................17
3.4 INAP Dialogue Request Message.............................................................................................18
3.5 INAP Dialogue Indication Message...........................................................................................20
3.6 INAP Dialogue Primitive Parameters........................................................................................22
3.7 INAP Service Request Message...............................................................................................26
3.8 INAP Service Indication Message............................................................................................27
3.9 INAP Service Primitive Parameters..........................................................................................29
4 Functional API User Interface...........................................................................33
4.1 Introduction.........................................................................................................................33
4.2 API Function Specifications.....................................................................................................34
4.3 API Function Parameter Specifications.....................................................................................39
4.4 INAP – API Message Sequence Charts.....................................................................................44
4.5 API Dialogue Parameters.......................................................................................................53
5 Non-Primitive Interface....................................................................................57
5.1 INAP Configuration Request...................................................................................................57
5.2 INAP Network Context Configuration Request...........................................................................61
5.3 INAP Timer Configuration Request..........................................................................................62
5.4 INAP Functional Entity Configuration Request...........................................................................63
5.5 INAP Application Context Configuration Request.......................................................................65
5.6 Read Revision Request..........................................................................................................66
5.7 INAP Software Event Indication..............................................................................................67
5.8 INAP Maintenance Event Indication.........................................................................................68
5.9 INAP Management Event Indication.........................................................................................69
5.10 INAP Trace Mask Request......................................................................................................70
5.11 Trace Event Indication...........................................................................................................72
5.12 INAP Maintenance Mask Request.............................................................................................73
5.13 INAP Software Event Mask Request.........................................................................................74
Appendix A. Tick Timer Message Format....................................................................75
A.1 Tick Timer Message Format....................................................................................................75
Contents
4
Appendix B. Supported INAP Application Contexts....................................................77
B.1 Overview.............................................................................................................................77
B.2 Supported INAP Application Contexts......................................................................................78
B.3 Supported INAP Operations....................................................................................................82
B.4 Supported INAP Operation Parameters....................................................................................85
B.5 ETSI CS-1 Operation Definitions.............................................................................................87
B.6 ITU-T CS-1 Operation Definitions..........................................................................................102
B.7 CAMEL v1 Operation Definitions............................................................................................117
B.8 CAMEL v2 Operation Definitions............................................................................................121
B.9 CAMEL v3 Operation Definitions............................................................................................133
B.10 CAMEL v4 Operation Definitions............................................................................................160
B.11 CAMEL v4 for IMS Operation Definitions................................................................................199
B.12 ETSI CS-2 Operation Definitions...........................................................................................203
B.13 AIN Operation Definitions....................................................................................................246
B.14 Operation Extensions..........................................................................................................257
B.15 Supported INAP Parameter List............................................................................................259
B.16 Supported INAP Operation Result.........................................................................................283
B.17 Supported INAP Errors........................................................................................................288
B.18 Supported INAP Error Parameters.........................................................................................289
Appendix C. Message Type Reference......................................................................293
C.1 Message Type Reference.....................................................................................................293
Figures
Figure 1. INAP at an SCP.......................................................................................................11
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
5
Revision History
Issue Date Description
12 June 2008 Rebranding and updates.
CAMEL v4 and CAMEL v4 for IMS added.
11 August 2007 CAP v3 documentation revised.
Minor corrections and updates.
10 Dec 2005 Added new parameters (qos, user_information, report_cause)
Addition of a subset of AIN operations from GR-1299-CORE (AINGR).
Minor corrections and updates.
9 Jul 2003 Addition of all CAP V3 operations and selected AIN operations.
8 Jul 2003 Branding changed: references to System7 removed.
7 Jul 2001 Addition of remaining operations for ETSI CS-2.
6 Mar 2001 Addition of operations for ETSI CS-2 SCF-SRF interface.
5 May 2000 Extension of protocol support to provide access to operations and application contexts
in ITU CS-1 (Oct ‘95) and CAMEL (v1 and v2).
Enhanced support for the sending and receiving of operation extensions.
Addition of new parameter for close pre-arranged end handling.
4 May 1999 Completion of all ETSI CS-1 operations and application contexts included in ETS 300
374-1. Includes details of new operations and additional parameters required to
support these new operations. Addition of the procedure IN_version procedure to
provide API version information.
3 Feb 1999 Addition of seven more ETSI 300-374-1 operations.
2 Nov 1998 Minor Corrections.
Notes on use of “pre-arranged end” of INAP dialogues
1 Oct 1998 First Issue. INAP interface.
Note: The latest release issue of this guide can be found at:
http://www.dialogic.com/support/helpweb/signaling
Revision History
6
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
7
1 About this Publication
1.1 Introduction
The INAP module enables straightforward development of Intelligent Network
applications in the SS7 environment. The User application is provided with
simple access to the operations specified in the Intelligent Network
Application Protocol (INAP).
The module is of use to applications implementing any of the functions of the
following IN Functional Entities: Service Control Function (SCF), Service
Switching Function (SSF), Specialized Resource Function (SRF) or Call
Unrelated Service Function (CUSF).
The module is a portable software implementation of the Single Association
Control Function (SACF) specified in the Intelligent Network Application
Protocol (INAP) ([Ref 1] on page 9).
The module consists of an event driven task using standard structured
message types, which provides a control interface at the service provider
level. A suite of API functions is also supplied to provide a convenient
interface for the user application as well as coding and decoding of IN
operations.
The module uses the services provided by the underlying Transaction
Capabilities (TCAP) service for the transfer of operations between peer INAP
Functional Entities.
This Programmer's Manual is intended for users developing their own
applications that interface to and make use of the functionality provided by
the INAP module.
Both the INAP module and the suite of API functions are written using the ‘C’
programming language. They are fully portable and make no operating
system or compiler specific references.
This manual provides an overview of the API IN functions and the interface to
the INAP module. It includes details of all API function parameters and the
structure of messages used to interface to the INAP module.
1 About this Publication
8
1.2 Abbreviations
The following table provides a list of abbreviations used in this manual.
Abbreviation Description
AIN Advanced Intelligent Network
ANSI American National Standards Institute
APDU Application Protocol Data Unit
ASE Application Service Element
ASN.1 Abstract Syntax Notation One
CAMEL Customized Application for Mobile Network Enhanced Logic
CAP CAMEL Application Part
CCITT The International Telegraph & Telephone Consultative Committee
CS-1 Capability Set One
CS-2 Capability Set Two
CUSF Call Unrelated Service Function
FE Functional Entity
FEAM Functional Entity Access Manager
INAP Intelligent Network Application Protocol
ITU-T International Telecommunication Union (formerly CCITT)
MACF Multiple Association Control Function
MTP Message Transfer Part
SACF Single Association Control Function
SCCP Signaling Connection Control Part
SCF Service Control Function
SCP Service Control Point
SRF Specialized Resource Function
SSF Service Switching Function
TCAP Transaction Capabilities Application Part
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
9
1.3 Related Documentation
[Ref 1] ETS 300 374-1 - ETSI Intelligent Network CS1 Specification
[Ref 2] X.208 - Specification of Abstract Syntax Notation One (ASN.1)
[Ref 3] X.209 - Basic Encoding Rules for Abstract Syntax Notation One
(ASN.1)
[Ref 4] Q.773 - SS7 Transaction Capabilities Formats and Encoding
[Ref 5] U06SSS - TCAP Programmer's Manual
[Ref 6] U10SSS - Software Environment Programmer’s Manual
[Ref 7] X.680 - Specification of Abstract Syntax Notation One (ASN.1)
[Ref 8] X.690 - Basic Encoding Rules for Abstract Syntax Notation One
(ASN.1)
[Ref 9] Q.1218 - ITU-T Interface Recommendation for Intelligent Networks
CS-1
[Ref 10] TS 101 046 v5.6.0 – CAMEL Application Part specification v1
[Ref 11] TS 101 046 v6.3.0 - CAMEL Application Part specification v2
[Ref 12] TS 129 078 v4.6.0 – CAMEL Application Part specification v3
[Ref 13] 3GGP TS 29.078 v7.1.0 (2005-09) - CAMEL Application Part
Specification v.4
[Ref 14] 3GGP TS 29.278 v7.0.0 (2005-12) - CAMEL Application Part 4 IP
Multimedia Subsystems (IMS) v.4
[Ref 15] EN 301 140-1 – ETSI Intelligent Network CS2 Specification
[Ref 16] GR-1299-CORE – AIN Specification, issue 7
[Ref 17] Q.1228 - ITU-T Interface Recommendation for Intelligent Networks
CS-2
1.4 Feature Overview
Key features of the INAP module include:
• Eases IN application development by providing simple access to
communication between IN functional entities.
• Functional Entity independent solution.
• Supports communication functions required at the SCF, SSF, SRF and
CUSF Functional Entities.
• Implements the Single Association Control Function (SACF) specified in
the ITU Q.1218 and ETSI ETS 300 374-1 specifications.
• INAP module provides service independent access to the SS7
environment.
• Procedural API provides a convenient means of accessing the INAP
module. Provides tailored suites of Application Service Elements (suites of
INAP operations) to support the required IN functions.
• The supported ASEs may be readily extended to support any network or
operator specific IN functions.
1 About this Publication
10
• Full user control of dialogues via message oriented or procedural (API)
interface.
• Support for application context negotiation.
• Support for ITU, ETSI and CAMEL protocol stacks.
• Support for a subset of the AIN protocol stack GR-1299-CORE (AINGR).
• Error handling for Class 1, 2, 3, and 4 operations.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
2 General Description
2.1 Module Overview
The module provides an implementation of the Single Association Control
Function (SACF) block of an IN Functional Entity. The figure below shows the
various components at a SCP functional entity but the module itself is FE
independent. It may provide services to applications implementing the
functions of the SCF, SSF and SRF Functional Entities. It may also support
services to multiple FEs located at the same node. The ASEs can be
implemented using the INAP API suite. Other modules in the Dialogic® SS7
Protocol stack can be used to implement the SCCP, TCAP and MTP layers.
Figure 1. INAP at an SCP
SCF
SCCP
MTP1-3
ASE(s)
[INAP API suite]
TCAP
SACF
[INAP Module]
SS7 link SS7 link
SCP
The module is event driven. It has a single input queue into which messages
from other modules (TCAP, INAP-User, management etc.) are written. The
module processes each message in turn until the input queue is empty, in
which case it will do nothing until the next event is received. Output from the
module is directed depending on the type of event to the TCAP module, the
INAP User module, the Management module or the Maintenance module.
11
2 General Description
12
The Intelligent Network Application Protocol (INAP) is specified in terms of
operations that are "invoked" at the serving FE by the requesting FE. See
[Ref 9] on page 9. These operations are invoked within the context of a
"dialogue" between the two FEs.
The INAP module provides the user with a primitive interface for INAP
dialogue control and for INAP service requests. The service request primitives
contain INAP operations coded as TCAP components ([Ref 4] on page 9) for
transmission via INAP dialogues.
The INAP module is supplied with an API function library containing a
procedural interface for the INAP module. This consists of a suite of API
functions for dialogue control and IN operation handling.
The API suite includes functions for the encoding and recovery of IN
operations and associated parameters. The operations are coded as TCAP
components using the Basic Encoding Rules of the Abstract Syntax Notation
1, see [Ref 3] on page 9. This is the format required by the INAP module.
Certain other parameters are also built into the INAP service request message
by the coding function.
If the user already has access to the ASN.1 encoded version of the
component the INAP module may be accessed directly via the primitive
interface.
The API functions suite may be used with different variants of the INAP
protocol. The required protocol handling is specified via internal coding tables.
The user indicates the required protocol at run time. The INAP module is
protocol independent. This approach allows new variants to be made available
in minimum time.
2.2 INAP Functional Entity Addressing
When opening a dialogue with a remote FE the User Application must provide
the SCCP address of the local and remote FEs in the SS7 network.
The User Application may provide the full SCCP address explicitly in each
dialogue message or alternatively, the INAP module provides a number of
Functional Entity records which once configured allow the User Application to
address Functional Entities using a locally defined reference code. This
feature also permits the INAP module to support more than one local
Functional Entity. For example an SCF and an SRF may be supported on the
same SS7 stack. The FE record for each local FE should be configured with
the module id of the user application implementing the procedures of that FE.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
13
2.3 INAP Application Context Handling
ITU-T and ETSI INAP specifications include the use of Application Context to
identify the "context" of a particular dialogue between two IN Functional
Entities. Application Context negotiation is required when a dialogue is
established between two IN Functional Entities. If the FE receiving the
dialogue request cannot support the requested context the dialogue is
aborted.
The INAP module is able to perform application context negotiation once the
supported contexts are configured. This can be done automatically using the
API interface. The API user handles Application Contexts using defined
interface codes.
Alternatively the INAP module may be configured to transparently pass raw
Application Context data to the User permitting the User Application to
perform context negotiation if required. This transparent Application Context
handling option can also be used to support interworking with some
proprietary INAP implementations that do not make use of Application
Contexts.
2.4 Module Dimensions
Internally there are a number of data structures used by the module.
The maximum dimensions of these structures are determined by compile time
constants. The constants of importance to the user are:
• The maximum number of IN Functional Entities supported by the module
(32 for all assemblies).
• The maximum number of Application Contexts supported by the module
(32 for all assemblies).
• The maximum number of simultaneous dialogues supported by the
module.
• The maximum number of simultaneous invocations supported by the
module.
Host based (Linux,
Windows®, Solaris) SS7SIU520 SS7G21 SS7G22 SS7HDP SS7HDC
Maximum number
of dialogues
supported
65535 16384 65535 0, 8192 or 32768
(depending on run-
time license)
Maximum number
of invokes
supported
65535 16384 65535 0, 8192 or 32768
(depending on run-
time license)
2.5 Module Requirements
The module requires a periodic timer tick notification to be issued via the
input queue. Typically this is required every tenth of a second. This can either
be generated by a timer module or using the services of the selected
operating system.
2 General Description
14
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
15
3 INAP Module User Interface
3.1 Introduction
The INAP module is event driven.
The INAP module - User interface is message based and uses the following
message types:
Message Type Value Usage
INAP-SERVICE-REQ 0xc7f0 Used to invoke an operation at a remote Functional Entity.
Also to respond to operation invocation requests from
remote Functional Entities.
INAP-SERVICE-IND 0x87f1 Used to receive the results or errors arising from
operations invoked at remote Functional Entities. Also to
receive operation invocation requests from remote
Functional Entities.
INAP-DIALOGUE-REQ 0xc7f2 Used to issue dialogue commands to the INAP module.
INAP-DIALOGUE-IND 0x87f3 Used to receive dialogue events from the INAP module.
User dialogue commands are passed by sending command primitives in the
dialogue request messages outlined above.
User operations are sent to the network using the service request messages
outlined above. The required operation and associated parameters are
supplied coded as a TCAP component ([Ref 4] on page 9) following the basic
ASN.1 encoding rules ([Ref 3] on page 9). It is recommended that the user
make use of the suite of API functions for the coding and decoding of INAP
operations, see Chapter 4: Functional API User Interface on page 33.
The message must be contained in a single buffer allocated by the sending
module. The suite of API functions includes functions for the allocation and
transmission of these message buffers.
Each INAP primitive includes a number of parameters. These parameters are
conveyed in the parameter area of the message buffer.
3 INAP Module User Interface
16
3.2 Dialog Primitive Types
Dialogue handling primitives provide the mechanism by which dialogues are
established and maintained with remote Functional Entities.
Dialogue primitives are sent by the INAP User in an INAP-DIALOGUE-REQ
message. These convey a dialogue request or response:
Primitive Value Usage
INAP-OPEN-REQ 0x1 Used to open a dialogue. The INAP module assigns
resources for the dialogue and awaits any INAP operations
the user wishes to open the dialogue with.
INAP-CLOSE-REQ 0x2 Basic End: Used to indicate that any operations supplied
should now be transmitted to the remote FE. The dialogue is
then terminated.
Pre Arranged End: Used to indicate that the dialogue may be
terminated locally when any active invocations have
completed. Any pending components sent to the INAP
module will be discarded. The INAP module will issue a
Close Indication when the dialogue is terminated.
INAP-DELIMIT-REQ 0x3 Used to indicate that any components supplied should now
be transmitted to the remote FE. The dialogue remains open.
INAP-U-ABORT-REQ 0x4 Used to indicate that the user wishes to abort this dialogue.
Any outstanding components are discarded.
INAP-OPEN-RSP 0x81 Used to accept or reject a dialogue request from a remote
FE.
Under some network configurations, it may be desirable to change the local
and remote addresses that INAP uses for a particular dialogue after the Open
has been received. The INAP module allows the user to specify a new set of
origination and destination addresses within the Open-Response (or U_Abort
if appropriate). These addresses will be used for the remainder of the
dialogue. The value of INAPPN_dest_address will become the new remote
address and the INAPPN_orig_address will become the new local address
which will be used in messages sent to TCAP.
The current TCAP specifications only allow for the local address of the
responding end of a dialogue to be changed; therefore, end-to-end support
for changing additional addresses may depend on functionality offered at
other nodes.
Where the INAP module started a dialogue, it accepts new local and remote
addresses and uses them for the rest of the dialogue. This means that the
INAP module supports the functionality to act at both ends of a dialogue
where the addresses have changed.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
17
Dialogue primitives sent by the INAP module in an INAP-DIALOGUE-IND
message. These convey a dialogue indication or confirmation:
Primitive Value Usage
INAP-OPEN-IND 0x1 Used to indicate a dialogue request from a remote FE. The
user may subsequently receive service indication messages
bearing components.
INAP-CLOSE-IND 0x2 Used to indicate that all the components received have
been issued to the user. The dialogue is terminated.
INAP-DELIMITER-IND 0x3 Used to indicate that all the components received have
been sent to the user. The dialogue remains open.
INAP-OPEN-CNF 0x81 Used to indicate that the remote FE has accepted the user’s
dialogue request.
INAP-U-ABORT-IND 0x4 Used to indicate that the remote user has aborted the
dialogue. Any outstanding components have been
discarded.
INAP-P-ABORT-IND 0x5 Used to indicate that the dialogue has been aborted
because of a network error. Any outstanding components
have been discarded.
INAP-NOTICE-IND 0x6 Used to indicate that an abnormal component was detected.
3.3 Service Component Primitives
Service Component Request primitives convey coded INAP operations to the
INAP module. The primitive type indicates the nature of the component.
Primitive Value Usage
INAP-INVOKE-REQ 0x1 Used by the user application to request an operation
invocation.
INAP-RESULT-REQ 0x2 Used by the user application to provide the successful result
of an operation invocation.
INAP-ERROR-REQ 0x3 Used by the user application to provide the unsuccessful
result of an operation invocation.
INAP-REJECT-REQ 0x4 Used by an API decode function to indicate a "provider"
problem. This occurs if the decode function is unable to
decode the received component.
Service Component Indication primitives convey coded INAP operations to the
user. The primitive type indicates the nature of the component.
Primitive Value Usage
INAP-INVOKE-IND 0x1 Used by the INAP module to convey an operation invocation
to the user application.
INAP-RESULT-IND 0x2 Used by the INAP module to convey the successful result of
an operation previously invoked by the user.
INAP-ERROR-IND 0x3 Used by the INAP module to convey the unsuccessful result
of an operation previously invoked by the user.
3 INAP Module User Interface
18
3.4 INAP Dialogue Request Message
Synopsis
Message sent from the User to the INAP module containing a dialogue
request primitive.
Message Format
Message Header
FIELD NAME MEANING
type INAP_MSG_DLG_REQ (0xc7f2)
id dialogue_ID
src Sending module_id
dst INAP_MODULE_ID
rsp_req 0
hclass 0
status 0
err_info 0
len Number of bytes of user data
H
Parameter Area
Offset Size Name
0 1 Dialogue primitive type octet.
1 len - 2 Parameters in Name-Length-Data format.
len - 1 1 Set to zero indicating end of message.
Description
This message is used by the User to send dialogue primitives to the INAP
module. All dialogue primitives contain a dialogue ID which is encoded in the
message header. It does not form part of the parameter area. It must be
provided by the User with the INAP-OPEN-REQ primitive and used in the
message header of all subsequent dialogue primitives associated with that
dialogue. Operation invocations, results and errors are also associated with a
particular dialogue using this dialogue ID.
See Section 3.2 Dialog Primitive Types on page 16 for details of primitive
usage.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
19
Parameter Area Contents
The following table lists the parameters associated with each dialogue request
primitive.
INAP Primitive
Parameter OPEN-
REQ CLOSE–REQ DELIMITER-REQ U-ABORT-REQ OPEN-RSP
Destination
address A O
Originating
address B O
Destination
reference A
Originating
reference B
Result M
Refuse reason O
Release method M
User reason M
Application
context name O O O O O
Application
context index C O
User Information O O O
NC O
Key
Symbol Description
M Mandatory The message will be discarded if the corresponding parameter is
omitted
O Optional The parameter is not essential
A Exclusive OR One of the parameters marked A must be included.
B Exclusive OR One of the parameters marked B must be included.
C Conditional The parameter marked C must be included if Application Context
negotiation is enabled i.e., if the INAP_MSG_CNF_AC message
has been issued at least once.
3 INAP Module User Interface
20
3.5 INAP Dialogue Indication Message
Synopsis
Dialogue event indication message sent from the INAP module to the user.
Message Format
Message Header
Field Name Meaning
type INAP_MSG_DLG_IND (0x87f3)
id Dialogue_ID
src INAP_MODULE_ID
dst User module_id
rsp_req 0
hclass 0
status 0
err_info 0
len Number of bytes of user data
Parameter Area
Offset Size Name
0 1 Dialogue primitive type octet.
1 len - 2 Parameters in Name-Length-Data format.
len – 1 1 Set to zero indicating end of message.
Description
This message is used by the INAP module to indicate dialogue events to the
User application.
All protocol messages must contain the dialogue ID of the dialogue to which
they refer. This is encoded in the message header. The INAP module assigns
the dialogue id for an incoming dialogue request (OPEN IND primitive).
See Section 3.2 Dialog Primitive Types on page 16 for details of dialogue
primitive usage.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
21
The following table lists the parameters associated with each dialogue
indication primitive:
INAP Primitive
Parameter OPEN–
IND CLOSE–IND DELIMITER-IND U-ABORT-IND P-ABORT-IND OPEN-CNF NOTICE-IND
Destination
address A O
Originating
address B O
Destination
reference A
Originating
reference B
Result M
Refuse reason O
User reason M
Provider reason M
Application
context name O O O O O
Application
context index C O
Source M
Problem
diagnostic M
Release confirm O
Report Cause O
User Information O O O O
NC O
Key
Symbol Description
M Mandatory The parameter will always be included in the message
O Optional The parameter may or may not be included in the message
depending on the circumstances in which the message is sent.
A Exclusive OR One of the parameters marked A must be included.
B Exclusive OR One of the parameters marked B must be included.
C Conditional The parameter marked C must be included if Application Context
negotiation is enabled i.e., if the INAP_MSG_CNF_AC message
has been issued at least once.
3 INAP Module User Interface
22
3.6 INAP Dialogue Primitive Parameters
The following parameter names are defined for use in dialogue primitive
messages:
Parameter Mnemonic Value (dec) Value (hex)
Destination address INAPPN_dest_address 1 0x01
Originating address INAPPN_orig_address 3 0x03
Result INAPPN_result 5 0x05
Refuse reason INAPPN_refuse_rsn 6 0x06
Release method INAPPN_release_method 7 0x07
User reason INAPPN_user_rsn 8 0x08
Provider reason INAPPN_prov_rsn 9 0x09
User Information INAPPN_user_info 10 0x0a
Application context name INAPPN_applic_context 11 0x0b
Source INAPPN_source 12 0x0c
Problem diagnostic INAPPN_prob_diag 13 0x0d
Destination FE code INAPPN_dest_FE 14 0x0e
Originating FE code INAPPN_orig_FE 15 0x0f
Application context index INAPPN_ac_reference 27 0x1b
Release confirm INAPPN_release_confirm 28 0x1c
Report Cause INAPPN_report_cause 30 0x1e
Network Context INAPPN_nc 31 0x1f
The coding for each parameter type is given in the following tables:
Parameter name INAPPN_dest_address
Parameter length Variable, in the range 2 to 18
Parameter data SCCP address of the FE with which the dialogue is required.
Destination address parameter encoded in the format expected by the
network layer (e.g. when using SCCP, in accordance with Q.713 definition
of “Called party address”, starting with the address indicator and
containing, optionally, signaling point code, subsystem number and global
title).
Parameter name INAPPN_dest_FE
Parameter length Fixed, set to two octets.
Parameter data User defined reference code for the destination Functional Entity for this
dialogue. The User must previously have issued a Functional Entity
configuration request message for this FE. See Section 5.4 INAP
Functional Entity Configuration Request on page 63.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
23
Parameter name INAPPN_orig_address
Parameter length Variable, in the range 2 to 18
Parameter data SCCP address of the FE requesting the dialogue.
Origination address parameter encoded in the format expected by the
network layer (e.g. when using SCCP, in accordance with Q.713 definition
of “Called party address”, starting with the address indicator and
containing, optionally, signaling point code and global title).
Parameter name INAPPN_orig_FE
Parameter length Fixed, set to two octets.
Parameter data User defined code for the originating Functional Entity for this dialogue.
The User must previously have issued a Functional Entity configuration
request message for this FE. Section 5.4 INAP Functional Entity
Configuration Request on page 63.
Parameter name INAPPN_result
Parameter length Fixed, set to one octet
Parameter data Indicates whether the remote FE accepts the dialogue request from the
user or not.
• 0 – dialogue accepted
• 1 – dialogue refused
Parameter name INAPPN_refuse_rsn
Parameter length Fixed, set to one octet
Parameter data When a remote FE refuses a dialogue request from the user a reason may
be provided.
Single octet coded as follows:
• 0 - no reason given
• 3 – application context not supported
• 4 – potential version incompatibility
Parameter name INAPPN_release_confirm
Parameter length Fixed, set to one octet
Parameter data Allows the user to distinguish between a normal “basic” or “pre-arranged”
termination of a dialogue. If this parameter is not present, then a normal
release should be assumed.
• 0 – normal release indication. The dialogue has been closed by the
remote system.
• 1 – release confirm indication. The indication is generated to confirm
that the dialogue has been closed using a pre-arranged end. All
operations have been completed or have timed-out.
3 INAP Module User Interface
24
Parameter name INAPPN_release_method
Parameter length Fixed, set to one octet
Parameter data Allows the user to select “basic” or “pre-arranged” termination of a
dialogue.
• 0 – normal release. The INAP module issues a dialogue termination
message to the remote system. May be used to transfer components to
the remote system. User application dialogue resources may be
released immediately.
• 1 – prearranged end. Used where the IN specifications allow the
dialogue to be terminated locally without sending a dialogue
termination message to the remote system. If the INAP module is
awaiting responses (errors or results) for any active Class 1, 2 or 3
operation invocations, the INAP module will maintain the dialogue until
the internal operation timers have expired or the responses received.
Once all the operations have completed the INAP module will issue a
Close Indication primitive. User application dialogue resources may
then be released.
Parameter name INAPPN_user_info
Parameter length Variable (subject to satisfying message length limits).
Parameter data User information encoded as an X.208 EXTERNAL, commencing with the
EXTERNAL tag.
This formatting is not required when the User Information is carried in a
User Abort primitive. Any format may be used in this case.
Parameter name INAPPN_user_rsn
Parameter length Fixed, set to one octet
Parameter data Allows the user to provide an abort cause when aborting a dialogue.
Single octet coded as follows:
• 0 - User specific reason
• 6 - Application Context not supported
Parameter name INAPPN_prov_rsn
Parameter length Fixed, set to one octet
Parameter data Provides the user with an abort cause when the network aborts a dialogue.
• 0 – provider malfunction
• 1 – supporting dialogue/transaction released
• 2 – resource limitation
• 3 – maintenance activity
• 4 – version incompatibility
• 5 – abnormal INAP dialogue
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
25
Parameter name INAPPN_source
Parameter length Fixed, set to one octet
Parameter data Used to indicate the source of the abort in a provider abort primitive.
• 0 – INAP problem
• 1 - TC problem
• 2 – network service problem
Parameter name INAPPN_applic_context
Parameter length Variable up to 32.
Parameter data This parameter is only used when the module has been configured for
"transparent AC operation" using the module configuration message.
The Application context as received or transmitted with this dialogue. May
be used to supply an alternative context when used with the U-ABORT
primitive.
Encoded as specified in Q.773 commencing with the Object Identifier
Name tag.
Parameter name INAPPN_ac_reference
Parameter length Variable, in the range 1 to 2
Parameter data The index specifying the Application context for use with this dialogue. The
module must previously have been configured with supported contexts and
associated references using the Configure AC message. See Section 5.5
INAP Application Context Configuration Request on page 65.
May be used to supply an alternative context when used with the U-
ABORT primitive.
Parameter name INAPPN_prob_diag
Parameter length Fixed, set to one octet
Parameter data Used to indicate unexpected events that are not related to an active
operation invocation.
• 0 – abnormal event detected by peer
• 1 – response rejected by peer
• 2 – abnormal event received from peer
• 3 – abnormal network report cause
Parameter name INAPPN_report_cause
Parameter length Fixed, set to 1
Parameter data Values as defined in Q.713 Return cause
Parameter name INAPPN_nc
Parameter length Variable, typically 1. Length of zero indicates Network Context is unknown.
Parameter data Network Context identifier.
If the default NC is being used then this parameter is optional. If present, it
should have a value of 0. For other Network Contexts it should match the
value defined in the relevant INP_MSG_NC_CONFIG message.
3 INAP Module User Interface
26
3.7 INAP Service Request Message
Synopsis
Protocol message sent from the User to the INAP module containing a single
INAP operation invocation, result or error.
Message Format
Message Header
Field Name Meaning
type INAP_MSG_SRV_REQ (0xc7f0)
id Dialogue_ID
src Sending module_id
dst INAP_TASK_ID
rsp_req 0
hclass 0
status 0
err_info 0
len Number of bytes of user data
Parameter Area
Offset Size Name
0 1 Component Type octet.
1 len – 2 Parameters in Name-Length-Data format.
len – 1 1 Set to zero indicating end of message.
Description
This message allows the user to send INAP operation invoke, result and error
components to a remote Functional Entity via an open dialogue. It is also
used to issue problem codes relating to received components.
The User's components are formatted as a TCAP component following the
basic ASN.1 encoding rules.
All service request messages must contain the dialogue ID of the dialogue to
which they belong. This is encoded in the message header and does not form
part of the parameter area.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
27
The following parameters are defined for use in service request messages:
Component Type
Parameter INVOKE-
REQ RESULT-REQ ERROR-REQ REJECT-REQ
Invoke ID M M M M
Linked ID O
Component M M M
Op code M
Parent Ind O
Class M
Timeout M
Problem code M
Quality Of Service O
Key
Symbol Description
M Mandatory The message will be discarded if the corresponding parameter is
omitted
O Optional The parameter is not essential
3.8 INAP Service Indication Message
Synopsis
Protocol message sent from the INAP module to the user containing a
received operation invoke, result or error component.
Message Format
Message Header
Field Name Meaning
type INAP_MSG_SRV_IND (0x87f1)
id Dialogue_ID
src INAP_TASK_ID
dst User module_id
rsp_req 0
hclass 0
status 0
err_info 0
len Number of bytes of user data
3 INAP Module User Interface
28
Parameter Area
Offset Size Name
0 1 Component Type octet.
1 Len - 2 Parameters in Name-Length-Data format.
len – 1 1 Set to zero indicating end of message.
Description
The INAP module uses this message to send received INAP operation invoke,
result and error components to the User.
The received components are formatted as a TCAP component following the
basic ASN.1 encoding rules.
All service indication messages must contain the dialogue ID of the dialogue
to which they belong. This is encoded in the message header and does not
form part of the parameter area.
The following parameters are defined for use in service indication messages:
Component Type
Parameter INVOKE-IND RESULT-IND ERROR-IND
Application context index C
Component M M A
Invoke ID M M M
Linked ID O
Linked Op code O M M
Provider Error A
Key
Symbol Description
M Mandatory The parameter will always be included in the message.
O Optional The parameter may or may not be included in the message
depending on the circumstances in which the message is sent.
C Conditional The parameter will be included in the message if Application
Context negotiation is enabled, i.e. at least one
INAP_MSG_CNF_AC message has been issued.
A Exclusive OR One of the parameters marked A will always be included in the
message.
Dialogic® SS7 Protocols INAP Programmer's Manual Issue 12
29
3.9 INAP Service Primitive Parameters
The following parameter names are defined for use in service primitive
messages:
Parameter Mnemonic Value (dec) Value (hex)
Invoke ID INAPPN_invoke_id 16 0x10
Linked ID INAPPN_linked_id 17 0x11
Component INAPPN_component 18 0x12
Class INAPPN_class 19 0x13
Timeout INAPPN_timeout 20 0x14
Op code INAPPN_op_code 21 0x15
Linked Op code INAPPN_linked_op_code 22 0x16
Problem code INAPPN_problem_code 23 0x17
Parent Ind INAPPN_parent_ind 24 0x18
Provider Error INAPPN_provider_error 25 0x19
MTP message priority INAPPN_priority 26 0x1a
Application context index INAPPN_ac_reference 27 0x1b
Quality Of Service INAPPN_qos 29 0x1d
Parameter name INAPPN_ac_reference
Parameter length Variable, in the range 1 to 2
Parameter data The index specifying the Application Context of the dialogue on which
the component was received.
Supplied with invoke components to permit the decoded operation to be
validated against the context.
The module must previously have been configured with supported
contexts and associated references using the Application Context
configuration message. See Section 5.5 INAP Application Context
Configuration Request on page 65.
Parameter name INAPPN_invoke_id
Parameter length Fixed, set to 1
Parameter data An id associated with every operation invocation. Assigned by the
invoking user.
Parameter name INAPPN_linked_id
Parameter length Fixed, set to 1
Parameter data The invoke id of the parent operation invocation.
This parameter is only included in linked (child) operation invocations.
3 INAP Module User Interface
30
Parameter name INAPPN_component
Parameter length Variable, 1 to 255
Parameter data The invoke, result or error component coded in accordance with Q.773
using the ASN.1 Basic Encoding Rules. Starting with the Component
type tag.
Parameter name INAPPN_class
Parameter length Fixed set to 1.
Parameter data The class of the INAP operation.
• 1 - Operation has Results and Errors
• 2 - Operation has Errors only
• 3 - Operation has Results only
• 4 - Operation has no Results or Errors
Where the INAP Operation code and decode functions are used, this
parameter is supplied automatically
Parameter name INAPPN_timeout
Parameter length Fixed set to 2.
Parameter data The TCAP timeout of the INAP operation.
Specified on a per operation basis in the INAP specifications. Time in
seconds.
Where the INAP Operation code and decode functions are used, this
parameter is supplied by using the API functions.
Parameter name INAPPN_op_code
Parameter length Fixed set to 1.
Parameter data The INAP specified Operation Code.
Supplied by the User in Service Invoke Request messages. The INAP
module does not examine the contents, storing it for use in Service