This is an old revision of the document!

Modules Functions

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

[A]

Name	Module Path	Module Name
abort()	modules	cfgutils
acc_db_request(comment, table)	modules	acc
acc_diam_request(comment)	modules	acc
acc_log_request(comment)	modules	acc
acc_rad_request(comment)	modules	acc
acc_rad_request(comment)	modules	acc_radius
add_diversion(reason [, uri])	modules	diversion
alias_db_lookup(table_name)	modules	alias_db
append_attr_hf(header_name, $avp_name)	modules	avp
append_attr_hf(name)	modules	avp
append_branch([ uri, [ q ] ])	modules	corex
assign_server_unreg(aysnc_reply_route, domain, direction)	modules	ims_registrar_scscf
async_route(routename, seconds)	modules	async
async_sleep(seconds)	modules	async
async_task_route(routename)	modules	async
attr2uri($attribute[,uri-part])	modules	avp
attr_destination($avp_name)	modules	avp
attr_equals(attribute, value)	modules	avp
attr_equals_xl(attribute, xl_format)	modules	avp
attr_exists(attribute)	modules	avp
attr_to_reply(header_name, $avp_name)	modules	avp
attr_to_reply(name)	modules	avp
autheph_authenticate(username, password)	modules	auth_ephemeral
autheph_check(realm)	modules	auth_ephemeral
autheph_check_from([username])	modules	auth_ephemeral
autheph_check_timestamp(username)	modules	auth_ephemeral
autheph_check_to([username])	modules	auth_ephemeral
autheph_proxy(realm)	modules	auth_ephemeral
autheph_www(realm[, method])	modules	auth_ephemeral
auth_add_identity()	modules	auth_identity
auth_challenge(realm, flags)	modules	auth
auth_check(realm, table, flags)	modules	auth_db
auth_date_proc()	modules	auth_identity
auth_get_www_authenticate(realm, flags, pvdest)	modules	auth
auth_xkeys_add(hdr, kid, alg, data)	modules	auth_xkeys
auth_xkeys_check(hdr, kid, alg, data)	modules	auth_xkeys
avp_check(name,op_value)	modules	avpops
avp_copy(old_name,new_name)	modules	avpops
avp_db_delete(source,name)	modules	avpops
avp_db_load(source,name)	modules	avpops
avp_db_query(query[,dest])	modules	avpops
avp_db_store(source,name)	modules	avpops
avp_delete(name)	modules	avpops
avp_op(name,op_value)	modules	avpops
avp_print()	modules	avpops
avp_printf(dest, format)	modules	avpops
avp_pushto(destination,name)	modules	avpops
avp_subst(avps, subst)	modules	avpops

[B]

Name	Module Path	Module Name
blst_add([timeout])	modules	blst
blst_add_retry_after(min, max)	modules	blst
blst_clear_ignore([flags])	modules	blst
blst_del()	modules	blst
blst_is_blacklisted()	modules	blst
blst_rpl_clear_ignore([flags])	modules	blst
blst_rpl_set_ignore([flags])	modules	blst
blst_set_ignore([flags])	modules	blst
bm_log_timer(name)	modules	benchmark
bm_start_timer(name)	modules	benchmark

[C]

Name	Module Path	Module Name
call_control()	modules	call_control
can_publish_reg(domain)	modules	ims_registrar_scscf
can_subscribe_to_reg(domain)	modules	ims_registrar_scscf
check_route_exists(route)	modules	cfgutils
cnt_add([group.]name, number)	modules	counters
cnt_inc([group.]name)	modules	counters
cnt_reset([group.]name)	modules	counters
cnxcc_set_max_channel()	modules	cnxcc
cnxcc_set_max_credit()	modules	cnxcc
cnxcc_set_max_time()	modules	cnxcc
cnxcc_terminate_all()	modules	cnxcc
cnxcc_update_max_time()	modules	cnxcc
Common requirements	modules	app_java
compare_ips (ip1, ip2)	modules	ipops
compare_pure_ips (ip1, ip2)	modules	ipops
consume_credentials()	modules	auth
core_hash(string1, string2, size)	modules	cfgutils
cpl_process_register()	modules	cpl-c
cpl_process_register_norpl()	modules	cpl-c
cpl_run_script(type,mode, [uri])	modules	cpl-c
crypto_aes_decrypt(text, key, res)	modules	crypto
crypto_aes_encrypt(text, key, res)	modules	crypto
cr_next_domain(carrier, domain, prefix_matching, host, reply_code, dstavp)	modules	carrierroute
cr_nofallback_route(carrier, domain, prefix_matching, rewrite_user, hash_source, descavp)	modules	carrierroute
cr_route(carrier, domain, prefix_matching, rewrite_user, hash_source, descavp)	modules	carrierroute
cr_user_carrier(user, domain, dstavp)	modules	carrierroute

