diff --git a/src/modules/cplc/README b/src/modules/cplc/README index 58d17ec8e98..903fa0fc860 100644 --- a/src/modules/cplc/README +++ b/src/modules/cplc/README @@ -32,7 +32,7 @@ Bogdan-Andrei Iancu 3.7. cpl_dtd_file (string) 3.8. log_dir (string) 3.9. proxy_recurse (int) - 3.10. proxy_route (int) + 3.10. proxy_route (string) 3.11. case_sensitive (int) 3.12. realm_prefix (string) 3.13. timer_avp (string) @@ -99,7 +99,7 @@ Chapter 1. Admin Guide 3.7. cpl_dtd_file (string) 3.8. log_dir (string) 3.9. proxy_recurse (int) - 3.10. proxy_route (int) + 3.10. proxy_route (string) 3.11. case_sensitive (int) 3.12. realm_prefix (string) 3.13. timer_avp (string) @@ -168,7 +168,7 @@ Chapter 1. Admin Guide 3.7. cpl_dtd_file (string) 3.8. log_dir (string) 3.9. proxy_recurse (int) - 3.10. proxy_route (int) + 3.10. proxy_route (string) 3.11. case_sensitive (int) 3.12. realm_prefix (string) 3.13. timer_avp (string) @@ -293,17 +293,17 @@ modparam("cpl-c","log_dir","/var/log/kamailio/cpl") modparam("cpl-c","proxy_recurse",2) ... -3.10. proxy_route (int) +3.10. proxy_route (string) Before doing proxy (forward), a script route can be executed. All modifications made by that route will be reflected only for the current branch. - Default value of this parameter is 0 (none). + Default value of this parameter is NULL (none). Example 1.10. Set proxy_route parameter ... -modparam("cpl-c","proxy_route",1) +modparam("cpl-c","proxy_route","1") ... 3.11. case_sensitive (int) diff --git a/src/modules/http_client/README b/src/modules/http_client/README index 7ee2d2f6933..7f5718db5c1 100644 --- a/src/modules/http_client/README +++ b/src/modules/http_client/README @@ -65,7 +65,7 @@ Hugh Waite result) 4.2. http_get_redirect(connection, result) - 4.3. http_client_query(url, [post-data], result) + 4.3. http_client_query(url, [post-data], [hdrs], result) 5. Pseudovariables @@ -117,7 +117,7 @@ Hugh Waite 1.18. Short http_client config file 1.19. http_connect() usage 1.20. http_get_redirect() usage - 1.21. curl_http_query() usage + 1.21. http_client_query() usage Chapter 1. Admin Guide @@ -153,7 +153,7 @@ Chapter 1. Admin Guide 4.1. http_connect(connection, url, [content_type, data,] result) 4.2. http_get_redirect(connection, result) - 4.3. http_client_query(url, [post-data], result) + 4.3. http_client_query(url, [post-data], [hdrs], result) 5. Pseudovariables @@ -609,7 +609,7 @@ http_follow_redirect = no 4.1. http_connect(connection, url, [content_type, data,] result) 4.2. http_get_redirect(connection, result) - 4.3. http_client_query(url, [post-data], result) + 4.3. http_client_query(url, [post-data], [hdrs], result) 4.1. http_connect(connection, url, [content_type, data,] result) @@ -667,7 +667,7 @@ modparam("http_client", "httpredirect", 1); http_get_redirect("apiserver", "$var(targeturl)"); ... -4.3. http_client_query(url, [post-data], result) +4.3. http_client_query(url, [post-data], [hdrs], result) Sends HTTP GET or POST request according to URL given in “url” parameter, which is a string that may contain pseudo variables. @@ -675,6 +675,12 @@ http_get_redirect("apiserver", "$var(targeturl)"); If you want to make a POST-Request, you have to define the “post”-data, that should be submitted in that request as the second parameter. + Custom headers may be specified via “hdrs” parameter (e.g., + Content-Type). + + Either of “post-data” or “hdrs” can be also set to empty string in + order to be ignored. + If HTTP server returns a class 2xx, 3xx or 4xx reply, the first line of the reply's body (if any) is stored in “result” parameter, which must be a writable pseudo variable. @@ -689,25 +695,26 @@ http_get_redirect("apiserver", "$var(targeturl)"); utils module. It is changed to use the same base library and settings as the rest of the functions in this module. - Example 1.21. curl_http_query() usage + Example 1.21. http_client_query() usage ... # GET-Request http_client_query("http://api.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$( fu{s.escape.param})", "$var(result)"); -switch ($retcode) { - ... +switch ($rc) { + ... } ... -... # POST-Request -http_client_query("http://api.com/index.php", "r_uri=$(ru{s.escape.param})&f_uri -=$(fu{s.escape.param})", - "$var(result)"); -switch ($retcode) { - ... +http_client_query("http://api.com/index.php", + "r_uri=$(ru{s.escape.param})&f_uri=$(fu{s.escape.param})", + "$var(result)"); } ... +# POST-Request +http_client_query("http://api.com/index.php", "src=$si", + "Content-Type: text/plain", "$var(result)"); +... 5. Pseudovariables diff --git a/src/modules/jsonrpcs/README b/src/modules/jsonrpcs/README index 8457e16b4a8..d615babde52 100644 --- a/src/modules/jsonrpcs/README +++ b/src/modules/jsonrpcs/README @@ -396,7 +396,7 @@ event_route[xhttp:request] { Example 1.15. jsonrpc_exec usage ... -jsonrpc_exec({"jsonrpc": "2.0", "method": "dispatcher.reload", "id": 1}'); +jsonrpc_exec('{"jsonrpc": "2.0", "method": "dispatcher.reload", "id": 1}'); ... 6. JSONRPC Commands diff --git a/src/modules/pua_reginfo/README b/src/modules/pua_reginfo/README index 49a7fbcfed3..68c9a852050 100644 --- a/src/modules/pua_reginfo/README +++ b/src/modules/pua_reginfo/README @@ -141,7 +141,8 @@ modparam("pua_reginfo", "publish_reginfo", 0) 3.3. outbound_proxy(str) - The outbound_proxy uri to be used when sending Subscribe requests. + The outbound_proxy uri to be used when sending Subscribe and Publish + requests. Default value is “NULL”. diff --git a/src/modules/rr/README b/src/modules/rr/README index 6c01c9707b0..5bbc59d119c 100644 --- a/src/modules/rr/README +++ b/src/modules/rr/README @@ -170,6 +170,7 @@ Chapter 1. Admin Guide * check_route_param() - see Section 5.7, “check_route_param(re)” Example 1.1. Dialog support in RR module +... UAC Kamailio PROXY UAS ---- INVITE ------> record_route() ----- INVITE ----> @@ -183,6 +184,7 @@ UAC Kamailio PROXY UAS <------ BYE ------- loose_route() <----- BYE ------- check_route_param(";foo=true") +... 3. Dependencies @@ -321,7 +323,6 @@ modparam("rr", "custom_user_avp", "$avp(RR_CUSTOMER_USER_AVP)") #usage in cfg file $avp(RR_CUSTOM_USER_AVP)="mo"; record_route(); - ... 5. Functions