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.
Browse code

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

Kamailio Dev authored on 01/06/2018 08:17:07
Showing 1 changed files
... ...
@@ -23,6 +23,7 @@ Torrey Searle
23 23
                       called_category, e2e_indicator)
24 24
 
25 25
               3.3. sipt_set_calling(origin, nai, presentation, screening)
26
+              3.4. sipt_forwarding(origin, nai)
26 27
 
27 28
         4. Exported pseudo-variables
28 29
 
... ...
@@ -42,6 +43,10 @@ Torrey Searle
42 43
 
43 44
               4.7. $sipt(event_info)
44 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) /
49
+                      $sipt_redirection_number_nai
45 50
 
46 51
    List of Tables
47 52
 
... ...
@@ -51,18 +56,22 @@ Torrey Searle
51 56
    1.4. Called Nature of Address Values
52 57
    1.5. Event Info Values
53 58
    1.6. Charge Indicator Values
59
+   1.7. Redirecting reason Values
60
+   1.8. Redirecting number NAI Values
54 61
 
55 62
    List of Examples
56 63
 
57 64
    1.1. sipt_destination(destination, hops, nai) usage
58 65
    1.2. sipt_destination(destination, hops, nai) usage
59 66
    1.3. sipt_set_calling(origin, nai, presentation, screening) usage
60
-   1.4. sipt_presentation pseudo-variable usage
61
-   1.5. sipt_screening pseudo-variable usage
62
-   1.6. sipt_hop_counter pseudo-variable usage
63
-   1.7. sipt_cpc pseudo-variable usage
64
-   1.8. sipt_calling_party_nai pseudo-variable usage
65
-   1.9. sipt_called_party_nai pseudo-variable usage
67
+   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
66 75
 
67 76
 Chapter 1. Admin Guide
68 77
 
... ...
@@ -77,6 +86,7 @@ Chapter 1. Admin Guide
77 86
                 called_category, e2e_indicator)
78 87
 
79 88
         3.3. sipt_set_calling(origin, nai, presentation, screening)
89
+        3.4. sipt_forwarding(origin, nai)
80 90
 
81 91
    4. Exported pseudo-variables
82 92
 
... ...
@@ -92,6 +102,9 @@ Chapter 1. Admin Guide
92 102
 
93 103
         4.7. $sipt(event_info)
94 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
95 108
 
96 109
 1. Overview
97 110
 
... ...
@@ -113,6 +126,7 @@ Chapter 1. Admin Guide
113 126
           e2e_indicator)
114 127
 
115 128
    3.3. sipt_set_calling(origin, nai, presentation, screening)
129
+   3.4. sipt_forwarding(origin, nai)
116 130
 
117 131
 3.1. sipt_destination(destination, hops, nai[, terminator=1])
118 132
 
... ...
@@ -160,6 +174,18 @@ sipt_set_bci_1("2", "1", "1", "0");
160 174
 sipt_set_calling($fU, 4, 0, 3);
161 175
 ...
162 176
 
177
+3.4. sipt_forwarding(origin, nai)
178
+
179
+   updates the IAM in the body if it exists, setting (or adding) the
180
+   forwarding number to “origin” with the nature address specified in
181
+   “nai”.
182
+
183
+   Example 1.4. sipt_set_calling(origin, nai) usage
184
+...
185
+# update the forwarding number to the value in the from header
186
+sipt_forwarfing($avp(s:forwarding_number), 3);
187
+...
188
+
163 189
 4. Exported pseudo-variables
164 190
 
165 191
    4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
... ...
@@ -174,6 +200,9 @@ sipt_set_calling($fU, 4, 0, 3);
174 200
 
175 201
    4.7. $sipt(event_info)
176 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
177 206
 
178 207
 4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
179 208
 
... ...
@@ -187,7 +216,7 @@ sipt_set_calling($fU, 4, 0, 3);
187 216
    2 address not avail (national use)
188 217
    3 spare
189 218
 