[D]

Name	Module Path	Module Name
dbg_breakpoint(mode)	modules	debugger
dbg_pv_dump([mask] [, level])	modules	debugger
dbg_sip_msg([log_level], [facility])	modules	debugger
del_attr($avp_name)	modules	avp
diameter_is_user_in(who, group)	modules	auth_diameter
diameter_proxy_authorize(realm)	modules	auth_diameter
diameter_www_authorize(realm)	modules	auth_diameter
dlg_bridge(from, to, op)	modules	dialog
dlg_bridge(from, to, op)	modules	ims_dialog
dlg_bye(side)	modules	dialog
dlg_get(callid, ftag, ttag)	modules	dialog
dlg_get(callid, ftag, ttag)	modules	ims_dialog
dlg_isflagset(flag)	modules	dialog
dlg_isflagset(flag)	modules	ims_dialog
dlg_manage()	modules	dialog
dlg_manage()	modules	ims_dialog
dlg_refer(side, address)	modules	dialog
dlg_refer(side, address)	modules	ims_dialog
dlg_remote_profile(cmd, profile, value, uid, expires)	modules	dialog
dlg_resetflag(flag)	modules	dialog
dlg_resetflag(flag)	modules	ims_dialog
dlg_setflag(flag)	modules	dialog
dlg_setflag(flag)	modules	ims_dialog
dlg_set_property(attr)	modules	dialog
dlg_set_timeout(timeout [, h_entry, h_id])	modules	dialog
dlg_set_timeout_by_profile(profile, [value], timeout)	modules	dialog
dlg_terminate	modules	ims_dialog
dmq_bcast_message(peer, body, content_type)	modules	dmq
dmq_handle_message()	modules	dmq
dmq_is_from_node()	modules	dmq
dmq_send_message(peer, node, body, content_type)	modules	dmq
dmq_t_replicate([skip_loop_test])	modules	dmq
dns_int_match_ip(hostname, ipaddr)	modules	ipops
dns_query(hostname, pvid)	modules	ipops
dns_sys_match_ip(hostname, ipaddr)	modules	ipops
do_routing(“[groupID]”)	modules	drouting
dp_apply_policy()	modules	domainpolicy
dp_can_connect()	modules	domainpolicy
dp_translate(id, [src[/dest]])	modules	dialplan
ds_is_from_list([groupid [, mode [, uri] ] ])	modules	dispatcher
ds_list_exist(groupid)	modules	dispatcher
ds_load_unset()	modules	dispatcher
ds_load_update()	modules	dispatcher
ds_mark_dst([state])	modules	dispatcher
ds_next_domain()	modules	dispatcher
ds_next_dst()	modules	dispatcher
ds_select(set, alg [, limit])	modules	dispatcher
ds_select_domain(set, alg[, limit])	modules	dispatcher
ds_select_dst(set, alg[, limit])	modules	dispatcher
dump_attrs()	modules	avp

[E]

Name	Module Path	Module Name
enum_pv_query(“pvar”[,“suffix”[,“service”]])	modules	enum
enum_query([“suffix”[,“service”]])	modules	enum
erl_reg_send(server,msg)	modules	erlang
erl_reply(msg)	modules	erlang
erl_rpc(mod,fun,args,reply)	modules	erlang
erl_send(pid,msg)	modules	erlang
evapi_async_multicast(evdata, etag)	modules	evapi
evapi_async_relay(evdata)	modules	evapi
evapi_async_unicast(evdata, etag)	modules	evapi
evapi_close()	modules	evapi
evapi_multicast(evdata, etag)	modules	evapi
evapi_relay(evdata)	modules	evapi
evapi_set_tag(tname)	modules	evapi
evapi_unicast(evdata, etag)	modules	evapi
exec_avp(command [, avplist])	modules	exec
exec_dset(command)	modules	exec
exec_msg(command)	modules	exec

