– Kamailio SIP Server –

Table of Contents

OpenSER 1.1.x Examples Index

A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T|T]],U,V,W,X,Y,Z$

[[A]]

Example Module Comment
acc_db_request usage acc user comment
Set "acc_db_table" parameter uac_redirect user comment
acc_diam_request usage acc user comment
acc_domain_column example acc user comment
acc_dst_leg_column example acc user comment
Set "accept" parameter options user comment
Set "accept_encoding" parameter options user comment
Set "accept_filter"module parameter uac_redirect user comment
Set "accept_language" parameter options user comment
acc_fromtag_column example acc user comment
acc_from_uri_column example acc user comment
Set "acc_function" parameter uac_redirect user comment
acc_i_uri_column example acc user comment
acc_log_request usage acc user comment
acc_o_uri_column example acc user comment
acc_rad_request usage acc user comment
acc_sip_callid_column example acc user comment
acc_sip_from_column example acc user comment
acc_sip_method_column example acc user comment
acc_sip_status_column example acc user comment
acc_sip_to_column example acc user comment
acc_src_leg_column example acc user comment
acc_time_column example acc user comment
acc_totag_column example acc user comment
acc_to_uri_column example acc user comment
acc_user_column example acc user comment
"add_diversion" usage diversion user comment
"add_path" usage path user comment
"add_path_received"() usage path user comment
"add_rcv_paramer" usage nathelper user comment
"add_rr_param" usage rr user comment
"add_sock_hdr" usage registrar user comment
"add_uri_param" usage uri user comment
Set "add_username" parameter rr user comment
alias_db sql script alias_db user comment
"alias_db_lookup"() usage alias_db user comment
Set "alias_domain_column" parameter alias_db user comment
Set "alias_user_column" parameter alias_db user comment
"allow_refer_to"(basename) usage permissions user comment
"allow_register"(basename) usage permissions user comment
"allow_routing" usage permissions user comment
Set "allow_suffix" parameter permissions user comment
"allow_trusted"() usage permissions user comment
Set "append_branches" parameter registrar user comment
Set "append_fromtag" parameter rr user comment
"append_hf" usage textops user comment
append_rpid_hf usage auth user comment
append_rpid_hf(prefix, suffix) usage auth user comment
"append_time" usage textops user comment
"append_to_reply" usage textops user comment
"append_urihf" usage textops user comment
Set "attribute_column" parameter avpops user comment
Set "auth_password_avp" parameter uac user comment
Set "auth_realm_avp" parameter uac user comment
Set "auth_username_avp" parameter uac user comment
Set "auto_reconnect" parameter mysql user comment
AVP naming examples avpops user comment
Set "avp_aliases" parameter avpops user comment
"avp_check" usage avpops user comment
"avp_copy" usage avpops user comment
"avp_db_delete" usage avpops user comment
"avp_db_load" usage avpops user comment
"avp_db_query" usage avpops user comment
"avp_db_store" usage avpops user comment
"avp_delete" usage avpops user comment
"avp_load_radius"() usage avp_radius user comment
"avp_op" usage avpops user comment
"avp_print" usage avpops user comment
"avp_printf" usage avpops user comment
"avp_pushto" usage avpops user comment
"avp_subst" usage avpops user comment
Set "avp_table" parameter avpops user comment
Set "avp_url" parameter avpops user comment
"avp_write" usage avpops user comment

[[B]]

Example Module Comment
Set "branch_flag_mask" parameter tm user comment
Set "buf_size" parameter xlog user comment

[[C]]