190
-   Example 1.4. sipt_presentation pseudo-variable usage
219
+   Example 1.5. sipt_presentation pseudo-variable usage
191 220
 ...
192 221
 # add privacy header if restriction is requested
193 222
 if($sipt(calling_party_number.presentation) == 1)
... ...
@@ -210,7 +239,7 @@ if($sipt(calling_party_number.presentation) == 1)
210 239
    2 Reserved (user provided, verified and failed)
211 240
    3 Network provided
212 241
 
213
-   Example 1.5. sipt_screening pseudo-variable usage
242
+   Example 1.6. sipt_screening pseudo-variable usage
214 243
 ...
215 244
 
216 245
 # remove P-Asserted-Identity header if the screening isn't verified
... ...
@@ -228,7 +257,7 @@ if($avp(s:screening) != 1 && $avp(s:screening) != 3)
228 257
    Returns the value of the Hop Counter for the IAM message if it exists.
229 258
    Returns -1 if there isn't a hop counter.
230 259
 
231
-   Example 1.6. sipt_hop_counter pseudo-variable usage
260
+   Example 1.7. sipt_hop_counter pseudo-variable usage
232 261
 ...
233 262
 # get the hop counter and update the Max-Forwards header if it exists
234 263
 $avp(s:hop) = $sipt(hop_counter);
... ...
@@ -245,7 +274,7 @@ if($avp(s:hop) > 0)
245 274
    Returns the value of the Calling Party Category for the IAM message.
246 275
    Returns -1 if there is a parsing error.
247 276
 
248
-   Example 1.7. sipt_cpc pseudo-variable usage
277
+   Example 1.8. sipt_cpc pseudo-variable usage
249 278
 ...
250 279
 # get the Cpc code and set put it in a custom sip header
251 280
 append_hf("X-CPC: $sipt(cpc)\r\n");
... ...
@@ -266,7 +295,7 @@ $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
266 295
    3 National (significant) number (national use)
267 296
    4 International use
268 297
 
269
-   Example 1.8. sipt_calling_party_nai pseudo-variable usage
298
+   Example 1.9. sipt_calling_party_nai pseudo-variable usage
270 299
 ...
271 300
 # get the Calling Nai and add country code if national
272 301
 if($sipt(calling_party_number.nai) == 3)
... ...
@@ -290,7 +319,7 @@ $sipt(called_party_number.nai) / $sipt_called_party_nai
290 319
    4 International use
291 320
    5 Network-specific number (national use)
292 321
 
293
-   Example 1.9. sipt_called_party_nai pseudo-variable usage
322
+   Example 1.10. sipt_called_party_nai pseudo-variable usage
294 323
 ...
295 324
 # get the Called Nai and add country code if national
296 325
 if($sipt(called_party_number.nai) == 3)
... ...
@@ -325,3 +354,41 @@ if($sipt(called_party_number.nai) == 3)
325 354
    1 no charge
326 355
    2 charge
327 356
    3 spare
357
+
358
+4.9. $sipt(redirection_info) / $sipt_redirection_info
359
+
360
+   Returns redirection info header from ISUP Returns "Redirecting reason"
361
+   or -1 if no redirection info found.
362
+
363
+   Table 1.7. Redirecting reason Values
364
+   0 Unknown
365
+   1 User busy
366
+   2 PROGRESS
367
+   3 no reply
368
+   4 deflection during alerting
369
+   5 deflection immediate response
370
+   6 mobile subscriber not reachable
371
+
372
+4.10. $sipt(redirection_number) / $sipt_redirection_number
373
+
374
+   Returns number to which redirection will trigered Returns -1 if there
375
+   is a parsing error.
376
+
377
+   Example 1.11. sipt_redirection_number usage
378
+...
379
+# get the redirection number
380
+$avp(s:redir_num) = $sipt(redirection_number);
381
+
382
+...
383
+
384
+4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
385
+
386
+   Returns NAI for redirection number from ISUP Returns NAI for
387
+   redirection number or -1 if no info found.
388
+
389
+   Table 1.8. Redirecting number NAI Values
390
+   0 Spare
391
+   1 Subscriber Number (national use)
392
+   2 Unknown (national use)
393
+   3 National (significant) number (national use)
394
+   4 International use
Browse code

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