[F]

Name	Module Path	Module Name
file_read(fpath, var)	modules	corex
file_write(fpath, content)	modules	corex
flags2attr(“$avp”)	modules	avp

[G]

Name	Module Path	Module Name
geoip2_match(ipaddr, pvc)	modules	geoip2
geoip_match(ipaddr, pvc)	modules	geoip
get_profile_size(profile,[value],size)	modules	dialog
get_profile_size(profile,[value],size)	modules	ims_dialog
get_user_group(URI, AVP)	modules	group
goes_to_gw([type])	modules	drouting

[H]

Name	Module Path	Module Name
h350_auth_lookup(auth_username, “username_avp_spec/pwd_avp_spec”)	modules	h350
h350_result_call_preferences(avp_name_prefix)	modules	h350
h350_result_service_level(avp_name_prefix)	modules	h350
h350_sipuri_lookup(sip_uri)	modules	h350
has_credentials(realm)	modules	auth
hdr_body2attrs(headername, prefix)	modules	avp
hdr_body2attrs2(headername, prefix)	modules	avp
http_append_header(header)	modules	http_async_client
http_async_query(url, [post_data], route_name)	modules	http_async_client
http_async_suspend(suspend)	modules	http_async_client
http_client_query(url, [post-data], result)	modules	http_client
http_connect(connection, url, [content_type, data,] result)	modules	http_client
http_get_redirect(connection, result)	modules	http_client
http_set_method(method)	modules	http_async_client
http_set_timeout(timeout)	modules	http_async_client
http_set_tls_ca_path(path)	modules	http_async_client
http_set_tls_client_cert(path)	modules	http_async_client
http_set_tls_client_key(path)	modules	http_async_client

[I]

Name	Module Path	Module Name
imc_manager()	modules	imc
impu_registered(domain)	modules	ims_registrar_scscf
ims_proxy_authenticate(realm, table)	modules	ims_auth
ims_proxy_challenge(route_block, realm, table)	modules	ims_auth
ims_www_authenticate(realm)	modules	ims_auth
ims_www_authorize(realm, table)	modules	ims_auth
ims_www_challenge(route_block, realm)	modules	ims_auth
ims_www_challenge(route_block, realm, algorithm)	modules	ims_auth
insert_attr_hf(header_name, $avp_name)	modules	avp
insert_attr_hf(name)	modules	avp
iptrtpproxy_adjust_timeout(gate_a_to_b, session_ids)	modules	iptrtpproxy
iptrtpproxy_alloc(gate_a_to_b [, existing_sess_ids])	modules	iptrtpproxy
iptrtpproxy_authorize_media()	modules	iptrtpproxy
iptrtpproxy_delete(session_ids)	modules	iptrtpproxy
iptrtpproxy_set_param(“(aggregation/switchboard)_by_sip_ip_(a/b)”, sip_ip)	modules	iptrtpproxy
iptrtpproxy_set_param(“codec_set”, value)	modules	iptrtpproxy
iptrtpproxy_set_param(“o_addr”, value)	modules	iptrtpproxy
iptrtpproxy_set_param(“o_name”, value)	modules	iptrtpproxy
iptrtpproxy_set_param(“protected_session_ids”, sess_ids)	modules	iptrtpproxy
iptrtpproxy_set_param(“remove_codec_mask”, value)	modules	iptrtpproxy
iptrtpproxy_set_param(param, value)	modules	iptrtpproxy
iptrtpproxy_update(gate_a_to_b, session_ids)	modules	iptrtpproxy
ip_type (ip)	modules	ipops
isc_from_as(direction)	modules	ims_isc
isc_match_filter(direction,domain)	modules	ims_isc
isc_match_filter_reg(reg_state,domain)	modules	ims_isc
is_avp_set(name)	modules	avpops
is_domain_local(pseudo_variable)	modules	domain
is_from_gw( type, [flag])	modules	drouting
is_from_gw([type])	modules	drouting
is_from_local()	modules	domain
is_from_user_enum()	modules	enum
is_gflag(flag)	modules	cfgutils
is_incoming()	modules	corex
is_in_profile(profile,[value])	modules	dialog
is_in_profile(profile,[value])	modules	ims_dialog
is_in_subnet (ip, subnet)	modules	ipops
is_ip (ip)	modules	ipops
is_ipv4 (ip)	modules	ipops
is_ipv6 (ip)	modules	ipops
is_ipv6_reference (ip)	modules	ipops
is_ip_rfc1918 (ip)	modules	ipops
is_known_dlg()	modules	dialog
is_known_dlg()	modules	ims_dialog
is_pure_ip (ip)	modules	ipops
is_subscriber(uri, dbtable, flags)	modules	auth_db
is_uri_host_local()	modules	domain
is_user_in(URI, group)	modules	group
i_enum_query([“suffix”[,“service”]])	modules	enum
I_perform_location_information_request(route_block)	modules	ims_icscf
I_perform_user_authorization_request(route_block, capabalities)	modules	ims_icscf
I_scscf_drop()	modules	ims_icscf
I_scscf_select(initial)	modules	ims_icscf

