Table of Contents
http_async_query(url, [post_data], route_name)
http_async_suspend(suspend)
tls_verify_host(verify)
tls_verify_peer(verify)
http_set_timeout(timeout)
http_append_header(header)
http_set_method(method)
http_set_tls_client_cert(path)
http_set_tls_client_key(path)
http_set_tls_ca_path(path)
List of Examples
workers parameterconnection_timeout parameterhash_size parametertls_version parametertls_verify_host parametertls_verify_peer parametercurl_verbose parametermemory_manager parametertls_client_cert parametertls_client_key parametertls_ca_path parameterhttp_async_query() usagehttp_async_suspend() usagetls_verify_host() usagetls_verify_peer() usagehttp_set_timeout() usagehttp_append_header() usagehttp_set_method() usagehttp_set_tls_client_cert() usagehttp_set_tls_client_key() usagehttp_set_tls_ca_path() usage$http_req(key) variable usageTable of Contents
http_async_query(url, [post_data], route_name)
http_async_suspend(suspend)
tls_verify_host(verify)
tls_verify_peer(verify)
http_set_timeout(timeout)
http_append_header(header)
http_set_method(method)
http_set_tls_client_cert(path)
http_set_tls_client_key(path)
http_set_tls_ca_path(path)
The following modules must be loaded before this module:
tm - Transaction module
pv - Pseudo-Variables module
Number of worker processes to be started to send HTTP requests and asynchronously handle responses.
Default value is 1.
Defines in milliseconds how long Kamailio waits for response from HTTP server.
Default value is 500ms.
Example 1.2. Set connection_timeout parameter
...
modparam("http_async_client", "connection_timeout", 1000)
...
The size of the hash table internally used to keep the requests. A larger table is much faster but consumes more memory. The hash size must be a power of two, otherwise it will be rounded down to the nearest power of two.
Default value is 2048.
For HTTPS connections, what's the preferred SSL version. http://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html
Default value is 0 (default SSL version).
For HTTPS connections, whether the client should verify the server host. http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html
Default value is 2 (enabled).
Example 1.5. Set tls_verify_host parameter
...
modparam("http_async_client", "tls_verify_host", 0)
...
For HTTPS connections, whether the client should verify the server identity. http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html
Default value is 1 (enabled).
Example 1.6. Set tls_verify_peer parameter
...
modparam("http_async_client", "tls_verify_peer", 0)
...
If defined to a non-zero value, extra informations from cURL (request and response headers) will be included in the kamailio logs, with LM_INFO priority.
Default value is 0 (disabled).
Choose the memory manager used by curl:
shm: curl will use kamailio's SHM pool and memory manager
sys: curl will use the system memory and memory manager (malloc, free, ...)
Note: if this module is used in conjunction with another module using libcurl (http_client, utils, xcap, xcap_client), it must be loaded as first one for this parameter to have effect, otherwise curl will likely use the system memory allocator by default. On the other hand if the module is loaded before any other module using libcurl, all the modules will use the memory manager specified by this parameter.
Default value "shm"
Example 1.8. Set memory_manager parameter
...
modparam("http_async_client", "memory_manager", "sys")
...
For HTTPS connections, the file path of the TLS client certificate to be used http://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html
Default value is NULL (not used). Default type is PEM.
Example 1.9. Set tls_client_cert parameter
...
modparam("http_async_client", "tls_client_cert", "/etc/kamailio/ssl/clientcert.pem")
...
Sends HTTP(S) request asyncronously to the URL given in “url” parameter, which is a string that may contain pseudo variables.
Unless a specific HTTP method was specified using http_async_set_method(), it defaults to a GET request, or to a POST request if “post_data” is issued as second argument.
Parameter “post_data”, optional, which is sent as the body of the request, may also contain pseudo variables.
Parameter “route_name” defines the route to be executed upon reception of HTTP reply, on error or on timeout. If a transaction exists before calling http_async_query(), it will be paused and resumed in this route, while the routing script execution will be stopped. If executed in a transactionless context, or if http_async_suspend_transaction() or $http_req(suspend) are used to not suspend the transaction, the routing script execution will continue and the query result will be available in “route_name”.
Return value: 0 (stop script execution) on success in transaction context, 1 (continue script execution) in transaction-less context (or if http_async_suspend_transaction(0) or $http_req(suspend) are used), -1 on error.
This function can be used from ANY_ROUTE.
This method is executed asynchronously. The HTTP return code, body and error are returned in the module-specific $http_* PVs (see below). See example on how to retrieve return values.
Example 1.12. http_async_query() usage
...
# create a transaction to be paused, and resumed in route[HTTP_REPLY]
t_newtran();
# GET
http_async_query("http://example.com/test.php?r_uri=$rU&f_uri=$fU", "HTTP_REPLY");
...
# POST
http_async_query("http://example.com/test.php", "{'r_uri':'$rU', 'f_uri':'$fU'}", "HTTP_REPLY");
...
route[HTTP_REPLY] {
if ($http_ok) {
xlog("L_INFO", "route[HTTP_REPLY]: status $http_rs\n");
xlog("L_INFO", "route[HTTP_REPLY]: body $http_rb\n");
} else {
xlog("L_INFO", "route[HTTP_REPLY]: error $http_err)\n");
}
}
...
In a transaction context if the transaction must be suspended and script execution stopped.
Parameter “suspend” set to "1" to suspend the transaction, "0" to not suspend and continue with script execution. Default: 1 (transaction suspended).
Example 1.13. http_async_suspend() usage
...
t_newtran();
http_async_suspend(0);
# the transaction won't be suspended for the next query
http_async_query("http://example.com/test.php", "HTTP_REPLY");
xlog("L_INFO", "query sent\n");
t_reply("200", "Ok");
...
For the next HTTPS connection, whether the client should verify the server host.
Parameter “verify” set to "1" to enable the host verification, "0" to disable. Default: the global value set as verify_host module parameter.
Example 1.14. tls_verify_host() usage
...
tls_verify_host("0");
# host verification is disabled for the next query
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
For the next HTTPS connection, whether the client should verify the server identity.
Parameter “verify” set to "1" to enable the identity verification, "0" to disable. Default: the global value set as verify_peer module parameter.
Example 1.15. tls_verify_peer() usage
...
tls_verify_peer("0");
# server identity verification is disabled for the next query
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
For the next HTTP query, set the response timeout.
Parameter “timeout” string representing the timeout in milliseconds. Default: the global value set as http_timeout module parameter.
Example 1.16. http_set_timeout() usage
...
http_set_timeout("200");
# the server must respond in maximum 200ms, otherwise the query will fail
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
Set/remove/replace a header in the next HTTP query.
From libcurl's documentation:
“If you add a header that is otherwise generated and used by libcurl internally, your added one will be used instead. If you add a header with no content as in 'Accept:' (no data on the right side of the colon), the internally used header will get disabled. With this option you can add new headers, replace internal headers and remove internal headers. To add a header with no content (nothing to the right side of the colon), use the form 'MyHeader;' (note the ending semicolon).”
“The headers included in the linked list must not be CRLF-terminated, because libcurl adds CRLF after each header item.”
Parameter “header” string representing the header to pass to libcurl for the next query.
Example 1.17. http_append_header() usage
...
http_append_header("X-Sip-Call-Id: $ci");
# a new 'X-Sip-Call-Id' header will be added to the next query
http_append_header("Content-Type": application/json");
# the curl default 'application/x-www-form-urlencoded' Content-Type will be replaced
http_async_query("https://example.com/test.php", "{'foo': 'bar'}", "HTTP_REPLY");
...
For the next HTTP query, set the method.
Parameter “method” string representing the method (verb): either "GET", "POST", "PUT" or "DELETE" (these are the only supported methods). (Note: if http_set_method() is not called before a query, curl will use GET, or POST if a body is specified)
Example 1.18. http_set_method() usage
...
http_set_method("PUT");
# the next query will be a HTTP PUT request
http_async_query("https://example.com/test.php", "{'foo': 'bar'}", "HTTP_REPLY");
...
For the next HTTPS connection, what client certificate to use.
Default: the global value set as tls_client_cert module parameter.
Example 1.19. http_set_tls_client_cert() usage
...
http_set_tls_client_cert("/etc/kamailio/ssl/cert.pem");
# Next query will use the client cert above
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
For the next HTTPS connection, what client certificate key to use.
Default: the global value set as tls_client_key module parameter.
Example 1.20. http_set_tls_client_key() usage
...
http_set_tls_client_key("/etc/kamailio/ssl/cert.key");
# Next query will use the client cert key above
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
For the next HTTP connection, what CA certificate files to use.
Default: the global value set as tls_ca_path module parameter.
Example 1.21. http_set_tls_ca_path() usage
...
http_set_tls_client_key("/etc/kamailio/ssl/ca/");
# Next query will use the CA certs above
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
The $http_req(key) write-only variable can be used to set custom parameters before sending a HTTP query
setting this variable has the same effect than using the http_set_*()functions
key can be one of:
all: if set to $null, resets all the parameters to their default value (the ones defined in modparam)
hdr: sets/modifies/remove a HTTP header (see http_append_header()). N.B.: setting this variable multiple times will add several headers to the query.
method: sets the HTTP method (see http_set_method())
timeout: sets the HTTP timeout (see http_set_timeout())
tls_client_cert: sets the client certificate to use (see http_set_tls_client_cert())
tls_client_key: sets the client certificate key to use (see http_set_tls_client_key())
tls_ca_path: sets the CA certificate files to use (see http_set_tls_ca_path())
suspend: if set to 0 doesn't suspend the current transaction before performing the query (see http_async_suspend())
Example 1.22. $http_req(key) variable usage
...
$http_req(all) = $null; # reset the parameters
$http_req(timeout) = 100; # 100 ms
$http_req(method) = "DELETE";
$http_req(hdr) = "X-Sip-Call-Id: " + $ci;
$http_req(hdr) = "X-Foo: bar"; # add a 2nd header
$http_req(suspend) = 0; # don't suspend the transaction, continue routing script's execution
# the following request will use the above parameters
http_async_query("https://example.com/test.php", "HTTP_REPLY");
...
The following read-only pseudo variables can only be used in the callback routes executed by http_async_query()
$http_ok: 1 if cURL executed the request successfully, 0 otherwise (check $http_err for details)
$http_err: cURL error string if an error occured, $null otherwise
$http_rs: http status
$http_rr: http reason phrase
$http_hdr(Name): value of the Name header (the $(http_hdr(Name)[N]) syntax can also be used, check the SIP $hdr() PV documentation for details)
$http_mb and $http_ml: HTTP response buffer (including headers) and length
$http_rb and $http_bs: HTTP response body and body length