Kamailio Dev authored on 28/02/2018 17:03:37 • The Root committed on 28/02/2018 19:11:36
Showing 1 changed files
... ...
@@ -95,7 +95,7 @@ Chapter 1. Admin Guide
95 95
 
96 96
 1. Overview
97 97
 
98
-   Module for updating ISUP encapuslated in SIP (SIP-T/SIP-I)
98
+   Module for updating ISUP encapsulated in SIP (SIP-T/SIP-I)
99 99
 
100 100
    The sipt module can be used to update various ss7 headers contained
101 101
    inside a message.
... ...
@@ -120,7 +120,7 @@ Chapter 1. Admin Guide
120 120
    number to “destination” with the nature address specified in “nai” and
121 121
    decrementing the hop counter value if present. If the hop counter
122 122
    header is missing it will be added with the value of “hops”. If
123
-   “terminator” is set to 1, then F will be appened to digit string to
123
+   “terminator” is set to 1, then F will be appended to digit string to
124 124
    indicate the number is complete (default).
125 125
 
126 126
    Example 1.1. sipt_destination(destination, hops, nai) usage
Browse code

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

Kamailio Dev authored on 04/04/2017 15:18:44
Showing 1 changed files
... ...
@@ -16,7 +16,9 @@ Torrey Searle
16 16
         2. Dependencies
17 17
         3. Functions
18 18
 
19
-              3.1. sipt_destination(destination, hops, nai)
19
+              3.1. sipt_destination(destination, hops, nai[,
20
+                      terminator=1])
21
+
20 22
               3.2. sipt_set_bci_1(charge_indicator, called_status,
21 23
                       called_category, e2e_indicator)
22 24
 
... ...
@@ -70,7 +72,7 @@ Chapter 1. Admin Guide
70 72
    2. Dependencies
71 73
    3. Functions
72 74
 
73
-        3.1. sipt_destination(destination, hops, nai)
75
+        3.1. sipt_destination(destination, hops, nai[, terminator=1])
74 76
         3.2. sipt_set_bci_1(charge_indicator, called_status,
75 77
                 called_category, e2e_indicator)
76 78
 
... ...
@@ -106,18 +108,20 @@ Chapter 1. Admin Guide
106 108
 
107 109
 3. Functions
108 110
 
109
-   3.1. sipt_destination(destination, hops, nai)
111
+   3.1. sipt_destination(destination, hops, nai[, terminator=1])
110 112
    3.2. sipt_set_bci_1(charge_indicator, called_status, called_category,
111 113
           e2e_indicator)
112 114
 
113 115
    3.3. sipt_set_calling(origin, nai, presentation, screening)
114 116
 
115
-3.1. sipt_destination(destination, hops, nai)
117
+3.1. sipt_destination(destination, hops, nai[, terminator=1])
116 118
 
117 119
    updates the IAM in the body if it exists, setting the called party
118 120
    number to “destination” with the nature address specified in “nai” and
119 121
    decrementing the hop counter value if present. If the hop counter
120
-   header is missing it will be added with the value of “hops”.
122
+   header is missing it will be added with the value of “hops”. If
123
+   “terminator” is set to 1, then F will be appened to digit string to
124
+   indicate the number is complete (default).
121 125
 
122 126
    Example 1.1. sipt_destination(destination, hops, nai) usage
123 127
 ...
Browse code

core, lib, modules: restructured source code tree

- new folder src/ to hold the source code for main project applications
- main.c is in src/
- all core files are subfolder are in src/core/
- modules are in src/modules/
- libs are in src/lib/
- application Makefiles are in src/
- application binary is built in src/ (src/kamailio)