Example Module Comment
Set "cache_time" parameter jabber user comment
"calculate_ha1" parameter usage auth_db user comment
"callee_service_type" parameter usage avp_radius user comment
"caller_service_type" parameter usage avp_radius user comment
Set "callid_column" parameter usrloc user comment
Set "case_sensitive" parameter cpl-c user comment
Set "check_all_branches" parameter permissions user comment
checkcallingtranslation usage osp user comment
"check_from" usage uri_db user comment
checkospheader usage osp user comment
checkosproute usage osp user comment
"check_route_param" usage rr user comment
Set "check_time" parameter jabber user comment
"check_to" usage uri_db user comment
Set the ""clean_period"" parameter msilo user comment
Set "clean_time" parameter pdt user comment
"client_nat_test" usage mediaproxy user comment
Set the ""cnt_avp_id"" parameter dispatcher user comment
Configuration file dbtext user comment
consume_credentials example auth user comment
Setting "contact_avp" module parameter lcr user comment
Set "contact_column" parameter usrloc user comment
Set "cpl_bin_column" parameter cpl-c user comment
Set "cpl_dtd_file" parameter cpl-c user comment
"cpl_process_register" usage cpl-c user comment
"cpl_process_register_norpl" usage cpl-c user comment
"cpl_run_script" usage cpl-c user comment
Set "cpl_table" parameter cpl-c user comment
Set "cpl_xml_column" parameter cpl-c user comment
Set "credential" parameter uac user comment
Set "cseq_column" parameter usrloc user comment
Set "cseq_delay" parameter usrloc user comment

[[D]]

Example Module Comment
db_extra example acc user comment
db_flag example acc user comment
db_localtime example acc user comment
db_missed_flag example acc user comment
Setting "db_mode" module parameter lcr user comment
Set "db_scheme" parameter avpops user comment
db_table_acc example acc user comment
Set the ""db_table"" parameter msilo user comment
db_table_missed_calls example acc user comment
db_url example acc user comment
Set "db_url" parameter alias_db user comment
"decode_contact" usage mangler user comment
"decode_contact_header" usage mangler user comment
Set "default_allow_file" parameter permissions user comment
Set "default_deny_file" parameter permissions user comment
Set "default_expires" parameter pa user comment
Set "default_filter"module parameter uac_redirect user comment
Set "default_net" parameter sms user comment
Set "default_q" parameter registrar user comment
Set "default_timeout" parameter dialog user comment
Definition of 'location' and 'aliases' tables (one line) dbtext user comment
Definition of 'subscriber' table (one line) dbtext user comment
Definition of 'version' table and sample records dbtext user comment
Set "delay_time" parameter jabber user comment
Set "delete_timer" parameter tm user comment
Set "deny_filter"module parameter uac_redirect user comment
Set "deny_suffix" parameter permissions user comment
Set "desc_time_order" parameter registrar user comment
detect_direction example acc user comment
Dialog support in RR module rr user comment
diameter_client_host example acc user comment
Set "diameter_client_host" parameter auth_diameter user comment
Set "diameter_client_port" parameter auth_diameter user comment
diameter_extra example acc user comment
diameter_flag example acc user comment
"diameter_is_user_in" usage auth_diameter user comment
diameter_missed_flag example acc user comment
"diameter_proxy_authorize" usage auth_diameter user comment
"diameter_www_authorize" usage auth_diameter user comment
Digest Authentication auth_diameter user comment
dispatcher list file dispatcher user comment
Set "dlg_flag" parameter dialog user comment
"does_uri_exist" usage uri_db user comment
Set "domain_column" parameter alias_db user comment
Set "domain_prefix" parameter alias_db user comment
Set "domain_str" parameter sms user comment
"ds_select_dst" usage dispatcher user comment
Set the ""dst_avp_id"" parameter dispatcher user comment
dst_leg_avp_id example acc user comment
Set "duplicate_uri" parameter siptrace user comment

[[E]]

Example Module Comment
early_media example acc user comment
Set "enable_double_rr" parameter rr user comment
Set "enable_full_lr" parameter rr user comment
enable_stats example sl user comment
Set "enable_stats" parameter dialog user comment
"encode_contact" usage mangler user comment
"end_media_session" usage mediaproxy user comment
"enum_fquery" usage enum user comment
"enum_query" usage enum user comment
Example of TLS logging tlsops user comment
"exec_dset" usage exec user comment
"exec_msg" usage exec user comment
Set "expires_column" parameter usrloc user comment
Set the ""expire_time"" parameter msilo user comment

