Browse code

modules: readme files regenerated - sipt ... [skip ci]

Kamailio Dev authored on 10/09/2021 10:16:25
Showing 1 changed files
... ...
@@ -24,6 +24,7 @@ Torrey Searle
24 24
 
25 25
               3.3. sipt_set_calling(origin, nai, presentation, screening)
26 26
               3.4. sipt_forwarding(origin, nai)
27
+              3.5. sipt_has_isup_body()
27 28
 
28 29
         4. Exported pseudo-variables
29 30
 
... ...
@@ -37,17 +38,28 @@ Torrey Searle
37 38
                       $sipt.(calling_party_number.nai) /
38 39
                       $sipt_calling_party_nai
39 40
 
40
-              4.6. $sipt(called_party_number.nature_of_address) /
41
+              4.6. $sipt(calling_party_number)
42
+              4.7. $sipt(called_party_number.nature_of_address) /
41 43
                       $sipt(called_party_number.nai) /
42 44
                       $sipt_called_party_nai
43 45
 
44
-              4.7. $sipt(event_info)
45
-              4.8. $sipt(backward_call_indicator.charge_indicator)
46
-              4.9. $sipt(redirection_info) / $sipt_redirection_info
47
-              4.10. $sipt(redirection_number) / $sipt_redirection_number
48
-              4.11. $sipt(redirection_number.nai) /
46
+              4.8. $sipt(called_party_number)
47
+              4.9. $sipt(event_info)
48
+              4.10. $sipt(backward_call_indicator.charge_indicator)
49
+              4.11. $sipt(redirection_info) / $sipt_redirection_info
50
+              4.12. $sipt(redirection_number) / $sipt_redirection_number
51
+              4.13. $sipt(redirection_number.nai) /
49 52
                       $sipt_redirection_number_nai
50 53
 
54
+              4.14. $sipt(redirection_information.reason)
55
+              4.15. $sipt(redirection_information.original_reason)
56
+              4.16. $sipt(redirecting_number.nai)
57
+              4.17. $sipt(redirecting_number)
58
+              4.18. $sipt(original_called_number.nai)
59
+              4.19. $sipt(original_called_number)
60
+              4.20. $sipt(generic_number.nai)
61
+              4.21. $sipt(generic_number)
62
+
51 63
    List of Tables
52 64
 
53 65
    1.1. Address Presentation Restricted Indicator Values
... ...
@@ -65,13 +77,14 @@ Torrey Searle
65 77
    1.2. sipt_destination(destination, hops, nai) usage
66 78
    1.3. sipt_set_calling(origin, nai, presentation, screening) usage
67 79
    1.4. sipt_set_calling(origin, nai) usage
68
-   1.5. sipt_presentation pseudo-variable usage
69
-   1.6. sipt_screening pseudo-variable usage
70
-   1.7. sipt_hop_counter pseudo-variable usage
71
-   1.8. sipt_cpc pseudo-variable usage
72
-   1.9. sipt_calling_party_nai pseudo-variable usage
73
-   1.10. sipt_called_party_nai pseudo-variable usage
74
-   1.11. sipt_redirection_number usage
80
+   1.5. sipt_has_isup_body() usage
81
+   1.6. sipt_presentation pseudo-variable usage
82
+   1.7. sipt_screening pseudo-variable usage
83
+   1.8. sipt_hop_counter pseudo-variable usage
84
+   1.9. sipt_cpc pseudo-variable usage
85
+   1.10. sipt_calling_party_nai pseudo-variable usage
86
+   1.11. sipt_called_party_nai pseudo-variable usage
87
+   1.12. sipt_redirection_number usage
75 88
 
76 89
 Chapter 1. Admin Guide
77 90
 
... ...
@@ -87,6 +100,7 @@ Chapter 1. Admin Guide
87 100
 
88 101
         3.3. sipt_set_calling(origin, nai, presentation, screening)
89 102
         3.4. sipt_forwarding(origin, nai)
103
+        3.5. sipt_has_isup_body()
90 104
 
91 105
    4. Exported pseudo-variables
92 106
 