[J]

Name	Module Path	Module Name
janssonrpc_notification(conn, method, parameters)	modules	janssonrpc-c
janssonrpc_request(conn, method, params[, options]])	modules	janssonrpc-c
jansson_append(type, key/path, value, result)	modules	jansson
jansson_array_size(key/path, src, dst)	modules	jansson
jansson_get(key/path, src, dst)	modules	jansson
jansson_get_field(src, field_name, dst)	modules	jansson
jansson_set(type, key/path, value, result)	modules	jansson
java_method_exec(method, method_signature, [param1[, param2[, …]]])	modules	app_java
java_staticmethod_exec(method, method_signature, [param1[, param2[, …]]])	modules	app_java
java_s_method_exec(method, method_signature, [param1[, param2[, …]]])	modules	app_java
java_s_staticmethod_exec(method, method_signature, [param1[, param2[, …]]])	modules	app_java
jsonrpc_dispatch()	modules	jsonrpc-s
jsonrpc_exec(cmd)	modules	jsonrpc-s
jsonrpc_notification(method, parameters)	modules	jsonrpc-c
jsonrpc_request(method, parameters, return_route, error_route, result_var)	modules	jsonrpc-c
json_get_field(json_string, field_name, destination)	modules	json

[K]

Name	Module Path	Module Name
kazoo_encode(to_encode, target_var)	modules	kazoo
kazoo_json(json_payload, field, target_var)	modules	kazoo
kazoo_pua_publish(json_payload)	modules	kazoo
kazoo_publish(exchange, routing_key, json_payload)	modules	kazoo
kazoo_query(exchange, routing_key, json_payload [, target_var])	modules	kazoo
kazoo_subscribe(exchange, exchange_type, queue, routing_key)	modules	kazoo
kazoo_subscribe(json_description)	modules	kazoo

[L]

Name	Module Path	Module Name
lock(key)	modules	cfgutils
lookup(domain)	modules	ims_registrar_scscf
lookup_domain(domain[, prefix])	modules	domain
lookup_path_to_contact(uri)	modules	ims_registrar_scscf
lua_dofile(path)	modules	app_lua
lua_dostring(script)	modules	app_lua
lua_run(function, params)	modules	app_lua
lua_runstring(script)	modules	app_lua

[M]

Name	Module Path	Module Name
mono_exec(path [, param])	modules	app_mono
mono_run([param])	modules	app_mono
msg_iflag_is_set(flagname)	modules	corex
msg_iflag_reset(flagname)	modules	corex
msg_iflag_set(flagname)	modules	corex

[N]

Name	Module Path	Module Name

[O]

Name	Module Path	Module Name

[P]

Name	Module Path	Module Name
pcscf_follows_service_routes(domain)	modules	ims_registrar_pcscf
pcscf_force_service_routes(domain)	modules	ims_registrar_pcscf
pcscf_is_registered(domain)	modules	ims_registrar_pcscf
pcscf_save(domain)	modules	ims_registrar_pcscf
pcscf_save_pending(domain)	modules	ims_registrar_pcscf
perl_exec(func, [param])	modules	app_perl
perl_exec_simple(func, [param])	modules	app_perl
pkg_status()	modules	cfgutils
pkg_summary()	modules	cfgutils
print_attr($attribute)	modules	avp
proxy_authenticate(realm, table)	modules	auth_db
proxy_authorize(realm, table)	modules	auth_db
proxy_challenge(realm, flags)	modules	auth
publish_reg(domain)	modules	ims_registrar_scscf
pv_auth_check(realm, passwd, flags, checks)	modules	auth
pv_proxy_authenticate(realm, passwd, flags)	modules	auth
pv_www_authenticate(realm, passwd, flags [, method])	modules	auth
python_exec(method [, args])	modules	app_python