[[F]]

Example Module Comment
failed_transaction_flag example acc user comment
"fix_contact" usage mediaproxy user comment
"fix_nated_contact" usage nathelper user comment
"fix_nated_register" usage nathelper user comment
"fix_nated_sdp" usage nathelper user comment
Set "flags_column" parameter usrloc user comment
Set the ""flags"" parameter dispatcher user comment
Set ""flush"" parameter flatstore user comment
Set "force_color" parameter xlog user comment
Set the ""force_dst"" parameter dispatcher user comment
"force_rtp_proxy" usage nathelper user comment
Set "force_socket" parameter nathelper user comment
Setting "fr_inv_timer_avp" module parameter lcr user comment
Setting "fr_inv_timer" module parameter lcr user comment
Setting "fr_inv_timer_next" module parameter lcr user comment
Set "from_col" parameter permissions user comment
"from_gw" usage lcr user comment
Set "from_passwd" parameter uac user comment
Set "from_restore_mode" parameter uac user comment
Setting "from_uri_column" module parameter lcr user comment
Set "fr_timer_avp" parameter tm user comment
Set "fr_timer" parameter tm user comment

[[G]]

Example Module Comment
"get_gflags" usage gflags user comment
"get_redirects" usage uac_redirect user comment
"get_user_group" usage group user comment
Set "group_column" parameter group user comment
Set the ""grp_avp_id"" parameter dispatcher user comment
Setting "grp_id_column" module parameter lcr user comment
Setting "gw_name_column" module parameter lcr user comment
Setting "gw_table" module parameter lcr user comment
Setting "gw_uri_avp" module parameter lcr user comment

[[H]]

Example Module Comment
"handle_subscription" usage pa user comment
"has_body" usage textops user comment
Set "hash_size" parameter dialog user comment
"has_totag" usage uri user comment
Set "hsize_2pow" parameter pdt user comment

[[I]]

Example Module Comment
"initial" parameter usage gflags user comment
"insert_hf" usage textops user comment
Instructing the module to use calling number in Remote-Party-ID osp user comment
Instructing the module to validate call id osp user comment
Setting "ip_addr_column" module parameter lcr user comment
IP pike user comment
"is_avp_set" usage avpops user comment
is_domain_local usage domain user comment
is_from_local usage domain user comment
"is_from_user_e164" usage enum user comment
"is_from_user_enum" usage enum user comment
"is_gflag"() usage gflags user comment
"is_maxfwd_lt" usage maxfwd user comment
"is_method" usage textops user comment
"is_peer_verified" usage tlsops user comment
"is_present_hf" usage textops user comment
is_rpid_user_e164 usage auth user comment
is_uri_host_local usage domain user comment
"is_user" usage uri user comment
"is_user_in" usage group user comment

[[J]]

Example Module Comment
"jab_exit_jconf"() usage jabber user comment
"jab_go_offline"() usage jabber user comment
"jab_go_online"() usage jabber user comment
"jab_join_jconf"() usage jabber user comment
"jab_send_message"() usage jabber user comment
Set "jaddress" parameter jabber user comment
Set "jdomain" parameter jabber user comment
Set "jport" parameter jabber user comment

[[L]]

Example Module Comment
Setting "lcr_table" module parameter lcr user comment
Set "links" parameter sms user comment
Set the ""list_file"" parameter dispatcher user comment
Load the dbtext module dbtext user comment
"load_contacts" usage lcr user comment
"load_credentials" parameter usage auth_db user comment
"load_gws" usage lcr user comment
Loading RR module's API from another module rr user comment
Set "log_dir" parameter cpl-c user comment
log_extra example acc user comment
log_flag example acc user comment
log_fmt example acc user comment
log_level example acc user comment
log_missed_flag example acc user comment
Set "lookup_append_branches"parameter cpl-c user comment
"lookup" usage registrar user comment
Set "lookup_domain" parameter cpl-c user comment
"loose_route" usage rr user comment

[[M]]