... ...
@@ -97,14 +111,24 @@ Chapter 1. Admin Guide
97 111
         4.5. $sipt(calling_party_number.nature_of_address) /
98 112
                 $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
99 113
 
100
-        4.6. $sipt(called_party_number.nature_of_address) /
114
+        4.6. $sipt(calling_party_number)
115
+        4.7. $sipt(called_party_number.nature_of_address) /
101 116
                 $sipt(called_party_number.nai) / $sipt_called_party_nai
102 117
 
103
-        4.7. $sipt(event_info)
104
-        4.8. $sipt(backward_call_indicator.charge_indicator)
105
-        4.9. $sipt(redirection_info) / $sipt_redirection_info
106
-        4.10. $sipt(redirection_number) / $sipt_redirection_number
107
-        4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
118
+        4.8. $sipt(called_party_number)
119
+        4.9. $sipt(event_info)
120
+        4.10. $sipt(backward_call_indicator.charge_indicator)
121
+        4.11. $sipt(redirection_info) / $sipt_redirection_info
122
+        4.12. $sipt(redirection_number) / $sipt_redirection_number
123
+        4.13. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
124
+        4.14. $sipt(redirection_information.reason)
125
+        4.15. $sipt(redirection_information.original_reason)
126
+        4.16. $sipt(redirecting_number.nai)
127
+        4.17. $sipt(redirecting_number)
128
+        4.18. $sipt(original_called_number.nai)
129
+        4.19. $sipt(original_called_number)
130
+        4.20. $sipt(generic_number.nai)
131
+        4.21. $sipt(generic_number)
108 132
 
109 133
 1. Overview
110 134
 
... ...
@@ -127,6 +151,7 @@ Chapter 1. Admin Guide
127 151
 
128 152
    3.3. sipt_set_calling(origin, nai, presentation, screening)
129 153
    3.4. sipt_forwarding(origin, nai)
154
+   3.5. sipt_has_isup_body()
130 155
 
131 156
 3.1. sipt_destination(destination, hops, nai[, terminator=1])
132 157
 
... ...
@@ -186,6 +211,18 @@ sipt_set_calling($fU, 4, 0, 3);
186 211
 sipt_forwarfing($avp(s:forwarding_number), 3);
187 212
 ...
188 213
 
214
+3.5. sipt_has_isup_body()
215
+
216
+   The function returns true if the SIP message has a ISUP body attached.
217
+
218
+   Example 1.5. sipt_has_isup_body() usage
219
+...
220
+if(sipt_has_isup_body())
221
+{
222
+    # do interesting stuff here
223
+}
224
+...
225
+
189 226
 4. Exported pseudo-variables
190 227
 
191 228
    4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
... ...
@@ -195,14 +232,24 @@ sipt_forwarfing($avp(s:forwarding_number), 3);
195 232
    4.5. $sipt(calling_party_number.nature_of_address) /
196 233
           $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
197 234
 
198
-   4.6. $sipt(called_party_number.nature_of_address) /
235
+   4.6. $sipt(calling_party_number)
236
+   4.7. $sipt(called_party_number.nature_of_address) /
199 237
           $sipt(called_party_number.nai) / $sipt_called_party_nai
200 238
 
201
-   4.7. $sipt(event_info)
202
-   4.8. $sipt(backward_call_indicator.charge_indicator)
203
-   4.9. $sipt(redirection_info) / $sipt_redirection_info
204
-   4.10. $sipt(redirection_number) / $sipt_redirection_number
205
-   4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
239
+   4.8. $sipt(called_party_number)
240
+   4.9. $sipt(event_info)
241
+   4.10. $sipt(backward_call_indicator.charge_indicator)
242
+   4.11. $sipt(redirection_info) / $sipt_redirection_info
243
+   4.12. $sipt(redirection_number) / $sipt_redirection_number
244
+   4.13. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
245
+   4.14. $sipt(redirection_information.reason)
246
+   4.15. $sipt(redirection_information.original_reason)
247
+   4.16. $sipt(redirecting_number.nai)
248
+   4.17. $sipt(redirecting_number)
249
+   4.18. $sipt(original_called_number.nai)
250
+   4.19. $sipt(original_called_number)
251
+   4.20. $sipt(generic_number.nai)
252
+   4.21. $sipt(generic_number)
206 253
 