[Q]

Name	Module Path	Module Name

[R]

Name	Module Path	Module Name
radius_proxy_authorize(realm [, uri_user])	modules	auth_radius
radius_www_authorize(realm [, uri_user])	modules	auth_radius
rand_event()	modules	cfgutils
rand_get_prob()	modules	cfgutils
rand_reset_prob()	modules	cfgutils
rand_set_prob(probabiltiy)	modules	cfgutils
reg_fetch_contacts(domain, uri, profile)	modules	ims_registrar_scscf
reg_free_contacts(profile)	modules	ims_registrar_scscf
replace_attr_hf(header_name, $avp_name)	modules	avp
replace_attr_hf(name)	modules	avp
reset_gflag(flag)	modules	cfgutils
route_if_exists(route)	modules	cfgutils
Ro_CCR(route_name, direction, reservation_units, domain, incoming_trunk_id, outgoing_trunk_id	modules	ims_charging
Ro_set_session_id_avp()	modules	ims_charging
Rx_AAR(route_block, direction, subscription_id, subscription_id_type)	modules	ims_qos
Rx_AAR_Register(route_block, domain)	modules	ims_qos

[S]

Name	Module Path	Module Name
save(async_reply_route, domain)	modules	ims_registrar_scscf
send([ host [ :port ] ])	modules	corex
send_data(uri, data)	modules	corex
send_tcp([ host [ :port ] ])	modules	corex
set_dlg_profile(profile,[value])	modules	dialog
set_dlg_profile(profile,[value])	modules	ims_dialog
set_gflag(flag)	modules	cfgutils
set_iattr(attribute,value)	modules	avp
set_sattr(attribute,value)	modules	avp
shm_status()	modules	cfgutils
shm_summary()	modules	cfgutils
sht_iterator_end(iname)	modules	htable
sht_iterator_next(iname)	modules	htable
sht_iterator_start(iname, hname)	modules	htable
sht_lock(htable=>key)	modules	htable
sht_print()	modules	htable
sht_reset(htable)	modules	htable
sht_rm_name_re(htable=>regexp)	modules	htable
sht_rm_value_re(htable=>regexp)	modules	htable
sht_unlock(htable=>key)	modules	htable
sleep(time)	modules	cfgutils
srv_query(srvcname, pvid)	modules	ipops
subscribe_to_reg(domain)	modules	ims_registrar_scscf
subst_attr($avp_name, subst_re)	modules	avp

[T]

Name	Module Path	Module Name
term_impu_registered(domain)	modules	ims_registrar_scscf
tls_verify_host(verify)	modules	http_async_client
tls_verify_peer(verify)	modules	http_async_client

[U]

Name	Module Path	Module Name
unlock(key)	modules	cfgutils
unregister(domain)	modules	ims_registrar_scscf
unset_dlg_profile(profile,[value])	modules	dialog
unset_dlg_profile(profile,[value])	modules	ims_dialog
use_next_gw()/next_routing()	modules	drouting
usleep(time)	modules	cfgutils

[V]

Name	Module Path	Module Name
vrfy_check_callid()	modules	auth_identity
vrfy_check_certificate()	modules	auth_identity
vrfy_check_date()	modules	auth_identity
vrfy_check_msgvalidity()	modules	auth_identity
vrfy_get_certificate()	modules	auth_identity

[W]

Name	Module Path	Module Name
www_authenticate(realm, table [, method])	modules	auth_db
www_authorize(realm, table)	modules	auth_db
www_challenge(realm, flags)	modules	auth

[X]

Name	Module Path	Module Name
xlfix_attr($attribute)	modules	avp
xlset_attr($attribute, xl_format)	modules	avp
xlset_destination(xl_format)	modules	avp

[Y]

Name	Module Path	Module Name

[Z]

Name	Module Path	Module Name

Kamailio SIP Server Wiki

Table of Contents

Modules Functions

[A]

[B]

[C]

[D]

[E]

[F]

[G]

[H]

[I]

[J]

[K]

[L]

[M]

[N]

[O]

[P]

[Q]

[R]

[S]

[T]

[U]

[V]

[W]

[X]

[Y]

[Z]