[sr-dev] git:master:b9cfe696: modules: readme files regenerated - phonenum ... [skip ci]

Module: kamailio Branch: master Commit: b9cfe696db5f7bbcbe6fc8c3ae63b4f9d640e311 URL: https://github.com/kamailio/kamailio/commit/b9cfe696db5f7bbcbe6fc8c3ae63b4f… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2019-09-02T13:47:22+02:00 modules: readme files regenerated - phonenum ... [skip ci] --- Modified: src/modules/phonenum/README --- Diff: https://github.com/kamailio/kamailio/commit/b9cfe696db5f7bbcbe6fc8c3ae63b4f… Patch: https://github.com/kamailio/kamailio/commit/b9cfe696db5f7bbcbe6fc8c3ae63b4f… --- diff --git a/src/modules/phonenum/README b/src/modules/phonenum/README index 842e2cfcc7..ebe872869b 100644 --- a/src/modules/phonenum/README +++ b/src/modules/phonenum/README @@ -26,6 +26,7 @@ Daniel-Constantin Mierla 3. Parameters 3.1. smode (int) + 3.2. resid (str) 4. Functions @@ -37,8 +38,9 @@ Daniel-Constantin Mierla List of Examples 1.1. Set smode parameter - 1.2. phonenum_match usage - 1.3. phonenum_match_cn usage + 1.2. Set resid parameter + 1.3. phonenum_match usage + 1.4. phonenum_match_cn usage Chapter 1. Admin Guide @@ -53,6 +55,7 @@ Chapter 1. Admin Guide 3. Parameters 3.1. smode (int) + 3.2. resid (str) 4. Functions @@ -95,10 +98,11 @@ Chapter 1. Admin Guide 3. Parameters 3.1. smode (int) + 3.2. resid (str) 3.1. smode (int) - Phone number search mode. + Phone number search mode (not in use yet). Default value is “0”. @@ -107,6 +111,23 @@ Chapter 1. Admin Guide modparam("phonenum", "smode", 0) ... +3.2. resid (str) + + Preregister result container id during initialization, enabling the use + of the module in KEMI scripts. In native Kamailio.cfg file, + registration is done when parsing config and finding variables. + + Default value is “” (empty). + + Example 1.2. Set resid parameter +... +modparam("phonenum", "resid", "src") +... +if(phonenum_match("1-484-555-8888", "src")) { + ... +} +... + 4. Functions 4.1. phonenum_match(num, pvc) @@ -115,14 +136,14 @@ modparam("phonenum", "smode", 0) 4.1. phonenum_match(num, pvc) Match num against the libphonenumber and set the attributes inside the - pvc container. The function has to be called before accessing a key - via: $phn(pvc=>key). + pvc result container. The function has to be called before accessing a + key via: $phn(pvc=>key). The parameters can be static strings or strings with variables. It can be used from ANY_ROUTE. - Example 1.2. phonenum_match usage + Example 1.3. phonenum_match usage ... if(phonenum_match("1-484-555-8888", "src")) { if($phn(src=>valid)==1) { @@ -144,7 +165,7 @@ if(phonenum_match("1-484-555-8888", "src")) { It can be used from ANY_ROUTE. - Example 1.3. phonenum_match_cn usage + Example 1.4. phonenum_match_cn usage ... if(phonenum_match_cn("1-484-555-8888", "US", "src")) { if($phn(src=>valid)==1) {