Example Module Comment
Set "matching_mode" parameter usrloc user comment
Set "max_contacts" parameter registrar user comment
Set "max_expires" parameter registrar user comment
Set "max_jobs" parameter jabber user comment
Set "max_limit" parameter maxfwd user comment
Set "max_sms_parts" parameter sms user comment
Setting "mediaproxy_socket" parameter mediaproxy user comment
Set "method_filtering" parameter registrar user comment
Set "methods_column" parameter usrloc user comment
Set "min_expires" parameter registrar user comment
Minimal OpenSER location dbtext table definition dbtext user comment
Minimal OpenSER subscriber dbtext table example dbtext user comment
Set "modems" parameter sms user comment
msilo sql script msilo user comment
multi_leg_enabled example acc user comment
Set "multiple_gid" parameter group user comment
"mx_process_maxfwd_header" usage maxfwd user comment

[[N]]

Example Module Comment
Set "nat_flag" parameter cpl-c user comment
Setting "natping_interval" parameter mediaproxy user comment
Set "networks" parameter sms user comment
Set "new_uri_column" parameter speeddial user comment
"next_contacts" usage from route block lcr user comment
"next_gw" usage from a route block lcr user comment
Set "noisy_ctimer" parameter tm user comment
nonce_expire example domain user comment
nonce_expire parameter example auth user comment

[[O]]

Example Module Comment
OpenSER config script - sample dispatcher usage dispatcher user comment
OpenSER config script - sample msilo usage msilo user comment
OpenSER config script - sample speeddial usage speeddial user comment
"options_reply" usage options user comment

[[P]]

Example Module Comment
Set "param_name" parameter uri_radius user comment
Set "pass_provisional_replies" parameter tm user comment
"password_column_2" parameter usage auth_db user comment
"password_column" parameter usage auth_db user comment
Set "path_mode" parameter registrar user comment
Set "path_use_received" parameter registrar user comment
Set "peer_tag_avp" parameter permissions user comment
"pike_check_req" usage pike user comment
Pinging exmaple configuration mediaproxy user comment
Set "ping_interval" parameter mysql user comment
Set "ping_nated_only" parameter nathelper user comment
Setting "port_column" module parameter lcr user comment
"prefix2domain" usage pdt user comment
Setting "prefix_column" module parameter lcr user comment
Set "prefix" parameter pdt user comment
prefix-domain translation pdt user comment
prepareallosproute usage osp user comment
prepareosproute usage osp user comment
Setting "priority_column" module parameter lcr user comment
Set "proto_col" parameter permissions user comment
proxy_authorize usage auth_db user comment
"proxy_authorize" usage auth_radius user comment
proxy_challenge usage auth user comment
Set "proxy" parameter jabber user comment
Set "proxy_recurse" parameter cpl-c user comment
Set "proxy_route" parameter cpl-c user comment

[[Q]]

Example Module Comment
Set "q_column" parameter usrloc user comment

[[R]]