207 254
 4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
208 255
 
... ...
@@ -216,7 +263,7 @@ sipt_forwarfing($avp(s:forwarding_number), 3);
216 263
    2 address not avail (national use)
217 264
    3 spare
218 265
 
219
-   Example 1.5. sipt_presentation pseudo-variable usage
266
+   Example 1.6. sipt_presentation pseudo-variable usage
220 267
 ...
221 268
 # add privacy header if restriction is requested
222 269
 if($sipt(calling_party_number.presentation) == 1)
... ...
@@ -239,7 +286,7 @@ if($sipt(calling_party_number.presentation) == 1)
239 286
    2 Reserved (user provided, verified and failed)
240 287
    3 Network provided
241 288
 
242
-   Example 1.6. sipt_screening pseudo-variable usage
289
+   Example 1.7. sipt_screening pseudo-variable usage
243 290
 ...
244 291
 
245 292
 # remove P-Asserted-Identity header if the screening isn't verified
... ...
@@ -257,7 +304,7 @@ if($avp(s:screening) != 1 && $avp(s:screening) != 3)
257 304
    Returns the value of the Hop Counter for the IAM message if it exists.
258 305
    Returns -1 if there isn't a hop counter.
259 306
 
260
-   Example 1.7. sipt_hop_counter pseudo-variable usage
307
+   Example 1.8. sipt_hop_counter pseudo-variable usage
261 308
 ...
262 309
 # get the hop counter and update the Max-Forwards header if it exists
263 310
 $avp(s:hop) = $sipt(hop_counter);
... ...
@@ -274,7 +321,7 @@ if($avp(s:hop) > 0)
274 321
    Returns the value of the Calling Party Category for the IAM message.
275 322
    Returns -1 if there is a parsing error.
276 323
 
277
-   Example 1.8. sipt_cpc pseudo-variable usage
324
+   Example 1.9. sipt_cpc pseudo-variable usage
278 325
 ...
279 326
 # get the Cpc code and set put it in a custom sip header
280 327
 append_hf("X-CPC: $sipt(cpc)\r\n");
... ...
@@ -295,7 +342,7 @@ $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
295 342
    3 National (significant) number (national use)
296 343
    4 International use
297 344
 
298
-   Example 1.9. sipt_calling_party_nai pseudo-variable usage
345
+   Example 1.10. sipt_calling_party_nai pseudo-variable usage
299 346
 ...
300 347
 # get the Calling Nai and add country code if national
301 348
 if($sipt(calling_party_number.nai) == 3)
... ...
@@ -305,7 +352,13 @@ if($sipt(calling_party_number.nai) == 3)
305 352
 
306 353
 ...
307 354
 
308
-4.6. $sipt(called_party_number.nature_of_address) /
355
+4.6. $sipt(calling_party_number)
356
+
357
+   Returns the value (Address signal) of the Calling Party for the IAM
358
+   message. Returns -1 if there is a parsing error or if the Calling Party
359
+   Number is not present.
360
+
361
+4.7. $sipt(called_party_number.nature_of_address) /
309 362
 $sipt(called_party_number.nai) / $sipt_called_party_nai
310 363
 
311 364
    Returns the value of the Nature of Address Indicator of the Called
... ...
@@ -319,7 +372,7 @@ $sipt(called_party_number.nai) / $sipt_called_party_nai
319 372
    4 International use
320 373
    5 Network-specific number (national use)
321 374
 
322
-   Example 1.10. sipt_called_party_nai pseudo-variable usage
375
+   Example 1.11. sipt_called_party_nai pseudo-variable usage
323 376
 ...
324 377
 # get the Called Nai and add country code if national
325 378
 if($sipt(called_party_number.nai) == 3)
... ...
@@ -329,7 +382,13 @@ if($sipt(called_party_number.nai) == 3)
329 382
 
330 383
 ...
331 384
 
