|
@@ -22,9 +22,9 @@ Alex Balashov
|
|
|
|
|
|
<[email protected]>
|
|
<[email protected]>
|
|
|
|
|
|
- Copyright © 2006 Voice Sistem SRL
|
|
|
|
|
|
+ Copyright © 2006 Voice Sistem SRL
|
|
|
|
|
|
- Copyright © 2011 Carsten Bock, http://www.ng-voice.com
|
|
|
|
|
|
+ Copyright © 2011 Carsten Bock, http://www.ng-voice.com
|
|
__________________________________________________________________
|
|
__________________________________________________________________
|
|
|
|
|
|
Table of Contents
|
|
Table of Contents
|
|
@@ -83,11 +83,12 @@ Alex Balashov
|
|
5.40. profiles_with_value (string)
|
|
5.40. profiles_with_value (string)
|
|
5.41. profiles_no_value (string)
|
|
5.41. profiles_no_value (string)
|
|
5.42. bridge_controller (string)
|
|
5.42. bridge_controller (string)
|
|
- 5.43. initial_cbs_inscript (int)
|
|
|
|
- 5.44. send_bye (int)
|
|
|
|
- 5.45. wait_ack (int)
|
|
|
|
- 5.46. ka_timer (int)
|
|
|
|
- 5.47. ka_interval (int)
|
|
|
|
|
|
+ 5.43. bridge_contact (string)
|
|
|
|
+ 5.44. initial_cbs_inscript (int)
|
|
|
|
+ 5.45. send_bye (int)
|
|
|
|
+ 5.46. wait_ack (int)
|
|
|
|
+ 5.47. ka_timer (int)
|
|
|
|
+ 5.48. ka_interval (int)
|
|
|
|
|
|
6. Functions
|
|
6. Functions
|
|
|
|
|
|
@@ -206,27 +207,28 @@ Alex Balashov
|
|
1.40. Set profiles_with_value parameter
|
|
1.40. Set profiles_with_value parameter
|
|
1.41. Set profiles_no_value parameter
|
|
1.41. Set profiles_no_value parameter
|
|
1.42. Set bridge_controller parameter
|
|
1.42. Set bridge_controller parameter
|
|
- 1.43. Set initial_cbs_inscript parameter
|
|
|
|
- 1.44. Set send_bye parameter
|
|
|
|
- 1.45. Set wait_ack parameter
|
|
|
|
- 1.46. Set ka_timer parameter
|
|
|
|
- 1.47. Set ka_interval parameter
|
|
|
|
- 1.48. set_dlg_profile usage
|
|
|
|
- 1.49. unset_dlg_profile usage
|
|
|
|
- 1.50. is_in_profile usage
|
|
|
|
- 1.51. get_profile_size usage
|
|
|
|
- 1.52. dlg_isflagset usage
|
|
|
|
- 1.53. dlg_setflag usage
|
|
|
|
- 1.54. dlg_resetflag usage
|
|
|
|
- 1.55. dlg_bye usage
|
|
|
|
- 1.56. dlg_refer usage
|
|
|
|
- 1.57. dlg_manage usage
|
|
|
|
- 1.58. dlg_bridge usage
|
|
|
|
- 1.59. dlg_get usage
|
|
|
|
- 1.60. is_known_dlg() usage
|
|
|
|
- 1.61. dlg_set_timeout usage
|
|
|
|
- 1.62. dlg_set_timeout_by_profile usage
|
|
|
|
- 1.63. dlg_set_property usage
|
|
|
|
|
|
+ 1.43. Set bridge_contact parameter
|
|
|
|
+ 1.44. Set initial_cbs_inscript parameter
|
|
|
|
+ 1.45. Set send_bye parameter
|
|
|
|
+ 1.46. Set wait_ack parameter
|
|
|
|
+ 1.47. Set ka_timer parameter
|
|
|
|
+ 1.48. Set ka_interval parameter
|
|
|
|
+ 1.49. set_dlg_profile usage
|
|
|
|
+ 1.50. unset_dlg_profile usage
|
|
|
|
+ 1.51. is_in_profile usage
|
|
|
|
+ 1.52. get_profile_size usage
|
|
|
|
+ 1.53. dlg_isflagset usage
|
|
|
|
+ 1.54. dlg_setflag usage
|
|
|
|
+ 1.55. dlg_resetflag usage
|
|
|
|
+ 1.56. dlg_bye usage
|
|
|
|
+ 1.57. dlg_refer usage
|
|
|
|
+ 1.58. dlg_manage usage
|
|
|
|
+ 1.59. dlg_bridge usage
|
|
|
|
+ 1.60. dlg_get usage
|
|
|
|
+ 1.61. is_known_dlg() usage
|
|
|
|
+ 1.62. dlg_set_timeout usage
|
|
|
|
+ 1.63. dlg_set_timeout_by_profile usage
|
|
|
|
+ 1.64. dlg_set_property usage
|
|
|
|
|
|
Chapter 1. Admin Guide
|
|
Chapter 1. Admin Guide
|
|
|
|
|
|
@@ -284,11 +286,12 @@ Chapter 1. Admin Guide
|
|
5.40. profiles_with_value (string)
|
|
5.40. profiles_with_value (string)
|
|
5.41. profiles_no_value (string)
|
|
5.41. profiles_no_value (string)
|
|
5.42. bridge_controller (string)
|
|
5.42. bridge_controller (string)
|
|
- 5.43. initial_cbs_inscript (int)
|
|
|
|
- 5.44. send_bye (int)
|
|
|
|
- 5.45. wait_ack (int)
|
|
|
|
- 5.46. ka_timer (int)
|
|
|
|
- 5.47. ka_interval (int)
|
|
|
|
|
|
+ 5.43. bridge_contact (string)
|
|
|
|
+ 5.44. initial_cbs_inscript (int)
|
|
|
|
+ 5.45. send_bye (int)
|
|
|
|
+ 5.46. wait_ack (int)
|
|
|
|
+ 5.47. ka_timer (int)
|
|
|
|
+ 5.48. ka_interval (int)
|
|
|
|
|
|
6. Functions
|
|
6. Functions
|
|
|
|
|
|
@@ -381,14 +384,14 @@ Chapter 1. Admin Guide
|
|
2. How it works
|
|
2. How it works
|
|
|
|
|
|
To create the dialog associated with an initial request, the flag
|
|
To create the dialog associated with an initial request, the flag
|
|
- “dlg_flag� (Section 5.4, “dlg_flag (integer)�) must be set before
|
|
|
|
|
|
+ "dlg_flag" (Section 5.4, "dlg_flag (integer)") must be set before
|
|
creating the corresponding transaction.
|
|
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 5.6, “default_timeout (integer)�) and
|
|
|
|
- custom timeout (see “timeout_avp� - Section 5.5, “timeout_avp
|
|
|
|
- (string)�). The dialog timeout is reset each time a sequential request
|
|
|
|
|
|
+ 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 5.6, "default_timeout (integer)") and
|
|
|
|
+ custom timeout (see "timeout_avp" - Section 5.5, "timeout_avp
|
|
|
|
+ (string)"). The dialog timeout is reset each time a sequential request
|
|
is processed.
|
|
is processed.
|
|
|
|
|
|
3. Dialog profiling
|
|
3. Dialog profiling
|
|
@@ -482,11 +485,12 @@ Chapter 1. Admin Guide
|
|
5.40. profiles_with_value (string)
|
|
5.40. profiles_with_value (string)
|
|
5.41. profiles_no_value (string)
|
|
5.41. profiles_no_value (string)
|
|
5.42. bridge_controller (string)
|
|
5.42. bridge_controller (string)
|
|
- 5.43. initial_cbs_inscript (int)
|
|
|
|
- 5.44. send_bye (int)
|
|
|
|
- 5.45. wait_ack (int)
|
|
|
|
- 5.46. ka_timer (int)
|
|
|
|
- 5.47. ka_interval (int)
|
|
|
|
|
|
+ 5.43. bridge_contact (string)
|
|
|
|
+ 5.44. initial_cbs_inscript (int)
|
|
|
|
+ 5.45. send_bye (int)
|
|
|
|
+ 5.46. wait_ack (int)
|
|
|
|
+ 5.47. ka_timer (int)
|
|
|
|
+ 5.48. ka_interval (int)
|
|
|
|
|
|
5.1. enable_stats (integer)
|
|
5.1. enable_stats (integer)
|
|
|
|
|
|
@@ -494,7 +498,7 @@ Chapter 1. Admin Guide
|
|
variables, the module provide information about the dialog processing.
|
|
variables, the module provide information about the dialog processing.
|
|
Set it to zero to disable or to non-zero to enable it.
|
|
Set it to zero to disable or to non-zero to enable it.
|
|
|
|
|
|
- Default value is “1 (enabled)�.
|
|
|
|
|
|
+ Default value is "1 (enabled)".
|
|
|
|
|
|
Example 1.1. Set enable_stats parameter
|
|
Example 1.1. Set enable_stats parameter
|
|
...
|
|
...
|
|
@@ -512,7 +516,7 @@ modparam("dialog", "enable_stats", 0)
|
|
not take place. If you really want to modify the hash_size, you must
|
|
not take place. If you really want to modify the hash_size, you must
|
|
delete all table's rows before restarting the server.
|
|
delete all table's rows before restarting the server.
|
|
|
|
|
|
- Default value is “4096�.
|
|
|
|
|
|
+ Default value is "4096".
|
|
|
|
|
|
Example 1.2. Set hash_size parameter
|
|
Example 1.2. Set hash_size parameter
|
|
...
|
|
...
|
|
@@ -525,7 +529,7 @@ modparam("dialog", "hash_size", 1024)
|
|
is used for the fast matching of sequential requests to tracked
|
|
is used for the fast matching of sequential requests to tracked
|
|
dialogs.
|
|
dialogs.
|
|
|
|
|
|
- Default value is “did�.
|
|
|
|
|
|
+ Default value is "did".
|
|
|
|
|
|
Example 1.3. Set rr_param parameter
|
|
Example 1.3. Set rr_param parameter
|
|
...
|
|
...
|
|
@@ -537,7 +541,7 @@ modparam("dialog", "rr_param", "xyz")
|
|
Flag to be used for marking if a dialog should be constructed for the
|
|
Flag to be used for marking if a dialog should be constructed for the
|
|
current request (this make sense only for initial requests).
|
|
current request (this make sense only for initial requests).
|
|
|
|
|
|
- Default value is “none�.
|
|
|
|
|
|
+ Default value is "none".
|
|
|
|
|
|
Example 1.4. Set dlg_flag parameter
|
|
Example 1.4. Set dlg_flag parameter
|
|
...
|
|
...
|
|
@@ -550,7 +554,7 @@ modparam("dialog", "dlg_flag", 4)
|
|
seconds) for the dialog. It may be used only in a request (initial or
|
|
seconds) for the dialog. It may be used only in a request (initial or
|
|
sequential) context.
|
|
sequential) context.
|
|
|
|
|
|
- Default value is “none�.
|
|
|
|
|
|
+ Default value is "none".
|
|
|
|
|
|
Example 1.5. Set timeout_avp parameter
|
|
Example 1.5. Set timeout_avp parameter
|
|
...
|
|
...
|
|
@@ -562,7 +566,7 @@ modparam("dialog", "timeout_avp", "$avp(i:10)")
|
|
The default dialog timeout (in seconds), in the absence of a custom
|
|
The default dialog timeout (in seconds), in the absence of a custom
|
|
value provided in an AVP.
|
|
value provided in an AVP.
|
|
|
|
|
|
- Default value is “43200 (12 hours)�.
|
|
|
|
|
|
+ Default value is "43200 (12 hours)".
|
|
|
|
|
|
Example 1.6. Set default_timeout parameter
|
|
Example 1.6. Set default_timeout parameter
|
|
...
|
|
...
|
|
@@ -574,7 +578,7 @@ modparam("dialog", "default_timeout", 21600)
|
|
A string containing the extra headers (full format, with EOH) to be
|
|
A string containing the extra headers (full format, with EOH) to be
|
|
added to requests generated locally by the module (like BYEs).
|
|
added to requests generated locally by the module (like BYEs).
|
|
|
|
|
|
- Default value is “NULL�.
|
|
|
|
|
|
+ Default value is "NULL".
|
|
|
|
|
|
Example 1.7. Set dlf_extra_hdrs parameter
|
|
Example 1.7. Set dlf_extra_hdrs parameter
|
|
...
|
|
...
|
|
@@ -595,7 +599,7 @@ modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
|
|
* 2 - DID_NONE - the match is done exclusively based on SIP elements;
|
|
* 2 - DID_NONE - the match is done exclusively based on SIP elements;
|
|
no DID information is added in RR.
|
|
no DID information is added in RR.
|
|
|
|
|
|
- Default value is “0 (DID_ONLY)�.
|
|
|
|
|
|
+ Default value is "0 (DID_ONLY)".
|
|
|
|
|
|
Example 1.8. Set dlg_match_mode parameter
|
|
Example 1.8. Set dlg_match_mode parameter
|
|
...
|
|
...
|
|
@@ -624,7 +628,7 @@ modparam("dialog", "detect_spirals", 1)
|
|
If you want to store the information about the dialogs in a database, a
|
|
If you want to store the information about the dialogs in a database, a
|
|
database URL must be specified.
|
|
database URL must be specified.
|
|
|
|
|
|
- Default value is “mysql://kamailio:kamailiorw@localhost/kamailio�.
|
|
|
|
|
|
+ Default value is "mysql://kamailio:kamailiorw@localhost/kamailio".
|
|
|
|
|
|
Example 1.10. Set db_url parameter
|
|
Example 1.10. Set db_url parameter
|
|
...
|
|
...
|
|
@@ -645,7 +649,7 @@ modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname")
|
|
* 3 - SHUTDOWN - the dialog information will be flushed into DB only
|
|
* 3 - SHUTDOWN - the dialog information will be flushed into DB only
|
|
at shutdown - no runtime updates.
|
|
at shutdown - no runtime updates.
|
|
|
|
|
|
- Default value is “0�.
|
|
|
|
|
|
+ Default value is "0".
|
|
|
|
|
|
Example 1.11. Set db_mode parameter
|
|
Example 1.11. Set db_mode parameter
|
|
...
|
|
...
|
|
@@ -659,7 +663,7 @@ modparam("dialog", "db_mode", 1)
|
|
interval will generate intensive database operations, while an
|
|
interval will generate intensive database operations, while an
|
|
excessively long one will miss dialogs with a short lifetime.
|
|
excessively long one will miss dialogs with a short lifetime.
|
|
|
|
|
|
- Default value is “60�.
|
|
|
|
|
|
+ Default value is "60".
|
|
|
|
|
|
Example 1.12. Set db_update_period parameter
|
|
Example 1.12. Set db_update_period parameter
|
|
...
|
|
...
|
|
@@ -675,7 +679,7 @@ modparam("dialog", "db_update_period", 120)
|
|
fetch_result() capability. A value of 0 means the functionality is
|
|
fetch_result() capability. A value of 0 means the functionality is
|
|
disabled.
|
|
disabled.
|
|
|
|
|
|
- Default value is “200�.
|
|
|
|
|
|
+ Default value is "200".
|
|
|
|
|
|
Example 1.13. Set db_fetch_rows parameter
|
|
Example 1.13. Set db_fetch_rows parameter
|
|
...
|
|
...
|
|
@@ -687,7 +691,7 @@ modparam("dialog", "db_fetch_rows", 500)
|
|
If you want to store the information about the dialogs in a database a
|
|
If you want to store the information about the dialogs in a database a
|
|
table name must be specified.
|
|
table name must be specified.
|
|
|
|
|
|
- Default value is “dialog�.
|
|
|
|
|
|
+ Default value is "dialog".
|
|
|
|
|
|
Example 1.14. Set table_name parameter
|
|
Example 1.14. Set table_name parameter
|
|
...
|
|
...
|
|
@@ -698,7 +702,7 @@ modparam("dialog", "table_name", "my_dialog")
|
|
|
|
|
|
The column name in the database to store the dialogs' callid.
|
|
The column name in the database to store the dialogs' callid.
|
|
|
|
|
|
- Default value is “callid�.
|
|
|
|
|
|
+ Default value is "callid".
|
|
|
|
|
|
Example 1.15. Set callid_column parameter
|
|
Example 1.15. Set callid_column parameter
|
|
...
|
|
...
|
|
@@ -709,7 +713,7 @@ modparam("dialog", "callid_column", "callid_c_name")
|
|
|
|
|
|
The column name in the database to store the caller's sip address.
|
|
The column name in the database to store the caller's sip address.
|
|
|
|
|
|
- Default value is “from_uri�.
|
|
|
|
|
|
+ Default value is "from_uri".
|
|
|
|
|
|
Example 1.16. Set from_uri_column parameter
|
|
Example 1.16. Set from_uri_column parameter
|
|
...
|
|
...
|
|
@@ -721,7 +725,7 @@ modparam("dialog", "from_uri_column", "from_uri_c_name")
|
|
The column name in the database to store the From tag from the INVITE
|
|
The column name in the database to store the From tag from the INVITE
|
|
request.
|
|
request.
|
|
|
|
|
|
- Default value is “from_tag�.
|
|
|
|
|
|
+ Default value is "from_tag".
|
|
|
|
|
|
Example 1.17. Set from_tag_column parameter
|
|
Example 1.17. Set from_tag_column parameter
|
|
...
|
|
...
|
|
@@ -732,7 +736,7 @@ modparam("dialog", "from_tag_column", "from_tag_c_name")
|
|
|
|
|
|
The column name in the database to store the callee's sip address.
|
|
The column name in the database to store the callee's sip address.
|
|
|
|
|
|
- Default value is “to_uri�.
|
|
|
|
|
|
+ Default value is "to_uri".
|
|
|
|
|
|
Example 1.18. Set to_uri_column parameter
|
|
Example 1.18. Set to_uri_column parameter
|
|
...
|
|
...
|
|
@@ -744,7 +748,7 @@ modparam("dialog", "to_uri_column", "to_uri_c_name")
|
|
The column name in the database to store the To tag from the 200 OK
|
|
The column name in the database to store the To tag from the 200 OK
|
|
response to the INVITE request, if present.
|
|
response to the INVITE request, if present.
|
|
|
|
|
|
- Default value is “to_tag�.
|
|
|
|
|
|
+ Default value is "to_tag".
|
|
|
|
|
|
Example 1.19. Set to_tag_column parameter
|
|
Example 1.19. Set to_tag_column parameter
|
|
...
|
|
...
|
|
@@ -755,7 +759,7 @@ modparam("dialog", "to_tag_column", "to_tag_c_name")
|
|
|
|
|
|
The column name in the database to store the cseq from caller side.
|
|
The column name in the database to store the cseq from caller side.
|
|
|
|
|
|
- Default value is “caller_cseq�.
|
|
|
|
|
|
+ Default value is "caller_cseq".
|
|
|
|
|
|
Example 1.20. Set caller_cseq_column parameter
|
|
Example 1.20. Set caller_cseq_column parameter
|
|
...
|
|
...
|
|
@@ -766,7 +770,7 @@ modparam("dialog", "caller_cseq_column", "column_name")
|
|
|
|
|
|
The column name in the database to store the cseq from callee side.
|
|
The column name in the database to store the cseq from callee side.
|
|
|
|
|
|
- Default value is “callee_cseq�.
|
|
|
|
|
|
+ Default value is "callee_cseq".
|
|
|
|
|
|
Example 1.21. Set callee_cseq_column parameter
|
|
Example 1.21. Set callee_cseq_column parameter
|
|
...
|
|
...
|
|
@@ -778,7 +782,7 @@ modparam("dialog", "callee_cseq_column", "column_name")
|
|
The column name in the database to store the route records from caller
|
|
The column name in the database to store the route records from caller
|
|
side (proxy to caller).
|
|
side (proxy to caller).
|
|
|
|
|
|
- Default value is “caller_route_set�.
|
|
|
|
|
|
+ Default value is "caller_route_set".
|
|
|
|
|
|
Example 1.22. Set caller_route_column parameter
|
|
Example 1.22. Set caller_route_column parameter
|
|
...
|
|
...
|
|
@@ -790,7 +794,7 @@ modparam("dialog", "caller_route_column", "column_name")
|
|
The column name in the database to store the route records from callee
|
|
The column name in the database to store the route records from callee
|
|
side (proxy to callee).
|
|
side (proxy to callee).
|
|
|
|
|
|
- Default value is “callee_route_set�.
|
|
|
|
|
|
+ Default value is "callee_route_set".
|
|
|
|
|
|
Example 1.23. Set to_route_column parameter
|
|
Example 1.23. Set to_route_column parameter
|
|
...
|
|
...
|
|
@@ -801,7 +805,7 @@ modparam("dialog", "callee_route_column", "column_name")
|
|
|
|
|
|
The column name in the database to store the caller's contact uri.
|
|
The column name in the database to store the caller's contact uri.
|
|
|
|
|
|
- Default value is “from_contact�.
|
|
|
|
|
|
+ Default value is "from_contact".
|
|
|
|
|
|
Example 1.24. Set caller_contact_column parameter
|
|
Example 1.24. Set caller_contact_column parameter
|
|
...
|
|
...
|
|
@@ -812,7 +816,7 @@ modparam("dialog", "caller_contact_column", "column_name")
|
|
|
|
|
|
The column name in the database to store the callee's contact uri.
|
|
The column name in the database to store the callee's contact uri.
|
|
|
|
|
|
- Default value is “callee_contact�.
|
|
|
|
|
|
+ Default value is "callee_contact".
|
|
|
|
|
|
Example 1.25. Set callee_contact_column parameter
|
|
Example 1.25. Set callee_contact_column parameter
|
|
...
|
|
...
|
|
@@ -824,7 +828,7 @@ modparam("dialog", "callee_contact_column", "column_name")
|
|
The column name in the database to store the information about the
|
|
The column name in the database to store the information about the
|
|
local interface receiving the traffic from caller.
|
|
local interface receiving the traffic from caller.
|
|
|
|
|
|
- Default value is “caller_sock�.
|
|
|
|
|
|
+ Default value is "caller_sock".
|
|
|
|
|
|
Example 1.26. Set caller_sock_column parameter
|
|
Example 1.26. Set caller_sock_column parameter
|
|
...
|
|
...
|
|
@@ -836,7 +840,7 @@ modparam("dialog", "caller_sock_column", "column_name")
|
|
The column name in the database to store information about the local
|
|
The column name in the database to store information about the local
|
|
interface receiving the traffic from callee.
|
|
interface receiving the traffic from callee.
|
|
|
|
|
|
- Default value is “callee_contact�.
|
|
|
|
|
|
+ Default value is "callee_contact".
|
|
|
|
|
|
Example 1.27. Set callee_sock_column parameter
|
|
Example 1.27. Set callee_sock_column parameter
|
|
...
|
|
...
|
|
@@ -848,7 +852,7 @@ modparam("dialog", "callee_sock_column", "column_name")
|
|
The column name in the database to store the dialogs' hash id
|
|
The column name in the database to store the dialogs' hash id
|
|
information.
|
|
information.
|
|
|
|
|
|
- Default value is “hash_id�.
|
|
|
|
|
|
+ Default value is "hash_id".
|
|
|
|
|
|
Example 1.28. Set h_id_column parameter
|
|
Example 1.28. Set h_id_column parameter
|
|
...
|
|
...
|
|
@@ -860,7 +864,7 @@ modparam("dialog", "h_id_column", "hash_id_c_name")
|
|
The column name in the database to store the dialogs' hash entry
|
|
The column name in the database to store the dialogs' hash entry
|
|
information.
|
|
information.
|
|
|
|
|
|
- Default value is “hash_entry�.
|
|
|
|
|
|
+ Default value is "hash_entry".
|
|
|
|
|
|
Example 1.29. Set h_entry_column parameter
|
|
Example 1.29. Set h_entry_column parameter
|
|
...
|
|
...
|
|
@@ -872,7 +876,7 @@ modparam("dialog", "h_entry_column", "h_entry_c_name")
|
|
The column name in the database to store the dialogs' state
|
|
The column name in the database to store the dialogs' state
|
|
information.
|
|
information.
|
|
|
|
|
|
- Default value is “state�.
|
|
|
|
|
|
+ Default value is "state".
|
|
|
|
|
|
Example 1.30. Set state_column parameter
|
|
Example 1.30. Set state_column parameter
|
|
...
|
|
...
|
|
@@ -884,7 +888,7 @@ modparam("dialog", "state_column", "state_c_name")
|
|
The column name in the database to store the dialogs' start time
|
|
The column name in the database to store the dialogs' start time
|
|
information.
|
|
information.
|
|
|
|
|
|
- Default value is “start_time�.
|
|
|
|
|
|
+ Default value is "start_time".
|
|
|
|
|
|
Example 1.31. Set start_time_column parameter
|
|
Example 1.31. Set start_time_column parameter
|
|
...
|
|
...
|
|
@@ -895,7 +899,7 @@ modparam("dialog", "start_time_column", "start_time_c_name")
|
|
|
|
|
|
The column name in the database to store the dialogs' timeout.
|
|
The column name in the database to store the dialogs' timeout.
|
|
|
|
|
|
- Default value is “timeout�.
|
|
|
|
|
|
+ Default value is "timeout".
|
|
|
|
|
|
Example 1.32. Set timeout_column parameter
|
|
Example 1.32. Set timeout_column parameter
|
|
...
|
|
...
|
|
@@ -906,7 +910,7 @@ modparam("dialog", "timeout_column", "timeout_c_name")
|
|
|
|
|
|
The column name in the database to store the script flags.
|
|
The column name in the database to store the script flags.
|
|
|
|
|
|
- Default value is “sflags�.
|
|
|
|
|
|
+ Default value is "sflags".
|
|
|
|
|
|
Example 1.33. Set sflags_column parameter
|
|
Example 1.33. Set sflags_column parameter
|
|
...
|
|
...
|
|
@@ -918,7 +922,7 @@ modparam("dialog", "sflags_column", "s_flags")
|
|
The column name in the database to store the index of the route to be
|
|
The column name in the database to store the index of the route to be
|
|
executed at timeout.
|
|
executed at timeout.
|
|
|
|
|
|
- Default value is “toroute�.
|
|
|
|
|
|
+ Default value is "toroute".
|
|
|
|
|
|
Example 1.34. Set toroute_column parameter
|
|
Example 1.34. Set toroute_column parameter
|
|
...
|
|
...
|
|
@@ -930,7 +934,7 @@ modparam("dialog", "toroute_column", "timeout_route")
|
|
If you want to store the variables for a dialog in a database a table
|
|
If you want to store the variables for a dialog in a database a table
|
|
name must be specified.
|
|
name must be specified.
|
|
|
|
|
|
- Default value is “dialog_vars�.
|
|
|
|
|
|
+ Default value is "dialog_vars".
|
|
|
|
|
|
Example 1.35. Set vars_table_name parameter
|
|
Example 1.35. Set vars_table_name parameter
|
|
...
|
|
...
|
|
@@ -942,7 +946,7 @@ modparam("dialog", "vars_table_name", "my_dialog_vars")
|
|
The column name in the database to store the dialogs' hash id
|
|
The column name in the database to store the dialogs' hash id
|
|
information (as a reference to the dialog table).
|
|
information (as a reference to the dialog table).
|
|
|
|
|
|
- Default value is “hash_id�.
|
|
|
|
|
|
+ Default value is "hash_id".
|
|
|
|
|
|
Example 1.36. Set vars_h_id_column parameter
|
|
Example 1.36. Set vars_h_id_column parameter
|
|
...
|
|
...
|
|
@@ -954,7 +958,7 @@ modparam("dialog", "vars_h_id_column", "vars_h_id_name")
|
|
The column name in the database to store the dialogs' hash entry
|
|
The column name in the database to store the dialogs' hash entry
|
|
information (as a reference to the dialog table).
|
|
information (as a reference to the dialog table).
|
|
|
|
|
|
- Default value is “hash_entry�.
|
|
|
|
|
|
+ Default value is "hash_entry".
|
|
|
|
|
|
Example 1.37. Set vars_h_entry_column parameter
|
|
Example 1.37. Set vars_h_entry_column parameter
|
|
...
|
|
...
|
|
@@ -965,7 +969,7 @@ modparam("dialog", "vars_h_entry_column", "vars_h_entry_name")
|
|
|
|
|
|
The column name in the database to store the keys of a variable.
|
|
The column name in the database to store the keys of a variable.
|
|
|
|
|
|
- Default value is “dialog_key�.
|
|
|
|
|
|
+ Default value is "dialog_key".
|
|
|
|
|
|
Example 1.38. Set vars_key_column parameter
|
|
Example 1.38. Set vars_key_column parameter
|
|
...
|
|
...
|
|
@@ -976,7 +980,7 @@ modparam("dialog", "vars_key_column", "vars_key_name")
|
|
|
|
|
|
The column name in the database to store the keys of a variable.
|
|
The column name in the database to store the keys of a variable.
|
|
|
|
|
|
- Default value is “dialog_value�.
|
|
|
|
|
|
+ Default value is "dialog_value".
|
|
|
|
|
|
Example 1.39. Set vars_value_column parameter
|
|
Example 1.39. Set vars_value_column parameter
|
|
...
|
|
...
|
|
@@ -987,7 +991,7 @@ modparam("dialog", "vars_value_column", "vars_value_name")
|
|
|
|
|
|
List of names for profiles with values.
|
|
List of names for profiles with values.
|
|
|
|
|
|
- Default value is “empty�.
|
|
|
|
|
|
+ Default value is "empty".
|
|
|
|
|
|
Example 1.40. Set profiles_with_value parameter
|
|
Example 1.40. Set profiles_with_value parameter
|
|
...
|
|
...
|
|
@@ -998,7 +1002,7 @@ modparam("dialog", "profiles_with_value", "caller ; my_profile")
|
|
|
|
|
|
List of names for profiles without values.
|
|
List of names for profiles without values.
|
|
|
|
|
|
- Default value is “empty�.
|
|
|
|
|
|
+ Default value is "empty".
|
|
|
|
|
|
Example 1.41. Set profiles_no_value parameter
|
|
Example 1.41. Set profiles_no_value parameter
|
|
...
|
|
...
|
|
@@ -1009,14 +1013,25 @@ modparam("dialog", "profiles_no_value", "inbound ; outbound")
|
|
|
|
|
|
SIP address to be used in From header when initiating a call bridge.
|
|
SIP address to be used in From header when initiating a call bridge.
|
|
|
|
|
|
- Default value is “sip:[email protected]�.
|
|
|
|
|
|
+ Default value is "sip:[email protected]".
|
|
|
|
|
|
Example 1.42. Set bridge_controller parameter
|
|
Example 1.42. Set bridge_controller parameter
|
|
...
|
|
...
|
|
modparam("dialog", "bridge_controller", "sip:[email protected]")
|
|
modparam("dialog", "bridge_controller", "sip:[email protected]")
|
|
...
|
|
...
|
|
|
|
|
|
-5.43. initial_cbs_inscript (int)
|
|
|
|
|
|
+5.43. bridge_contact (string)
|
|
|
|
+
|
|
|
|
+ SIP address to be used in Contact header when doing a call bridge.
|
|
|
|
+
|
|
|
|
+ Default value is "sip:[email protected]:5060".
|
|
|
|
+
|
|
|
|
+ Example 1.43. Set bridge_contact parameter
|
|
|
|
+...
|
|
|
|
+modparam("dialog", "bridge_contact", "sip:[email protected]:5060")
|
|
|
|
+...
|
|
|
|
+
|
|
|
|
+5.44. initial_cbs_inscript (int)
|
|
|
|
|
|
If the initial dialog callbacks (i.e., DLGCB_CREATED and
|
|
If the initial dialog callbacks (i.e., DLGCB_CREATED and
|
|
DLGCB_SPIRALED) should be executed in-script or post-script. If
|
|
DLGCB_SPIRALED) should be executed in-script or post-script. If
|
|
@@ -1032,53 +1047,53 @@ modparam("dialog", "bridge_controller", "sip:[email protected]")
|
|
* 1 - IN-SCRIPT - execute initial callbacks during script execution,
|
|
* 1 - IN-SCRIPT - execute initial callbacks during script execution,
|
|
i.e., right after dlg_manage() is called;
|
|
i.e., right after dlg_manage() is called;
|
|
|
|
|
|
- Default value is “1�.
|
|
|
|
|
|
+ Default value is "1".
|
|
|
|
|
|
- Example 1.43. Set initial_cbs_inscript parameter
|
|
|
|
|
|
+ Example 1.44. Set initial_cbs_inscript parameter
|
|
...
|
|
...
|
|
modparam("dialog", "initial_cbs_inscript", 0)
|
|
modparam("dialog", "initial_cbs_inscript", 0)
|
|
...
|
|
...
|
|
|
|
|
|
-5.44. send_bye (int)
|
|
|
|
|
|
+5.45. send_bye (int)
|
|
|
|
|
|
If set to 1, BYE requests will be sent out for each dialog that timed
|
|
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.
|
|
out. It is an alternative to $dlg_ctx(timeout_bye)=1 for all dialogs.
|
|
|
|
|
|
- Default value is “0�.
|
|
|
|
|
|
+ Default value is "0".
|
|
|
|
|
|
- Example 1.44. Set send_bye parameter
|
|
|
|
|
|
+ Example 1.45. Set send_bye parameter
|
|
...
|
|
...
|
|
modparam("dialog", "send_bye", 1)
|
|
modparam("dialog", "send_bye", 1)
|
|
...
|
|
...
|
|
|
|
|
|
-5.45. wait_ack (int)
|
|
|
|
|
|
+5.46. wait_ack (int)
|
|
|
|
|
|
If set to 1, dialog will be keept a bit longer in memory in order to
|
|
If set to 1, dialog will be keept a bit longer in memory in order to
|
|
absorb the ACK negative replies of initial INVITE. If not, the dialog
|
|
absorb the ACK negative replies of initial INVITE. If not, the dialog
|
|
is destroyed when negative reply is sent out (less internal
|
|
is destroyed when negative reply is sent out (less internal
|
|
complexity).
|
|
complexity).
|
|
|
|
|
|
- Default value is “1�.
|
|
|
|
|
|
+ Default value is "1".
|
|
|
|
|
|
- Example 1.45. Set wait_ack parameter
|
|
|
|
|
|
+ Example 1.46. Set wait_ack parameter
|
|
...
|
|
...
|
|
modparam("dialog", "wait_ack", 0)
|
|
modparam("dialog", "wait_ack", 0)
|
|
...
|
|
...
|
|
|
|
|
|
-5.46. ka_timer (int)
|
|
|
|
|
|
+5.47. ka_timer (int)
|
|
|
|
|
|
Keep-alive timer step - how often to execute the callback to send
|
|
Keep-alive timer step - how often to execute the callback to send
|
|
dialog keep alives (SIP OPTIONS requests within dialog). The value
|
|
dialog keep alives (SIP OPTIONS requests within dialog). The value
|
|
represents the number of seconds.
|
|
represents the number of seconds.
|
|
|
|
|
|
- Default value is “0� (no keep alive).
|
|
|
|
|
|
+ Default value is "0" (no keep alive).
|
|
|
|
|
|
- Example 1.46. Set ka_timer parameter
|
|
|
|
|
|
+ Example 1.47. Set ka_timer parameter
|
|
...
|
|
...
|
|
modparam("dialog", "ka_timer", 10)
|
|
modparam("dialog", "ka_timer", 10)
|
|
...
|
|
...
|
|
|
|
|
|
-5.47. ka_interval (int)
|
|
|
|
|
|
+5.48. ka_interval (int)
|
|
|
|
|
|
The interval between keep alives within dialog (SIP OPTIONS requests),
|
|
The interval between keep alives within dialog (SIP OPTIONS requests),
|
|
sent to caller or callee. The keep alive request will be sent by the
|
|
sent to caller or callee. The keep alive request will be sent by the
|
|
@@ -1086,9 +1101,9 @@ modparam("dialog", "ka_timer", 10)
|
|
dialog setup or previous keep-alive. The value represents the number of
|
|
dialog setup or previous keep-alive. The value represents the number of
|
|
seconds.
|
|
seconds.
|
|
|
|
|
|
- Default value is “0� (no keep alive).
|
|
|
|
|
|
+ Default value is "0" (no keep alive).
|
|
|
|
|
|
- Example 1.47. Set ka_interval parameter
|
|
|
|
|
|
+ Example 1.48. Set ka_interval parameter
|
|
...
|
|
...
|
|
modparam("dialog", "ka_interval", 300)
|
|
modparam("dialog", "ka_interval", 300)
|
|
...
|
|
...
|
|
@@ -1112,7 +1127,7 @@ modparam("dialog", "ka_interval", 300)
|
|
6.15. dlg_set_timeout_by_profile(profile, [value], timeout)
|
|
6.15. dlg_set_timeout_by_profile(profile, [value], timeout)
|
|
6.16. dlg_set_property(attr)
|
|
6.16. dlg_set_property(attr)
|
|
|
|
|
|
-6.1. set_dlg_profile(profile,[value])
|
|
|
|
|
|
+6.1. set_dlg_profile(profile,[value])
|
|
|
|
|
|
Inserts the current dialog into a profile. Note that if the profile
|
|
Inserts the current dialog into a profile. Note that if the profile
|
|
does not support values, they will be silently discarded. Also, there
|
|
does not support values, they will be silently discarded. Also, there
|
|
@@ -1128,13 +1143,13 @@ modparam("dialog", "ka_interval", 300)
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
and FAILURE_ROUTE.
|
|
and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.48. set_dlg_profile usage
|
|
|
|
|
|
+ Example 1.49. set_dlg_profile usage
|
|
...
|
|
...
|
|
set_dlg_profile("inbound_call");
|
|
set_dlg_profile("inbound_call");
|
|
set_dlg_profile("caller","$fu");
|
|
set_dlg_profile("caller","$fu");
|
|
...
|
|
...
|
|
|
|
|
|
-6.2. unset_dlg_profile(profile,[value])
|
|
|
|
|
|
+6.2. unset_dlg_profile(profile,[value])
|
|
|
|
|
|
Removes the current dialog from a profile.
|
|
Removes the current dialog from a profile.
|
|
|
|
|
|
@@ -1147,13 +1162,13 @@ set_dlg_profile("caller","$fu");
|
|
This function can be used from BRANCH_ROUTE, REPLY_ROUTE and
|
|
This function can be used from BRANCH_ROUTE, REPLY_ROUTE and
|
|
FAILURE_ROUTE.
|
|
FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.49. unset_dlg_profile usage
|
|
|
|
|
|
+ Example 1.50. unset_dlg_profile usage
|
|
...
|
|
...
|
|
unset_dlg_profile("inbound_call");
|
|
unset_dlg_profile("inbound_call");
|
|
unset_dlg_profile("caller","$fu");
|
|
unset_dlg_profile("caller","$fu");
|
|
...
|
|
...
|
|
|
|
|
|
-6.3. is_in_profile(profile,[value])
|
|
|
|
|
|
+6.3. is_in_profile(profile,[value])
|
|
|
|
|
|
Checks if the current dialog belongs to a profile. If the profile
|
|
Checks if the current dialog belongs to a profile. If the profile
|
|
supports values, the check can be reinforced to take into account a
|
|
supports values, the check can be reinforced to take into account a
|
|
@@ -1170,7 +1185,7 @@ unset_dlg_profile("caller","$fu");
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
and FAILURE_ROUTE.
|
|
and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.50. is_in_profile usage
|
|
|
|
|
|
+ Example 1.51. is_in_profile usage
|
|
...
|
|
...
|
|
if (is_in_profile("inbound_call")) {
|
|
if (is_in_profile("inbound_call")) {
|
|
log("this request belongs to a inbound call\n");
|
|
log("this request belongs to a inbound call\n");
|
|
@@ -1181,7 +1196,7 @@ if (is_in_profile("caller","XX")) {
|
|
}
|
|
}
|
|
...
|
|
...
|
|
|
|
|
|
-6.4. get_profile_size(profile,[value],size)
|
|
|
|
|
|
+6.4. get_profile_size(profile,[value],size)
|
|
|
|
|
|
Returns the number of dialogs belonging to a profile. If the profile
|
|
Returns the number of dialogs belonging to a profile. If the profile
|
|
supports values, the check can be reinforced to take into account a
|
|
supports values, the check can be reinforced to take into account a
|
|
@@ -1199,7 +1214,7 @@ if (is_in_profile("caller","XX")) {
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
and FAILURE_ROUTE.
|
|
and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.51. get_profile_size usage
|
|
|
|
|
|
+ Example 1.52. get_profile_size usage
|
|
...
|
|
...
|
|
if(get_profile_size("inbound_call","$avp(size)"))
|
|
if(get_profile_size("inbound_call","$avp(size)"))
|
|
xlog("currently there are $avp(size) inbound calls\n");
|
|
xlog("currently there are $avp(size) inbound calls\n");
|
|
@@ -1208,7 +1223,7 @@ if(get_profile_size("caller","$fu","$avp(size)"))
|
|
xlog("currently, the user $fu has $avp(size) active outgoing calls\n");
|
|
xlog("currently, the user $fu has $avp(size) active outgoing calls\n");
|
|
...
|
|
...
|
|
|
|
|
|
-6.5. dlg_isflagset(flag)
|
|
|
|
|
|
+6.5. dlg_isflagset(flag)
|
|
|
|
|
|
Check if the dialog flag is set or not.
|
|
Check if the dialog flag is set or not.
|
|
|
|
|
|
@@ -1218,7 +1233,7 @@ if(get_profile_size("caller","$fu","$avp(size)"))
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.52. dlg_isflagset usage
|
|
|
|
|
|
+ Example 1.53. dlg_isflagset usage
|
|
...
|
|
...
|
|
if(dlg_isflagset("1"))
|
|
if(dlg_isflagset("1"))
|
|
{
|
|
{
|
|
@@ -1226,7 +1241,7 @@ if(dlg_isflagset("1"))
|
|
}
|
|
}
|
|
...
|
|
...
|
|
|
|
|
|
-6.6. dlg_setflag(flag)
|
|
|
|
|
|
+6.6. dlg_setflag(flag)
|
|
|
|
|
|
Set the dialog flag.
|
|
Set the dialog flag.
|
|
|
|
|
|
@@ -1236,12 +1251,12 @@ if(dlg_isflagset("1"))
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.53. dlg_setflag usage
|
|
|
|
|
|
+ Example 1.54. dlg_setflag usage
|
|
...
|
|
...
|
|
dlg_setflag("1");
|
|
dlg_setflag("1");
|
|
...
|
|
...
|
|
|
|
|
|
-6.7. dlg_resetflag(flag)
|
|
|
|
|
|
+6.7. dlg_resetflag(flag)
|
|
|
|
|
|
Reset the dialog flag.
|
|
Reset the dialog flag.
|
|
|
|
|
|
@@ -1251,12 +1266,12 @@ dlg_setflag("1");
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.54. dlg_resetflag usage
|
|
|
|
|
|
+ Example 1.55. dlg_resetflag usage
|
|
...
|
|
...
|
|
redlg_setflag("1");
|
|
redlg_setflag("1");
|
|
...
|
|
...
|
|
|
|
|
|
-6.8. dlg_bye(side)
|
|
|
|
|
|
+6.8. dlg_bye(side)
|
|
|
|
|
|
Send BYE to both parties of a dialog.
|
|
Send BYE to both parties of a dialog.
|
|
|
|
|
|
@@ -1267,12 +1282,12 @@ redlg_setflag("1");
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.55. dlg_bye usage
|
|
|
|
|
|
+ Example 1.56. dlg_bye usage
|
|
...
|
|
...
|
|
dlg_bye("all");
|
|
dlg_bye("all");
|
|
...
|
|
...
|
|
|
|
|
|
-6.9. dlg_refer(side, address)
|
|
|
|
|
|
+6.9. dlg_refer(side, address)
|
|
|
|
|
|
Refer the 'side' to a new SIP 'address'.
|
|
Refer the 'side' to a new SIP 'address'.
|
|
|
|
|
|
@@ -1284,12 +1299,12 @@ dlg_bye("all");
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.56. dlg_refer usage
|
|
|
|
|
|
+ Example 1.57. dlg_refer usage
|
|
...
|
|
...
|
|
dlg_refer("caller", "sip:[email protected]");
|
|
dlg_refer("caller", "sip:[email protected]");
|
|
...
|
|
...
|
|
|
|
|
|
-6.10. dlg_manage()
|
|
|
|
|
|
+6.10. dlg_manage()
|
|
|
|
|
|
Process current SIP request with dialog module. It is an alternative to
|
|
Process current SIP request with dialog module. It is an alternative to
|
|
setting dialog flag for initial INVITE and Route-parameter-callback
|
|
setting dialog flag for initial INVITE and Route-parameter-callback
|
|
@@ -1297,7 +1312,7 @@ dlg_refer("caller", "sip:[email protected]");
|
|
|
|
|
|
This function can be used from REQUEST_ROUTE.
|
|
This function can be used from REQUEST_ROUTE.
|
|
|
|
|
|
- Example 1.57. dlg_manage usage
|
|
|
|
|
|
+ Example 1.58. dlg_manage usage
|
|
...
|
|
...
|
|
modparam("dialog", "default_timeout", 100)
|
|
modparam("dialog", "default_timeout", 100)
|
|
...
|
|
...
|
|
@@ -1313,25 +1328,25 @@ route {
|
|
}
|
|
}
|
|
...
|
|
...
|
|
|
|
|
|
-6.11. dlg_bridge(from, to, op)
|
|
|
|
|
|
+6.11. dlg_bridge(from, to, op)
|
|
|
|
|
|
Bridge 'from' SIP address to 'to' SIP address via outbound proxy 'op'.
|
|
Bridge 'from' SIP address to 'to' SIP address via outbound proxy 'op'.
|
|
|
|
|
|
Meaning of the parameters is as follows:
|
|
Meaning of the parameters is as follows:
|
|
* from - SIP address of first side to call.
|
|
* from - SIP address of first side to call.
|
|
- * to - SIP address to refer “from� to.
|
|
|
|
|
|
+ * to - SIP address to refer "from" to.
|
|
* op - outbound proxy SIP address.
|
|
* op - outbound proxy SIP address.
|
|
|
|
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.58. dlg_bridge usage
|
|
|
|
|
|
+ Example 1.59. dlg_bridge usage
|
|
...
|
|
...
|
|
dlg_bridge("sip:[email protected]", "sip:[email protected]",
|
|
dlg_bridge("sip:[email protected]", "sip:[email protected]",
|
|
"sip:kamailio.org:5080");
|
|
"sip:kamailio.org:5080");
|
|
...
|
|
...
|
|
|
|
|
|
-6.12. dlg_get(callid, ftag, ttag)
|
|
|
|
|
|
+6.12. dlg_get(callid, ftag, ttag)
|
|
|
|
|
|
Search and set current dialog based on Call-ID, From-Tag and To-Tag
|
|
Search and set current dialog based on Call-ID, From-Tag and To-Tag
|
|
parameters.
|
|
parameters.
|
|
@@ -1344,7 +1359,7 @@ dlg_bridge("sip:[email protected]", "sip:[email protected]",
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
ONREPLY_ROUTE and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.59. dlg_get usage
|
|
|
|
|
|
+ Example 1.60. dlg_get usage
|
|
...
|
|
...
|
|
if(dlg_get("abcdef", "123", "456"))
|
|
if(dlg_get("abcdef", "123", "456"))
|
|
{
|
|
{
|
|
@@ -1352,7 +1367,7 @@ if(dlg_get("abcdef", "123", "456"))
|
|
}
|
|
}
|
|
...
|
|
...
|
|
|
|
|
|
-6.13. is_known_dlg()
|
|
|
|
|
|
+6.13. is_known_dlg()
|
|
|
|
|
|
This function checks if the current SIP message being processed belongs
|
|
This function checks if the current SIP message being processed belongs
|
|
to any transaction within an active dialog that the dialog module is
|
|
to any transaction within an active dialog that the dialog module is
|
|
@@ -1368,7 +1383,7 @@ if(dlg_get("abcdef", "123", "456"))
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
|
|
and FAILURE_ROUTE.
|
|
and FAILURE_ROUTE.
|
|
|
|
|
|
- Example 1.60. is_known_dlg() usage
|
|
|
|
|
|
+ Example 1.61. is_known_dlg() usage
|
|
...
|
|
...
|
|
if(!uri == myself) {
|
|
if(!uri == myself) {
|
|
if(is_known_dlg()) {
|
|
if(is_known_dlg()) {
|
|
@@ -1377,7 +1392,7 @@ if(!uri == myself) {
|
|
}
|
|
}
|
|
...
|
|
...
|
|
|
|
|
|
-6.14. dlg_set_timeout(timeout [, h_entry, h_id])
|
|
|
|
|
|
+6.14. dlg_set_timeout(timeout [, h_entry, h_id])
|
|
|
|
|
|
Set the dialog timeout. Dialog timeout will be updated if it was
|
|
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
|
|
already set. If h_entry and h_id parameters are not provided, the
|
|
@@ -1392,7 +1407,7 @@ if(!uri == myself) {
|
|
|
|
|
|
This function can be used from ANY_ROUTE.
|
|
This function can be used from ANY_ROUTE.
|
|
|
|
|
|
- Example 1.61. dlg_set_timeout usage
|
|
|
|
|
|
+ Example 1.62. dlg_set_timeout usage
|
|
...
|
|
...
|
|
if(dlg_set_timeout("180", "123", "456"))
|
|
if(dlg_set_timeout("180", "123", "456"))
|
|
{
|
|
{
|
|
@@ -1400,7 +1415,7 @@ if(dlg_set_timeout("180", "123", "456"))
|
|
}
|
|
}
|
|
...
|
|
...
|
|
|
|
|
|
-6.15. dlg_set_timeout_by_profile(profile, [value], timeout)
|
|
|
|
|
|
+6.15. dlg_set_timeout_by_profile(profile, [value], timeout)
|
|
|
|
|
|
Like dlg_set_timeout(), but simultaneously sets the timeout of all
|
|
Like dlg_set_timeout(), but simultaneously sets the timeout of all
|
|
dialogs in a given profile. Can be constrained by profile value.
|
|
dialogs in a given profile. Can be constrained by profile value.
|
|
@@ -1414,7 +1429,7 @@ if(dlg_set_timeout("180", "123", "456"))
|
|
|
|
|
|
This function can be used from ANY_ROUTE.
|
|
This function can be used from ANY_ROUTE.
|
|
|
|
|
|
- Example 1.62. dlg_set_timeout_by_profile usage
|
|
|
|
|
|
+ Example 1.63. dlg_set_timeout_by_profile usage
|
|
...
|
|
...
|
|
# All dialogs belonging to user abc123 (tracked via set_dlg_profile())
|
|
# All dialogs belonging to user abc123 (tracked via set_dlg_profile())
|
|
# will be timed out in 3 seconds.
|
|
# will be timed out in 3 seconds.
|
|
@@ -1422,7 +1437,7 @@ if(dlg_set_timeout("180", "123", "456"))
|
|
dlg_set_timeout_by_profile("users", "abc123", "3");
|
|
dlg_set_timeout_by_profile("users", "abc123", "3");
|
|
...
|
|
...
|
|
|
|
|
|
-6.16. dlg_set_property(attr)
|
|
|
|
|
|
+6.16. dlg_set_property(attr)
|
|
|
|
|
|
Set a dialog property - an attribute that enable/disable various
|
|
Set a dialog property - an attribute that enable/disable various
|
|
behaviours (e.g., sending keep alive requests).
|
|
behaviours (e.g., sending keep alive requests).
|
|
@@ -1441,7 +1456,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
|
|
|
|
|
|
This function can be used from ANY_ROUTE.
|
|
This function can be used from ANY_ROUTE.
|
|
|
|
|
|
- Example 1.63. dlg_set_property usage
|
|
|
|
|
|
+ Example 1.64. dlg_set_property usage
|
|
...
|
|
...
|
|
dlg_set_property("ka-src");
|
|
dlg_set_property("ka-src");
|
|
dlg_set_property("ka-dst");
|
|
dlg_set_property("ka-dst");
|
|
@@ -1511,12 +1526,12 @@ dlg_set_property("ka-dst");
|
|
|
|
|
|
8.2. dlg_list_ctx
|
|
8.2. dlg_list_ctx
|
|
|
|
|
|
- The same as the “dlg_list� but including in the dialog description the
|
|
|
|
|
|
+ The same as the "dlg_list" but including in the dialog description the
|
|
associated context from modules sitting on top of the dialog module.
|
|
associated context from modules sitting on top of the dialog module.
|
|
|
|
|
|
Name: dlg_list_ctx
|
|
Name: dlg_list_ctx
|
|
|
|
|
|
- Parameters: see “dlg_list�
|
|
|
|
|
|
+ Parameters: see "dlg_list"
|
|
|
|
|
|
MI FIFO Command Format:
|
|
MI FIFO Command Format:
|
|
:dlg_list_ctx:_reply_fifo_file_
|
|
:dlg_list_ctx:_reply_fifo_file_
|
|
@@ -1649,7 +1664,7 @@ dlg_set_property("ka-dst");
|
|
|
|
|
|
9.2. dlg.list_ctx
|
|
9.2. dlg.list_ctx
|
|
|
|
|
|
- The same as the “dlg_list� but including in the dialog description the
|
|
|
|
|
|
+ The same as the "dlg_list" but including in the dialog description the
|
|
associated context from modules sitting on top of the dialog module.
|
|
associated context from modules sitting on top of the dialog module.
|
|
|
|
|
|
Name: dlg.list_ctx
|
|
Name: dlg.list_ctx
|
|
@@ -1674,13 +1689,13 @@ dlg_set_property("ka-dst");
|
|
|
|
|
|
9.4. dlg.dlg_list_ctx
|
|
9.4. dlg.dlg_list_ctx
|
|
|
|
|
|
- The same as the “dlg.list_ctx� but including in the dialog description
|
|
|
|
|
|
+ The same as the "dlg.list_ctx" but including in the dialog description
|
|
the associated context from modules sitting on top of the dialog
|
|
the associated context from modules sitting on top of the dialog
|
|
module.
|
|
module.
|
|
|
|
|
|
Name: dlg.dlg_list_ctx
|
|
Name: dlg.dlg_list_ctx
|
|
|
|
|
|
- Parameters: see “dlg_list�
|
|
|
|
|
|
+ Parameters: see "dlg_list"
|
|
|
|
|
|
RPC Command Format:
|
|
RPC Command Format:
|
|
serctl dlg.list_ctx [email protected] AAdfeEFF33
|
|
serctl dlg.list_ctx [email protected] AAdfeEFF33
|
|
@@ -1837,7 +1852,7 @@ Chapter 2. Developer Guide
|
|
1.1. register_dlgcb (dialog, type, cb, param, free_param_cb)
|
|
1.1. register_dlgcb (dialog, type, cb, param, free_param_cb)
|
|
1.2. terminate_dlg (dlg, hdrs)
|
|
1.2. terminate_dlg (dlg, hdrs)
|
|
|
|
|
|
-1.1. register_dlgcb (dialog, type, cb, param, free_param_cb)
|
|
|
|
|
|
+1.1. register_dlgcb (dialog, type, cb, param, free_param_cb)
|
|
|
|
|
|
Register a new callback to the dialog.
|
|
Register a new callback to the dialog.
|
|
|
|
|
|
@@ -1879,14 +1894,14 @@ Chapter 2. Developer Guide
|
|
+ DLGCB_SPIRALED - called when the dialog matches a spiraling
|
|
+ DLGCB_SPIRALED - called when the dialog matches a spiraling
|
|
request - it's a per dialog type.
|
|
request - it's a per dialog type.
|
|
+ DLGCB_DESTROY
|
|
+ DLGCB_DESTROY
|
|
- * dialog_cb cb - callback function to be called. Prototype is: “void
|
|
|
|
|
|
+ * dialog_cb cb - callback function to be called. Prototype is: "void
|
|
(dialog_cb) (struct dlg_cell* dlg, int type, struct dlg_cb_params *
|
|
(dialog_cb) (struct dlg_cell* dlg, int type, struct dlg_cb_params *
|
|
- params); �
|
|
|
|
|
|
+ params); "
|
|
* void *param - parameter to be passed to the callback function.
|
|
* void *param - parameter to be passed to the callback function.
|
|
* param_free callback_param_free - callback function to be called to
|
|
* param_free callback_param_free - callback function to be called to
|
|
- free the param. Prototype is: “void (param_free_cb) (void *param);�
|
|
|
|
|
|
+ free the param. Prototype is: "void (param_free_cb) (void *param);"
|
|
|
|
|
|
-1.2. terminate_dlg (dlg, hdrs)
|
|
|
|
|
|
+1.2. terminate_dlg (dlg, hdrs)
|
|
|
|
|
|
Terminate a Dialog
|
|
Terminate a Dialog
|
|
|
|
|
|
@@ -1897,46 +1912,46 @@ Chapter 2. Developer Guide
|
|
|
|
|
|
Chapter 3. Frequently Asked Questions
|
|
Chapter 3. Frequently Asked Questions
|
|
|
|
|
|
- 3.1. What happend with “use_tight_match� parameter?
|
|
|
|
|
|
+ 3.1. What happend with "use_tight_match" parameter?
|
|
3.2. Where can I find more about Kamailio?
|
|
3.2. Where can I find more about Kamailio?
|
|
3.3. Where can I post a question about this module?
|
|
3.3. Where can I post a question about this module?
|
|
3.4. How can I report a bug?
|
|
3.4. How can I report a bug?
|
|
|
|
|
|
3.1.
|
|
3.1.
|
|
|
|
|
|
- What happend with “use_tight_match� parameter?
|
|
|
|
|
|
+ What happend 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).
|
|
|
|
|
|
+ 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.
|
|
3.2.
|
|
|
|
|
|
- Where can I find more about Kamailio?
|
|
|
|
|
|
+ Where can I find more about Kamailio?
|
|
|
|
|
|
- Take a look at http://www.kamailio.org/.
|
|
|
|
|
|
+ Take a look at http://www.kamailio.org/.
|
|
|
|
|
|
3.3.
|
|
3.3.
|
|
|
|
|
|
- Where can I post a question about this module?
|
|
|
|
|
|
+ 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:
|
|
|
|
- * User Mailing List -
|
|
|
|
- http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
|
|
|
|
- * Developer Mailing List -
|
|
|
|
- http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
|
|
|
|
|
|
+ First at all check if your question was already answered on one of our
|
|
|
|
+ mailing lists:
|
|
|
|
+ * User Mailing List -
|
|
|
|
+ http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
|
|
|
|
+ * Developer Mailing List -
|
|
|
|
+ http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
|
|
|
|
|
|
- E-mails regarding any stable Kamailio release should be sent to
|
|
|
|
- <[email protected]> and e-mails regarding development
|
|
|
|
- versions should be sent to <[email protected]>.
|
|
|
|
|
|
+ E-mails regarding any stable Kamailio release should be sent to
|
|
|
|
+ <[email protected]> and e-mails regarding development
|
|
|
|
+ versions should be sent to <[email protected]>.
|
|
|
|
|
|
- If you want to keep the mail private, send it to
|
|
|
|
- <[email protected]>.
|
|
|
|
|
|
+ If you want to keep the mail private, send it to
|
|
|
|
+ <[email protected]>.
|
|
|
|
|
|
3.4.
|
|
3.4.
|
|
|
|
|
|
- How can I report a bug?
|
|
|
|
|
|
+ How can I report a bug?
|
|
|
|
|
|
- Please follow the guidelines provided at:
|
|
|
|
- http://sip-router.org/tracker.
|
|
|
|
|
|
+ Please follow the guidelines provided at:
|
|
|
|
+ http://sip-router.org/tracker.
|