Example Module Comment
radius_config example acc user comment
"radius_config" parameter usage auth_radius user comment
"radius_does_uri_exist" usage uri_radius user comment
radius_extra example acc user comment
radius_flag example acc user comment
"radius_is_user_in" usage group_radius user comment
radius_missed_flag example acc user comment
"radius_www_authorize" usage auth_radius user comment
realm_prefix parameter example auth user comment
Set "realm_prefix" parameter cpl-c user comment
Set "received_avp" parameter nathelper user comment
Set "received_column" parameter usrloc user comment
Set "received_param" parameter registrar user comment
"record_route" usage rr user comment
"record_route_preset" usage rr user comment
Redirection script example uac_redirect user comment
Set "reg_exp_column" parameter group user comment
Set "re_gid_column" parameter group user comment
"registered" usage registrar user comment
Set "registrar" parameter jabber user comment
Set the ""reminder"" parameter msilo user comment
"remove_hf" usage textops user comment
Set "remove_latency" parameter pike user comment
"replace_all" usage textops user comment
"replace_body_all" usage textops user comment
"replace_body" usage textops user comment
"replace" usage textops user comment
report_ack example acc user comment
report_cancels example acc user comment
reportospusage usage osp user comment
Set "reqs_density_per_unit" parameter pike user comment
requestosprouting usage osp user comment
"reset_gflag" usage gflags user comment
"reset_stat" usage statistics user comment
Set "restart_fr_on_each_reply" parameter tm user comment
Set "re_table" parameter group user comment
Set "retr_timer1p1" parameter tm user comment
Set "retr_timer1p2" parameter tm user comment
Set "retr_timer1p4" parameter tm user comment
Set "retr_timer2" parameter tm user comment
Set "retry_after" parameter registrar user comment
rpid_avp parameter example auth user comment
Setting "rpid_avp" module parameter lcr user comment
rpid_prefix parameter example auth user comment
rpid_suffix parameter example auth user comment
Set "rr_param" parameter dialog user comment
Set "rr_store_param" parameter uac user comment
Setting "rtp_asymmetrics" parameter mediaproxy user comment
Set "rtpproxy_disable" parameter nathelper user comment
Set "rtpproxy_disable_tout" parameter nathelper user comment
Set "rtpproxy_retr" parameter nathelper user comment
Set "rtpproxy_sock" parameter nathelper user comment
Set "rtpproxy_tout" parameter nathelper user comment
Set "ruri_matching" parameter tm user comment
Setting "ruri_user_avp" module parameter lcr user comment

[[S]]

Example Module Comment
Sample of a dbtext table dbtext user comment
Set "sampling_time_unit" parameter pike user comment
"save" usage registrar user comment
"save_memory" usage registrar user comment
"save_noreply" usage registrar user comment
Set "sd_domain_column" parameter speeddial user comment
"sd_lookup" usage speeddial user comment
Set "sdomain_column" parameter pdt user comment
"sdp_mangle_ip" usage mangler user comment
"sdp_mangle_port" usage mangler user comment
Set "sd_user_column" parameter speeddial user comment
"search_append_body" usage textops user comment
"search_append" usage textops user comment
"search_body" usage textops user comment
"search" usage textops user comment
secret parameter example auth user comment
Set the ""send_time"" parameter msilo user comment
service_type example acc user comment
"service_type" parameter usage auth_radius user comment
Set authorization files osp user comment
"set_accept_filter" usage uac_redirect user comment
"set_deny_filter" usage uac_redirect user comment
"set_gflag" usage gflags user comment
Setting db_url parameter domain user comment
Setting domain_col parameter domain user comment
Setting domain_suffix module parameter enum user comment
Setting domain_table parameter domain user comment
Setting tel_uri_params module parameter enum user comment
Setting the device IP address osp user comment
Setting the device port osp user comment
Setting the hardware support osp user comment
Setting the number of destination osp user comment
Setting the OSP server weights osp user comment
Setting the OSP servers osp user comment
Setting the persistence osp user comment
Setting the retry delay osp user comment
Setting the retry limit osp user comment
Setting the ssl lifetime osp user comment
Setting the timeout osp user comment
Setting the token format osp user comment
Set ""setvars"" parameter exec user comment
Setting "sip_asymmetrics" parameter mediaproxy user comment
""SIP-AVP"" RADIUS AVP exmaples auth_radius user comment
Set "sip_natping_flag" parameter registrar user comment
Set "sipping_from" parameter nathelper user comment
Set "sipping_method" parameter nathelper user comment
sip_trace sql siptrace user comment
"sip_trace"() usage siptrace user comment
Set "sleep_time" parameter jabber user comment
"sl_reply_error" usage sl user comment
"sl_send_reply" usage sl user comment
Set "sms_report_type" parameter sms user comment
"sms_send_msg" usage sms user comment
"sms_send_msg_to_net" usage sms user comment
Set the ""snd_time_avp"" parameter msilo user comment
Set "socket_column" parameter usrloc user comment
Set "sock_flag" parameter registrar user comment
Set "sock_hdr_namer" parameter registrar user comment
Set "source_col" parameter permissions user comment
speeddial sql script speeddial user comment
src_leg_avp_id example acc user comment
Setting "strip_column" module parameter lcr user comment
Set "subscriber_domain_column" parameter uri_db user comment
Set "subscriber_table" parameter uri_db user comment
Set "subscriber_user_column" parameter uri_db user comment
"subst_body" usage textops user comment
"subst" usage textops user comment
"subst_uri" usage textops user comment
"suffix" usage diversion user comment
Set "support" parameter options user comment
Set "sync_time" parameter pdt user comment

