Skip to content
About
Downloads
Documentation
Community
Development
Training
Search
Ctrl
K
Cancel
Dark
Light
Auto
About
Downloads
Documentation
Community
Development
Training
Documentation
Manual
Overview
Installation
Download OpenSIPS
Compile and Install OpenSIPS
Database Deployment
Database schema
Configuring
Config file
Generating opensips.cfg files
Templating opensips.cfg files
OpenSIPS scripting
Script syntax
Core parameters
Types of routes
Script operators
Script statements
Core functions
Core variables
Scripting flags
Transformations
Asynchronous statements
Modules documentation
Overview
SIP related modules
SIP signaling modules
B2B_ENTITIES
B2B_LOGIC
CALL-CENTER
DIALOG
NAT TRAVERSAL
NATHELPER
OPTIONS
REGISTRAR
SIGNALING
UAC REGISTRANT
TM
SL
MEDIA EXCHANGE
CALLING OPERATIONS
B2B SDP DE-MULTIPLEXER
MSRP UA
SIP Routing modules
CARRIERROUTE
CPL_C
DISPATCHER
DYNAMIC ROUTING
QUALITY-BASED ROUTING
EMERGENCY CALL
ENUM
JABBER
IMC
LOAD BALANCER
MID_REGISTRAR
MSILO
MSRP GATEWAY
RR
SCRIPT HELPER
OSP
SIP messaging operations
COMPRESSION
DIVERSION
IDENTITY
MAXFWD
MANGLER
PATH
SIP-I
SIPMSGOPS
STIR/SHAKEN
TOPOLOGY HIDING
UAC
UAC AUTH
UAC REDIRECT
SIP SESSION TIMER
SIP Presence Modules
PRESENCE
PRESENCE_CALLINFO
PRESENCE_DIALOGINFO
PRESENCE_DFKS
PRESENCE_MWI
PRESENCE_REGINFO
PRESENCE_XCAPDIFF
PRESENCE_XML
PRESENCE USER AGENT
PUA BLA
PUA DIALOGINFO
PUA MI
PUA REGINFO
PUA USRLOC
PUA XMPP
B2B_SCA
RESOURCE LIST SERVER
XCAP
XCAP_CLIENT
Scripting modules
Script helper modules
JSON
XML
CFGUTILS
CONFIG
EXEC
TEXTOPS
SQLOPS
REGEX
MATHOPS
BENCHMARK
GFLAGS
PYTHON
LUA
PERL
MMGEOIP
UUID
MQUEUE
Auth modules
AUTH_AAA
AUTH
AUTH_DB
AUTH_JWT
AUTH AKA
AUTH WEB3
AKA AUTHENTICATION VECTOR DIAMETER
PERMISSIONS
Accounting & Billing modules
ACC
CALL CONTROL
CGRATES
Dialplan Modules
ALIAS_DB
DIALPLAN
DOMAIN
DOMAIN POLICY
GROUP
USERBLACKLIST
SPEEDDIAL
PEERING
Data caching
DNS_CACHE
RATE_CACHER
SQL CACHER
TRIE
USRLOC
Traffic shaping module
PIKE
QOS
RATELIMIT
FRAUD DETECTION
Database modules
SQL modules
BERKELEY DB
DB_CACHEDB
FLATSTORE
DB_HTTP
MYSQL
ORACLE
PERL VIRTUAL DATABASE
DB_POSTGRES
DB_SQLITE
DB_TEXT
UNIXODBC
DB_VIRTUAL
noSQL modules
CACHEDB_CASSANDRA
CACHEDB_COUCHBASE
CACHEDB_DYNAMODB
CACHEDB_LOCAL
CACHEDB_MEMCACHED
CACHEDB_MONGODB
CACHEDB_REDIS
CACHEDB_SQL
External Integration modules
OpenSIPS API modules
EVENT_DATAGRAM
EVENT_FLATSTORE
EVENT_KAFKA
EVENT (BASED) ROUTING
EVENT_RABBITMQ
EVENT_STREAM
EVENT_SQS
EVENT_VIRTUAL
EVENT_XMLRPC
MI_DATAGRAM
MI_FIFO
MI_HTML
MI_HTTP
MI SCRIPT
MI_XMLRPC
HTTPD
PI_HTTP
RABBITMQ CONSUMER
STATISTICS
STATUS/REPORTS
Media Relays
MEDIAPROXY
MSRP RELAY
RTPENGINE
RTPPROXY
RTP.IO
RTP RELAY
External integration (non-SIP protocols)
AAA_DIAMETER
AAA RADIUS
FREESWITCH
FREESWITCH_SCRIPTING
H350
HTTP2D
JANUS
JSON-RPC
LAUNCH_DARKLY
LDAP
OPENTELEMETRY
PROMETHEUS
REST_CLIENT
SIPCAPTURE
SIPREC
TRACER
SNGTC
SNMPSTATS
STUN
XMPP
OpenSIPS protocols and infrastructure
CLUSTERER
TLS_MGM
TLS_OPENSSL
TLS_WOLFSSL
TCP MANAGEMENT module (TCP_MGM)
PROTO_BIN
PROTO_BINS
PROTO_HEP
PROTO_IPSEC
PROTO_MSRP
PROTO_SCTP
PROTO_TCP
PROTO_TLS
PROTO_UDP
PROTO_WS
PROTO_WSS
PROTO_SMPP
DYNAMIC SOCKETS MANAGEMENT
Other
EXAMPLE
Function Index
OpenSIPS Interfaces
MI interface
Core MI commands
Event Interface
Core Events
Statistics Interface
Core Statistics
Status/Report Interface
Binary Internal Interface
OpenSIPS Testing
Conformance Tests
Advanced Tutorials
Overview
Topology Hiding
Advanced Accounting
Script Helper
SIPREC Call Recording
Fraud Detection
Message Compression
Emergency Calls
WebSocket Integration
B2BUA
Presence Server
Presence User Agent
Presence RLS
Load Balancing
Key-Value Interface
Event Interface
Memory Caching
FreeSWITCH Media Integration
Asterisk Realtime Integration
Concurrent Call Limits
TLS Setup
RADIUS Integration
SIP Redirect Server
fail2ban Integration
Sangoma Voice Transcoding
Mid-Registrar
Federated User Location
Full-Sharing User Location
Diameter Accounting
RCS Capabilities
Diameter Client/Server
Version Migration
Overview
4.0.0 to 4.1.0
3.6.0 to 4.0.0
3.5.0 to 3.6.0
3.4.0 to 3.5.0
3.3.0 to 3.4.0
3.2.0 to 3.3.0
3.1.0 to 3.2.0
3.0.0 to 3.1.0
2.4.0 to 3.0.0
2.3.0 to 2.4.0
2.2.0 to 2.3.0
2.1.0 to 2.2.0
1.11.0 to 2.1.0
1.10.0 to 1.11.0
1.9.0 to 1.10.0
1.8.0 to 1.9.0
1.7.0 to 1.8.0
1.6.4 to 1.7.0
1.6.3 to 1.6.4
1.6.2 to 1.6.3
1.5.x to 1.6.0/1/2
1.4.x to 1.5.x
Troubleshooting
Overview
OpenSIPS Does Not Start
OpenSIPS Crashes
Out Of Memory
Increasing Memory
Script Samples
GitHub
LinkedIn
YouTube
Dark
Light
Auto
3.1
4.1 / devel
4.0
3.6
3.5
3.4
3.3
3.2
3.1
3.0
2.4
2.3
2.2
2.1
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
Function Index
Note: Core functions are not included. You can find them
here
.
Function
Module
aaa_does_uri_exist
auth_aaa
aaa_does_uri_user_exist
auth_aaa
aaa_is_user_in
group
aaa_proxy_authorize
auth_aaa
aaa_www_authorize
auth_aaa
abort
cfgutils
acc_aaa_request
acc
acc_db_request
acc
acc_evi_request
acc
acc_load_ctx_from_dlg
acc
acc_log_request
acc
acc_new_leg
acc
acc_unload_ctx_from_dlg
acc
add_body_part
sipmsgops
add_diversion
diversion
add_isup_part
sip_i
add_path
path
add_path_received
path
add_rcv_param
nathelper
add_rr_param
rr
add_sock_hdr
registrar
alias_db_find
alias_db
alias_db_lookup
alias_db
allow_register
permissions
allow_routing
permissions
allow_uri
permissions
append_hf
sipmsgops
append_rpid_hf
auth
append_time
sipmsgops
append_to_reply
sipmsgops
append_urihf
sipmsgops
authservice
identity
avp_check
avpops
avp_copy
avpops
avp_db_delete
avpops
avp_db_load
avpops
avp_db_query
avpops
avp_db_store
avpops
avp_delete
avpops
avp_op
avpops
avp_print
avpops
avp_pushto
avpops
avp_subst
avpops
b2b_bridge_request
b2b_logic
b2b_init_request
b2b_logic
bla_handle_notify
pua_bla
bla_set_flag
pua_bla
bm_log_timer
benchmark
bm_start_timer
benchmark
cache_remove_chunk
cachedb_local
call_blind_replace
callops
call_control
call_control
call_transfer
callops
call_transfer_notify
callops
cc_agent_login
call_center
cc_handle_call
call_center
cgrates_acc
cgrates
cgrates_auth
cgrates
cgrates_cmd
cgrates
change_reply_status
sipmsgops
check_address
permissions
check_blacklist
userblacklist
check_fraud
fraud_detection
check_route_param
rr
check_source_address
permissions
check_time_rec
cfgutils
check_user_blacklist
userblacklist
checkcallingtranslation
osp
checkospheader
osp
checkosproute
osp
client_nat_test
nat_traversal
cluster_broadcast_req
clusterer
cluster_check_addr
clusterer
cluster_send_req
clusterer
cluster_send_rpl
clusterer
codec_delete
sipmsgops
codec_delete_except_re
sipmsgops
codec_delete_re
sipmsgops
codec_exists
sipmsgops
codec_exists_re
sipmsgops
codec_move_down
sipmsgops
codec_move_down_re
sipmsgops
codec_move_up
sipmsgops
codec_move_up_re
sipmsgops
consume_credentials
auth
correlate
proto_hep
cost_based_filtering
rate_cacher
cost_based_ordering
rate_cacher
cpl_process_register
cpl_c
cpl_process_register_norpl
cpl_c
cpl_run_script
cpl_c
cr_next_domain
carrierroute
cr_prime_route
carrierroute
cr_route
carrierroute
cr_user_carrier
carrierroute
create_dialog
dialog
db_does_uri_exist
auth_db
db_get_auth_id
auth_db
db_get_user_group
group
db_is_from_authorized
auth_db
db_is_to_authorized
auth_db
db_is_user_in
group
decode_contact
mangler
decode_contact_header
mangler
dialoginfo_mute_branch
pua_dialoginfo
dialoginfo_set
pua_dialoginfo
dialoginfo_set_branch_callee
pua_dialoginfo
dlg_on_answer
dialog
dlg_on_hangup
dialog
dlg_on_timeout
dialog
dlg_send_sequential
dialog
do_accounting
acc
do_routing
drouting
dp_apply_policy
domainpolicy
dp_can_connect
domainpolicy
dp_translate
dialplan
dr_disable
drouting
dr_is_gw
drouting
dr_match
drouting
drop_accounting
acc
ds_count
dispatcher
ds_get_script_attrs
dispatcher
ds_is_in_list
dispatcher
ds_mark_dst
dispatcher
ds_next_domain
dispatcher
ds_next_dst
dispatcher
ds_push_script_attrs
dispatcher
ds_select_domain
dispatcher
ds_select_dst
dispatcher
emergency_call
emergency
encode_contact
mangler
end_media_session
mediaproxy
engage_media_proxy
mediaproxy
enum_query
enum
exec
exec
failure
emergency
fetch_dlg_value
dialog
fix_contact
nat_traversal
fix_nated_contact
nathelper
fix_nated_register
nathelper
fix_nated_sdp
nathelper
fix_route_dialog
dialog
freeswitch_esl
freeswitch_scripting
get_accurate_time
cfgutils
get_client_price
rate_cacher
get_dialog_info
dialog
get_dialog_vals
dialog
get_dialogs_by_profile
dialog
get_dialogs_by_val
dialog
get_dynamic_lock
cfgutils
get_profile_size
dialog
get_redirects
uac_redirect
get_source_group
permissions
get_static_lock
cfgutils
get_vendor_price
rate_cacher
getlocaladdress
osp
goes_to_gw
drouting
handle_publish
presence
handle_subscribe
presence
has_body_part
sipmsgops
has_totag
sipmsgops
hep_del
sipcapture
hep_get
sipcapture
hep_relay
sipcapture
hep_resume_sip
sipcapture
hep_set
sipcapture
i_enum_query
enum
imc_manager
imc
insert_hf
sipmsgops
is_audio_on_hold
sipmsgops
is_avp_set
avpops
is_contact_registered
registrar
is_direction
rr
is_dlg_flag_set
dialog
is_domain_local
domain
is_from_gw
drouting
is_from_local
domain
is_from_user_enum
enum
is_gflag
gflags
is_in_profile
dialog
is_ip_registered
registrar
is_maxfwd_lt
maxfwd
is_method
sipmsgops
is_peer_verified
tls_mgm
is_present_hf
sipmsgops
is_privacy
sipmsgops
is_registered
registrar
is_rpid_user_e164
auth
is_uri_host_local
domain
is_uri_user_e164
sipmsgops
isn_query
enum
jab_exit_jconf
jabber
jab_go_offline
jabber
jab_go_online
jabber
jab_join_jconf
jabber
jab_send_message
jabber
json_link
json
jsonrpc_notification
jsonrpc
jsonrpc_request
jsonrpc
jwt_authorize
auth_jwt
lb_count_call
load_balancer
lb_disable_dst
load_balancer
lb_is_destination
load_balancer
lb_is_started
load_balancer
lb_next
load_balancer
lb_reset
load_balancer
lb_start
load_balancer
lb_start_or_next
load_balancer
list_hdr_add_option
sipmsgops
list_hdr_has_option
sipmsgops
list_hdr_remove_option
sipmsgops
load_balance
load_balancer
load_dialog_ctx
dialog
lookup
registrar
loose_route
rr
m_dump
msilo
m_store
msilo
match_dialog
dialog
math_ceil
mathops
math_eval
mathops
math_floor
mathops
math_round
mathops
math_round_sf
mathops
math_rpn
mathops
math_trunc
mathops
mc_compact
compression
mc_compress
compression
mc_decompress
compression
media_exchange_from_uri
media_exchange
media_exchange_to_call
media_exchange
media_fork_from_call
media_exchange
media_fork_pause
media_exchange
media_fork_resume
media_exchange
media_fork_to_uri
media_exchange
media_handle_indialog
media_exchange
media_terminate
media_exchange
mf_process_maxfwd_header
maxfwd
mid_registrar_lookup
mid_registrar
mid_registrar_save
mid_registrar
mmg_lookup
mmgeoip
nat_keepalive
nat_traversal
nat_uac_test
nathelper
notify_on_event
event_routing
options_reply
options
pcre_match
regex
pcre_match_group
regex
perl_exec
perl
perl_exec_simple
perl
pike_check_req
pike
pkg_status
cfgutils
prepareallosproutes
osp
prepareospresponse
osp
prepareosproute
osp
processsubscribe
osp
proxy_authorize
auth_db
proxy_challenge
auth
pua_set_publish
pua_usrloc
pua_update_contact
pua
pua_xmpp_notify
pua_xmpp
pua_xmpp_req_winfo
pua_xmpp
pv_proxy_authorize
auth
pv_www_authorize
auth
python_exec
python
qr_disable_dst
qrouting
qr_enable_dst
qrouting
qr_set_xstat
qrouting
rabbitmq_publish
rabbitmq
radius_send_acct
aaa_radius
radius_send_auth
aaa_radius
rand_event
cfgutils
rand_get_prob
cfgutils
rand_reset_prob
cfgutils
rand_set_prob
cfgutils
record_route
rr
record_route_preset
rr
release_dynamic_lock
cfgutils
release_static_lock
cfgutils
remove
registrar
remove_body_part
sipmsgops
remove_hf
sipmsgops
remove_hf_glob
sipmsgops
remove_hf_re
sipmsgops
replace
textops
replace_all
textops
replace_body
textops
replace_body_all
textops
replace_body_atonce
textops
report_capture
sipcapture
reportospusage
osp
requestosprouting
osp
reset_dlg_flag
dialog
reset_gflag
gflags
reset_stat
statistics
rest_append_hf
rest_client
rest_get
rest_client
rest_init_client_tls
rest_client
rest_post
rest_client
rest_put
rest_client
rl_check
ratelimit
rl_dec_count
ratelimit
rl_reset_count
ratelimit
rls_handle_notify
rls
rls_handle_subscribe
rls
route_to_carrier
drouting
route_to_gw
drouting
rtpengine_answer
rtpengine
rtpengine_block_dtmf
rtpengine
rtpengine_block_media
rtpengine
rtpengine_delete
rtpengine
rtpengine_manage
rtpengine
rtpengine_offer
rtpengine
rtpengine_play_dtmf
rtpengine
rtpengine_play_media
rtpengine
rtpengine_start_forwarding
rtpengine
rtpengine_start_recording
rtpengine
rtpengine_stop_forwarding
rtpengine
rtpengine_stop_media
rtpengine
rtpengine_stop_recording
rtpengine
rtpengine_unblock_dtmf
rtpengine
rtpengine_unblock_media
rtpengine
rtpengine_use_set
rtpengine
rtpproxy_all_stats
rtpproxy
rtpproxy_answer
rtpproxy
rtpproxy_engage
rtpproxy
rtpproxy_offer
rtpproxy
rtpproxy_start_recording
rtpproxy
rtpproxy_stats
rtpproxy
rtpproxy_stop_stream2uac
rtpproxy
rtpproxy_stop_stream2uas
rtpproxy
rtpproxy_stream2uac
rtpproxy
rtpproxy_stream2uas
rtpproxy
rtpproxy_unforce
rtpproxy
ruri_add_param
sipmsgops
ruri_del_param
sipmsgops
ruri_has_param
sipmsgops
ruri_tel2sip
sipmsgops
save
registrar
sca_bridge_request
b2b_sca
sca_init_request
b2b_sca
sca_set_called_line
presence_callinfo
sca_set_calling_line
presence_callinfo
sd_lookup
speeddial
sdp_mangle_ip
mangler
sdp_mangle_port
mangler
search
textops
search_append
textops
search_append_body
textops
search_body
textops
send_reply
signaling
send_smpp_message
proto_smpp
set_accept_filter
uac_redirect
set_count
cfgutils
set_deny_filter
uac_redirect
set_dlg_flag
dialog
set_dlg_profile
dialog
set_dlg_sharing_tag
dialog
set_gflag
gflags
set_select_weight
cfgutils
setrequestdate
osp
shm_status
cfgutils
sip_capture
sipcapture
sipmsg_validate
sipmsgops
siprec_start_recording
siprec
sl_reply_error
sl
sl_send_reply
sl
sleep
cfgutils
sngtc_callee_answer
sngtc
sngtc_caller_answer
sngtc
sngtc_offer
sngtc
sstCheckMin
sst
stat_iter_init
statistics
stat_iter_next
statistics
stir_shaken_auth
stir_shaken
stir_shaken_check
stir_shaken
stir_shaken_check_cert
stir_shaken
stir_shaken_verify
stir_shaken
store_dlg_value
dialog
stream_delete
sipmsgops
stream_exists
sipmsgops
strings_share_lock
cfgutils
subst
textops
subst_body
textops
subst_uri
textops
subst_user
textops
t_add_cancel_reason
tm
t_add_hdrs
tm
t_anycast_replicate
tm
t_cancel_branch
tm
t_check_status
tm
t_check_trans
tm
t_flush_flags
tm
t_inject_branches
tm
t_local_replied
tm
t_new_request
tm
t_newtran
tm
t_on_branch
tm
t_on_failure
tm
t_on_reply
tm
t_relay
tm
t_replicate
tm
t_reply
tm
t_reply_with_body
tm
t_wait_for_new_branches
tm
t_was_cancelled
tm
t_write_req
tm
t_write_unix
tm
test_and_set_dlg_flag
dialog
topology_hiding
topology_hiding
topology_hiding_match
topology_hiding
trace
tracer
ts_usec_delta
cfgutils
uac_auth
uac
uac_replace_from
uac
uac_replace_to
uac
uac_restore_from
uac
uac_restore_to
uac
unload_dialog_ctx
dialog
unset_dlg_profile
dialog
update_stat
statistics
use_media_proxy
mediaproxy
use_next_gw
drouting
usleep
cfgutils
uuid
uuid
validate_dialog
dialog
validateospheader
osp
verifier
identity
verify_destination
peering
verify_source
peering
www_authorize
auth_db
www_challenge
auth
xmpp_send_message
xmpp