332
-4.7. $sipt(event_info)
385
+4.8. $sipt(called_party_number)
386
+
387
+   Returns the value (Address signal) of the Called Party for the IAM
388
+   message. Returns -1 if there is a parsing error or if the Called Party
389
+   Number is not present.
390
+
391
+4.9. $sipt(event_info)
333 392
 
334 393
    Returns the value of the Event Info header of the CPG message. Returns
335 394
    -1 if there is a parsing error.
... ...
@@ -343,7 +402,7 @@ if($sipt(called_party_number.nai) == 3)
343 402
    5 Call forward on no reply
344 403
    6 Call forward unconditional
345 404
 
346
-4.8. $sipt(backward_call_indicator.charge_indicator)
405
+4.10. $sipt(backward_call_indicator.charge_indicator)
347 406
 
348 407
    Returns the value of the charge indication of the backward call
349 408
    indicator header in the ACM or COT message. Returns -1 if there is a
... ...
@@ -355,10 +414,10 @@ if($sipt(called_party_number.nai) == 3)
355 414
    2 charge
356 415
    3 spare
357 416
 
358
-4.9. $sipt(redirection_info) / $sipt_redirection_info
417
+4.11. $sipt(redirection_info) / $sipt_redirection_info
359 418
 
360
-   Returns redirection info header from ISUP Returns "Redirecting reason"
361
-   or -1 if no redirection info found.
419
+   Returns call diversion information header from ISUP Returns
420
+   "Redirecting reason" or -1 if no call diversion information found.
362 421
 
363 422
    Table 1.7. Redirecting reason Values
364 423
    0 Unknown
... ...
@@ -369,19 +428,19 @@ if($sipt(called_party_number.nai) == 3)
369 428
    5 deflection immediate response
370 429
    6 mobile subscriber not reachable
371 430
 
372
-4.10. $sipt(redirection_number) / $sipt_redirection_number
431
+4.12. $sipt(redirection_number) / $sipt_redirection_number
373 432
 
374 433
    Returns number to which redirection will trigered Returns -1 if there
375 434
    is a parsing error.
376 435
 
377
-   Example 1.11. sipt_redirection_number usage
436
+   Example 1.12. sipt_redirection_number usage
378 437
 ...
379 438
 # get the redirection number
380 439
 $avp(s:redir_num) = $sipt(redirection_number);
381 440
 
382 441
 ...
383 442
 
384
-4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
443
+4.13. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
385 444
 
386 445
    Returns NAI for redirection number from ISUP Returns NAI for
387 446
    redirection number or -1 if no info found.
... ...
@@ -392,3 +451,42 @@ $avp(s:redir_num) = $sipt(redirection_number);
392 451
    2 Unknown (national use)
393 452
    3 National (significant) number (national use)
394 453
    4 International use
454
+
455
+4.14. $sipt(redirection_information.reason)
456
+
457
+   Returns redirection reason from Redirection information from ISUP or -1
458
+   if no Redirection information found.
459
+
460
+4.15. $sipt(redirection_information.original_reason)
461
+
462
+   Returns original redirection reason from Redirection information from
463
+   ISUP or -1 if no Redirection information found.
464
+
465
+4.16. $sipt(redirecting_number.nai)
466
+
467
+   Returns NAI for redirecting number from ISUP or -1 if no redirecting
468
+   number found.
469
+
470
+4.17. $sipt(redirecting_number)
471
+
472
+   Returns redirecting number from ISUP or -1 if no redirecting number
473
+   found.
474
+
475
+4.18. $sipt(original_called_number.nai)
476
+
477
+   Returns NAI for original called number from ISUP or -1 if no original
478
+   called number found.
479
+
480
+4.19. $sipt(original_called_number)
481
+
482
+   Returns original called number from ISUP or -1 if no original called
483
+   number found.
484
+
485
+4.20. $sipt(generic_number.nai)
486
+
487
+   Returns NAI for generic number from ISUP or -1 if no generic number
488
+   found.
489
+
490
+4.21. $sipt(generic_number)
491
+
492
+   Returns generic number from ISUP or -1 if no generic number found.