Daniel-Constantin Mierla authored on 07/12/2016 11:03:51
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,323 @@
1
+sipt Module
2
+
3
+Torrey Searle
4
+
5
+   Voxbone SA
6
+   <torrey@voxbone.com>
7
+
8
+   Copyright © 2013 Voxbone SA
9
+     __________________________________________________________________
10
+
11
+   Table of Contents
12
+
13
+   1. Admin Guide
14
+
15
+        1. Overview
16
+        2. Dependencies
17
+        3. Functions
18
+
19
+              3.1. sipt_destination(destination, hops, nai)
20
+              3.2. sipt_set_bci_1(charge_indicator, called_status,
21
+                      called_category, e2e_indicator)
22
+
23
+              3.3. sipt_set_calling(origin, nai, presentation, screening)
24
+
25
+        4. Exported pseudo-variables
26
+
27
+              4.1. $sipt(calling_party_number.presentation) /
28
+                      $sipt_presentation
29
+
30
+              4.2. $sipt(calling_party_number.screening) / $sipt_screening
31
+              4.3. $sipt(hop_counter) / $sipt_hop_counter
32
+              4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
33
+              4.5. $sipt(calling_party_number.nature_of_address) /
34
+                      $sipt.(calling_party_number.nai) /
35
+                      $sipt_calling_party_nai
36
+
37
+              4.6. $sipt(called_party_number.nature_of_address) /
38
+                      $sipt(called_party_number.nai) /
39
+                      $sipt_called_party_nai
40
+
41
+              4.7. $sipt(event_info)
42
+              4.8. $sipt(backward_call_indicator.charge_indicator)
43
+
44
+   List of Tables
45
+
46
+   1.1. Address Presentation Restricted Indicator Values
47
+   1.2. Screening Indicator Values
48
+   1.3. Calling Nature of Address Values
49
+   1.4. Called Nature of Address Values
50
+   1.5. Event Info Values
51
+   1.6. Charge Indicator Values
52
+
53
+   List of Examples
54
+
55
+   1.1. sipt_destination(destination, hops, nai) usage
56
+   1.2. sipt_destination(destination, hops, nai) usage
57
+   1.3. sipt_set_calling(origin, nai, presentation, screening) usage
58
+   1.4. sipt_presentation pseudo-variable usage
59
+   1.5. sipt_screening pseudo-variable usage
60
+   1.6. sipt_hop_counter pseudo-variable usage
61
+   1.7. sipt_cpc pseudo-variable usage
62
+   1.8. sipt_calling_party_nai pseudo-variable usage
63
+   1.9. sipt_called_party_nai pseudo-variable usage
64
+
65
+Chapter 1. Admin Guide
66
+
67
+   Table of Contents
68
+
69
+   1. Overview
70
+   2. Dependencies
71
+   3. Functions
72
+
73
+        3.1. sipt_destination(destination, hops, nai)
74
+        3.2. sipt_set_bci_1(charge_indicator, called_status,
75
+                called_category, e2e_indicator)
76
+
77
+        3.3. sipt_set_calling(origin, nai, presentation, screening)
78
+
79
+   4. Exported pseudo-variables
80
+
81
+        4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
82
+        4.2. $sipt(calling_party_number.screening) / $sipt_screening
83
+        4.3. $sipt(hop_counter) / $sipt_hop_counter
84
+        4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
85
+        4.5. $sipt(calling_party_number.nature_of_address) /
86
+                $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
87
+
88
+        4.6. $sipt(called_party_number.nature_of_address) /
89
+                $sipt(called_party_number.nai) / $sipt_called_party_nai
90
+
91
+        4.7. $sipt(event_info)
92
+        4.8. $sipt(backward_call_indicator.charge_indicator)
93
+
94
+1. Overview
95
+
96
+   Module for updating ISUP encapuslated in SIP (SIP-T/SIP-I)
97
+
98
+   The sipt module can be used to update various ss7 headers contained
99
+   inside a message.
100
+
101
+2. Dependencies
102
+
103
+   The module depends on the following modules (in the other words the
104
+   listed modules must be loaded before this module):
105
+     * none
106
+
107
+3. Functions
108
+
109
+   3.1. sipt_destination(destination, hops, nai)
110
+   3.2. sipt_set_bci_1(charge_indicator, called_status, called_category,
111
+          e2e_indicator)
112
+
113
+   3.3. sipt_set_calling(origin, nai, presentation, screening)
114
+
115
+3.1. sipt_destination(destination, hops, nai)
116
+
117
+   updates the IAM in the body if it exists, setting the called party
118
+   number to “destination” with the nature address specified in “nai” and
119
+   decrementing the hop counter value if present. If the hop counter
120
+   header is missing it will be added with the value of “hops”.
121
+
122
+   Example 1.1. sipt_destination(destination, hops, nai) usage
123
+...
124
+# update the destination number to our current request uri,
125
+# setting nature of address to international
126
+$rU = "19495551234";
127
+sipt_destination($rU, 31, 4);
128
+...
129
+
130
+3.2. sipt_set_bci_1(charge_indicator, called_status, called_category,
131
+e2e_indicator)
132
+
133
+   updates the first byte of the backward call indicator in the ACM or COT
134
+   in the body if setting the Charge Indicator to “charge_indicator”, the
135
+   Called party's status indicator in “called_status”, the Called party's
136
+   category indicator in “called_category” and the End to End Method
137
+   Indicator with the value of the value of “e2e_indicator”.
138
+
139
+   Example 1.2. sipt_destination(destination, hops, nai) usage
140
+...
141
+# set bci for charging, subscriber free, ordinary, no e2e available
142
+sipt_set_bci_1("2", "1", "1", "0");
143
+...
144
+
145
+3.3. sipt_set_calling(origin, nai, presentation, screening)
146
+
147
+   updates the IAM in the body if it exists, setting (or adding) the
148
+   calling party number to “origin” with the nature address specified in
149
+   “nai” and setting the presentation and screening values to
150
+   “presentation” and “screening”.
151
+
152
+   Example 1.3. sipt_set_calling(origin, nai, presentation, screening)
153
+   usage
154
+...
155
+# update the calling party to the value in the from header
156
+sipt_set_calling($fU, 4, 0, 3);
157
+...
158
+
159
+4. Exported pseudo-variables
160
+
161
+   4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
162
+   4.2. $sipt(calling_party_number.screening) / $sipt_screening
163
+   4.3. $sipt(hop_counter) / $sipt_hop_counter
164
+   4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
165
+   4.5. $sipt(calling_party_number.nature_of_address) /
166
+          $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
167
+
168
+   4.6. $sipt(called_party_number.nature_of_address) /
169
+          $sipt(called_party_number.nai) / $sipt_called_party_nai
170
+
171
+   4.7. $sipt(event_info)
172
+   4.8. $sipt(backward_call_indicator.charge_indicator)
173
+
174
+4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
175
+
176
+   Returns the value of the Address presentation restricted indicator
177
+   contained in the Calling Party Number header of the IAM message if it
178
+   exists. Returns -1 if there isn't a Calling Party Number header.
179
+
180
+   Table 1.1. Address Presentation Restricted Indicator Values
181
+   0 presentation allowed
182
+   1 presentation restricted
183
+   2 address not avail (national use)
184
+   3 spare
185
+
186
+   Example 1.4. sipt_presentation pseudo-variable usage
187
+...
188
+# add privacy header if restriction is requested
189
+if($sipt(calling_party_number.presentation) == 1)
190
+{
191
+        append_hf("Privacy: id\r\n");
192
+        $fn = "Anonymous";
193
+}
194
+
195
+...
196
+
197
+4.2. $sipt(calling_party_number.screening) / $sipt_screening
198
+
199
+   Returns the value of the Screening Indicator contained in the Calling
200
+   Party Number header of the IAM message if it exists. Returns -1 if
201
+   there isn't a Calling Party Number header.
202
+
203
+   Table 1.2. Screening Indicator Values
204
+   0 Reserved (user provided, not verified)
205
+   1 User Provided, Verified and Passed
206
+   2 Reserved (user provided, verified and failed)
207
+   3 Network provided
208
+
209
+   Example 1.5. sipt_screening pseudo-variable usage
210
+...
211
+
212
+# remove P-Asserted-Identity header if the screening isn't verified
213
+# or network provided
214
+$avp(s:screening) = $sipt(calling_party_number.screening);
215
+if($avp(s:screening) != 1 && $avp(s:screening) != 3)
216
+{
217
+        remove_hf("P-Asserted-Id");
218
+}
219
+
220
+...
221
+
222
+4.3. $sipt(hop_counter) / $sipt_hop_counter
223
+
224
+   Returns the value of the Hop Counter for the IAM message if it exists.
225
+   Returns -1 if there isn't a hop counter.
226
+
227
+   Example 1.6. sipt_hop_counter pseudo-variable usage
228
+...
229
+# get the hop counter and update the Max-Forwards header if it exists
230
+$avp(s:hop) = $sipt(hop_counter);
231
+if($avp(s:hop) > 0)
232
+{
233
+        remove_hf("Max-Forwards");
234
+        append_hf("Max-Forwards: $avp(s:hop)\r\n");
235
+}
236
+
237
+...
238
+
239
+4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
240
+
241
+   Returns the value of the Calling Party Category for the IAM message.
242
+   Returns -1 if there is a parsing error.
243
+
244
+   Example 1.7. sipt_cpc pseudo-variable usage
245
+...
246
+# get the Cpc code and set put it in a custom sip header
247
+append_hf("X-CPC: $sipt(cpc)\r\n");
248
+
249
+...
250
+
251
+4.5. $sipt(calling_party_number.nature_of_address) /
252
+$sipt.(calling_party_number.nai) / $sipt_calling_party_nai
253
+
254
+   Returns the value of the Nature of Address Indicator of the Calling
255
+   Party for the IAM message. Returns -1 if there is a parsing error or if
256
+   the Calling Party Number is not present.
257
+
258
+   Table 1.3. Calling Nature of Address Values
259
+   0 Spare
260
+   1 Subscriber Number (national use)
261
+   2 Unknown (national use)
262
+   3 National (significant) number (national use)
263
+   4 International use
264
+
265
+   Example 1.8. sipt_calling_party_nai pseudo-variable usage
266
+...
267
+# get the Calling Nai and add country code if national
268
+if($sipt(calling_party_number.nai) == 3)
269
+{
270
+        $fU = "32" + "$fU";
271
+}
272
+
273
+...
274
+
275
+4.6. $sipt(called_party_number.nature_of_address) /
276
+$sipt(called_party_number.nai) / $sipt_called_party_nai
277
+
278
+   Returns the value of the Nature of Address Indicator of the Called
279
+   Party for the IAM message. Returns -1 if there is a parsing error.
280
+
281
+   Table 1.4. Called Nature of Address Values
282
+   0 Spare
283
+   1 Subscriber Number (national use)
284
+   2 Unknown (national use)
285
+   3 National (significant) number
286
+   4 International use
287
+   5 Network-specific number (national use)
288
+
289
+   Example 1.9. sipt_called_party_nai pseudo-variable usage
290
+...
291
+# get the Called Nai and add country code if national
292
+if($sipt(called_party_number.nai) == 3)
293
+{
294
+        $rU = "32" + "$rU";
295
+}
296
+
297
+...
298
+
299
+4.7. $sipt(event_info)
300
+
301
+   Returns the value of the Event Info header of the CPG message. Returns
302
+   -1 if there is a parsing error.
303
+
304
+   Table 1.5. Event Info Values
305
+   0 Spare
306
+   1 ALERTING
307
+   2 PROGRESS
308
+   3 In-band information or an appropriate pattern is now available
309
+   4 Call forward on busy
310
+   5 Call forward on no reply
311
+   6 Call forward unconditional
312
+
313
+4.8. $sipt(backward_call_indicator.charge_indicator)
314
+