[[T]]

Example Module Comment
Set "table" parameter group user comment
Set "tag_col" parameter permissions user comment
"t_check_status" usage tm user comment
"t_check_trans" usage tm user comment
Set "tcp_persistent_flag" parameter registrar user comment
"tel2sip" usage uri user comment
"t_flush_flags" usage tm user comment
"t_forward_nonack" usage tm user comment
Set "timeout_avp" parameter dialog user comment
Set "timer_avp" parameter cpl-c user comment
Set "timer_interval" parameter usrloc user comment
"t_local_replied" usage tm user comment
"t_lookup_request" usage tm user comment

[[$]]

Example Module Comment
Example of "$tls_[peer|my]_[subject|issuer]" tlsops issuer]_comments|my]_[subject|issuer]_comments|user comment

[[T]]

Example Module Comment
"t_newtran" usage tm user comment
"to_gw" usage lcr user comment
"t_on_branch" usage tm user comment
"t_on_failure" usage tm user comment
"t_on_reply" usage tm user comment
Set "trace_flag" parameter siptrace user comment
Set "trace_on" parameter siptrace user comment
Setting "transport_column" moduleparameter lcr user comment
"t_relay" usage tm user comment
"t_release" usage tm user comment
"t_replicate" usage tm user comment
"t_reply" usage tm user comment
"t_retransmit_reply" usage tm user comment
Set "trusted_table" parameter permissions user comment
Set "tw_append" parameter tm user comment
"t_was_cancelled" usage tm user comment
"t_write_fifo/unix" usage tm user comment
Set "type_column" parameter avpops user comment

[[U]]

Example Module Comment
"uac_auth" usage uac user comment
"uac_replace_from" usage uac user comment
"uac_restore_from" usage uac user comment
"unforce_rtp_proxy" usage nathelper user comment
Set "unix_tx_timeout" parameter tm user comment
"update_stat" usage statistics user comment
Set "uri_domain_column" parameter uri_db user comment
"uri_param" usage uri user comment
Setting "uri_scheme_column" moduleparameter lcr user comment
Set "uri_table" parameter uri_db user comment
Set "uri_uriuser_column" parameter uri_db user comment
Set "uri_user_column" parameter uri_db user comment
Set "use_branch_flags" parameter registrar user comment
Set the ""use_contact"" parameter msilo user comment
Set the ""use_default"" parameter dispatcher user comment
Set "use_domain" parameter alias_db user comment
Set the ""use_escape_common"" parameter unixodbc user comment
"use_media_proxy" usage mediaproxy user comment
Set "use_path" parameter registrar user comment
Set "user_agent_column" parameter usrloc user comment
Set "user_column" parameter alias_db user comment
Set "use_received" parameter path user comment
Set the ""userid_avp"" parameter msilo user comment
Set "username_column" parameter avpops user comment
Set "use_tight_match" parameter dialog user comment
Set "use_uri_table" parameter uri_db user comment
Set "uuid_column" parameter avpops user comment

[[V]]

Example Module Comment
validateospheader usage osp user comment
Set "value_column" parameter avpops user comment
variable example statistics user comment
Set "via1_matching" parameter tm user comment

[[W]]

Example Module Comment
Set "workers" parameter jabber user comment
Set "wt_timer" parameter tm user comment
"www_authorize" usage auth_db user comment
www_challenge usage auth user comment

[[X]]

Example Module Comment
"xdbg" usage xlog user comment
"xlog" usage xlog user comment

Trace: • index-examples