Copyright © 2006 Voice Sistem SRL
Copyright © 2011 Carsten Bock, http://www.ng-voice.com
Table of Contents
enable_stats (integer)
hash_size (integer)
rr_param (string)
dlg_flag (integer)
timeout_avp (string)
default_timeout (integer)
early_timeout (integer)
noack_timeout (integer)
end_timeout (integer)
dlg_extra_hdrs (string)
dlg_match_mode (integer)
detect_spirals (integer)
db_url (string)
db_mode (integer)
db_update_period (integer)
db_fetch_rows (integer)
db_skip_load (integer)
table_name (string)
call_id_column (string)
from_uri_column (string)
from_tag_column (string)
to_uri_column (string)
to_tag_column (string)
from_cseq_column (string)
to_cseq_column (string)
from_route_column (string)
to_route_column (string)
from_contact_column (string)
to_contact_column (string)
from_sock_column (string)
to_sock_column (string)
h_id_column (string)
h_entry_column (string)
state_column (string)
start_time_column (string)
timeout_column (string)
sflags_column (string)
toroute_name_column (string)
vars_table_name (string)
vars_h_id_column (string)
vars_h_entry_column (string)
vars_key_column (string)
vars_value_column (string)
profiles_with_value (string)
profiles_no_value (string)
bridge_controller (string)
bridge_contact (string)
initial_cbs_inscript (int)
send_bye (int)
wait_ack (int)
ka_timer (int)
ka_interval (int)
ka_failed_limit (int)
timeout_noreset (int)
timer_procs (int)
enable_dmq (int)
track_cseq_updates (int)
lreq_callee_headers (string)
event_callback (str)
h_id_start (int)
h_id_step (int)
keep_proxy_rr (string)
set_dlg_profile(profile,[value])
unset_dlg_profile(profile,[value])
is_in_profile(profile,[value])
get_profile_size(profile,[value],size)
dlg_isflagset(flag)
dlg_setflag(flag)
dlg_resetflag(flag)
dlg_bye(side)
dlg_refer(side, address)
dlg_manage()
dlg_bridge(from, to, op)
dlg_get(callid, ftag, ttag)
is_known_dlg()
dlg_set_timeout(timeout [, h_entry, h_id])
dlg_set_timeout_by_profile(profile, [value], timeout)
dlg_set_property(attr)
dlg_remote_profile(cmd, profile, value, uid, expires)
dlg_set_ruri()
dlg_db_load_callid(cival)
dlg_db_load_extra()
dlg_reset_property(attr)
List of Examples
enable_stats parameterhash_size parameterrr_param parameterdlg_flag parametertimeout_avp parameterdefault_timeout parameterearly_timeout parameternoack_timeout parameterend_timeout parameterdlf_extra_hdrs parameterdlg_match_mode parameterdetect_spirals parameterdb_url parameterdb_mode parameterdb_update_period parameterdb_fetch_rows parameterdb_skip_load parametertable_name parametercall_id_column parameterfrom_uri_column parameterfrom_tag_column parameterto_uri_column parameterto_tag_column parameterfrom_cseq_column parameterto_cseq_column parameterfrom_route_column parameterto_route_column parameterfrom_contact_column parameterto_contact_column parameterfrom_sock_column parameterto_sock_column parameterh_id_column parameterh_entry_column parameterstate_column parameterstart_time_column parametertimeout_column parametersflags_column parametertoroute_name_column parametervars_table_name parametervars_h_id_column parametervars_h_entry_column parametervars_key_column parametervars_value_column parameterprofiles_with_value parameterprofiles_no_value parameterbridge_controller parameterbridge_contact parameterinitial_cbs_inscript parametersend_bye parameterwait_ack parameterka_timer parameterka_interval parameterka_failed_limit parametertimeout_noreset parametertimer_procs parameterenable_dmq parametertrack_cseq_updates parameterlreq_callee_headers parameterevent_callback parameterh_id_start parameterh_id_step parameterdlg_keep_proxy_rr parameterset_dlg_profile usageunset_dlg_profile usageis_in_profile usageget_profile_size usagedlg_isflagset usagedlg_setflag usagedlg_resetflag usagedlg_bye usagedlg_refer usagedlg_manage usagedlg_bridge usagedlg_get usageis_known_dlg() usagedlg_set_timeout usagedlg_set_timeout_by_profile usagedlg_set_property usagedlg_remote_profile usagedlg_set_ruri() usagedlg_db_load_callid() usagedlg_db_load_extra() usagedlg_reset_property usageTable of Contents
enable_stats (integer)
hash_size (integer)
rr_param (string)
dlg_flag (integer)
timeout_avp (string)
default_timeout (integer)
early_timeout (integer)
noack_timeout (integer)
end_timeout (integer)
dlg_extra_hdrs (string)
dlg_match_mode (integer)
detect_spirals (integer)
db_url (string)
db_mode (integer)
db_update_period (integer)
db_fetch_rows (integer)
db_skip_load (integer)
table_name (string)
call_id_column (string)
from_uri_column (string)
from_tag_column (string)
to_uri_column (string)
to_tag_column (string)
from_cseq_column (string)
to_cseq_column (string)
from_route_column (string)
to_route_column (string)
from_contact_column (string)
to_contact_column (string)
from_sock_column (string)
to_sock_column (string)
h_id_column (string)
h_entry_column (string)
state_column (string)
start_time_column (string)
timeout_column (string)
sflags_column (string)
toroute_name_column (string)
vars_table_name (string)
vars_h_id_column (string)
vars_h_entry_column (string)
vars_key_column (string)
vars_value_column (string)
profiles_with_value (string)
profiles_no_value (string)
bridge_controller (string)
bridge_contact (string)
initial_cbs_inscript (int)
send_bye (int)
wait_ack (int)
ka_timer (int)
ka_interval (int)
ka_failed_limit (int)
timeout_noreset (int)
timer_procs (int)
enable_dmq (int)
track_cseq_updates (int)
lreq_callee_headers (string)
event_callback (str)
h_id_start (int)
h_id_step (int)
keep_proxy_rr (string)
set_dlg_profile(profile,[value])
unset_dlg_profile(profile,[value])
is_in_profile(profile,[value])
get_profile_size(profile,[value],size)
dlg_isflagset(flag)
dlg_setflag(flag)
dlg_resetflag(flag)
dlg_bye(side)
dlg_refer(side, address)
dlg_manage()
dlg_bridge(from, to, op)
dlg_get(callid, ftag, ttag)
is_known_dlg()
dlg_set_timeout(timeout [, h_entry, h_id])
dlg_set_timeout_by_profile(profile, [value], timeout)
dlg_set_property(attr)
dlg_remote_profile(cmd, profile, value, uid, expires)
dlg_set_ruri()
dlg_db_load_callid(cival)
dlg_db_load_extra()
dlg_reset_property(attr)
Kamailio can behave as a stateful proxy through the TM module. However, "stateful" in this context refers to transaction state, not dialog state. Certain applications may benefit from an awareness of "calls" in the proxy, not just SIP transactions.
For example, a common need is to limit the number of calls that can be made concurrently by an endpoint, account, user group, etc. In order to count the number of calls in progress, it is necessary for the proxy to be aware of whole dialogs, not just transactions, and to provide some means of programmatically classifying these dialogs. This is just one common application discussed for illustrative purposes; there are many others.
The dialog module provides dialog awareness for the Kamailio proxy. Its functionality is to keep track of the current dialogs, to offer information about them (e.g. how many dialogs are active), and to manage various characteristics of dialogs. The module exports several functions that can be used directly from the configuration route script as well as functions for the RPC interface.
This module also provides an API foundation on which to build more complex dialog-oriented functionality in other Kamailio modules.
To create the dialog associated with an initial INVITE request, execute
the function “dlg_manage()” or set the flag specified by
parameter “dlg_flag” (Section 6.4, “dlg_flag (integer)”)
before creating the corresponding transaction.
The dialog is automatically destroyed when a “BYE” is
received. In case of no “BYE”, the dialog lifetime is
controlled via the default timeout (see “default_timeout”
- Section 6.6, “default_timeout (integer)”) and custom timeout (see
“timeout_avp” - Section 6.5, “timeout_avp (string)”). The
dialog timeout is reset each time a sequential request is processed.
Dialogs have states that are shown in the RPC interface as well as stored in the database.
1 : Unconfirmed dialog
2 : Early dialog (ringing)
3 : Confirmed dialog (waiting for ACK)
4 : Confirmed dialog (active call)
5 : Deleted dialog
The early and deleted dialog states are not updated in database storage.
Dialog profiling is a mechanism that helps in classifying, sorting and keeping track of certain types of dialogs. The classification criteria can be any attributes desired by the administrator; it can be SIP message attributes, other pseudo-variables, custom values, etc. Dialogs can be dynamically added into one or more profile tables. Logically, each profile table can have a special meaning (like dialogs outside the domain, dialogs terminated to the PSTN, etc.).
There are two types of profiles:
with no value - a dialog simply belongs to a profile (for instance, an outbound calls profile). There is no other additional information to describe the dialog beyond its membership in the profile per se.
with value - a dialog belongs to a profile having a certain value (like in a caller profile, where the value is the caller ID). The membership of the dialog in the profile is strictly related to the value. For example, if the account ID of the caller is stored in the pseudo-variable $var(account_id), you can use $var(account_id) as a value/key by which to group dialogs so that you can count the number of open dialogs for each account, enforce concurrent call limits as necessary, etc.
A dialog can be added to multiple profiles at the same time.
Profiles are visible (at the moment) in the request route (for initial and sequential requests) and in the branch, failure and reply routes of the original request.
The following modules must be loaded before this module:
TM - Transaction module
RR - Record-Route module
PV - Pseudovariables module
If statistics support should be enabled or not. Via statistics variables, the module provide information about the dialog processing. Set it to zero to disable or to non-zero to enable it.
Default value is “1 (enabled)”.
The size of the hash table internally used to keep the dialogs. A larger table is much faster but consumes more memory. The hash size must be a power of two.
IMPORTANT: If dialog information should be stored in a database, a constant hash_size should be used, otherwise the restoring process will not take place. If you really want to modify the hash_size, you must delete all table's rows before restarting the server.
Default value is “4096”.
Name of the Record-Route parameter used to store the dialog cookie. It is used for the fast matching of sequential requests to tracked dialogs.
Default value is “did”.
Flag to be used for marking if a dialog should be constructed for the current request (this make sense only for initial requests).
Note: it is not needed to set this parameter and its corresponding flag for initial request in case the “dlg_manage()” function is used. In other words, using “dlg_manage()” alone is enough.
Default value is “none”.
The specification of an AVP that contains a custom timeout value (in seconds) for the dialog. It may be used only in a request (initial or sequential) context.
Default value is “none”.
The default dialog timeout (in seconds), in the absence of a custom value provided in an AVP.
Default value is “43200 (12 hours)”.
The timeout (in seconds) after which the dialogs in unconfirmed or early state (no final response received) are destroyed.
Default value is “300 (5 minutes)”.
The timeout (in seconds) after which the dialogs which were answered with 200ok but didn't receive the ACK are marked for termination (the lifetime is set to 10 more seconds).
Default value is “60 (1 minute)”.
The timeout (in seconds) after which the dialogs in terminated state are destroyed.
Default value is “300 (5 minutes)”.
A string containing the extra headers (full format, with EOH) to be added to requests generated locally by the module (like BYEs).
Default value is “NULL”.
Example 1.10. Set dlf_extra_hdrs parameter
...
modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
...
How the sequential requests should be matched against the known dialogs. The modes are a combination of matching based on a cookie (DID) stored as cookie in Record-Route header and matching based on SIP elements (as in RFC 3261).
Note: DID-based matching does not replace callid/fromtag/totag comparison. It will speed up dialog matching by not iterating over the whole dialog list for callid/fromtag/totag comparison, but instead it uses a hash table to find the respective dialog and then doing only one callid/fromtag/totag comparison. Thus, there is no security issue when using DID based matching. Use DID_FALLBACK for maximum interoperability or use DID_ONLY to reject buggy clients or hacking attempts. DID_NONE is only useful, when you want to hide dialog-tracking from the users (preventing the DID Record-Route cookie).
The supported modes are:
0 - DID_ONLY - the match is done exclusively based on DID;
1 - DID_FALLBACK - the match is first tried based on DID and if not present, it will fall back to SIP matching;
2 - DID_NONE - the match is done exclusively based on SIP elements; no DID information is added in RR.
Default value is “0 (DID_ONLY)”.
Whether spirals (i.e., messages routed through the proxy multiple times) should be detected.
If set to 0, spirals will not be detected and result in the generation of a new, possibly dangling dialog structure per occurring spiral. If set to 1, spirals are detected and internally mapped to existing dialog structures.
Default value is 1.
In order to store information about dialogs in a database, a database URL must be specified.
Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
Example 1.13. Set db_url parameter
...
modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname")
...
Mode of synchronisation of dialog information from memory to an underlying database (if desired):
The supported modes are:
0 - NO_DB - the memory content is not flushed into DB;
1 - REALTIME - any dialog information changes will be reflected into the database immediately.
2 - DELAYED - the dialog information changes will be flushed into DB periodically, based on a timer routine.
3 - SHUTDOWN - the dialog information will be flushed into DB only at shutdown - no runtime updates.
Default value is “0”.
The interval (seconds) at which to update dialogs' information, if the server is configured to store the dialog information at a given interval. Too short an interval will generate intensive database operations, while an excessively long one will miss dialogs with a short lifetime.
Default value is “60” seconds.
The number of the rows to be fetched at once from database when loading the dialog records at startup from the database. This value can be used to tune the load time at startup. For 1MB of private memory (default), it should be below 400. The database driver must support the fetch_result() capability. A value of 0 means the database fetch is not limited.
Default value is “200”.
Set db_skip_load to 1, to skip the loading of dialog data from the database.
Default value is “0” ( not skipped ).
Database table name used for storing dialog information.
Default value is “dialog”.
The column name in the database to store the dialog call-id.
Default value is “callid”.
Example 1.19. Set call_id_column parameter
...
modparam("dialog", "call_id_column", "callid_c_name")
...
The column name in the database to store the caller's SIP address (URI).
Default value is “from_uri”.
Example 1.20. Set from_uri_column parameter
...
modparam("dialog", "from_uri_column", "from_uri_c_name")
...
The column name in the database to store the From header tag from the INVITE request.
Default value is “from_tag”.
Example 1.21. Set from_tag_column parameter
...
modparam("dialog", "from_tag_column", "from_tag_c_name")
...
The column name in the database to store the callee's SIP address (URI).
Default value is “to_uri”.
Example 1.22. Set to_uri_column parameter
...
modparam("dialog", "to_uri_column", "to_uri_c_name")
...
The column name in the database to store the To header tag from the 200 OK response to the INVITE request, if present.
Default value is “to_tag”.
Example 1.23. Set to_tag_column parameter
...
modparam("dialog", "to_tag_column", "to_tag_c_name")
...
The column name in the database to store the Cseq from caller side.
Default value is “caller_cseq”.
Example 1.24. Set from_cseq_column parameter
...
modparam("dialog", "from_cseq_column", "from_cseq")
...
The column name in the database to store the cseq from callee side.
Default value is “callee_cseq”.
The column name in the database to store the route records from caller side (proxy to caller).
Default value is “caller_route_set”.
Example 1.26. Set from_route_column parameter
...
modparam("dialog", "from_route_column", "rroute_from")
...
The column name in the database to store the route records from callee side (proxy to callee).
Default value is “callee_route_set”.
Example 1.27. Set to_route_column parameter
...
modparam("dialog", "to_route_column", "rroute_to")
...
The column name in the database to store the caller's contact uri.
Default value is “caller_contact”.
Example 1.28. Set from_contact_column parameter
...
modparam("dialog", "from_contact_column", "from_contact_uri")
...
The column name in the database to store the callee's contact uri.
Default value is “callee_contact”.
Example 1.29. Set to_contact_column parameter
...
modparam("dialog", "to_contact_column", "to_contact_uri")
...
The column name in the database to store the information about the local interface receiving the traffic from caller.
Default value is “caller_sock”.
Example 1.30. Set from_sock_column parameter
...
modparam("dialog", "from_sock_column", "socket_from")
...
The column name in the database to store information about the local interface receiving the traffic from callee.
Default value is “callee_sock”.
Example 1.31. Set to_sock_column parameter
...
modparam("dialog", "to_sock_column", "socket_to")
...
The column name in the database to store the dialogs' hash id information.
Default value is “hash_id”.
The column name in the database to store the dialog's hash entry information.
Default value is “hash_entry”.
Example 1.33. Set h_entry_column parameter
...
modparam("dialog", "h_entry_column", "h_entry_c_name")
...
The column name in the database to store the dialog's state information.
Default value is “state”.
The column name in the database to store the dialog's start time information.
Default value is “start_time”.
Example 1.35. Set start_time_column parameter
...
modparam("dialog", "start_time_column", "start_time_c_name")
...
The column name in the database to store the dialog's timeout.
Default value is “timeout”.
Example 1.36. Set timeout_column parameter
...
modparam("dialog", "timeout_column", "timeout_c_name")
...
The column name in the database to store the dialog script flags.
Default value is “sflags”.
The column name in the database to store the index of the route to be executed at timeout.
Default value is “toroute_name”.
Example 1.38. Set toroute_name_column parameter
...
modparam("dialog", "toroute_name_column", "timeout_route")
...
If you want to store the dialog variables (“$dlg_var(name)”) for a dialog in a database a table name must be specified.
Default value is “dialog_vars”.
Example 1.39. Set vars_table_name parameter
...
modparam("dialog", "vars_table_name", "my_dialog_vars")
...
The column name in the database to store the dialog's hash id information (as a reference to the dialog table).
Default value is “hash_id”.
Example 1.40. Set vars_h_id_column parameter
...
modparam("dialog", "vars_h_id_column", "vars_h_id_name")
...
The column name in the database to store the dialog's hash entry information (as a reference to the dialog table).
Default value is “hash_entry”.
Example 1.41. Set vars_h_entry_column parameter
...
modparam("dialog", "vars_h_entry_column", "vars_h_entry_name")
...
The column name in the database to store the names (keys) of a dialog variable.
Default value is “dialog_key”.
Example 1.42. Set vars_key_column parameter
...
modparam("dialog", "vars_key_column", "vars_key_name")
...
The column name in the database to store the values of a dialog variable.
Default value is “dialog_value”.
Example 1.43. Set vars_value_column parameter
...
modparam("dialog", "vars_value_column", "vars_value_name")
...
List of names for profiles with values, separated with semi-colon ";".
Default value is “empty”.
Example 1.44. Set profiles_with_value parameter
...
modparam("dialog", "profiles_with_value", "caller ; my_profile")
...
List of names for profiles without values, separated with semi-colon ";".
Default value is “empty”.
Example 1.45. Set profiles_no_value parameter
...
modparam("dialog", "profiles_no_value", "inbound ; outbound")
...
SIP address to be used in From header when initiating a call bridge.
Default value is “sip:controller@kamailio.org”.
Example 1.46. Set bridge_controller parameter
...
modparam("dialog", "bridge_controller", "sip:ctd@kamailio.org")
...
SIP address to be used in Contact header when doing a call bridge.
Default value is “sip:controller@kamailio.org:5060”.
Example 1.47. Set bridge_contact parameter
...
modparam("dialog", "bridge_contact", "sip:ctd@127.0.0.1:5060")
...
If the initial dialog callbacks (i.e., DLGCB_CREATED and DLGCB_SPIRALED) should be executed in-script or post-script. If dlg_manage() is not used, the setting of this parameter does not matter; otherwise, initial callbacks will be executed directly after dlg_manage() is called if this parameter is enabled. If it is disabled, initial callback execution will be postponed until configuration script execution completes.
The supported values are:
0 - POST-SCRIPT - execute initial callbacks after the script completes;
1 - IN-SCRIPT - execute initial callbacks during script execution, i.e., right after dlg_manage() is called;
Default value is “1”.
Example 1.48. Set initial_cbs_inscript parameter
...
modparam("dialog", "initial_cbs_inscript", 0)
...
If set to 1, BYE requests will be sent out for each dialog that timed out. It is an alternative to $dlg_ctx(timeout_bye)=1 for all dialogs.
Default value is “0”.
If set to 1, dialog will be kept a bit longer in memory in order to absorb the ACK negative replies of initial INVITE. If not, the dialog is destroyed when negative reply is sent out (less internal complexity).
Default value is “1”.
Keep-alive timer step - how often to execute the callback to send dialog keep alives (SIP OPTIONS requests within dialog). The value represents the number of seconds.
Default value is “0” (no keep alive).
The interval between keep alives within dialog (SIP OPTIONS requests), sent to caller or callee. The keep alive request will be sent by the first callback fired by KA timer after the ka_interval elapsed from dialog setup or previous keep-alive. The value represents the number of seconds.
If the requests times out (generating a 408) or if the UA responds with 481 the lifetime is set to 10 seconds. When lifetime expires the dialog will be terminated. Any other response (including error responses) will reset the timers.
Default value is “0” (no keep alive). The lowest settable interval is 30 seconds.
The number of failed keep-alive requests that is accepted before generating a dialog timeout.
Default value is “1”.
If set to 1, the dialog timeout won't be reset each time a sequential request is processed. It is an alternative to dlg_set_property("timeout-noreset") for all dialogs.
Default value is “0”.
If set to 1, the dialog module will start a separate dialog timer process to execute dialog timeout tasks. The default is to use the core timer process.
Default value is “0” (use core timer process).
If set to 1, the dialog will be synced via dmq. For now, only very basic dialog info is shared, just enough to have synced profiles. Notably, it is not possible to send in-dialog requests on any but the original proxy instance.
Default value is “0”.
Enable the callbacks for tracking if CSeq number needs to be updated. It is the case when the INVITE has to be authenticated to downstream provider using uac_auth() from uac module.
This is done only for requests in downstream direction. The CSeq difference is stored in $dlg_var(cseq_diff), be sure this variable is not overwritten via config operation.
Default value is “0” (disabled).
SIP headers to be added when sending local generated requests (e.g., BYE) to callee. It can be useful when you use topoh module with call-id masking (see the docs of topoh module).
Default value is “null”.
Example 1.58. Set lreq_callee_headers parameter
...
modparam("dialog", "lreq_callee_headers", "TH: dlh\r\n")
...
The name of the function in the kemi configuration file (embedded scripting language such as Lua, Python, ...) to be executed instead of event_route[...] blocks.
The function receives a string parameter with the name of the event, the values are: 'dialog:start', 'dialog:end', 'dialog:failed'. It is also executed if '$dlg_ctx(timeout_route)' is set, the callback function being executed with the variable value as parameter.
Default value is 'empty' (no function is executed for events).
Example 1.59. Set event_callback parameter
...
modparam("dialog", "event_callback", "ksr_dialog_event")
...
-- event callback function implemented in Lua
function ksr_dialog_event(evname)
KSR.info("===== dialog module triggered event: " .. evname .. "\n");
return 1;
end
...
Set the offset to be used for generating dialog internal hash id. If set to -1, the h_id_start is set to the value of the server_id global parameter.
Default value is “0”.
Set the step to increment the dialog internal hash id.
If the value is greater than 1, the internal hash id is generated with the rule: h_id_start + N * h_id_step. The first value of N is randomly selected at startup, then incremented by 1 for each new dialog. Setting h_id_start and h_id_step to non-default values should be done when using dlg_db_load_callid(...) or dlg_db_load_extra() to load dialog records generated by another Kamailio instance. Pay attention to ensure that those Kamailio instances are not going to generate overlapping dialog hash id values by using different h_id_start and the same h_id_step (h_id_step has to be greater than the maximum value of h_id_start).
Default value is “1”.
Whether to keep the record-route header added by the proxy. When enabled, it will keep this proxy's record-route header from the reply. The result is that generated requests like the BYE from the dlg_end_dlg mi function will pass through the proxy (looped).
Valid values are:
0 - Don't keep any proxy Record-Route headers
1 - Keep Record-route headers for the callee leg
2 - Keep Record-route headers for the caller leg
3 - Keep Record-route headers for both legs
Inserts the current dialog into a profile. Note that if the profile does not support values, they will be silently discarded. Also, there is no check for inserting the same dialog into the same profile multiple times.
Meaning of the parameters is as follows:
profile - name of the profile to be added to;
value (optional) - string value to define the membership of the dialog in the profile. Note that the profile must support values. Pseudo-variables are supported.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE.
Example 1.63. set_dlg_profile usage
...
set_dlg_profile("inbound_call");
set_dlg_profile("caller","$fu");
...
Removes the current dialog from a profile.
Meaning of the parameters is as follows:
profile - name of the profile to be removed from;
value (optional) - string value to define the belonging of the dialog to the profile - note that the profile must support values. Pseudo-variables are supported.
This function can be used from BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE.
Example 1.64. unset_dlg_profile usage
...
unset_dlg_profile("inbound_call");
unset_dlg_profile("caller","$fu");
...
Checks if the current dialog belongs to a profile. If the profile is defined with values, then the check is also matching with the specific value provided as parameter.
Note that if the profile is not defined with support for values, the value parameter will be silently discarded.
Meaning of the parameters is as follows:
profile - name of the profile to be checked against;
value (optional) - string value to be matched during the check. Pseudo-variables are supported.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE.
Example 1.65. is_in_profile usage
...
if (is_in_profile("inbound_call")) {
log("this request belongs to an inbound call\n");
}
...
if (is_in_profile("caller","XX")) {
log("this request belongs to a call of user XX\n");
}
...
Returns the number of dialogs belonging to a profile. If the profile supports values, the check can be reinforced to take into account a specific value, i.e. how many dialogs were inserted into the profile with a specific value. If no value is passed, only the membership of the dialog in the profile per se is checked. Note that if the profile does not support values, the value parameter will be silently discarded.
Meaning of the parameters is as follows:
profile - name of the profile to get the size for;
value (optional) - string value to further restrict the check. Pseudo-variables are supported;
size - an AVP or script variable to return the profile size in.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE.
Example 1.66. get_profile_size usage
...
if(get_profile_size("inbound_call","$avp(size)"))
xlog("currently there are $avp(size) inbound calls\n");
...
if(get_profile_size("caller","$fu","$avp(size)"))
xlog("currently, the user $fu has $avp(size) active outgoing calls\n");
...
Check if the dialog flag is set or not.
Meaning of the parameters is as follows:
flag - index of the flag - can be pseudo-variable.
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE.
Set a dialog flag.
Meaning of the parameters is as follows:
flag - index of the flag - can be pseudo-variable.
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE.
Reset the dialog flag.
Meaning of the parameters is as follows:
flag - index of the flag - can be pseudo-variable.
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE.
Send BYE to both parties of a dialog.
Meaning of the parameters is as follows:
side - where to send the BYE. It can be: 'caller', 'callee', or 'all' (send to both sides).
This function can be used from ANY_ROUTE.
Refer the 'side' to a new SIP 'address'.
Meaning of the parameters is as follows:
side - which side of the dialog to REFER. It can be: 'caller' or 'callee'.
address - SIP address to refer to.
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE.
Process current SIP request with dialog module. It is an alternative to setting dialog flag for initial INVITE and Route-parameter-callback execution for within-dialog requests.
This function can be used from REQUEST_ROUTE.
Example 1.72. dlg_manage usage
...
modparam("dialog", "default_timeout", 100)
...
request_route {
...
if(is_method("INVITE") && !has_totag())
{
$dlg_ctx(timeout_route) = "DLGTIMEOUT";
$dlg_ctx(timeout_bye) = 1;
}
dlg_manage();
...
}
...
Bridge 'from' SIP address to 'to' SIP address via outbound proxy 'op'.
Meaning of the parameters is as follows:
from - SIP address of first side to call.
to - SIP address to refer “from” to.
op - outbound proxy SIP address.
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE.
Example 1.73. dlg_bridge usage
...
dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org",
"sip:kamailio.org:5080");
...
Search and set current dialog based on Call-ID, From-Tag and To-Tag parameters.
Meaning of the parameters is as follows:
callid - SIP call-id.
ftag - SIP From tag.
ttag - SIP To tag.
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE.
This function checks if the current SIP message being processed belongs to any transaction within an active dialog that the dialog module is currently tracking. This is a check for tracking of any kind, without regard to profiles.
This function has numerous potential applications, among which is that it can be used to strengthen security for loose-routing sequential (in-dialog) requests or responses to them, as by providing a preventative check against spoofing on the proxy level instead of leaving the issue purely to the receiving UA.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE.
Example 1.75. is_known_dlg() usage
...
if(!uri == myself) {
if(is_known_dlg()) {
xlog("Request $rm from $ci is in-dialog\n");
}
}
...
Set the dialog timeout. Dialog timeout will be updated if it was already set. If h_entry and h_id parameters are not provided, the dialog will be searched based on (callid, fromtag, totag) of currently processed SIP message.
Meaning of the parameters is as follows:
timeout - the interval in seconds after which the dialog will time out.
h_entry - h_entry value of the iternal dialog identifier.
h_id - h_id valye if the internal dialog identifier.
This function can be used from ANY_ROUTE.
Like dlg_set_timeout(), but simultaneously sets the timeout of all dialogs in a given profile. Can be constrained by profile value.
Meaning of the parameters is as follows:
profile - The dialog profile across which to apply the timeout.
value (optional) - The profile value to use when applying the dialog timeout.
timeout - the interval in seconds after which the dialog will time out.
This function can be used from ANY_ROUTE.
Example 1.77. dlg_set_timeout_by_profile usage
...
# All dialogs belonging to user abc123 (tracked via set_dlg_profile())
# will be timed out in 3 seconds.
dlg_set_timeout_by_profile("users", "abc123", "3");
...
Set a dialog property - an attribute that enable/disable various behaviours (e.g., sending keep alive requests).
Meaning of the parameters is as follows:
attr - name of property. It can be:
If keep alive is enabled for a dialog, the module will send SIP OPTIONS requests with CSeq lower or equal than last request within dialog, with the scope of detecting if the destination is still in the call. If the keep alive request results in a local timeout or '481 Call Leg/Transaction Does Not Exist', then the dialog is ended from the server.
If 'timeout-noreset' is set, dialog timeout won't be reset upon reception of in-dialog messages (default behavior).
This function can be used from ANY_ROUTE.
Example 1.78. dlg_set_property usage
...
dlg_set_property("ka-src");
dlg_set_property("ka-dst");
dlg_set_property("timeout-noreset");
...
Manage remote profile via config file. A remote profile item is considered when the dialog is not managed by this server instance. The notification to add/remove can be received via SIP or a RPC command, the operation can be then triggered from configuration file. This should allow counting active dialogs in a profile that are managed by multiple SIP server instances.
Meaning of the parameters is as follows:
cmd - the operations to do: add - add an item in profile; rm - remove an item from profile
profile - name of profile
value - value for profile (if no value is needed for that profile, use an empty string.
expires - absolute time (unix timestamp) when this profile item should be removed automatically (time based), if still in the profile
This function can be used from ANY_ROUTE.
Example 1.79. dlg_remote_profile usage
...
$var(exp) = 3600 + $Ts;
dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
...
This function sets the R-URI with the corresponding endpoint address stored in dialog structure (i.e., its Contact field).
This function can be used from ANY_ROUTE.
Example 1.80. dlg_set_ruri() usage
...
if(has_totag() and is_present_hf("Route") and uri==myself ) {
if(dlg_set_ruri()) {
xlog("Request URI changed from [$ou] to dlg value: [$ru]\n");
}
}
...
Load dialog record from database matching on Call-Id provided as parameter.
This function can be used from ANY_ROUTE.
Example 1.81. dlg_db_load_callid() usage
...
if(has_totag()) {
if(!is_known_dlg()) {
dlg_db_load_callid("$ci");
if(!is_known_dlg()) {
xlog("no dialog found with callid: $ci\n");
}
}
}
...
Load all dialog records from database that are not in memory of the current Kamailio instance.
This function can be used from ANY_ROUTE.
Example 1.82. dlg_db_load_extra() usage
...
if(has_totag()) {
if(!is_known_dlg()) {
dlg_db_load_extra();
if(!is_known_dlg()) {
xlog("no dialog found with callid: $ci\n");
}
}
}
...
Reset a dialog property - an attribute that enable/disable various behaviours (e.g., sending keep alive requests).
Meaning of the parameters is as follows:
attr - name of property. It can be:
This function can be used from ANY_ROUTE.
Example 1.83. dlg_reset_property usage
...
dlg_reset_property("ka-src");
dlg_reset_property("ka-dst");
dlg_reset_property("timeout-noreset");
...
Returns the total number of processed dialogs (terminated, expired or active) from the startup.
Lists the description of all dialogs (active calls).
Name: dlg.list
RPC Command Format:
... kamcmd dlg.list ...
The same as the “dlg_list” but including in the dialog description the associated context from modules sitting on top of the dialog module.
Name: dlg.list_ctx
RPC Command Format:
... kamcmd dlg.list_ctx ...
Lists the details of matching dialogs. The paramters specify the matching key, operator, value and optionally a limit of matched dialogs.
Name: dlg.list_match
Parameters:
mkey - matching key. It can be: 'ruri' - match against R-URI of the dialog; 'furi' - match against From header URI of the dialog; 'turi' - match against the To header URI of the dialog; 'callid' - match against Call-Id value.
mop - matching operator. It can be: 'eq' - match using string comparison; 're' - match using regular expression; 'sw' - match using starts-with (prefix) comparison.
mval - matching value.
RPC Command Format:
... kamcmd dlg.list_match furi eq sip:alice@test.com 2 ... kamcmd dlg.list_match furi sw sip:alice@ ...
Similar to “dlg.list_match”, but including in the attributes associated with the dialog context from modules sitting on top of the dialog module.
Name: dlg.list_match_ctx
RPC Command Format:
... kamcmd dlg.list_match_ctx furi sw sip:alice@ ...
Dump all dialogs in a json file. (much faster than dlg.list)
Name: dlg.dump_file
Parameters:
file name output file name
RPC Command Format:
... kamcmd dlg.dump_file "/tmp/dlg.json" ...
Lists the description of one dialog. The dialog identifiers are to be passed as parameter (callid and optionally fromtag).
Name: dlg.dlg_list
Parameters:
callid callid of the dialog to be listed.
from_tag from tag (as per initial request) of the dialog to be listed.
RPC Command Format:
... kamcmd dlg.dlg_list abcdrssfrs122444@192.168.1.1 AAdfeEFF33 ... kamcmd dlg.dlg_list abcdrssfrs122444@192.168.1.1 ...
The same as the “dlg.list_list” but including in the dialog description the associated context from modules sitting on top of the dialog module.
Name: dlg.dlg_list_ctx
Parameters: see “dlg_list”
RPC Command Format:
... kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1 AAdfeEFF33 ... kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1 ...
Terminates an ongoing dialog by sending BYE in both directions, matching the dialog on call-id, from tag and to tag.
Name: dlg.terminate_dlg
Parameters:
callid - callid of dialog to be terminated
from_tag - from tag of the dialog to terminated
to_tag - to tag of the dialog to terminated
The command works only for confirmed dialogs.
RPC Command Format:
kamcmd dlg.terminate_dlg callid12345 fromtag123 totag123
Terminates an ongoing dialog by sending BYE in both directions.
Name: dlg.end_dlg
Parameters:
h_entry - hash entry of the dialog in the internal dialog table
h_id - hash id of the dialog on the hash entry
extra_hdrs - (optional) string containg extra headers (full format) to be added to the BYE requests.
The values for the h_entry and h_id can be get via the dlg_list RPC command.
RPC Command Format:
... kamcmd dlg.end_dlg 342 56 ...
Set state for the dialog matching the dialog on Call-ID, From-Tag and To-Tag.
Name: dlg.kill_active_dlg
Parameters:
callid - Call-ID of active dialog to kill
from_tag - From-Tag of active dialog to kill
to_tag - To-tag of active dialog to kill
state - The value for new state
At this moment, the command targets the need to change from active dialogs (state 4) to terminated state (5), although it allows setting other state value. Be careful using with it, it can cause side effects and the terminated dialog is wiped out silently. Dialog ending functions are not executed, such as accounting end-of-call events, dialog-end events, module-generated BYE requests, etc. After executing the command, dialog remains in memory until execution of the recurring function in charge of removing old dialogs (a "dialog in delete state is too old" will then be logged).
RPC Command Format:
... kamcmd dlg.set_state callid12345 fromtag123 totag123 5 ...
Returns the number of dialogs belonging to a profile. If the profile supports values, the check can be reinforced to take into account a specific value - how many dialogs were inserted into the profile with a specific value. If no value is passed, only the simply belonging of the dialog to the profile is checked. Note that if the profile does not support values, the value parameter will be silently discarded.
Name: dlg.profile_get_size
Parameters:
profile - name of the profile to get the value for.
value (optional)- string value to further restrict the check;
RPC Command Format:
... kamcmd dlg.dlg.profile_get_size inbound_calls ...
Lists all the dialogs belonging to a profile. If the profile supports values, the check can be reinforced to take into account a specific value, i.e. list only the dialogs that were inserted into the profile with that specific value. If no value is passed, all dialogs belonging to the profile will be listed. Note that if the profile does not supports values, this will be silently discarded.
Name: dlg.profile_list
Parameters:
profile - name of the profile to list the dialog for.
value (optional)- string value to further restrict the check;
RPC Command Format:
... kamcmd dlg.profile_list inbound_calls ...
Bridge two SIP addresses into a call using INVITE(hold)-REFER-BYE mechanism.
Name: dlg.bridge_dlg
Parameters:
from - SIP address to initiate the call
to - SIP address to refer 'from' to
op (optional) - outbound proxy SIP address. If its value is set to '.' (dot), then it is ignored (like it would not have been provided).
body (optional) - SDP body for initial INVITE. If its value is set to '.' (dot), then it is ignored (like it would not have been provided). If body is not set via RPC command parameter, then an internal generated SDP with G711a and G711u is used. If its value is set to '' (empty string) or '_' (underline), then the INVITE is sent without an SDP body.
RPC Command Format:
... kamcmd dlg.bridge_dlg _from_ _to_ _op_ ...
Get stats about active dialogs by scanning internal list of dialogs (not relying on core stats framework).
Name: dlg.stats_active
Parameters: none.
Returned fields
starting - initial INVITE has been processed, no ringing or 1xx has been received.
connecting - initial INVITE was forwarded and rining or 1xx has been received.
answering - initial INVITE received 200ok, but ACK was not handled yet.
ongoing - ongoing active dialog, after the ACK was processed.
all - all active dialogs, respectively the sum of the above values.
RPC Command Format:
... kamcmd dlg.stats_active ...
Check whether a dialog matching the parameter is in confirmed state (answered and alive).
Name: dlg.is_alive
Parameters:
callid - callid of dialog
from_tag - from tag of the dialog
to_tag - to tag of the dialog
This command will return error if dialog is not found or not confirmed state (answered).
RPC Command Format:
... kamcmd dlg.is_alive callid123 fromtag123 totag123 ...
Lists fewer attributes for dialog records in memory. The dialog hash entry and id are added always, the rest of them are a matter of 'attrs' parameter.
Name: dlg.briefing
Parameters:
attrs - (optional) a list of characters (flags) representing the fields to be added to the response. If is missing, its default value is 'ftcFT' (note the characters are case sensitive).
The characters can be:
f - From URI
t - To URI
c - Call-ID
F - From tag
T - To tag
I - Init time
S - Start time
E - End time
s - State
RPC Command Example:
... kamctl rpc dlg.briefing ... kamctl rpc dlg.briefing "ft" ...
Returns the status of the dialog corresponding to the processed sequential request. This PV will be available only for sequential requests, after doing loose_route().
Value may be:
NULL - Dialog not found.
3 - Confirmed by a final reply but no ACK received yet.
4 - Confirmed by a final reply and ACK received.
5 - Dialog ended.
Returns the duration (in seconds) of the dialog corresponding to the processed sequential request. The duration is calculated from the dialog confirmation and the current moment. This PV will be available only for sequential requests, after doing loose_route().
NULL will be returned if there is no dialog for the request.
This is a read/write variable that can be used to store custom values assigned with a dialog (e.g. the URI of a billing-server, an assigned emergency-server). This pseudo-variable will be available only for subsequential requests after doing loose_route().
Note: You will receive "NULL", if there is no dialog for this request.
Executed when the BYE for the call is processed or the dialog timed out.
Table of Contents
Register a new callback to the dialog.
Meaning of the parameters is as follows:
struct dlg_cell* dlg - dialog to register callback to. If maybe NULL only for DLGCB_CREATED callback type, which is not a per dialog type.
int type - types of callbacks; more types may be register for the same callback function; only DLGCB_LOADED and DLGCB_CREATED must be registered alone. Possible types:
DLGCB_LOADED
DLGCB_CREATED - called when a new dialog is created - it's a global type (not associated to any dialog)
DLGCB_FAILED - called when the dialog was negatively replied (non-2xx) - it's a per dialog type.
DLGCB_CONFIRMED_NA - called when the dialog is confirmed (2xx replied) but the setup-concluding ACK message from the caller is yet pending - it's a per dialog type.
DLGCB_CONFIRMED - called when the dialog is confirmed (2xx replied) and the setup-concluding ACK message from the caller has been seen - it's a per dialog type.
DLGCB_REQ_WITHIN - called when the dialog matches a sequential request (excluding setup-concluding ACK messages which are handled in DLGCB_CONFIRMED) - it's a per dialog type.
DLGCB_TERMINATED - called when the dialog is terminated via BYE - it's a per dialog type.
DLGCB_TERMINATED_CONFIRMED - called when response to a BYE request is received - it's a per dialog type.
DLGCB_EXPIRED - called when the dialog expires without receiving a BYE - it's a per dialog type.
DLGCB_EARLY - called when the dialog is created in an early state (18x replied) - it's a per dialog type.
DLGCB_RESPONSE_FWDED - called when the dialog matches a reply to the initial INVITE request - it's a per dialog type.
DLGCB_RESPONSE_WITHIN - called when the dialog matches a reply to a subsequent in dialog request - it's a per dialog type.
DLGCB_RPC_CONTEXT - called when the rpc dlg_list_ctx command is invoked - it's a per dialog type.
DLGCB_SPIRALED - called when the dialog matches a spiraling request - it's a per dialog type.
DLGCB_DESTROY
dialog_cb cb - callback function to be called. Prototype is: “void (dialog_cb) (struct dlg_cell* dlg, int type, struct dlg_cb_params * params); ”
void *param - parameter to be passed to the callback function.
param_free callback_param_free - callback function to be called to free the param. Prototype is: “void (param_free_cb) (void *param);”
|
3.1. |
What happened with “use_tight_match” parameter? |
|
The parameter was removed with version 1.3 as the option of tight matching became mandatory and not configurable. Now, the tight matching is done all the time (when using DID matching). |
|
|
3.2. |
Where can I find more about Kamailio? |
|
Take a look at https://www.kamailio.org/. |
|
|
3.3. |
Where can I post a question about this module? |
|
First at all check if your question was already answered on one of our mailing lists:
E-mails regarding any stable Kamailio release should be sent to
|
|
|
3.4. |
How can I report a bug? |
|
Please follow the guidelines provided at: https://github.com/kamailio/kamailio/issues. |