Asterisk Docs

Module	Support Level	Deprecated In	Removed In	Dependencies
chan_motif	core			iksemel, res_xmpp, iksemel, res_xmpp
dialplan_functions	core
console_gui	extended
chan_sip	deprecated	17	21
bridge_native_dahdi	core
chan_console	extended			portaudio, portaudio
chan_dahdi	core			dahdi, tonezone, dahdi, tonezone
chan_mgcp	deprecated	19	21
console_board	extended
console_video	extended
sig_pri	core
chan_pjsip	core			pjproject, res_pjsip, res_pjsip_pubsub, res_pjsip_session, pjproject, res_pjsip, res_pjsip_pubsub, res_pjsip_session
sig_ss7	core
chan_unistim	extended
vcodecs	extended
chan_alsa	deprecated	19	21	alsa, alsa
chan_skinny	deprecated	19	21
chan_iax2	core
chan_audiosocket	extended			res_audiosocket, res_audiosocket
chan_bridge_media	core
sig_analog	core
vgrabbers	extended
route	deprecated
config_parser	deprecated
utils	deprecated
dialplan_functions	deprecated
reqresp_parser	deprecated
security_events	deprecated
format_compatibility	core
provision	core
firmware	core
parser	core
netsock	core
codec_pref	core
chan_rtp	core			res_rtp_multicast, res_rtp_multicast
dundi-parser	extended
pbx_lua	extended			lua, lua
pbx_realtime	extended
pbx_spool	core
pbx_config	core
pbx_ael	extended			res_ael_share, res_ael_share
pbx_loopback	core
pbx_dundi	extended			zlib, zlib
app_originate	core
app_directory	core
app_alarmreceiver	extended
app_privacy	core
app_softmodem	extended			spandsp, spandsp
app_fsk	extended			spandsp, spandsp
app_assert	extended
app_mp3	extended
app_playback	core
app_jack	extended			jack, resample, jack, resample
app_minivm	extended
app_transfer	core
app_osplookup	deprecated	19	21	osptk, openssl, osptk, openssl
app_waitforring	extended
app_if	extended
app_morsecode	extended
app_mf	extended
app_randomplayback	extended
app_loopdisconnect	extended			dahdi, dahdi
app_stream_echo	core
app_echo	core
app_festival	extended
app_bridgeaddchan	core
app_celgenuserevent	core
app_dial	core
app_loopplayback	extended
app_amd	extended
app_getcpeid	deprecated			res_adsi, res_adsi
app_skel	core
app_macro	deprecated	16	21
app_adsiprog	deprecated			res_adsi, res_adsi
app_zapateller	extended
app_dtmfstore	extended
app_blind_transfer	extended
app_followme	core
app_channelredirect	core
app_dictate	extended
app_dialtone	extended
app_externalivr	extended
app_readexten	core
app_userevent	core
app_exec	core
app_record	core
app_mwi	extended			pbx_spool, pbx_spool
conf_state_multi	core
conf_config_parser	core
conf_state_single	core
conf_state	core
conf_state_empty	core
conf_state_inactive	core
conf_state_multi_marked	core
conf_state_single_marked	core
app_remoteaccess	extended
app_talkdetect	core
app_tdd	extended			spandsp, spandsp
app_system	core
app_senddtmf	core
app_meetme	deprecated	19	21	dahdi, dahdi
app_page	core			app_confbridge, app_confbridge
app_authenticate	core
app_bridgewait	core			bridge_holding, bridge_holding
app_sms	extended
app_sendtext	core
app_callback	extended			func_query, func_query
app_verbose	core
app_dumpchan	core
app_chanspy	core
app_playdigits	extended
app_partialplayback	extended
app_while	core
app_forkcdr	core
app_broadcast	extended
app_read	core
app_stack	core
app_db	core
app_confbridge	core
app_waituntil	core
app_controlplayback	core
app_waitforsilence	extended
app_ivrdemo	extended
app_waitforcond	extended
app_audiosocket	extended			res_audiosocket, res_audiosocket
app_saytelnumber	extended
app_keyprefetch	extended			res_crypto, curl, res_crypto, curl
app_george	extended
app_mail	extended
app_softhangup	core
app_stasis	core			res_stasis, res_stasis
app_predial	extended
app_milliwatt	core
app_agent_pool	core
app_verify	extended			curl, curl
app_test	extended
app_signal	extended
app_disa	core
app_callerid	extended
app_playtones	core
app_statsd	extended			res_statsd, res_statsd
app_wakeupcall	extended			pbx_spool, pbx_spool
app_tonetest	extended
app_ccsa	extended
app_mixmonitor	core
app_cdr	core
app_streamsilence	extended
app_memory	extended
app_speech_utils	core			res_speech, res_speech
app_chanisavail	extended
app_attended_transfer	extended
app_sayunixtime	core
app_queue	core
app_sf	extended
app_saycounted	extended
app_frame	extended
app_reload	extended
app_flash	core			dahdi, dahdi
app_selective	extended			app_stack, app_db, func_db, app_stack, app_db, func_db
app_pulsar	extended
app_directed_pickup	core
codec_a_mu	core
codec_gsm	core			gsm, gsm
codec_adpcm	core
codec_speex	core			speex, speex_preprocess, speex, speex_preprocess
codec_ilbc	core
codec_lpc10	core
codec_resample	core
codec_ulaw	core
codec_codec2	core			codec2, codec2
codec_dahdi	core			dahdi, dahdi
codec_g722	core
codec_g726	core
codec_alaw	core
format_g719	core
format_h263	core
format_ilbc	core
format_siren7	core
format_h264	core
format_wav	core
format_ogg_vorbis	core			vorbis, ogg, vorbis, ogg
format_pcm	core
format_sln	core
format_siren14	core
format_g723	core
format_g729	core
format_g726	core
format_wav_gsm	core
format_ogg_speex	extended			speex, ogg, speex, ogg
format_gsm	core
format_vox	extended
cdr_sqlite3_custom	extended			sqlite3, sqlite3
cdr_csv	extended
cdr_pgsql	extended			pgsql, pgsql
cdr_custom	core
cdr_manager	core
cdr_tds	extended			freetds, freetds
cdr_adaptive_odbc	core			res_odbc, generic_odbc, res_odbc, generic_odbc
cdr_beanstalkd	extended			beanstalk, beanstalk
cdr_radius	extended			radius, radius
cdr_odbc	extended			res_odbc, generic_odbc, res_odbc, generic_odbc
cel_sqlite3_custom	extended			sqlite3, sqlite3
cel_tds	extended			freetds, freetds
cel_pgsql	extended			pgsql, pgsql
cel_odbc	core			res_odbc, generic_odbc, res_odbc, generic_odbc
cel_beanstalkd	extended			beanstalk, beanstalk
cel_radius	extended			radius, radius
cel_manager	core
cel_custom	core
bridge_softmix	core
bridge_builtin_interval_features	core
bridge_builtin_features	core
bridge_holding	core
bridge_native_rtp	core
bridge_simple	core
func_frame_trace	extended
func_dtmf_flash	extended
func_tech	extended
func_channel	core
func_pjsip_endpoint	core			pjproject, res_pjsip, pjproject, res_pjsip
func_shell	core
func_sprintf	core
func_enum	core
func_version	core
func_query	extended
func_uri	core
func_env	core
func_groupcount	core
func_scramble	extended
func_aes	core			res_crypto, crypto, res_crypto, crypto
func_curl	core			res_curl, curl, res_curl, curl
func_md5	core
func_rand	core
func_dialplan	core
func_sayfiles	extended
func_talkdetect	core
func_presencestate	core
func_notchfilter	extended
func_config	core
func_hangupcause	core
func_periodic_hook	core			app_chanspy, func_cut, func_groupcount, func_uri, app_chanspy, func_cut, func_groupcount, func_uri
func_pitchshift	extended
func_dbchan	extended
func_dialgroup	core
func_callcompletion	core
func_global	core
func_lock	core
func_export	extended
func_iconv	core			iconv, iconv
func_cut	core
func_module	core
func_realtime	core
func_vmcount	core
func_cdr	core
func_nanpa	extended
func_strings	core
func_numpeer	extended
func_pjsip_aor	core			pjproject, res_pjsip, pjproject, res_pjsip
func_callerid	core
func_holdintercept	core
func_blacklist	core
func_logic	core
func_base64	core
func_dtmf_trace	extended
func_sorcery	core
func_speex	core			speex, speex_preprocess, speex, speex_preprocess
func_pjsip_contact	core			pjproject, res_pjsip, pjproject, res_pjsip
func_sha1	core
func_extstate	core
func_frame_drop	extended
func_devstate	core
func_jitterbuffer	core
func_db	core
func_math	core
func_sysinfo	core
func_evalexten	extended
func_timeout	core
func_json	extended
func_resonance	extended
func_srv	core
func_odbc	core			res_odbc, generic_odbc, res_odbc, generic_odbc
func_volume	core
test_named_lock	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_threadpool	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_hashtab_thrash	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_substitution	core			TEST_FRAMEWORK, func_curl, TEST_FRAMEWORK, func_curl
test_sorcery_astdb	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_stream	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_func_file	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_gosub	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_pbx	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_core_format	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_stasis_endpoints	core			TEST_FRAMEWORK, res_stasis_test, TEST_FRAMEWORK, res_stasis_test
test_channel	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_json	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_linkedlists	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_voicemail_api	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_poll	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_security_events	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_vector	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_logger	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_dns_query_set	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_time	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_ari	core			TEST_FRAMEWORK, res_ari, TEST_FRAMEWORK, res_ari
test_res_pjsip_scheduler	core			TEST_FRAMEWORK, pjproject, res_pjsip, TEST_FRAMEWORK, pjproject, res_pjsip
test_dlinklists	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_amihooks	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_callerid	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_http_media_cache	core			TEST_FRAMEWORK, curl, res_http_media_cache, TEST_FRAMEWORK, curl, res_http_media_cache
test_cel	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_db	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_sorcery	core			TEST_FRAMEWORK, func_sorcery, TEST_FRAMEWORK, func_sorcery
test_uri	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_format_cache	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_res_prometheus	extended			TEST_FRAMEWORK, res_prometheus, curl, TEST_FRAMEWORK, res_prometheus, curl
test_message	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_sorcery_realtime	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_stringfields	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_netsock2	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_mwi	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_aoc	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_devicestate	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_bridging	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_conversions	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_utils	core			TEST_FRAMEWORK, res_agi, res_crypto, crypto, TEST_FRAMEWORK, res_agi, res_crypto, crypto
test_endpoints	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_ari_model	core			TEST_FRAMEWORK, res_ari_model, TEST_FRAMEWORK, res_ari_model
test_abstract_jb	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_sorcery_memory_cache_thrash	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_websocket_client	core			TEST_FRAMEWORK, res_http_websocket, TEST_FRAMEWORK, res_http_websocket
test_expr	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_stasis_state	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_astobj2_weaken	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_aeap_transport	core			TEST_FRAMEWORK, res_aeap, TEST_FRAMEWORK, res_aeap
test_crypto	core			TEST_FRAMEWORK, res_crypto, crypto, TEST_FRAMEWORK, res_crypto, crypto
test_config	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_dns_naptr	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_taskprocessor	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_core_codec	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_acl	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_dns	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_media_cache	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_astobj2_thrash	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_capture	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_res_pjsip_session_caps	core			TEST_FRAMEWORK, pjproject, res_pjsip, res_pjsip_session, TEST_FRAMEWORK, pjproject, res_pjsip, res_pjsip_session
test_strings	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_cdr	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_heap	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_stasis	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_app	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_dns_recurring	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_res_stasis	core			TEST_FRAMEWORK, res_stasis, TEST_FRAMEWORK, res_stasis
test_sched	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_data_buffer	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_aeap_transaction	core			TEST_FRAMEWORK, res_aeap, TEST_FRAMEWORK, res_aeap
test_res_rtp	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_aeap_speech	core			TEST_FRAMEWORK, res_aeap, TEST_FRAMEWORK, res_aeap
test_dns_srv	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_format_cap	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_bucket	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_scoped_lock	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_event	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_locale	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_uuid	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_optional_api	core			TEST_FRAMEWORK, OPTIONAL_API, TEST_FRAMEWORK, OPTIONAL_API
test_ast_format_str_reduce	core			TEST_FRAMEWORK, format_g723, format_g726, format_g729, format_gsm, format_ogg_vorbis, format_pcm, format_siren14, format_siren7, format_sln, format_wav, format_wav_gsm, TEST_FRAMEWORK, format_g723, format_g726, format_g729, format_gsm, format_ogg_vorbis, format_pcm, format_siren14, format_siren7, format_sln, format_wav, format_wav_gsm
test_scope_trace	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_skel	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_channel_feature_hooks	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_jitterbuf	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_xml_escape	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_aeap	core			TEST_FRAMEWORK, res_aeap, TEST_FRAMEWORK, res_aeap
test_stasis_channels	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_file	core			TEST_FRAMEWORK, TEST_FRAMEWORK
test_astobj2	core			TEST_FRAMEWORK, TEST_FRAMEWORK
dns_srv	core
dns_tlsa	core
bucket	core
pbx_app	core
format_compatibility	core
event	core
ulaw	core
astfd	core
syslog	core
fskmodem	core
io	core
dns_recurring	core
json	core			jansson, jansson
stasis_message	core
config_options	core
logger	core
dns_txt	core
mwi	core
rtp_engine	core
stasis_cache_pattern	core
format_cache	core
channel	core
ccss	core
bridge	core
dns_naptr	core
stasis_state	core
http	core
conversions	core
frame	core
pickup	core
xml	core
audiohook	core
pbx_builtins	core
acl	core
sounds	core
mixmonitor	core
say	core
heap	core
pbx_timing	core
translate	core
fixedjitterbuf	core
sdp_srtp	core
test	core
media_index	core
astobj2	core
dial	core
autochan	core
file	core
presencestate	core
manager	core
abstract_jb	core
loader	core
format	core
stasis_channels	core
core_unreal	core
db	core
pbx_variables	core
global_datastores	core
taskprocessor	core
stream	core
threadstorage	core
app	core
pbx_ignorepat	core
timing	core
dns_query_set	core
localtime	core
image	core
pbx_sw	core
bridge_roles	core
term	core
smoother	core
srv	core
framehook	core
config	core
channel_internal_api	core
pbx	core
fskmodem_int	core
tdd	core
lock	core
fskmodem_float	core
bridge_after	core
sched	core
cli	core
plc	core
devicestate	core
cel	core
netsock2	core
pbx_hangup_handler	core
udptl	core
xmldoc	core
callerid	core
privacy	core
stasis_message_router	core
dns_core	core
stasis_bridges	core
utils	core
autoservice	core
astmm	core
sorcery	core
format_cap	core
cdr	core
pbx_include	core
strings	core
datastore	core
indications	core
codec_builtin	core
time	core
pbx_switch	core
alaw	core
utf8	core
backtrace	core
asterisk	core
options	core
dns	core
dsp	core
stasis_endpoints	core
stasis	core
data_buffer	core
stasis_cache	core
enum	core
core_local	core
pbx_functions	core
dnsmgr	core
stun	core
aoc	core
stasis_system	core
jitterbuf	core
strcompat	core
slinfactory	core
libasteriskpj	core
dns_test	core
media_cache	core
message	core
chanvars	core
astobj2_global	core
bridge_channel	core
crypt	core
codec	core
endpoints	core
hashtab	core
security_events	core
features	core
res_format_attr_siren7	core
res_pjsip_publish_asterisk	core			pjproject, res_pjsip, res_pjsip_outbound_publish, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_outbound_publish, res_pjsip_pubsub
res_mwi_external	core
res_phoneprov	extended
res_mwi_devstate	core
resource_mailboxes	core
resource_asterisk	core
resource_playbacks	core
resource_channels	core
resource_recordings	core
resource_device_states	core
resource_events	core
resource_bridges	core
res_resolver_unbound	core			unbound, unbound
res_endpoint_stats	extended			res_statsd, res_statsd
res_pjsip_aoc	extended			pjproject, res_pjsip, pjproject, res_pjsip
res_mutestream	core
res_crypto	core			openssl, openssl
res_irc	extended
res_aeap	core			res_http_websocket, res_http_websocket
res_rtp_asterisk	core
res_timing_kqueue	extended			kqueue, kqueue
res_timing_pthread	extended
res_ari_device_states	core			res_ari, res_ari_model, res_stasis, res_stasis_device_state, res_ari, res_ari_model, res_stasis, res_stasis_device_state
res_pjsip_refer	core			pjproject, res_pjsip, res_pjsip_session, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_session, res_pjsip_pubsub
res_config_curl	core			func_curl, res_curl, curl, func_curl, res_curl, curl
res_stasis_snoop	core			res_stasis, res_stasis
res_srtp	core			srtp, srtp
res_smdi	extended
res_pjsip_endpoint_identifier_anonymous	core			pjproject, res_pjsip, pjproject, res_pjsip
res_pjsip_caller_id	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_timing_timerfd	core			timerfd, timerfd
res_calendar_caldav	extended			res_calendar, neon, ical, libxml2, res_calendar, neon, ical, libxml2
res_pjsip_dlg_options	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_hep	extended
res_chan_stats	extended			res_statsd, res_statsd
res_pjsip_stir_shaken	core			pjproject, res_pjsip, res_pjsip_session, res_stir_shaken, pjproject, res_pjsip, res_pjsip_session, res_stir_shaken
res_pjsip_pidf_body_generator	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_pjsip_outbound_registration	core			pjproject, res_pjsip, pjproject, res_pjsip
res_speech_aeap	core
res_pjsip_pubsub	core			pjproject, res_pjsip, pjproject, res_pjsip
res_ari_recordings	core			res_ari, res_ari_model, res_stasis, res_stasis_recording, res_ari, res_ari_model, res_stasis, res_stasis_recording
res_sorcery_memory_cache	core
res_timing_dahdi	core			dahdi, dahdi
res_pjsip_diversion	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_pjsip_notify	core			pjproject, res_pjsip, pjproject, res_pjsip
res_ari_endpoints	core			res_ari, res_ari_model, res_stasis, res_ari, res_ari_model, res_stasis
res_format_attr_siren14	core
res_ari_sounds	core			res_ari, res_ari_model, res_stasis, res_ari, res_ari_model, res_stasis
res_coindetect	extended
res_pjsip_dialog_info_body_generator	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_fax_spandsp	extended			spandsp, res_fax, spandsp, res_fax
res_pktccops	deprecated	19	21
res_clioriginate	core
res_pjsip_history	extended			pjproject, res_pjsip, pjproject, res_pjsip
res_prometheus	extended
res_limit	core
res_cliexec	extended
res_hep_pjsip	extended			pjproject, res_pjsip, res_pjsip_session, res_hep, pjproject, res_pjsip, res_pjsip_session, res_hep
res_pjsip_sdp_rtp	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_phreaknet	extended			res_crypto, curl, pbx_config, app_verify, res_crypto, curl, pbx_config, app_verify
res_pjsip_empty_info	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
pval	extended
res_odbc_transaction	core			generic_odbc, generic_odbc
res_pjsip_session	core			pjproject, res_pjsip, pjproject, res_pjsip
res_pjsip_config_wizard	core			pjproject, res_pjsip, pjproject, res_pjsip
res_convert	core
res_stasis_mailbox	core			res_stasis, res_mwi_external, res_stasis, res_mwi_external
res_pjsip_messaging	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_http_media_cache	core			curl, res_curl, curl, res_curl
res_pjsip_registrar	core			pjproject, res_pjproject, res_pjsip, pjproject, res_pjproject, res_pjsip
res_calendar_exchange	extended			res_calendar, neon, ical, iksemel, res_calendar, neon, ical, iksemel
res_pjsip_rfc3326	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_stasis_answer	core			res_stasis, res_stasis
res_pjsip_sips_contact	core			pjproject, res_pjsip, pjproject, res_pjsip
res_odbc	core			generic_odbc, res_odbc_transaction, generic_odbc, res_odbc_transaction
res_hep_rtcp	extended			res_hep, res_hep
res_stasis_device_state	core			res_stasis, res_stasis
res_ari_events	core			res_ari, res_ari_model, res_stasis, res_http_websocket, res_ari, res_ari_model, res_stasis, res_http_websocket
res_geolocation	core			libxml2, libxslt, libxml2, libxslt
res_format_attr_h263	core
res_calendar_icalendar	extended			res_calendar, neon, ical, res_calendar, neon, ical
res_pjsip_exten_state	core			pjproject, res_pjsip, res_pjsip_pubsub, res_pjsip_outbound_publish, pjproject, res_pjsip, res_pjsip_pubsub, res_pjsip_outbound_publish
res_speech	core
res_format_attr_silk	core
res_pjsip_presence	extended			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_snmp	extended			netsnmp, netsnmp
res_corosync	extended			corosync, corosync
res_pjsip_acl	core			pjproject, res_pjsip, pjproject, res_pjsip
res_pjsip_pidf_digium_body_supplement	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_agi	core			res_speech, res_speech
res_ari_applications	core			res_ari, res_ari_model, res_stasis, res_ari, res_ari_model, res_stasis
res_calendar_ews	extended			res_calendar, neon29, res_calendar, neon29
res_http_post	core			gmime, gmime
res_pjsip_mwi_body_generator	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_pjsip_phoneprov_provider	extended			pjproject, res_pjsip, res_phoneprov, pjproject, res_pjsip, res_phoneprov
res_digitmap	extended
res_pjsip_one_touch_record_info	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_format_attr_celt	core
res_xmpp	core			iksemel, iksemel
res_sorcery_config	core
res_audiosocket	extended
res_pjsip_endpoint_identifier_ip	core			pjproject, res_pjsip, pjproject, res_pjsip
res_mwi_external_ami	core			res_mwi_external, res_mwi_external
res_manager_devicestate	core
res_http_websocket	core
res_rtp_multicast	core
res_stasis_recording	core			res_stasis, res_stasis
res_pjsip_dtmf_info	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_ari_bridges	core			res_ari, res_ari_model, res_stasis, res_stasis_recording, res_stasis_playback, res_ari, res_ari_model, res_stasis, res_stasis_recording, res_stasis_playback
res_format_attr_opus	core
res_pjsip_t38	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_ari	core			res_http_websocket, res_stasis, res_http_websocket, res_stasis
res_pjsip_send_to_voicemail	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_ari_model	core
res_pjsip_logger	core			pjproject, res_pjsip, pjproject, res_pjsip
res_remb_modifier	extended
res_format_attr_ilbc	core
res_config_ldap	extended			ldap, ldap
res_pjsip	core			pjproject, res_pjproject, res_sorcery_config, res_sorcery_memory, res_sorcery_astdb, pjproject, res_pjproject, res_sorcery_config, res_sorcery_memory, res_sorcery_astdb
res_monitor	deprecated	16	21
res_calendar	extended
res_fax	core
agent	extended
res_security_log	core
res_format_attr_h264	core
res_stasis_playback	core			res_stasis, res_stasis_recording, res_stasis, res_stasis_recording
res_ari_asterisk	core			res_ari, res_ari_model, res_stasis, res_ari, res_ari_model, res_stasis
res_config_odbc	core			res_odbc, generic_odbc, res_odbc, generic_odbc
res_tonedetect	extended
res_stir_shaken	core			crypto, curl, res_curl, crypto, curl, res_curl
res_ari_channels	core			res_ari, res_ari_model, res_stasis, res_stasis_answer, res_stasis_playback, res_stasis_recording, res_stasis_snoop, res_ari, res_ari_model, res_stasis, res_stasis_answer, res_stasis_playback, res_stasis_recording, res_stasis_snoop
res_pjproject	core			pjproject, res_sorcery_config, pjproject, res_sorcery_config
res_format_attr_vp8	core
res_pjsip_transport_websocket	core			pjproject, res_pjsip, res_http_websocket, pjproject, res_pjsip, res_http_websocket
res_parking	core			bridge_holding, bridge_holding
res_pjsip_path	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_pjsip_nat	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_pjsip_outbound_publish	core			pjproject, res_pjproject, res_pjsip, pjproject, res_pjproject, res_pjsip
res_pjsip_xpidf_body_generator	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_pjsip_header_funcs	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_sorcery_astdb	core
res_curl	core			curl, curl
res_format_attr_g729	core
res_clialiases	core
res_realtime	core
res_pjsip_endpoint_identifier_user	core			pjproject, res_pjsip, pjproject, res_pjsip
res_pjsip_rfc3329	core			pjproject, res_pjsip, res_pjsip_session, pjproject, res_pjsip, res_pjsip_session
res_manager_presencestate	core
res_stun_monitor	core
res_adsi	deprecated
res_ari_mailboxes	core			res_ari, res_ari_model, res_stasis, res_stasis_mailbox, res_ari, res_ari_model, res_stasis, res_stasis_mailbox
res_config_sqlite3	core			sqlite3, sqlite3
res_sorcery_memory	core
res_pjsip_mwi	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_ari_playbacks	core			res_ari, res_ari_model, res_stasis, res_stasis_playback, res_ari, res_ari_model, res_stasis, res_stasis_playback
res_stasis	core
res_pjsip_outbound_authenticator_digest	core			pjproject, res_pjsip, pjproject, res_pjsip
res_stasis_test	core			TEST_FRAMEWORK, TEST_FRAMEWORK
res_config_pgsql	extended			pgsql, pgsql
res_pjsip_authenticator_digest	core			pjproject, res_pjsip, pjproject, res_pjsip
res_statsd	extended
res_pjsip_geolocation	core			res_geolocation, pjproject, res_pjsip, res_pjsip_session, chan_pjsip, libxml2, res_geolocation, pjproject, res_pjsip, res_pjsip_session, chan_pjsip, libxml2
res_sorcery_realtime	core
res_musiconhold	core
res_pjsip_pidf_eyebeam_body_supplement	core			pjproject, res_pjsip, res_pjsip_pubsub, pjproject, res_pjsip, res_pjsip_pubsub
res_ael_share	extended
chan_ooh323	extended
res_config_mysql	extended			mysqlclient, mysqlclient
format_mp3	extended
chan_mobile	extended			bluetooth, bluetooth

chan_motif

Synopsis

Jingle Channel Driver

This configuration documentation is for functionality provided by chan_motif.

Description

Transports

There are three different transports and protocol derivatives supported by chan_motif. They are in order of preference: Jingle using ICE-UDP, Google Jingle, and Google-V1.

Jingle as defined in XEP-0166 supports the widest range of features. It is referred to as ice-udp. This is the specification that Jingle clients implement.

Google Jingle follows the Jingle specification for signaling but uses a custom transport for media. It is supported by the Google Talk Plug-in in Gmail and by some other Jingle clients. It is referred to as google in this file.

Google-V1 is the original Google Talk signaling protocol which uses an initial preliminary version of Jingle. It also uses the same custom transport as Google Jingle for media. It is supported by Google Voice, some other Jingle clients, and the Windows Google Talk client. It is referred to as google-v1 in this file.

Incoming sessions will automatically switch to the correct transport once it has been determined.

Outgoing sessions are capable of determining if the target is capable of Jingle or a Google transport if the target is in the roster. Unfortunately it is not possible to differentiate between a Google Jingle or Google-V1 capable resource until a session initiate attempt occurs. If a resource is determined to use a Google transport it will initially use Google Jingle but will fall back to Google-V1 if required.

If an outgoing session attempt fails due to failure to support the given transport chan_motif will fall back in preference order listed previously until all transports have been exhausted.

Dialing and Resource Selection Strategy

Placing a call through an endpoint can be accomplished using the following dial string:

Motif/[endpoint name]/[target]

When placing an outgoing call through an endpoint the requested target is searched for in the roster list. If present the first Jingle or Google Jingle capable resource is specifically targeted. Since the capabilities of the resource are known the outgoing session initiation will disregard the configured transport and use the determined one.

If the target is not found in the roster the target will be used as-is and a session will be initiated using the transport specified in this configuration file. If no transport has been specified the endpoint defaults to ice-udp.

Video Support

Support for video does not need to be explicitly enabled. Configuring any video codec on your endpoint will automatically enable it.

DTMF

The only supported method for DTMF is RFC2833. This is always enabled on audio streams and negotiated if possible.

Incoming Calls

Incoming calls will first look for the extension matching the name of the endpoint in the configured context. If no such extension exists the call will automatically fall back to the s extension.

CallerID

The incoming caller id number is populated with the username of the caller and the name is populated with the full identity of the caller. If you would like to perform authentication or filtering of incoming calls it is recommended that you use these fields to do so.

Outgoing caller id can not be set.

Multiple endpoints using the same connection is NOT supported. Doing so may result in broken calls.

Configuration Option Reference

motif.conf

endpoint

The configuration for an endpoint.

Option Name	Type	Default Value	Regular Expression	Description
context				Default dialplan context that incoming sessions will be routed to
callgroup				A callgroup to assign to this endpoint.
pickupgroup				A pickup group to assign to this endpoint.
language				The default language for this endpoint.
musicclass				Default music on hold class for this endpoint.
parkinglot				Default parking lot for this endpoint.
accountcode				Accout code for CDR purposes
allow				Codecs to allow
disallow				Codecs to disallow
connection				Connection to accept traffic on and on which to send traffic out
transport				The transport to use for the endpoint.
maxicecandidates				Maximum number of ICE candidates to offer
maxpayloads				Maximum number of payloads to offer

app_skel

Synopsis

Description

Configuration Option Reference

app_skel.conf

globals

Options that apply globally to app_skel

Option Name	Type	Default Value	Regular Expression	Description
games				The number of games a single execution of SkelGuessNumber will play
cheat				Should the computer cheat?

sounds

Prompts for SkelGuessNumber to play

Option Name	Type	Default Value	Regular Expression	Description
prompt				A prompt directing the user to enter a number less than the max number
wrong_guess				The sound file to play when a wrong guess is made
right_guess				The sound file to play when a correct guess is made
too_low				The sound file to play when a guess is too low
too_high				The sound file to play when a guess is too high
lose				The sound file to play when a player loses

level

Defined levels for the SkelGuessNumber game

Option Name	Type	Default Value	Regular Expression	Description
max_number				The maximum in the range of numbers to guess (1 is the implied minimum)
max_guesses				The maximum number of guesses before a game is considered lost

app_confbridge

Synopsis

Conference Bridge Application

This configuration documentation is for functionality provided by app_confbridge.

Description

Configuration Option Reference

confbridge.conf

global

Unused, but reserved.

user_profile

A named profile to apply to specific callers.

Option Name	Type	Default Value	Regular Expression	Description
type				Define this configuration category as a user profile.
admin				Sets if the user is an admin or not
send_events				Sets if events are send to the user
echo_events				Sets if events are echoed back to the user that triggered them
marked				Sets if this is a marked user or not
startmuted				Sets if all users should start out muted
music_on_hold_when_empty				Play MOH when user is alone or waiting on a marked user
quiet				Silence enter/leave prompts and user intros for this user
hear_own_join_sound				Determines if the user also hears the join sound when they enter a conference
announce_user_count				Sets if the number of users should be announced to the user
announce_user_count_all				Announce user count to all the other users when this user joins
announce_only_user				Announce to a user when they join an empty conference
wait_marked				Sets if the user must wait for a marked user to enter before joining a conference
end_marked				Kick the user from the conference when the last marked user leaves
end_marked_any				Kick the user from the conference when any marked user leaves
talk_detection_events				Set whether or not notifications of when a user begins and ends talking should be sent out as events over AMI
dtmf_passthrough				Sets whether or not DTMF should pass through the conference
announce_join_leave				Prompt user for their name when joining a conference and play it to the conference when they enter
announce_join_leave_review				Prompt user for their name when joining a conference and play it to the conference when they enter. The user will be asked to review the recording of their name before entering the conference.
pin				Sets a PIN the user must enter before joining the conference
music_on_hold_class				The MOH class to use for this user
announcement				Sound file to play to the user when they join a conference
denoise				Apply a denoise filter to the audio before mixing
dsp_drop_silence				Drop what Asterisk detects as silence from audio sent to the bridge
dsp_silence_threshold				The number of milliseconds of silence necessary to declare talking stopped.
dsp_talking_threshold				Average magnitude threshold to determine talking.
jitterbuffer				Place a jitter buffer on the user's audio stream before audio mixing is performed
template				When using the CONFBRIDGE dialplan function, use a user profile as a template for creating a new temporary profile
timeout				Kick the user out of the conference after this many seconds. 0 means there is no timeout for the user.
text_messaging				Sets if text messages are sent to the user.
answer_channel				Sets if a user's channel should be answered if currently unanswered.

bridge_profile

A named profile to apply to specific bridges.

Option Name	Type	Default Value	Regular Expression	Description
type				Define this configuration category as a bridge profile
jitterbuffer				Place a jitter buffer on the conference's audio stream
internal_sample_rate				Set the internal native sample rate for mixing the conference
maximum_sample_rate				Set the maximum native sample rate for mixing the conference
language				The language used for announcements to the conference.
mixing_interval				Sets the internal mixing interval in milliseconds for the bridge
binaural_active				If true binaural conferencing with stereo audio is active
record_conference				Record the conference starting with the first active user's entrance and ending with the last active user's exit
record_file				The filename of the conference recording
record_file_append				Append to record file when starting/stopping on same conference recording
record_file_timestamp				Append the start time to the record_file name so that it is unique.
record_options				Pass additional options to MixMonitor when recording
record_command				Execute a command after recording ends
regcontext				The name of the context into which to register the name of the conference bridge as NoOP() at priority 1
video_mode				Sets how confbridge handles video distribution to the conference participants
max_members				Limit the maximum number of participants for a single conference
sound_				Override the various conference bridge sound files
video_update_discard				Sets the amount of time in milliseconds after sending a video update to discard subsequent video updates
remb_send_interval				Sets the interval in milliseconds that a combined REMB frame will be sent to video sources
remb_behavior				Sets how REMB reports are generated from multiple sources
remb_estimated_bitrate				Sets the estimated bitrate sent to each participant in REMB reports
enable_events				Enables events for this bridge
template				When using the CONFBRIDGE dialplan function, use a bridge profile as a template for creating a new temporary profile

app_george

Synopsis

George, the Interactive Answering Machine

This configuration documentation is for functionality provided by app_george.

Description

Configuration Option Reference

app_george.conf

general

Audio files to use for George. All audio prompts must be specified.

Option Name	Type	Default Value	Regular Expression	Description
hello				Hello?
whos_calling				This is the answering machine, who's calling please?
recording				This is the answering machine. I'm recording your message, go ahead.
get_number				All right, what's your number?
go_ahead				Go ahead.
thanks_anything_else				Thanks, anything else?
okay_thanks				Okay, thanks.
bye				Bye.
cw_prompt				I have another call, can you hold please?
prompt_anything_else				Anything else?
connect_sound				Answering sound
hangup_sound				Hangup sound

app_agent_pool

Synopsis

Agent pool applications

This configuration documentation is for functionality provided by app_agent_pool.

Description

Option changes take effect on agent login or after an agent disconnects from a call.

Configuration Option Reference

agents.conf

global

Unused, but reserved.

agent-id

Configure an agent for the pool.

Option Name	Type	Default Value	Regular Expression	Description
ackcall				Enable to require the agent to acknowledge a call.
acceptdtmf				DTMF key sequence the agent uses to acknowledge a call.
autologoff				Time the agent has to acknowledge a call before being logged off.
wrapuptime				Minimum time the agent has between calls.
musiconhold				Music on hold class the agent listens to between calls.
recordagentcalls				Enable to automatically record calls the agent takes.
custom_beep				Sound file played to alert the agent when a call is present.
fullname				A friendly name for the agent used in log messages.

app_verify

Synopsis

Module to verify incoming and outgoing calls

This configuration documentation is for functionality provided by app_verify.

Description

Configuration Option Reference

verify.conf

general

Options that apply globally to app_verify

Option Name	Type	Default Value	Regular Expression	Description
curltimeout				The number of seconds curl has to retrieve a resource before timing out.

profile

Defined profiles for app_verify to use with call verification.

Option Name	Type	Default Value	Regular Expression	Description
verifymethod				Method to use for verification.
requestmethod				Method to use for making verification requests.
verifyrequest				Request to make for verification requests.
verifycontext				Context to use for verification.
local_var				Name of variable in which to store the verification result.
stirshaken_var				Name of variable in which to store the STIR/SHAKEN disposition.
remote_stirshaken_var				Name of remote variable in which the STIR/SHAKEN disposition can be found.
via_number				Number on this node for reverse identification.
remote_var				Name of remote variable containing upstream verification result.
via_remote_var				Name of remote variable containing upstream node identifier.
setinvars				Variable assignments to make after verification of an incoming call has completed.
setoutvars				Opposite of setinvars: variable assignments made after OutVerify has completed.
sanitychecks				Whether or not to perform basic sanity checks.
extendtrust				Whether or not to allow thru calls to be verified by verifying the upstream node.
allowdisathru				Whether or not to allow thru-dialing out of the node.
allowpstnthru				Whether or not to allow PSTN calls to leave the node.
allowtoken				Whether or not to allow token verification.
validatetokenrequest				Request to make for token verification. Only supported for "reverse" verifications. Must be an HTTP endpoint. Dialplan variables may be used.
token_remote_var				Name of remote variable (probably an IAXVAR) in which a verification token may be stored. Must be universal across a telephony domain.
exceptioncontext				Name of dialplan context containing exceptions.
successregex				Regular expression to determine if a verification was successful or not.
blacklist_endpoint				Request to make for blacklist check.
blacklist_threshold				Blacklist threshold above which calls are rejected
blacklist_failopen				Allow calls that cannot successfully be queried using the blacklist API
flagprivateip				Whether or not to flag calls to private IP addresses as malicious destinations.
outregex				Regular expression to use to validate lookups, if provided to the OutVerify application.
threshold				Maximum number of unsuccessfully verified calls to accept before subsequent calls are dropped upon arrival.
failgroup				Group category to which to assign calls that fail verification.
failureaction				Action to take when a call fails verification.
failurefile				File or ampersand-separated files to play when verification fails.
region				Region identifier (e.g. 2 characters) to use for tagging PSTN calls that enter and leave this node.
clli				String node identifier (e.g. CLLI) to use for tagging calls that leave this node.
code_good				Codes to assign to calls we attempt to verify.
code_fail				Code to assign to local_var for unsuccessfully verified calls.
code_requestfail				Code to assign to local_var for calls that could not be verified (e.g. request failure).
code_spoof				Code to assign to local_var for spoofed calls.
loglevel				Name of log level at which to log incoming calls (e.g. WARNING, custom, etc.)
logmsg				Format of message to log. May contain variables which will be evaluated/substituted at log time.

app_ccsa

Synopsis

Module to provide Common Control Switching Arrangement functionality

This configuration documentation is for functionality provided by app_ccsa.

Description

Configuration Option Reference

ccsa.conf

general

Options that apply globally to app_ccsa

Option Name	Type	Default Value	Regular Expression	Description
cdrvar_frl				CDR field in which to store original FRL
cdrvar_frl_req				CDR field in which to store required FRL
cdrvar_frl_eff				CDR field in which to store the effective (upgraded) FRL
cdrvar_mlpp				CDR field in which to store the MLPP precedence for a call
cdrvar_authcode				CDR field in which to store the auth code for a call
cdrvar_facility				CDR field in which to store the facility (trunk group) used for a call
cdrvar_route				CDR field in which to store the route used for a call
cdrvar_queuestart				CDR field in which to store the queue start timestamp
cdrvar_digits				CDR field in which to store any dialed digits

route

Individual CCSA route (trunk group).

Option Name	Type	Default Value	Regular Expression	Description
facility				Name of facility
route_type				Type of route.
dialstr				Dial string for Dial application to use for calls
threshold				Threshold of queued priority 3 calls at which it is unlikely an additional call would be able to queue successfully at priority 3 without timing out.
limit				Maximum number of simultaneous calls that may use this route
frl				Facility Restriction Level required for usage
mer				More Expensive Route
busyiscongestion				Whether busy constitutes trunk busy/congestion
time				Time restrictions for route

ccsa

Individual CCSA configuration.

Option Name	Type	Default Value	Regular Expression	Description
route				Default routes.
mer_tone				More Expensive Route Tone
auth_code_len				Authorization code length
extension_len				Extension length
frl_allow_upgrade				FRL Upgrades Allowed
auth_code_remote_allowed				Remote Usage of Authorization Codes Allowed
auth_sub_context				Authorization code validation subroutine
hold_announcement				Hold announcement
extension_prompt				Extension prompt
queue_promo_timer				Queue Promotion Timer
route_advance_timer				Route Advance Timer
callback_caller_context				Callback caller context
callback_dest_context				Callback destination context

app_selective

Synopsis

Module to provide user management of selective calling features

This configuration documentation is for functionality provided by app_selective.

Description

Configuration Option Reference

selective.conf

general

Options that apply globally to app_selective

Option Name	Type	Default Value	Regular Expression	Description
brief_wait				Audio file containing a 1 second pause.
short_wait				Audio file containing a 3 second pause.
main_wait				Audio file containing a 4 second pause.
med_wait				Audio file containing a 7 second pause.
long_wait				Audio file containing a 15 second pause.

profile

Defined profiles for app_selective to use.

Option Name	Type	Default Value	Regular Expression	Description
empty_list_allowed				Whether or not this feature may be active if the list is empty.
astdb_active				The AstDB family/key path that indicates with a 1 or 0 whether or not the feature is active.
astdb_entries				The AstDB prefix used for managing entries on this list
astdb_featnum				If specified, the AstDB location of a number to use when feature is invoked.
sub_numvalid				Dialplan subroutine to execute as a callback to check if a user-entered number is valid
sub_numaddable				Dialplan subroutine to execute as a callback to check if a user-entered number may be added to the feature list as an entry
sub_featnumcheck				Dialplan subroutine to execute as a callback to check if a user-entered number may be used as the special feature number
last_caller_num				Expression for CALLERID(num) of last incoming call
last_caller_pres				Expression for CALLERID(pres) of last incoming call
saytelnum_dir				Directory containing prompts for SayTelephoneNumber announcements
saytelnum_args				Arguments for SayTelephoneNumber application, following the number
prompt_on				Prompt to indicate the feature is currently or newly enabled
prompt_off				Prompt to indicate the feature is currently or newly disabled
prompt_dial_during_instr				Prompt to say "You may dial during the instructions for faster service".
prompt_to_reject_last				Prompt to say "To reject the last calling party, dial 12, and then, dial 01".
prompt_to_reject_last_dtmf				Prompt to say "To reject the last calling party, press the number sign key, dial 01, and then, press the number sign key, again".
prompt_to_turn_off				Prompt to say "To turn off this service, dial 3".
prompt_to_turn_on				Prompt to say "To turn on this service, dial 3".
prompt_add_delete				Prompt to for adding or deleting entries
prompt_instructions_1				Main instructions part 1
prompt_instructions_1_dtmf				Main instructions part 1 (DTMF version)
prompt_instructions_2_on				Main instructions part 2 (service on)
prompt_instructions_2_off				Main instructions part 2 (service off)
prompt_instructions_3				Main instructions part 3
prompt_there_is				Prompt to say "there is"
prompt_there_are				Prompt to say "there are"
prompt_no_entries				Prompt to say "There are no entries on your list"
prompt_on_your_list				Prompt to say "on your list"
prompt_one				Prompt to say "1"
prompt_ten				Prompt to say "10"
prompt_sorry_no_entries				Prompt to say "Sorry, there are no entries on your list."
prompt_no_more_private				Prompt to say "There are no more private entries on your list."
prompt_no_more				Prompt to say "There are no more entries on your list."
prompt_private_entries				Prompt to say "private entries"
prompt_one_private_entry				Prompt to say "one private entry"
prompt_one_private_entry_down				Prompt to say "one private entry", ending in a down pitch
prompt_private_entries_down				Prompt to say "private entries", ending in a down pitch
prompt_one_entry				Prompt to say "one entry"
prompt_entries_on_your_list				Prompt to say "entries on your list"
prompt_including				Prompt to say "including"
prompt_entry_required				Prompt if an entry is required to activate the feature
prompt_entry_required_dtmf				Prompt if an entry is required to activate the feature (DTMF version)
prompt_beep				Beep tone
prompt_dial_number_to_add				Prompt to dial number to be added
prompt_dial_number_to_add_dtmf				Prompt to dial number to be added (DTMF version)
prompt_dial_remove				Prompt to dial number to be removed
prompt_must_dial_number				Prompt to inform caller he or she must dial a number
prompt_start_again				Prompt to inform caller to start again
prompt_number_dialed				Prompt to say "The number you have dialed"
prompt_not_permitted				Prompt for number not permitted
prompt_too_few_digits_start_again				Prompt for "You have dialed too few digits. Please start again."
prompt_too_many_digits_start_again				Prompt for "You have dialed too many digits. Please start again."
prompt_last_caller_not_available				Prompt for last caller is not available
prompt_number_incorrect				Prompt for number dialed is incorrect
prompt_number_not_available_svc				Prompt for number dialed is not available with this service
prompt_already_on_list				Prompt for number dialed already on list
prompt_as_a_private_entry				Prompt for "as a private entry"
prompt_list_full				Prompt for list full
prompt_number_to_remove_not_on_list				Prompt for number to remove not on list
prompt_confirm_entry				Prompt to confirm entry
prompt_dial_featnum				Prompt to enter a feature number for enabling the service. Only applies when feature number required
prompt_active_featnum				Prompt to hear current feature number.
prompt_number_added_is				Prompt to hear number added
prompt_number_removed_is				Prompt to hear number removed
prompt_a_private_entry				Prompt for "a private entry"
prompt_please_continue				Prompt to continue
prompt_try_again_later				Prompt to try again later
prompt_hangup				Prompt to hangup and consult instructions
prompt_invalid_command				Prompt for invalid command
prompt_to_delete_dial_07				Prompt for "To delete an entry, dial 07 as soon as you hear it"
prompt_first_entry_is				Prompt for "The first entry on your list is"
prompt_next				Prompt for "Next..."
prompt_next				Prompt for "This is the end of your list"

core

Synopsis

Bucket file API

This configuration documentation is for functionality provided by core.

Description

Configuration Option Reference

bucket

Option Name	Type	Default Value	Regular Expression	Description
scheme				Scheme in use for bucket
created				Time at which the bucket was created
modified				Time at which the bucket was last modified

file

Option Name	Type	Default Value	Regular Expression	Description
scheme				Scheme in use for file
created				Time at which the file was created
modified				Time at which the file was last modified

cel

Synopsis

Description

Configuration Option Reference

cel.conf

general

Options that apply globally to Channel Event Logging (CEL)

Option Name	Type	Default Value	Regular Expression	Description
enable				Determines whether CEL is enabled
dateformat				The format to be used for dates when logging
apps				List of apps for CEL to track
events				List of events for CEL to track

udptl

Synopsis

Description

Configuration Option Reference

udptl.conf

global

Global options for configuring UDPTL

Option Name	Type	Default Value	Regular Expression	Description
udptlstart				The start of the UDPTL port range
udptlend				The end of the UDPTL port range
udptlchecksums				Whether to enable or disable UDP checksums on UDPTL traffic
udptlfecentries				The number of error correction entries in a UDPTL packet
udptlfecspan				The span over which parity is calculated for FEC in a UDPTL packet
use_even_ports				Whether to only use even-numbered UDPTL ports
t38faxudpec				Removed
t38faxmaxdatagram				Removed

cdr

Synopsis

Call Detail Record configuration

This configuration documentation is for functionality provided by cdr.

Description

CDR is Call Detail Record, which provides logging services via a variety of pluggable backend modules. Detailed call information can be recorded to databases, files, etc. Useful for billing, fraud prevention, compliance with Sarbanes-Oxley aka The Enron Act, QOS evaluations, and more.

Configuration Option Reference

cdr.conf

general

Global settings applied to the CDR engine.

Option Name	Type	Default Value	Regular Expression	Description
debug				Enable/disable verbose CDR debugging.
enable				Enable/disable CDR logging.
channeldefaultenabled				Whether CDR is enabled on a channel by default
ignorestatechanges				Whether CDR is updated or forked by bridging changes.
ignoredialchanges				Whether CDR is updated or forked by dial updates.
unanswered				Log calls that are never answered and don't set an outgoing party.
congestion				Log congested calls.
endbeforehexten				Don't produce CDRs while executing hangup logic
initiatedseconds				Count microseconds for billsec purposes
batch				Submit CDRs to the backends for processing in batches
size				The maximum number of CDRs to accumulate before triggering a batch
time				The maximum time to accumulate CDRs before triggering a batch
scheduleronly				Post batched CDRs on their own thread instead of the scheduler
safeshutdown				Block shutdown of Asterisk until CDRs are submitted

features

Synopsis

Features Configuration

This configuration documentation is for functionality provided by features.

Description

Configuration Option Reference

features.conf

globals

Option Name	Type	Default Value	Regular Expression	Description
featuredigittimeout				Milliseconds allowed between digit presses when entering a feature code.
courtesytone				Sound to play when automon or automixmon is activated
recordingfailsound				Sound to play when automon or automixmon is attempted but fails to start
transferdigittimeout				Seconds allowed between digit presses when dialing a transfer destination
atxfernoanswertimeout				Seconds to wait for attended transfer destination to answer
atxferdropcall				Hang up the call entirely if the attended transfer fails
atxferloopdelay				Seconds to wait between attempts to re-dial transfer destination
atxfercallbackretries				Number of times to re-attempt dialing a transfer destination
xfersound				Sound to play to during transfer and transfer-like operations.
xferfailsound				Sound to play to a transferee when a transfer fails
atxferabort				Digits to dial to abort an attended transfer attempt
atxfercomplete				Digits to dial to complete an attended transfer
atxferthreeway				Digits to dial to change an attended transfer into a three-way call
atxferswap				Digits to dial to toggle who the transferrer is currently bridged to during an attended transfer
pickupexten				Digits used for picking up ringing calls
pickupsound				Sound to play to picker when a call is picked up
pickupfailsound				Sound to play to picker when a call cannot be picked up
transferdialattempts				Number of dial attempts allowed when attempting a transfer
transferretrysound				Sound that is played when an incorrect extension is dialed and the transferer should try again.
transferinvalidsound				Sound that is played when an incorrect extension is dialed and the transferer has no attempts remaining.
transferannouncesound				Sound that is played to the transferer when a transfer is initiated. If empty, no sound will be played.

featuremap

DTMF options that can be triggered during bridged calls

Option Name	Type	Default Value	Regular Expression	Description
atxfer				DTMF sequence to initiate an attended transfer
blindxfer				DTMF sequence to initiate a blind transfer
disconnect				DTMF sequence to disconnect the current call
parkcall				DTMF sequence to park a call
automon				DTMF sequence to start or stop Monitor on a call
automixmon				DTMF sequence to start or stop MixMonitor on a call

applicationmap

Section for defining custom feature invocations during a call

Option Name	Type	Default Value	Regular Expression	Description
				A custom feature to invoke during a bridged call

featuregroup

Groupings of items from the applicationmap

Option Name	Type	Default Value	Regular Expression	Description
				Applicationmap item to place in the feature group

named_acl

Synopsis

Description

Configuration Option Reference

named_acl.conf

named_acl

Options for configuring a named ACL

Option Name	Type	Default Value	Regular Expression	Description
permit				An address/subnet from which to allow access
deny				An address/subnet from which to disallow access

stasis

Synopsis

Description

Configuration Option Reference

stasis.conf

threadpool

Settings that configure the threadpool Stasis uses to deliver some messages.

Option Name	Type	Default Value	Regular Expression	Description
initial_size				Initial number of threads in the message bus threadpool.
idle_timeout_sec				Number of seconds before an idle thread is disposed of.
max_size				Maximum number of threads in the threadpool.

declined_message_types

Stasis message types for which to decline creation.

Option Name	Type	Default Value	Regular Expression	Description
decline				The message type to decline.

res_pjsip_publish_asterisk

Synopsis

SIP resource for inbound and outbound Asterisk event publications

This configuration documentation is for functionality provided by res_pjsip_publish_asterisk.

Description

Inbound and outbound Asterisk event publication

This module allows res_pjsip to send and receive Asterisk event publications.

Configuration Option Reference

pjsip.conf

asterisk-publication

The configuration for inbound Asterisk event publication

Option Name	Type	Default Value	Regular Expression	Description
devicestate_publish				Optional name of a publish item that can be used to publish a request for full device state information.
mailboxstate_publish				Optional name of a publish item that can be used to publish a request for full mailbox state information.
device_state				Whether we should permit incoming device state events.
device_state_filter				Optional regular expression used to filter what devices we accept events for.
mailbox_state				Whether we should permit incoming mailbox state events.
mailbox_state_filter				Optional regular expression used to filter what mailboxes we accept events for.
type				Must be of type 'asterisk-publication'.

res_mwi_external

Synopsis

Core external MWI support

This configuration documentation is for functionality provided by res_mwi_external.

Description

Configuration Option Reference

sorcery.conf

mailboxes

Persistent cache of external MWI Mailboxs.

res_resolver_unbound

Synopsis

Description

Configuration Option Reference

resolver_unbound.conf

general

General options for res_resolver_unbound

Option Name	Type	Default Value	Regular Expression	Description
hosts				Full path to an optional hosts file
resolv				Full path to an optional resolv.conf file
nameserver				Nameserver to use for queries
debug				Unbound debug level
ta_file				Trust anchor file

res_aeap

Synopsis

Asterisk External Application Protocol (AEAP) module for Asterisk

This configuration documentation is for functionality provided by res_aeap.

Description

Configuration Option Reference

aeap.conf

client

AEAP client options

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'client'.
url				The URL of the server to connect to.
protocol				The application protocol.
codecs				Optional media codec(s)

res_hep

Synopsis

Resource for integration with Homer using HEPv3

This configuration documentation is for functionality provided by res_hep.

Description

Configuration Option Reference

hep.conf

general

General settings.

Option Name	Type	Default Value	Regular Expression	Description
enabled				Enable or disable packet capturing.
uuid_type				The preferred type of UUID to pass to Homer.
capture_address				The address and port of the Homer server to send packets to.
capture_password				If set, the authentication password to send to Homer.
capture_id				The ID for this capture agent.
capture_name				The name for this capture agent.

res_pjsip_outbound_registration

Synopsis

SIP resource for outbound registrations

This configuration documentation is for functionality provided by res_pjsip_outbound_registration.

Description

Outbound Registration

This module allows res_pjsip to register to other SIP servers.

Configuration Option Reference

pjsip.conf

registration

The configuration for outbound registration

Option Name	Type	Default Value	Regular Expression	Description
auth_rejection_permanent				Determines whether failed authentication challenges are treated as permanent failures.
client_uri				Client SIP URI used when attemping outbound registration
contact_user				Contact User to use in request. If this value is not set, this defaults to 's'
contact_header_params				Header parameters to place in the Contact header
expiration				Expiration time for registrations in seconds
max_retries				Maximum number of registration attempts.
security_negotiation				The kind of security agreement negotiation to use. Currently, only mediasec is supported.
security_mechanisms				List of security mechanisms supported.
outbound_auth				Authentication object(s) to be used for outbound registrations.
outbound_proxy				Full SIP URI of the outbound proxy used to send registrations
max_random_initial_delay				Maximum interval in seconds for which an initial registration may be randomly delayed
retry_interval				Interval in seconds between retries if outbound registration is unsuccessful
forbidden_retry_interval				Interval used when receiving a 403 Forbidden response.
fatal_retry_interval				Interval used when receiving a Fatal response.
server_uri				SIP URI of the server to register against
transport				Transport used for outbound authentication
line				Whether to add a 'line' parameter to the Contact for inbound call matching
endpoint				Endpoint to use for incoming related calls
type				Must be of type 'registration'.
support_path				Enables advertising SIP Path support for outbound REGISTER requests.
support_outbound				Enables advertising SIP Outbound support (RFC5626) for outbound REGISTER requests.

res_pjsip_pubsub

Synopsis

Module that implements publish and subscribe support.

This configuration documentation is for functionality provided by res_pjsip_pubsub.

Description

Configuration Option Reference

pjsip.conf

subscription_persistence

Persists SIP subscriptions so they survive restarts.

Option Name	Type	Default Value	Regular Expression	Description
packet				Entire SIP SUBSCRIBE packet that created the subscription
src_name				The source address of the subscription
src_port				The source port of the subscription
transport_key				The type of transport the subscription was received on
local_name				The local address the subscription was received on
local_port				The local port the subscription was received on
cseq				The sequence number of the next NOTIFY to be sent
tag				The local tag of the dialog for the subscription
endpoint				The name of the endpoint that subscribed
expires				The time at which the subscription expires
contact_uri				The Contact URI of the dialog for the subscription
prune_on_boot				If set, indicates that the contact used a reliable transport and therefore the subscription must be deleted after an asterisk restart.
generator_data				If set, contains persistence data for all generators of content for the subscription.

resource_list

Resource list configuration parameters.

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'resource_list'
event				The SIP event package that the list resource belong to.
list_item				The name of a resource to report state on
full_state				Indicates if the entire list's state should be sent out.
notification_batch_interval				Time Asterisk should wait, in milliseconds, before sending notifications.
resource_display_name				Indicates whether display name of resource or the resource name being reported.

inbound-publication

The configuration for inbound publications

Option Name	Type	Default Value	Regular Expression	Description
endpoint				Optional name of an endpoint that is only allowed to publish to this resource
type				Must be of type 'inbound-publication'.

res_pjsip_notify

Synopsis

Module that supports sending NOTIFY requests to endpoints from external sources

This configuration documentation is for functionality provided by res_pjsip_notify.

Description

Configuration Option Reference

pjsip_notify.conf

general

Unused, but reserved.

notify

Configuration of a NOTIFY request.

Option Name	Type	Default Value	Regular Expression	Description
				A key/value pair to add to a NOTIFY request.

res_prometheus

Synopsis

Resource for integration with Prometheus

This configuration documentation is for functionality provided by res_prometheus.

Description

Configuration Option Reference

prometheus.conf

general

General settings.

Option Name	Type	Default Value	Regular Expression	Description
enabled				Enable or disable Prometheus statistics.
core_metrics_enabled				Enable or disable core metrics.
uri				The HTTP URI to serve metrics up on.
auth_username				Username to use for Basic Auth.
auth_password				Password to use for Basic Auth.
auth_realm				Auth realm used in challenge responses

res_phreaknet

Synopsis

PhreakNet enhancement module

This configuration documentation is for functionality provided by res_phreaknet.

Description

Configuration Option Reference

res_phreaknet.conf

general

Option Name	Type	Default Value	Regular Expression	Description
hostname				PhreakNet hostname
autokeyfetch				Whether to automatically fetch RSA public keys periodically.
autokeyrotate				Whether to automatically rotate the local PhreakNet RSA keypair once per day.
requesttoken				Whether to automatically request a token on outgoing PhreakNet calls.
fallbackwarning				Provide audible warning tone if a call initially attempted using RSA authentication is forced to fallback to MD5 authentication
blacklistthreshold				Blacklisting threshold for lookup requests.
requirekeytoload				Specifies whether this module should decline to load if API key is missing.

intervals

Option Name	Type	Default Value	Regular Expression	Description
keyfetch_interval				How often (in seconds) all RSA public keys will be downloaded.
keyrotate_hour				The hour of the day (from 0-23), in system time, to rotate the local PhreakNet RSA keypair.

res_pjsip_config_wizard

Synopsis

Module that provides simple configuration wizard capabilities.

This configuration documentation is for functionality provided by res_pjsip_config_wizard.

Description

PJSIP Configuration Wizard

This module allows creation of common PJSIP configuration scenarios without having to specify individual endpoint, aor, auth, identify and registration objects.

For example, the following configuration snippet would create the endpoint, aor, contact, auth and phoneprov objects necessary for a phone to get phone provisioning information, register, and make and receive calls. A hint is also created in the default context for extension 1000.

The first 8 items are specific to the wizard. The rest of the items are passed verbatim to the underlying objects.

The following configuration snippet would create the endpoint, aor, contact, auth, identify and registration objects necessary for a trunk to another pbx or ITSP that requires registration.

Of course, any of the items in either example could be placed into templates and shared among wizard objects.

For more information, visit:

https://wiki.asterisk.org/wiki/display/AST/PJSIP+Configuration+Wizard

Example: myphone

	[myphone]
	type = wizard
	sends_auth = no
	accepts_auth = yes
	sends_registrations = no
	accepts_registrations = yes
	has_phoneprov = yes
	transport = ipv4
	has_hint = yes
	hint_exten = 1000
	inbound_auth/username = testname
	inbound_auth/password = test password
	endpoint/allow = ulaw
	endpoint/context = default
	phoneprov/MAC = 001122aa4455
	phoneprov/PROFILE = profile1

Example: mytrunk

	[mytrunk]
	type = wizard
	sends_auth = yes
	accepts_auth = no
	sends_registrations = yes
	accepts_registrations = no
	transport = ipv4
	remote_hosts = sip1.myitsp.com:5060,sip2.myitsp.com:5060
	outbound_auth/username = testname
	outbound_auth/password = test password
	endpoint/allow = ulaw
	endpoint/context = default

Configuration Option Reference

pjsip_wizard.conf

wizard

Provides config wizard.

Option Name	Type	Default Value	Regular Expression	Description
type				Must be 'wizard'.
transport				The name of a transport to use for this object.
remote_hosts				List of remote hosts.
outbound_proxy				Shortcut for specifying proxy on individual objects.
sends_auth				Send outbound authentication to remote hosts.
accepts_auth				Accept incoming authentication from remote hosts.
sends_registrations				Send outbound registrations to remote hosts.
sends_line_with_registrations				Sets "line" and "endpoint parameters on registrations.
accepts_registrations				Accept inbound registration from remote hosts.
has_phoneprov				Create a phoneprov object for this endpoint.
server_uri_pattern				A pattern to use for constructing outbound registration server_uris.
client_uri_pattern				A pattern to use for constructing outbound registration client_uris.
contact_pattern				A pattern to use for constructing outbound contact uris.
has_hint				Create hint and optionally a default application.
hint_context				The context in which to place hints.
hint_exten				Extension to map a PJSIP hint to.
hint_application				Application to call when 'hint_exten' is dialed.
endpoint/*				Variables to be passed directly to the endpoint.
aor/*				Variables to be passed directly to the aor.
inbound_auth/*				Variables to be passed directly to the inbound auth.
outbound_auth/*				Variables to be passed directly to the outbound auth.
identify/*				Variables to be passed directly to the identify.
registration/*				Variables to be passed directly to the outbound registrations.
phoneprov/*				Variables to be passed directly to the phoneprov object.

res_http_media_cache

Synopsis

HTTP media cache

This configuration documentation is for functionality provided by res_http_media_cache.

Description

Configuration Option Reference

http_media_cache.conf

general

General configuration

Option Name	Type	Default Value	Regular Expression	Description
timeout_secs				The maximum time the transfer is allowed to complete in seconds. See https://curl.se/libcurl/c/CURLOPT_TIMEOUT.html for details.
user_agent				The HTTP User-Agent to use for requests. See https://curl.se/libcurl/c/CURLOPT_USERAGENT.html for details.
follow_location				Follow HTTP 3xx redirects on requests. See https://curl.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html for details.
max_redirects				The maximum number of redirects to follow. See https://curl.se/libcurl/c/CURLOPT_MAXREDIRS.html for details.
proxy				The proxy to use for requests. See https://curl.se/libcurl/c/CURLOPT_PROXY.html for details.
protocols				The comma separated list of allowed protocols for the request. Available with cURL 7.85.0 or later. See https://curl.se/libcurl/c/CURLOPT_PROTOCOLS_STR.html for details.
redirect_protocols				The comma separated list of allowed protocols for redirects. Available with cURL 7.85.0 or later. See https://curl.se/libcurl/c/CURLOPT_REDIR_PROTOCOLS_STR.html for details.
dns_cache_timeout_secs				The life-time for DNS cache entries. See https://curl.se/libcurl/c/CURLOPT_DNS_CACHE_TIMEOUT.html for details.

res_pjsip_acl

Synopsis

SIP ACL module

This configuration documentation is for functionality provided by res_pjsip_acl.

Description

ACL

The ACL module used by res_pjsip. This module is independent of endpoints and operates on all inbound SIP communication using res_pjsip.

There are two main ways of defining your ACL with the options provided. You can use the permit and deny options which act on IP addresses, or the contactpermit and contactdeny options which act on Contact header addresses in incoming REGISTER requests. You can combine the various options to create a mixed ACL.

Additionally, instead of defining an ACL with options, you can reference IP or Contact header ACLs from the file acl.conf by using the acl or contactacl options.

Configuration Option Reference

pjsip.conf

acl

Access Control List

Option Name	Type	Default Value	Regular Expression	Description
acl				List of IP ACL section names in acl.conf
contact_acl				List of Contact ACL section names in acl.conf
contact_deny				List of Contact header addresses to deny
contact_permit				List of Contact header addresses to permit
deny				List of IP addresses to deny access from
permit				List of IP addresses to permit access from
type				Must be of type 'acl'.

res_pjsip_phoneprov_provider

Synopsis

Module that integrates res_pjsip with res_phoneprov.

This configuration documentation is for functionality provided by res_pjsip_phoneprov_provider.

Description

PJSIP Phoneprov Provider

This module creates the integration between res_pjsip and res_phoneprov.

Each user to be integrated requires a phoneprov section defined in pjsip.conf. Each section identifies the endpoint associated with the user and any other name/value pairs to be passed on to res_phoneprov's template substitution. Only MAC and PROFILE variables are required. Any other variables supplied will be passed through.

Example:

[1000]

type = phoneprovr

endpoint = ep1000

MAC = deadbeef4dad

PROFILE = grandstream2

LINEKEYS = 2

LINE = 1

OTHERVAR = othervalue

The following variables are automatically defined if an endpoint is defined for the user:

In addition to the standard variables, the following are also automatically defined:

All other template substitution variables must be explicitly defined in the phoneprov_default or phoneprov sections.

Configuration Option Reference

pjsip.conf

phoneprov

Provides variables for each user.

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'phoneprov'.
endpoint				The endpoint from which variables will be retrieved.
MAC				The mac address for this user. (required)
PROFILE				The phoneprov profile to use for this user. (required)
*				Other name/value pairs to be passed through for use in templates.

res_xmpp

Synopsis

XMPP Messaging

This configuration documentation is for functionality provided by res_xmpp.

Description

Configuration Option Reference

xmpp.conf

global

Global configuration settings

Option Name	Type	Default Value	Regular Expression	Description
debug				Enable/disable XMPP message debugging
autoprune				Auto-remove users from buddy list.
autoregister				Auto-register users from buddy list
collection_nodes				Enable support for XEP-0248 for use with distributed device state
pubsub_autocreate				Whether or not the PubSub server supports/is using auto-create for nodes
auth_policy				Whether to automatically accept or deny users' subscription requests

client

Configuration options for an XMPP client

Option Name	Type	Default Value	Regular Expression	Description
username				XMPP username with optional resource
secret				XMPP password
refresh_token				Google OAuth 2.0 refresh token
oauth_clientid				Google OAuth 2.0 application's client id
oauth_secret				Google OAuth 2.0 application's secret
serverhost				Route to server, e.g. talk.google.com
statusmessage				Custom status message
pubsub_node				Node for publishing events via PubSub
context				Dialplan context to send incoming messages to
priority				XMPP resource priority
port				XMPP server port
timeout				Timeout in seconds to hold incoming messages
debug				Enable debugging
type				Connection is either a client or a component
distribute_events				Whether or not to distribute events using this connection
usetls				Whether to use TLS for the connection or not
usesasl				Whether to use SASL for the connection or not
forceoldssl				Force the use of old-style SSL for the connection
keepalive				If enabled, periodically send an XMPP message from this client with an empty message
autoprune				Auto-remove users from buddy list.
autoregister				Auto-register users bfrom buddy list
auth_policy				Whether to automatically accept or deny users' subscription requests
sendtodialplan				Send incoming messages into the dialplan
status				Default XMPP status for the client
buddy				Manual addition of buddy to list

res_pjsip_endpoint_identifier_ip

Synopsis

Module that identifies endpoints

This configuration documentation is for functionality provided by res_pjsip_endpoint_identifier_ip.

Description

Configuration Option Reference

pjsip.conf

identify

Identifies endpoints via some criteria.

Option Name	Type	Default Value	Regular Expression	Description
endpoint				Name of endpoint identified
match				IP addresses or networks to match against.
srv_lookups				Perform SRV lookups for provided hostnames.
match_header				Header/value pair to match against.
type				Must be of type 'identify'.

res_ari

Synopsis

HTTP binding for the Stasis API

This configuration documentation is for functionality provided by res_ari.

Description

Configuration Option Reference

ari.conf

general

General configuration settings

Option Name	Type	Default Value	Regular Expression	Description
enabled				Enable/disable the ARI module
websocket_write_timeout				The timeout (in milliseconds) to set on WebSocket connections.
pretty				Responses from ARI are formatted to be human readable
auth_realm				Realm to use for authentication. Defaults to Asterisk REST Interface.
allowed_origins				Comma separated list of allowed origins, for Cross-Origin Resource Sharing. May be set to * to allow all origins.
channelvars				Comma separated list of channel variables to display in channel json.

user

Per-user configuration settings

Option Name	Type	Default Value	Regular Expression	Description
type				Define this configuration section as a user.
read_only				When set to yes, user is only authorized for read-only requests
password				Crypted or plaintext password (see password_format)
password_format				password_format may be set to plain (the default) or crypt. When set to crypt, crypt(3) is used to validate the password. A crypted password can be generated using mkpasswd -m sha-512. When set to plain, the password is in plaintext

res_stir_shaken

Synopsis

STIR/SHAKEN module for Asterisk

This configuration documentation is for functionality provided by res_stir_shaken.

Description

Configuration Option Reference

stir_shaken.conf

general

STIR/SHAKEN general options

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'general'.
ca_file				File path to the certificate authority certificate
ca_path				File path to a chain of trust
cache_max_size				Maximum size to use for caching public keys
curl_timeout				Maximum time to wait to CURL certificates
signature_timeout				Amount of time a signature is valid for

store

STIR/SHAKEN certificate store options

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'store'.
path				Path to a directory containing certificates
public_cert_url				URL to the public certificate(s)

certificate

STIR/SHAKEN certificate options

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'certificate'.
path				File path to a certificate
public_cert_url				URL to the public certificate
attestation				Attestation level
caller_id_number				The caller ID number to match on.

profile

STIR/SHAKEN profile configuration options

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'profile'.
stir_shaken				STIR/SHAKEN configuration settings
acllist				An existing ACL from acl.conf to use
permit				An IP or subnet to permit
deny				An IP or subnet to deny

res_pjproject

Synopsis

pjproject common configuration

This configuration documentation is for functionality provided by res_pjproject.

Description

Configuration Option Reference

pjproject.conf

startup

Asterisk startup time options for PJPROJECT

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'startup'.
log_level				Initial maximum pjproject logging level to log.

log_mappings

PJPROJECT to Asterisk Log Level Mapping

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'log_mappings'.
asterisk_error				A comma separated list of pjproject log levels to map to Asterisk LOG_ERROR.
asterisk_warning				A comma separated list of pjproject log levels to map to Asterisk LOG_WARNING.
asterisk_notice				A comma separated list of pjproject log levels to map to Asterisk LOG_NOTICE.
asterisk_verbose				A comma separated list of pjproject log levels to map to Asterisk LOG_VERBOSE.
asterisk_debug				A comma separated list of pjproject log levels to map to Asterisk LOG_DEBUG.
asterisk_trace				A comma separated list of pjproject log levels to map to Asterisk LOG_TRACE.

res_parking

Synopsis

Description

Configuration Option Reference

res_parking.conf

globals

Options that apply to every parking lot

Option Name	Type	Default Value	Regular Expression	Description
parkeddynamic				Enables dynamically created parkinglots.

parking_lot

Defined parking lots for res_parking to use to park calls on

Option Name	Type	Default Value	Regular Expression	Description
context				The name of the context where calls are parked and picked up from.
parkext				Extension to park calls to this parking lot.
parkext_exclusive				If yes, the extension registered as parkext will park exclusively to this parking lot.
parkpos				Numerical range of parking spaces which can be used to retrieve parked calls.
parkinghints				If yes, this parking lot will add hints automatically for parking spaces.
parkingtime				Amount of time a call will remain parked before giving up (in seconds).
parkedmusicclass				Which music class to use for parked calls. They will use the default if unspecified.
comebacktoorigin				Determines what should be done with the parked channel if no one picks it up before it times out.
comebackdialtime				Timeout for the Dial extension created to call back the parker when a parked call times out.
comebackcontext				Context where parked calls will enter the PBX on timeout when comebacktoorigin=no
courtesytone				If the name of a sound file is provided, use this as the courtesy tone
parkedplay				Who we should play the courtesytone to on the pickup of a parked call from this lot
parkedcalltransfers				Who to apply the DTMF transfer features to when parked calls are picked up or timeout.
parkedcallreparking				Who to apply the DTMF parking feature to when parked calls are picked up or timeout.
parkedcallhangup				Who to apply the DTMF hangup feature to when parked calls are picked up or timeout.
parkedcallrecording				Who to apply the DTMF MixMonitor recording feature to when parked calls are picked up or timeout.
findslot				Rule to use when trying to figure out which parking space a call should be parked with.

res_pjsip_outbound_publish

Synopsis

SIP resource for outbound publish

This configuration documentation is for functionality provided by res_pjsip_outbound_publish.

Description

Outbound Publish

This module allows res_pjsip to publish to other SIP servers.

Configuration Option Reference

pjsip.conf

outbound-publish

The configuration for outbound publish

Option Name	Type	Default Value	Regular Expression	Description
expiration				Expiration time for publications in seconds
outbound_auth				Authentication object(s) to be used for outbound publishes.
outbound_proxy				Full SIP URI of the outbound proxy used to send publishes
server_uri				SIP URI of the server and entity to publish to
from_uri				SIP URI to use in the From header
to_uri				SIP URI to use in the To header
event				Event type of the PUBLISH.
max_auth_attempts				Maximum number of authentication attempts before stopping the publication.
transport				Transport used for outbound publish
multi_user				Enable multi-user support
type				Must be of type 'outbound-publish'.

res_statsd

Synopsis

StatsD client

This configuration documentation is for functionality provided by res_statsd.

Description

The res_statsd module provides an API that allows Asterisk and its modules to send statistics to a StatsD server. It only provides a means to communicate with a StatsD server and does not send any metrics of its own.

An example module, res_chan_stats, is provided which uses the API exposed by this module to send channel statistics to the configured StatsD server.

More information about StatsD can be found at https://github.com/statsd/statsd

Configuration Option Reference

statsd.conf

global

Global configuration settings

Option Name	Type	Default Value	Regular Expression	Description
enabled				Enable/disable the StatsD module
server				Address of the StatsD server
prefix				Prefix to prepend to every metric
add_newline				Append a newline to every event. This is useful if you want to fake out a server using netcat (nc -lu 8125)
meter_support				Enable/disable the non-standard StatsD Meter type, if disabled falls back to counter and will append a "_meter" suffix to the metric name

res_pjsip

Synopsis

SIP Resource using PJProject

This configuration documentation is for functionality provided by res_pjsip.

Description

Configuration Option Reference

pjsip.conf

endpoint

Endpoint

Option Name	Type	Default Value	Regular Expression	Description
100rel				Allow support for RFC3262 provisional ACK tags
aggregate_mwi				Condense MWI notifications into a single NOTIFY.
allow				Media Codec(s) to allow
codec_prefs_incoming_offer				Codec negotiation prefs for incoming offers.
codec_prefs_outgoing_offer				Codec negotiation prefs for outgoing offers.
codec_prefs_incoming_answer				Codec negotiation prefs for incoming answers.
codec_prefs_outgoing_answer				Codec negotiation prefs for outgoing answers.
allow_overlap				Enable RFC3578 overlap dialing support.
overlap_context				Dialplan context to use for RFC3578 overlap dialing.
aors				AoR(s) to be used with the endpoint
auth				Authentication Object(s) associated with the endpoint
callerid				CallerID information for the endpoint
callerid_privacy				Default privacy level
callerid_tag				Internal id_tag for the endpoint
context				Dialplan context for inbound sessions
direct_media_glare_mitigation				Mitigation of direct media (re)INVITE glare
direct_media_method				Direct Media method type
trust_connected_line				Accept Connected Line updates from this endpoint
send_connected_line				Send Connected Line updates to this endpoint
connected_line_method				Connected line method type
direct_media				Determines whether media may flow directly between endpoints.
disable_direct_media_on_nat				Disable direct media session refreshes when NAT obstructs the media session
disallow				Media Codec(s) to disallow
dtmf_mode				DTMF mode
media_address				IP address used in SDP for media handling
bind_rtp_to_media_address				Bind the RTP instance to the media_address
force_rport				Force use of return port
ice_support				Enable the ICE mechanism to help traverse NAT
identify_by				Way(s) for the endpoint to be identified
redirect_method				How redirects received from an endpoint are handled
mailboxes				NOTIFY the endpoint when state changes for any of the specified mailboxes
mwi_subscribe_replaces_unsolicited				An MWI subscribe will replace sending unsolicited NOTIFYs
voicemail_extension				The voicemail extension to send in the NOTIFY Message-Account header
moh_suggest				Default Music On Hold class
outbound_auth				Authentication object(s) used for outbound requests
outbound_proxy				Full SIP URI of the outbound proxy used to send requests
rewrite_contact				Allow Contact header to be rewritten with the source IP address-port
rtp_ipv6				Allow use of IPv6 for RTP traffic
rtp_symmetric				Enforce that RTP must be symmetric
send_diversion				Send the Diversion header, conveying the diversion information to the called user agent
send_history_info				Send the History-Info header, conveying the diversion information to the called and calling user agents
send_pai				Send the P-Asserted-Identity header
send_rpid				Send the Remote-Party-ID header
rpid_immediate				Immediately send connected line updates on unanswered incoming calls.
timers_min_se				Minimum session timers expiration period
timers				Session timers for SIP packets
timers_sess_expires				Maximum session timer expiration period
transport				Explicit transport configuration to use
trust_id_inbound				Accept identification information received from this endpoint
trust_id_outbound				Send private identification details to the endpoint.
type				Must be of type 'endpoint'.
use_ptime				Use Endpoint's requested packetization interval
use_avpf				Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.
force_avp				Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint.
media_use_received_transport				Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.
media_encryption				Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.
media_encryption_optimistic				Determines whether encryption should be used if possible but does not terminate the session if not achieved.
g726_non_standard				Force g.726 to use AAL2 packing order when negotiating g.726 audio
inband_progress				Determines whether chan_pjsip will indicate ringing using inband progress.
call_group				The numeric pickup groups for a channel.
pickup_group				The numeric pickup groups that a channel can pickup.
named_call_group				The named pickup groups for a channel.
named_pickup_group				The named pickup groups that a channel can pickup.
device_state_busy_at				The number of in-use channels which will cause busy to be returned as device state
t38_udptl				Whether T.38 UDPTL support is enabled or not
t38_udptl_ec				T.38 UDPTL error correction method
t38_udptl_maxdatagram				T.38 UDPTL maximum datagram size
fax_detect				Whether CNG tone detection is enabled
fax_detect_timeout				How long into a call before fax_detect is disabled for the call
t38_udptl_nat				Whether NAT support is enabled on UDPTL sessions
t38_udptl_ipv6				Whether IPv6 is used for UDPTL Sessions
t38_bind_udptl_to_media_address				Bind the UDPTL instance to the media_adress
tone_zone				Set which country's indications to use for channels created for this endpoint.
language				Set the default language to use for channels created for this endpoint.
one_touch_recording				Determines whether one-touch recording is allowed for this endpoint.
record_on_feature				The feature to enact when one-touch recording is turned on.
record_off_feature				The feature to enact when one-touch recording is turned off.
rtp_engine				Name of the RTP engine to use for channels created for this endpoint
allow_transfer				Determines whether SIP REFER transfers are allowed for this endpoint
user_eq_phone				Determines whether a user=phone parameter is placed into the request URI if the user is determined to be a phone number
moh_passthrough				Determines whether hold and unhold will be passed through using re-INVITEs with recvonly and sendrecv to the remote side
sdp_owner				String placed as the username portion of an SDP origin (o=) line.
sdp_session				String used for the SDP session (s=) line.
tos_audio				DSCP TOS bits for audio streams
tos_video				DSCP TOS bits for video streams
cos_audio				Priority for audio streams
cos_video				Priority for video streams
allow_subscribe				Determines if endpoint is allowed to initiate subscriptions with Asterisk.
sub_min_expiry				The minimum allowed expiry time for subscriptions initiated by the endpoint.
from_user				Username to use in From header for requests to this endpoint.
mwi_from_user				Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.
from_domain				Domain to use in From header for requests to this endpoint.
dtls_verify				Verify that the provided peer certificate is valid
dtls_rekey				Interval at which to renegotiate the TLS session and rekey the SRTP session
dtls_auto_generate_cert				Whether or not to automatically generate an ephemeral X.509 certificate
dtls_cert_file				Path to certificate file to present to peer
dtls_private_key				Path to private key for certificate file
dtls_cipher				Cipher to use for DTLS negotiation
dtls_ca_file				Path to certificate authority certificate
dtls_ca_path				Path to a directory containing certificate authority certificates
dtls_setup				Whether we are willing to accept connections, connect to the other party, or both.
dtls_fingerprint				Type of hash to use for the DTLS fingerprint in the SDP.
srtp_tag_32				Determines whether 32 byte tags should be used instead of 80 byte tags.
set_var				Variable set on a channel involving the endpoint.
message_context				Context to route incoming MESSAGE requests to.
accountcode				An accountcode to set automatically on any channels created for this endpoint.
preferred_codec_only				Respond to a SIP invite with the single most preferred codec (DEPRECATED)
incoming_call_offer_pref				Preferences for selecting codecs for an incoming call.
outgoing_call_offer_pref				Preferences for selecting codecs for an outgoing call.
rtp_keepalive				Number of seconds between RTP comfort noise keepalive packets.
rtp_timeout				Maximum number of seconds without receiving RTP (while off hold) before terminating call.
rtp_timeout_hold				Maximum number of seconds without receiving RTP (while on hold) before terminating call.
acl				List of IP ACL section names in acl.conf
deny				List of IP addresses to deny access from
permit				List of IP addresses to permit access from
contact_acl				List of Contact ACL section names in acl.conf
contact_deny				List of Contact header addresses to deny
contact_permit				List of Contact header addresses to permit
subscribe_context				Context for incoming MESSAGE requests.
contact_user				Force the user on the outgoing Contact header to this value.
asymmetric_rtp_codec				Allow the sending and receiving RTP codec to differ
rtcp_mux				Enable RFC 5761 RTCP multiplexing on the RTP port
refer_blind_progress				Whether to notifies all the progress details on blind transfer
notify_early_inuse_ringing				Whether to notifies dialog-info 'early' on InUse&Ringing state
max_audio_streams				The maximum number of allowed audio streams for the endpoint
max_video_streams				The maximum number of allowed video streams for the endpoint
bundle				Enable RTP bundling
webrtc				Defaults and enables some options that are relevant to WebRTC
incoming_mwi_mailbox				Mailbox name to use when incoming MWI NOTIFYs are received
follow_early_media_fork				Follow SDP forked media when To tag is different
accept_multiple_sdp_answers				Accept multiple SDP answers on non-100rel responses
suppress_q850_reason_headers				Suppress Q.850 Reason headers for this endpoint
ignore_183_without_sdp				Do not forward 183 when it doesn't contain SDP
stir_shaken				Enable STIR/SHAKEN support on this endpoint
stir_shaken_profile				STIR/SHAKEN profile containing additional configuration options
allow_unauthenticated_options				Skip authentication when receiving OPTIONS requests
security_negotiation				The kind of security agreement negotiation to use. Currently, only mediasec is supported.
security_mechanisms				List of security mechanisms supported.
geoloc_incoming_call_profile				Geolocation profile to apply to incoming calls
geoloc_outgoing_call_profile				Geolocation profile to apply to outgoing calls
send_aoc				Send Advice-of-Charge messages

auth

Authentication type

Option Name	Type	Default Value	Regular Expression	Description
auth_type				Authentication type
nonce_lifetime				Lifetime of a nonce associated with this authentication config.
md5_cred				MD5 Hash used for authentication.
password				Plain text password used for authentication.
refresh_token				OAuth 2.0 refresh token
oauth_clientid				OAuth 2.0 application's client id
oauth_secret				OAuth 2.0 application's secret
realm				SIP realm for endpoint
type				Must be 'auth'
username				Username to use for account

domain_alias

Domain Alias

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'domain_alias'.
domain				Domain to be aliased

transport

SIP Transport

Option Name	Type	Default Value	Regular Expression	Description
async_operations				Number of simultaneous Asynchronous Operations, can no longer be set, always set to 1
bind				IP Address and optional port to bind to for this transport
ca_list_file				File containing a list of certificates to read (TLS ONLY, not WSS)
ca_list_path				Path to directory containing a list of certificates to read (TLS ONLY, not WSS)
cert_file				Certificate file for endpoint (TLS ONLY, not WSS)
cipher				Preferred cryptography cipher names (TLS ONLY, not WSS)
domain				Domain the transport comes from
external_media_address				External IP address to use in RTP handling
external_signaling_address				External address for SIP signalling
external_signaling_port				External port for SIP signalling
method				Method of SSL transport (TLS ONLY, not WSS)
local_net				Network to consider local (used for NAT purposes).
password				Password required for transport
priv_key_file				Private key file (TLS ONLY, not WSS)
protocol				Protocol to use for SIP traffic
require_client_cert				Require client certificate (TLS ONLY, not WSS)
type				Must be of type 'transport'.
verify_client				Require verification of client certificate (TLS ONLY, not WSS)
verify_server				Require verification of server certificate (TLS ONLY, not WSS)
tos				Enable TOS for the signalling sent over this transport
cos				Enable COS for the signalling sent over this transport
websocket_write_timeout				The timeout (in milliseconds) to set on WebSocket connections.
allow_reload				Allow this transport to be reloaded.
allow_wildcard_certs				Allow use of wildcards in certificates (TLS ONLY)
symmetric_transport				Use the same transport for outgoing requests as incoming ones.

contact

A way of creating an aliased name to a SIP URI

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'contact'.
uri				SIP URI to contact peer
expiration_time				Time to keep alive a contact
qualify_frequency				Interval at which to qualify a contact
qualify_timeout				Timeout for qualify
authenticate_qualify				Authenticates a qualify challenge response if needed
outbound_proxy				Outbound proxy used when sending OPTIONS request
path				Stored Path vector for use in Route headers on outgoing requests.
user_agent				User-Agent header from registration.
endpoint				Endpoint name
reg_server				Asterisk Server name
via_addr				IP-address of the last Via header from registration.
via_port				IP-port of the last Via header from registration.
call_id				Call-ID header from registration.
prune_on_boot				A contact that cannot survive a restart/boot.

aor

The configuration for a location of an endpoint

Option Name	Type	Default Value	Regular Expression	Description
contact				Permanent contacts assigned to AoR
default_expiration				Default expiration time in seconds for contacts that are dynamically bound to an AoR.
mailboxes				Allow subscriptions for the specified mailbox(es)
voicemail_extension				The voicemail extension to send in the NOTIFY Message-Account header
maximum_expiration				Maximum time to keep an AoR
max_contacts				Maximum number of contacts that can bind to an AoR
minimum_expiration				Minimum keep alive time for an AoR
remove_existing				Determines whether new contacts replace existing ones.
remove_unavailable				Determines whether new contacts should replace unavailable ones.
type				Must be of type 'aor'.
qualify_frequency				Interval at which to qualify an AoR
qualify_timeout				Timeout for qualify
authenticate_qualify				Authenticates a qualify challenge response if needed
outbound_proxy				Outbound proxy used when sending OPTIONS request
support_path				Enables Path support for REGISTER requests and Route support for other requests.

system

Options that apply to the SIP stack as well as other system-wide settings

Option Name	Type	Default Value	Regular Expression	Description
timer_t1				Set transaction timer T1 value (milliseconds).
timer_b				Set transaction timer B value (milliseconds).
compact_headers				Use the short forms of common SIP header names.
threadpool_initial_size				Initial number of threads in the res_pjsip threadpool.
threadpool_auto_increment				The amount by which the number of threads is incremented when necessary.
threadpool_idle_timeout				Number of seconds before an idle thread should be disposed of.
threadpool_max_size				Maximum number of threads in the res_pjsip threadpool. A value of 0 indicates no maximum.
disable_tcp_switch				Disable automatic switching from UDP to TCP transports.
follow_early_media_fork				Follow SDP forked media when To tag is different
accept_multiple_sdp_answers				Follow SDP forked media when To tag is the same
disable_rport				Disable the use of rport in outgoing requests.
type				Must be of type 'system' UNLESS the object name is 'system'.

global

Options that apply globally to all SIP communications

Option Name	Type	Default Value	Regular Expression	Description
max_forwards				Value used in Max-Forwards header for SIP requests.
keep_alive_interval				The interval (in seconds) to send keepalives to active connection-oriented transports.
contact_expiration_check_interval				The interval (in seconds) to check for expired contacts.
disable_multi_domain				Disable Multi Domain support
max_initial_qualify_time				The maximum amount of time from startup that qualifies should be attempted on all contacts. If greater than the qualify_frequency for an aor, qualify_frequency will be used instead.
unidentified_request_period				The number of seconds over which to accumulate unidentified requests.
unidentified_request_count				The number of unidentified requests from a single IP to allow.
unidentified_request_prune_interval				The interval at which unidentified requests are older than twice the unidentified_request_period are pruned.
type				Must be of type 'global' UNLESS the object name is 'global'.
user_agent				Value used in User-Agent header for SIP requests and Server header for SIP responses.
regcontext				When set, Asterisk will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with us.
default_outbound_endpoint				Endpoint to use when sending an outbound request to a URI without a specified endpoint.
default_voicemail_extension				The voicemail extension to send in the NOTIFY Message-Account header if not specified on endpoint or aor
debug				Enable/Disable SIP debug logging. Valid options include yes, no, or a host address
endpoint_identifier_order				The order by which endpoint identifiers are processed and checked. Identifier names are usually derived from and can be found in the endpoint identifier module itself (res_pjsip_endpoint_identifier_*). You can use the CLI command "pjsip show identifiers" to see the identifiers currently available.
default_from_user				When Asterisk generates an outgoing SIP request, the From header username will be set to this value if there is no better option (such as CallerID) to be used.
default_realm				When Asterisk generates a challenge, the digest realm will be set to this value if there is no better option (such as auth/realm) to be used.
mwi_tps_queue_high				MWI taskprocessor high water alert trigger level.
mwi_tps_queue_low				MWI taskprocessor low water clear alert level.
mwi_disable_initial_unsolicited				Enable/Disable sending unsolicited MWI to all endpoints on startup.
ignore_uri_user_options				Enable/Disable ignoring SIP URI user field options.
use_callerid_contact				Place caller-id information into Contact header
send_contact_status_on_update_registration				Enable sending AMI ContactStatus event when a device refreshes its registration.
taskprocessor_overload_trigger				Trigger scope for taskprocessor overloads
norefersub				Advertise support for RFC4488 REFER subscription suppression
allow_sending_180_after_183				Allow 180 after 183
all_codecs_on_empty_reinvite				If we should return all codecs on re-INVITE without SDP

res_geolocation

Synopsis

Core Geolocation Support

This configuration documentation is for functionality provided by res_geolocation.

Description

Configuration Option Reference

geolocation.conf

location

Location

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'location'.
format				Location specification type
location_info				Location information
location_source				Fully qualified host name
method				Location determination method
confidence				Level of confidence

profile

Profile

Option Name	Type	Default Value	Regular Expression	Description
type				Must be of type 'profile'.
pidf_element				PIDF-LO element to place this profile in
location_reference				Reference to a location object
location_info_refinement				Reference to a location object
location_variables				Reference to a location object
usage_rules				location specification type
notes				Notes to be added to the outgoing PIDF-LO document
allow_routing_use				Sets the value of the Geolocation-Routing header.
suppress_empty_ca_elements				Sets if empty Civic Address elements should be suppressed from the PIDF-LO document.
profile_precedence				Determine which profile on a channel should be used

SIPDtmfMode()

Synopsis

Change the dtmfmode for a SIP call.

Description

Changes the dtmfmode for a SIP call.

Syntax

SIPDtmfMode(mode)

Arguments

mode

SIPAddParameter()

Synopsis

Add a SIP parameter to the From header in the outbound call.

Description

Adds a parameter to a SIP call placed with DIAL.

Use this with care. Adding the wrong tags may jeopardize the SIP dialog.

Always returns 0.

Syntax

SIPAddParameter(Parameter,Content)

Arguments

Parameter
Content

SIPAddHeader()

Synopsis

Add a SIP header to the outbound call.

Description

Adds a header to a SIP call placed with DIAL.

Remember to use the X-header if you are adding non-standard SIP headers, like X-Asterisk-Accountcode:. Use this with care. Adding the wrong headers may jeopardize the SIP dialog.

Always returns 0.

Syntax

SIPAddHeader(Header,Content)

Arguments

Header
Content

SIPRemoveHeader()

Synopsis

Remove SIP headers previously added with SIPAddHeader

Description

SIPRemoveHeader() allows you to remove headers which were previously added with SIPAddHeader(). If no parameter is supplied, all previously added headers will be removed. If a parameter is supplied, only the matching headers will be removed.

Always returns 0.

Example: Add 2 headers

	same => n,SIPAddHeader(P-Asserted-Identity: sip:foo@bar)
	same => n,SIPAddHeader(P-Preferred-Identity: sip:bar@foo)

Example: Remove all headers

	same => n,SIPRemoveHeader()

Example: Remove all P- headers

	same => n,SIPRemoveHeader(P-)

Example: Remove only the PAI header (note the : at the end)

	same => n,SIPRemoveHeader(P-Asserted-Identity:)

Syntax

SIPRemoveHeader([Header])

Arguments

Header

SIPSendCustomINFO()

Synopsis

Send a custom INFO frame on specified channels.

Description

SIPSendCustomINFO() allows you to send a custom INFO message on all active SIP channels or on channels with the specified User Agent. This application is only available if TEST_FRAMEWORK is defined.

Syntax

SIPSendCustomINFO(Data,[UserAgent])

Arguments

Data
UserAgent

DAHDISendKeypadFacility()

Synopsis

Send digits out of band over a PRI.

Description

This application will send the given string of digits in a Keypad Facility IE over the current channel.

Syntax

DAHDISendKeypadFacility(digits)

Arguments

digits

DAHDISendCallreroutingFacility()

Synopsis

Send an ISDN call rerouting/deflection facility message.

Description

This application will send an ISDN switch specific call rerouting/deflection facility message over the current channel. Supported switches depend upon the version of libpri in use.

Syntax

DAHDISendCallreroutingFacility(destination,[original,[reason]])

Arguments

destination - Destination number.
original - Original called number.
reason - Diversion reason, if not specified defaults to unknown

DAHDIAcceptR2Call()

Synopsis

Accept an R2 call if its not already accepted (you still need to answer it)

Description

This application will Accept the R2 call either with charge or no charge.

Syntax

DAHDIAcceptR2Call(charge)

Arguments

charge - Yes or No.
Whether you want to accept the call with charge or without charge.

IAX2Provision()

Synopsis

Provision a calling IAXy with a given template.

Description

Provisions the calling IAXy (assuming the calling entity is in fact an IAXy) with the given template. Returns -1 on error or 0 on success.

Syntax

IAX2Provision([template])

Arguments

template - If not specified, defaults to default.

AELSub()

Synopsis

Launch subroutine built with AEL

Description

Execute the named subroutine, defined in AEL, from another dialplan language, such as extensions.conf, Realtime extensions, or Lua.

The purpose of this application is to provide a sane entry point into AEL subroutines, the implementation of which may change from time to time.

Syntax

AELSub(routine,[args])

Arguments

routine - Named subroutine to execute.
args

Originate()

Synopsis

Originate a call.

Description

This application originates an outbound call and connects it to a specified extension or application. This application will block until the outgoing call fails or gets answered, unless the async option is used. At that point, this application will exit with the status variable set and dialplan processing will continue.

This application sets the following channel variable before exiting:

ORIGINATE_STATUS - This indicates the result of the call origination.
- FAILED
- SUCCESS
- BUSY
- CONGESTION
- HANGUP
- RINGING
- UNKNOWN - In practice, you should never see this value. Please report it to the issue tracker if you ever see it.

Syntax

Originate(tech_data,type,arg1,[arg2,[arg3,[timeout,[options]]]])

Arguments

tech_data - Channel technology and data for creating the outbound channel. For example, SIP/1234.
type - This should be app or exten, depending on whether the outbound channel should be connected to an application or extension.
arg1 - If the type is app, then this is the application name. If the type is exten, then this is the context that the channel will be sent to.
arg2 - If the type is app, then this is the data passed as arguments to the application. If the type is exten, then this is the extension that the channel will be sent to.
arg3 - If the type is exten, then this is the priority that the channel is sent to. If the type is app, then this parameter is ignored.
timeout - Timeout in seconds. Default is 30 seconds.
options
- a - Originate asynchronously. In other words, continue in the dialplan without waiting for the originated channel to answer.
- b( context^exten^priority ) - Before originating the outgoing call, Gosub to the specified location using the newly created channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- B( context^exten^priority ) - Before originating the outgoing call, Gosub to the specified location using the current channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- C - Comma-separated list of codecs to use for this call. Default is slin.
- c - The caller ID number to use for the called channel. Default is the current channel's Caller ID number.
- n - The caller ID name to use for the called channel. Default is the current channel's Caller ID name.
- v( var1 ) - A series of channel variables to set on the destination channel.
  - var1
    - name[=name...]
    - value[=value...]

Directory()

Synopsis

Provide directory of voicemail extensions.

Description

This application will present the calling channel with a directory of extensions from which they can search by name. The list of names and corresponding extensions is retrieved from the voicemail configuration file, voicemail.conf, or from the specified filename.

This application will immediately exit if one of the following DTMF digits are received and the extension to jump to exists:

0 - Jump to the 'o' extension, if it exists.

* - Jump to the 'a' extension, if it exists.

This application will set the following channel variables before completion:

DIRECTORY_RESULT - Reason Directory application exited.
- OPERATOR - User requested operator
- ASSISTANT - User requested assistant
- TIMEOUT - User allowed DTMF wait duration to pass without sending DTMF
- HANGUP - The channel hung up before the application finished
- SELECTED - User selected a user to call from the directory
- USEREXIT - User exited with '#' during selection
- FAILED - The application failed
DIRECTORY_EXTEN - If the skip calling option is set this will be set to the selected extension provided one is selected.

Syntax

Directory([vm-context,[dial-context,[options]]])

Arguments

vm-context - This is the context within voicemail.conf to use for the Directory. If not specified and searchcontexts=no in voicemail.conf, then default will be assumed.
dial-context - This is the dialplan context to use when looking for an extension that the user has selected, or when jumping to the o or a extension. If not specified, the current context will be used.
options
- e - In addition to the name, also read the extension number to the caller before presenting dialing options.
- f( n ) - Allow the caller to enter the first name of a user in the directory instead of using the last name. If specified, the optional number argument will be used for the number of characters the user should enter.
  - n
- l( n ) - Allow the caller to enter the last name of a user in the directory. This is the default. If specified, the optional number argument will be used for the number of characters the user should enter.
  - n
- b( n ) - Allow the caller to enter either the first or the last name of a user in the directory. If specified, the optional number argument will be used for the number of characters the user should enter.
  - n
- a - Allow the caller to additionally enter an alias for a user in the directory. This option must be specified in addition to the f, l, or b option.
- m - Instead of reading each name sequentially and asking for confirmation, create a menu of up to 8 names.
- n - Read digits even if the channel is not answered.
- p( n ) - Pause for n milliseconds after the digits are typed. This is helpful for people with cellphones, who are not holding the receiver to their ear while entering DTMF.
  - n
- c( filename ) - Load the specified config file instead of voicemail.conf
  - filename
- s - Skip calling the extension, instead set it in the DIRECTORY_EXTEN channel variable.

AlarmReceiver()

Synopsis

Provide support for receiving alarm reports from a burglar or fire alarm panel.

Description

This application should be called whenever there is an alarm panel calling in to dump its events. The application will handshake with the alarm panel, and receive events, validate them, handshake them, and store them until the panel hangs up. Once the panel hangs up, the application will run the system command specified by the eventcmd setting in alarmreceiver.conf and pipe the events to the standard input of the application. The configuration file also contains settings for DTMF timing, and for the loudness of the acknowledgement tones.

The application is affected by the following variables:

Few Ademco DTMF signalling formats are detected automatically: Contact ID, Express 4+1, Express 4+2, High Speed and Super Fast.

ALARMRECEIVER_CALL_LIMIT - Maximum call time, in milliseconds.If set, this variable causes application to exit after the specified time.
ALARMRECEIVER_RETRIES_LIMIT - Maximum number of retries per call.If set, this variable causes application to exit after the specified number of messages.

PrivacyManager()

Synopsis

Require phone number to be entered, if no CallerID sent

Description

If no Caller*ID is sent, PrivacyManager answers the channel and asks the caller to enter their phone number. The caller is given maxretries attempts to do so. The application does nothing if Caller*ID was received on the channel.

The application sets the following channel variable upon completion:

PRIVACYMGRSTATUS - The status of the privacy manager's attempt to collect a phone number from the user.
- SUCCESS
- FAILED

Syntax

PrivacyManager([maxretries,[minlength,[options,[context]]]])

Arguments

maxretries - Total tries caller is allowed to input a callerid. Defaults to 3.
minlength - Minimum allowable digits in the input callerid number. Defaults to 10.
options - Position reserved for options.
context - Context to check the given callerid against patterns.

Softmodem()

Synopsis

A Softmodem that connects the caller to a Telnet server (TCP port).

Description

Simulates a FSK(V.23), V.22bis, or Baudot modem. The modem on the other end is connected to the specified server using a simple TCP connection (like Telnet).

Syntax

Softmodem([hostname,[port,[options]]])

Arguments

hostname - Hostname. Default is 127.0.0.1
port - Port. Default is 23 (default Telnet port).
options
- d - Amount of data bits (5-8, default 8)
- e - Even parity bit
- f - Flip the mode from answering to originating, for modes (e.g. Bell 103) that use different settings for the originating and answering sides.
- l - Least significant bit first (default is most significant bit)
- m - Most significant bit first (default)
- n - Send NULL-Byte to modem after carrier detection (Btx)
- o - Odd parity bit
- r - RX cutoff (dBi, float, default: -35)
- s - Amount of stop bits (1-2, default 1)
- t - tx power (dBi, float, default: -28)
- u - Send ULM header to Telnet server (Btx)
- v - Modem version
  - V21 - 300/300 baud
  - V23 - 1200/75 baud
  - Bell103 - 300/300 baud
  - Bell202 - 1200/1200 baud
  - V22 - 1200/1200 baud
  - V22bis - 2400/2400 baud
  - baudot45 - V18 45.45bps TDD (US TTY) Baudot code
  - baudot50 - V18 50bps TDD (international) Baudot code
- x - Use TLS encryption for the data connection.

SendFSK()

Synopsis

Send FSK message over audio channel.

Description

SendFSK() is an utility to send digital messages over an audio channel

Syntax

SendFSK([modem])

Arguments

modem - Name of modem protocol to use. Default is Bell 103.
- 103 - Bell 103 modem (300 baud), originating side
- 202 - Bell 202 modem (1200 baud)

ReceiveFSK()

Synopsis

Receive FSK message from audio channel.

Description

ReceiveFSK() is an utility to receive digital messages from an audio channel

This application will answer the channel if it has not yet been answered.

Syntax

ReceiveFSK([variable,[modem,[options]]])

Arguments

variable - Name of variable in which to save the received data.
modem - Name of modem protocol to use. Default is Bell 103.
- 103 - Bell 103 modem (300 baud), terminating side
- 202 - Bell 202 modem (1200 baud)
options
- h - Receive frames until it gets a hangup. Default behaviour is to stop receiving on carrier loss.
- s - Generate silence back to caller. Default behaviour is generate no stream. This can cause some applications to misbehave.

Assert()

Synopsis

Asserts that an expression is true.

Description

Evaluates expression and continues dialplan execution if the expression is true and ends the call with a warning if it is false (unless the d option is provided).

This application can be used to verify functional correctness of dialplans (e.g. dialplan test cases), similar to the assert function in C. For instance, if a certain property is expected to always hold at some point in your dialplan, this application can be used to enforce that.

Syntax

Assert([expression,[options]])

Arguments

expression - The expression to evaluate.
options
- d - Do not hang up if expression is false.

MP3Player()

Synopsis

Play an MP3 file or M3U playlist file or stream.

Description

Executes mpg123 to play the given location, which typically would be a mp3 filename or m3u playlist filename or a URL. Please read https://en.wikipedia.org/wiki/M3U to see what the M3U playlist file format is like.

Note that mpg123 does not support HTTPS, so use HTTP for web streams.

User can exit by pressing any key on the dialpad, or by hanging up.

This application does not automatically answer and should be preceeded by an application such as Answer() or Progress().

Example: Play an MP3 playlist

	exten => 1234,1,MP3Player(/var/lib/asterisk/playlist.m3u)

Syntax

MP3Player(Location)

Arguments

Location - Location of the file to be played. (argument passed to mpg123)

Playback()

Synopsis

Play a file.

Description

Plays back given filenames (do not put extension of wav/alaw etc). The Playback application answers the channel if no options are specified. If the file is non-existent it will fail.

This application sets the following channel variable upon completion:

See Also: Background (application) -- for playing sound files that are interruptible

WaitExten (application) -- wait for digits from caller, optionally play music on hold

PLAYBACKSTATUS - The status of the playback attempt as a text string.
- SUCCESS
- FAILED

Syntax

Playback(filename&[filename2[&...]],[options]])

Arguments

filenames
- filename
- filename2
options
- skip - Do not play if not answered
- noanswer - Playback without answering, otherwise the channel will be answered before the sound is played.
- say - Play using the say.conf file.
- mix - Play using a mix of filename and the say.conf file.

JACK()

Synopsis

Jack Audio Connection Kit

Description

When executing this application, two jack ports will be created; one input and one output. Other applications can be hooked up to these ports to access audio coming from, or being send to the channel.

Syntax

JACK([options])

Arguments

options
- s( name )
  - name - Connect to the specified jack server name
- i( name )
  - name - Connect the output port that gets created to the specified jack input port
- o( name )
  - name - Connect the input port that gets created to the specified jack output port
- c( name )
  - name - By default, Asterisk will use the channel name for the jack client name.
    Use this option to specify a custom client name.

MinivmRecord()

Synopsis

Receive Mini-Voicemail and forward via e-mail.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf

MiniVM records audio file in configured format and forwards message to e-mail and pager.

If there's no user account for that address, a temporary account will be used with default options.

The recorded file name and path will be stored in MVM_FILENAME and the duration of the message will be stored in MVM_DURATION

If the caller hangs up after the recording, the only way to send the message and clean up is to execute in the h extension. The application will exit if any of the following DTMF digits are received and the requested extension exist in the current context.

MVM_RECORD_STATUS - This is the status of the record operation
- SUCCESS
- USEREXIT
- FAILED

Syntax

MinivmRecord(username@domain,[options])

Arguments

mailbox
- username - Voicemail username
- domain - Voicemail domain
options
- 0 - Jump to the o extension in the current dialplan context.
- * - Jump to the a extension in the current dialplan context.
- g( gain ) - Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB).
  - gain - Amount of gain to use

MinivmGreet()

Synopsis

Play Mini-Voicemail prompts.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

MinivmGreet() plays default prompts or user specific prompts for an account.

Busy and unavailable messages can be choosen, but will be overridden if a temporary message exists for the account.

MVM_GREET_STATUS - This is the status of the greeting playback.
- SUCCESS
- USEREXIT
- FAILED

Syntax

MinivmGreet(username@domain,[options])

Arguments

mailbox
- username - Voicemail username
- domain - Voicemail domain
options
- b - Play the busy greeting to the calling party.
- s - Skip the playback of instructions for leaving a message to the calling party.
- u - Play the unavailable greeting.

MinivmNotify()

Synopsis

Notify voicemail owner about new messages.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

MiniVMnotify forwards messages about new voicemail to e-mail and pager. If there's no user account for that address, a temporary account will be used with default options (set in minivm.conf).

If the channel variable MVM_COUNTER is set, this will be used in the message file name and available in the template for the message.

If no template is given, the default email template will be used to send email and default pager template to send paging message (if the user account is configured with a paging address.

MVM_NOTIFY_STATUS - This is the status of the notification attempt
- SUCCESS
- FAILED

Syntax

MinivmNotify(username@domain,[options])

Arguments

mailbox
- username - Voicemail username
- domain - Voicemail domain
options
- template - E-mail template to use for voicemail notification

MinivmDelete()

Synopsis

Delete Mini-Voicemail voicemail messages.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

It deletes voicemail file set in MVM_FILENAME or given filename.

MVM_DELETE_STATUS - This is the status of the delete operation.
- SUCCESS
- FAILED

Syntax

MinivmDelete(filename)

Arguments

filename - File to delete

MinivmAccMess()

Synopsis

Record account specific messages.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

Use this application to record account specific audio/video messages for busy, unavailable and temporary messages.

Account specific directories will be created if they do not exist.

MVM_ACCMESS_STATUS - This is the result of the attempt to record the specified greeting.FAILED is set if the file can't be created.
- SUCCESS
- FAILED

Syntax

MinivmAccMess(username@domain,[options])

Arguments

mailbox
- username - Voicemail username
- domain - Voicemail domain
options
- u - Record the unavailable greeting.
- b - Record the busy greeting.
- t - Record the temporary greeting.
- n - Account name.

MinivmMWI()

Synopsis

Send Message Waiting Notification to subscriber(s) of mailbox.

Description

This application is part of the Mini-Voicemail system, configured in minivm.conf.

MinivmMWI is used to send message waiting indication to any devices whose channels have subscribed to the mailbox passed in the first parameter.

Syntax

MinivmMWI(username@domain,urgent,new,old)

Arguments

mailbox
- username - Voicemail username
- domain - Voicemail domain
urgent - Number of urgent messages in mailbox.
new - Number of new messages in mailbox.
old - Number of old messages in mailbox.

VoiceMail()

Synopsis

Leave a Voicemail message.

Description

This application allows the calling party to leave a message for the specified list of mailboxes. When multiple mailboxes are specified, the greeting will be taken from the first mailbox specified. Dialplan execution will stop if the specified mailbox does not exist.

The Voicemail application will exit if any of the following DTMF digits are received:

This application will set the following channel variable upon completion:

VMSTATUS - This indicates the status of the execution of the VoiceMail application.
- SUCCESS
- USEREXIT
- FAILED

Syntax

VoiceMail(mailbox1&[mailbox2[&...]],[options]])

Arguments

mailboxs
- mailbox1
- mailbox2
options
- b - Play the busy greeting to the calling party.
- d( c ) - Accept digits for a new extension in context c, if played during the greeting. Context defaults to the current context.
  - c
- e - Play greetings as early media -- only answer the channel just before accepting the voice message.
- g( # ) - Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB). Only works on supported technologies, which is DAHDI only.
  - #
- s - Skip the playback of instructions for leaving a message to the calling party.
- S - Skip the playback of instructions for leaving a message to the calling party, but only if a greeting has been recorded by the mailbox user.
- t( x ) - Play a custom beep tone to the caller instead of the default one. If this option is used but no file is specified, the beep is suppressed.
  - x
- u - Play the unavailable greeting.
- U - Mark message as URGENT.
- P - Mark message as PRIORITY.

VoiceMailMain()

Synopsis

Check Voicemail messages.

Description

This application allows the calling party to check voicemail messages. A specific mailbox, and optional corresponding context, may be specified. If a mailbox is not provided, the calling party will be prompted to enter one. If a context is not specified, the default context will be used.

The VoiceMailMain application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VoiceMailMain([mailbox@[context,[options]]])

Arguments

mailbox
- mailbox
- context
options
- p - Consider the mailbox parameter as a prefix to the mailbox that is entered by the caller.
- g( # ) - Use the specified amount of gain when recording a voicemail message. The units are whole-number decibels (dB).
  - #
- r - "Read only". Prevent user from deleting any messages.
  This applies only to specific executions of VoiceMailMain, NOT the mailbox itself.
- s - Skip checking the passcode for the mailbox.
- a( folder ) - Skip folder prompt and go directly to folder specified. Defaults to INBOX (or 0).
  - folder
  - 0 - INBOX
  - 1 - Old
  - 2 - Work
  - 3 - Family
  - 4 - Friends
  - 5 - Cust1
  - 6 - Cust2
  - 7 - Cust3
  - 8 - Cust4
  - 9 - Cust5

VMAuthenticate()

Synopsis

Authenticate with Voicemail passwords.

Description

This application behaves the same way as the Authenticate application, but the passwords are taken from voicemail.conf. If the mailbox is specified, only that mailbox's password will be considered valid. If the mailbox is not specified, the channel variable AUTH_MAILBOX will be set with the authenticated mailbox.

The VMAuthenticate application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VMAuthenticate([mailbox@[context,[options]]])

Arguments

mailbox
- mailbox
- context
options
- s - Skip playing the initial prompts.

VoiceMailPlayMsg()

Synopsis

Play a single voice mail msg from a mailbox by msg id.

Description

This application sets the following channel variable upon completion:

VOICEMAIL_PLAYBACKSTATUS - The status of the playback attempt as a text string.
- SUCCESS
- FAILED

Syntax

VoiceMailPlayMsg([mailbox@[context,]]msg_id)

Arguments

mailbox
- mailbox
- context
msg_id - The msg id of the msg to play back.

VMSayName()

Synopsis

Play the name of a voicemail user

Description

This application will say the recorded name of the voicemail user specified as the argument to this application. If no context is provided, default is assumed.

Similar to the Background() application, playback of the recorded name can be interrupted by entering an extension, which will be searched for in the current context.

Syntax

VMSayName([mailbox@[context]])

Arguments

mailbox
- mailbox
- context

Transfer()

Synopsis

Transfer caller to remote extension.

Description

Requests the remote caller be transferred to a given destination. If TECH (SIP, IAX2, etc) is used, only an incoming call with the same channel technology will be transferred. Note that for SIP, if you transfer before call is setup, a 302 redirect SIP message will be returned to the caller.

The result of the application will be reported in the TRANSFERSTATUS channel variable:

TRANSFERSTATUS
- SUCCESS - Transfer succeeded.
- FAILURE - Transfer failed.
- UNSUPPORTED - Transfer unsupported by channel driver.
TRANSFERSTATUSPROTOCOL
- 0 - No error.
- 3xx-6xx - SIP example - Error result code.

Syntax

Transfer([Tech/]destination)

Arguments

dest
- Tech/
- destination

OSPAuth()

Synopsis

OSP Authentication.

Description

Authenticate a call by OSP.

Input variables:

Output variables:

This application sets the following channel variable upon completion:

OSPINPEERIP - The last hop IP address.
OSPINTOKEN - The inbound OSP token.

Syntax

OSPAuth([provider,[options]])

Arguments

provider - The name of the provider that authenticates the call.
options - Reserverd.

OSPLookup()

Synopsis

Lookup destination by OSP.

Description

Looks up destination via OSP.

Input variables:

Output variables:

This application sets the following channel variable upon completion:

OSPINACTUALSRC - The actual source device IP address in indirect mode.
OSPINPEERIP - The last hop IP address.
OSPINTECH - The inbound channel technology for the call.
OSPINHANDLE - The inbound call OSP transaction handle.
OSPINTIMELIMIT - The inbound call duration limit in seconds.
OSPINNETWORKID - The inbound source network ID.
OSPINNPRN - The inbound routing number.
OSPINNPCIC - The inbound carrier identification code.
OSPINNPDI - The inbound number portability database dip indicator.
OSPINSPID - The inbound service provider identity.
OSPINOCN - The inbound operator company number.
OSPINSPN - The inbound service provider name.
OSPINALTSPN - The inbound alternate service provider name.
OSPINMCC - The inbound mobile country code.
OSPINMNC - The inbound mobile network code.
OSPINTOHOST - The inbound To header host part.
OSPINRPIDUSER - The inbound Remote-Party-ID header user part.
OSPINPAIUSER - The inbound P-Asserted-Identify header user part.
OSPINDIVUSER - The inbound Diversion header user part.
OSPINDIVHOST - The inbound Diversion header host part.
OSPINPCIUSER - The inbound P-Charge-Info header user part.
OSPINCUSTOMINFOn - The inbound custom information, where n is the index beginning with 1 upto 8.

Syntax

OSPLookup(exten,[provider,[options]])

Arguments

exten - The exten of the call.
provider - The name of the provider that is used to route the call.
options

OSPNext()

Synopsis

Lookup next destination by OSP.

Description

Looks up the next destination via OSP.

Input variables:

Output variables:

This application sets the following channel variable upon completion:

OSPINHANDLE - The inbound call OSP transaction handle.
OSPOUTHANDLE - The outbound call OSP transaction handle.
OSPINTIMELIMIT - The inbound call duration limit in seconds.
OSPOUTCALLIDTYPES - The outbound Call-ID types.
OSPDESTREMAILS - The number of remained destinations.

OSPFinish()

Synopsis

Report OSP entry.

Description

Report call state.

Input variables:

This application sets the following channel variable upon completion:

OSPINHANDLE - The inbound call OSP transaction handle.
OSPOUTHANDLE - The outbound call OSP transaction handle.
OSPAUTHSTATUS - The OSPAuth status.
OSPLOOKUPSTATUS - The OSPLookup status.
OSPNEXTSTATUS - The OSPNext status.
OSPINAUDIOQOS - The inbound call leg audio QoS string.
OSPOUTAUDIOQOS - The outbound call leg audio QoS string.

Syntax

OSPFinish([cause,[options]])

Arguments

cause - Hangup cause.
options - Reserved.

WaitForRing()

Synopsis

Wait for Ring Application.

Description

Returns 0 after waiting at least timeout seconds, and only after the next ring has completed. Returns 0 on success or -1 on hangup.

Syntax

WaitForRing(timeout)

Arguments

timeout

If()

Synopsis

Start an if branch.

Description

Start an If branch. Execution will continue inside the branch if expr is true.

This application (and related applications) set variables internally during execution.

Syntax

If(expr)

Arguments

expr

ElseIf()

Synopsis

Start an else if branch.

Description

Start an optional ElseIf branch. Execution will continue inside the branch if expr is true and if previous If and ElseIf branches evaluated to false.

Please note that execution inside a true If branch will fallthrough into ElseIf unless the If segment is terminated with an ExitIf call. This is only necessary with ElseIf but not with Else.

Syntax

ElseIf(expr)

Arguments

expr

Else()

Synopsis

Define an optional else branch.

Description

Start an Else branch. Execution will jump here if all previous If and ElseIf branches evaluated to false.

Syntax

Else(expr)

Arguments

expr

EndIf()

Synopsis

End an if branch.

Description

Ends the branch begun by the preceding If() application.

ExitIf()

Synopsis

End an If branch.

Description

Exits an If() branch, whether or not it has completed.

Morsecode()

Synopsis

Plays morse code.

Description

Plays the Morse code equivalent of the passed string.

This application does not automatically answer and should be preceeded by an application such as Answer() or Progress().

This application uses the following variables:

MORSEDITLEN - Use this value in (ms) for length of dit
MORSETONE - The pitch of the tone in (Hz), default is 800
MORSESPACETONE - The pitch of the spaces in (Hz), default is 0
MORSETYPE - The code type to use (AMERICAN for standard American Morse or INTERNATIONAL for international code. Default is INTERNATIONAL).

Syntax

Morsecode(string)

Arguments

string - String to playback as morse code to channel

ReceiveMF()

Synopsis

Detects MF digits on a channel and saves them to a variable.

Description

Reads a ST, STP, ST2P, or ST3P-terminated string of MF digits from the user in to the given variable.

This application does not automatically answer the channel and should be preceded with Answer or Progress as needed.

RECEIVEMFSTATUS - This is the status of the read operation.
- START
- ERROR
- HANGUP
- MAXDIGITS
- TIMEOUT

Syntax

ReceiveMF(variable,[timeout,[options]])

Arguments

variable - The input digits will be stored in the given variable name.
timeout - The number of seconds to wait for all digits, if greater than 0. Can be floating point. Default is no timeout.
options
- d - Delay audio by a frame to try to extra quelch.
- l - Receive digits even if a key pulse (KP) has not yet been received. By default, this application will ignore all other digits until a KP has been received.
- k - Do not return a character for the KP digit.
- m - Mute conference.
- n - Maximum number of digits, regardless of the sequence.
- o - Enable override. Repeated KPs will clear all previous digits.
- q - Quelch MF from in-band.
- r - "Radio" mode (relaxed MF).
- s - Do not return a character for ST digits.

SendMF()

Synopsis

Sends arbitrary MF digits on the current or specified channel.

Description

It will send all digits or terminate if it encounters an error.

Syntax

SendMF(digits,[timeout_ms,[duration_ms,[duration_ms_kp,[duration_ms_st,[channel]]]]])

Arguments

digits - List of digits 0-9,*#ABC to send; w for a half-second pause, also f or F for a flash-hook if the channel supports flash-hook, h or H for 250 ms of 2600 Hz, and W for a wink if the channel supports wink.
Key pulse and start digits are not included automatically. * is used for KP, # for ST, A for STP, B for ST2P, and C for ST3P.
timeout_ms - Amount of time to wait in ms between tones. (defaults to 50ms).
duration_ms - Duration of each numeric digit (defaults to 55ms).
duration_ms_kp - Duration of KP digits (defaults to 120ms).
duration_ms_st - Duration of ST, STP, ST2P, and ST3P digits (defaults to 65ms).
channel - Channel where digits will be played

RandomPlayback()

Synopsis

Plays a random file with a particular directory and/or file prefix

Description

Plays back a random file with the provided prefix which contains a specific directory, optionally followed by a file prefix. If there is no file prefix, be sure to end with a trailing slash to search in a directory of the given name as opposed to a trailing file prefix.

Knowledge of actual specific file candidates is not necessary.

A random file matching this full prefix will be played.

This application does not automatically answer the channel and should be preceded by Progress or Answer as appropriate.

Syntax

RandomPlayback([prefix])

Arguments

prefix - Directory/file prefix that must match.

LoopDisconnect()

Synopsis

Performs a loop disconnect on an FXS channel.

Description

Performs a loop disconnect (open switching interval) on an FXS channel.

This will not hangup the channel or do anything besides the loop disconnect.

Providing a loop disconnect can be used to force compatible equipment that will recognize a loop disconnect to release the line, such as answering machines.

This application will wait for the loop disconnect to finish before continuing.

StreamEcho()

Synopsis

Echo media, up to 'N' streams of a type, and DTMF back to the calling party

Description

If a "num" (the number of streams) is not given then this simply echos back any media or DTMF frames (note, however if '#' is detected then the application exits) read from the calling channel back to itself. This means for any relevant frame read from a particular stream it is written back out to the associated write stream in a one to one fashion.

However if a "num" is specified, and if the calling channel allows it (a new offer is made requesting the allowance of additional streams) then any any media received, like before, is echoed back onto each stream. However, in this case a relevant frame received on a stream of the given "type" is also echoed back out to the other streams of that same type. It should be noted that when operating in this mode only the first stream found of the given "type" is allowed from the original offer. And this first stream found is also the only stream of that "type" granted read (send/receive) capabilities in the new offer whereas the additional ones are set to receive only.

This does not echo CONTROL, MODEM, or NULL frames.

Syntax

StreamEcho([num,[type]])

Arguments

num - The number of streams of a type to echo back. If '0' is specified then all streams of a type are removed.
type - The media type of the stream(s) to add or remove (in the case of "num" being '0'). This can be set to either "audio" or "video" (default). If "num" is empty (i.e. not specified) then this parameter is ignored.

Echo()

Synopsis

Echo media, DTMF back to the calling party

Description

Echos back any media or DTMF frames read from the calling channel back to itself. This will not echo CONTROL, MODEM, or NULL frames. Note: If '#' detected application exits.

This application does not automatically answer and should be preceeded by an application such as Answer() or Progress().

Festival()

Synopsis

Say text to the user.

Description

Connect to Festival, send the argument, get back the waveform, play it to the user, allowing any given interrupt keys to immediately terminate and return the value, or any to allow any number back (useful in dialplan).

Syntax

Festival(text,[intkeys])

Arguments

text
intkeys

BridgeAdd()

Synopsis

Join a bridge that contains the specified channel.

Description

This application places the incoming channel into the bridge containing the specified channel. The specified channel only needs to be the prefix of a full channel name IE. 'PJSIP/cisco0001'.

This application sets the following channel variable upon completion:

BRIDGERESULT - The result of the bridge attempt as a text string.
- SUCCESS
- FAILURE
- LOOP
- NONEXISTENT

Syntax

BridgeAdd(channel)

Arguments

channel - The current channel joins the bridge containing the channel identified by the channel name, channel name prefix, or channel uniqueid.

CELGenUserEvent()

Synopsis

Generates a CEL User Defined Event.

Description

A CEL event will be immediately generated by this channel, with the supplied name for a type.

Syntax

CELGenUserEvent(event-name,[extra])

Arguments

event-name
- event-name
- extra - Extra text to be included with the event.

Dial()

Synopsis

Attempt to connect to another device or endpoint and bridge the call.

Description

This application will place calls to one or more specified channels. As soon as one of the requested channels answers, the originating channel will be answered, if it has not already been answered. These two channels will then be active in a bridged call. All other channels that were requested will then be hung up.

Unless there is a timeout specified, the Dial application will wait indefinitely until one of the called channels answers, the user hangs up, or if all of the called channels are busy or unavailable. Dialplan execution will continue if no requested channels can be called, or if the timeout expires. This application will report normal termination if the originating channel hangs up, or if the call is bridged and either of the parties in the bridge ends the call.

If the OUTBOUND_GROUP variable is set, all peer channels created by this application will be put into that group (as in Set(GROUP()=...). If the OUTBOUND_GROUP_ONCE variable is set, all peer channels created by this application will be put into that group (as in Set(GROUP()=...). Unlike OUTBOUND_GROUP, however, the variable will be unset after use.

This application sets the following channel variables:

Example: Dial with 30 second timeout

	same => n,Dial(PJSIP/alice,30)

Example: Parallel dial with 45 second timeout

	same => n,Dial(PJSIP/alice&PJIP/bob,45)

Example: Dial with 'g' continuation option

	same => n,Dial(PJSIP/alice,,g)
	same => n,Log(NOTICE, Alice call result: ${DIALSTATUS})

Example: Dial with transfer/recording features for calling party

	same => n,Dial(PJSIP/alice,,TX)

Example: Dial with call length limit

	same => n,Dial(PJSIP/alice,,L(60000:30000:10000))

Example: Dial alice and bob and send NO_ANSWER to bob instead of ANSWERED_ELSEWHERE when alice answers

	same => n,Dial(PJSIP/alice&PJSIP/bob,,Q(NO_ANSWER))

Example: Dial with pre-dial subroutines

	[default]

	exten => callee_channel,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
	same => n,Log(NOTICE, I'm called on channel ${CHANNEL} prior to it starting the dial attempt)
	same => n,Return()

	exten => called_channel,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
	same => n,Log(NOTICE, I'm called on outbound channel ${CHANNEL} prior to it being used to dial someone)
	same => n,Return()

	exten => _X.,1,NoOp()
	same => n,Dial(PJSIP/alice,,b(default^called_channel^1(my_gosub_arg1^my_gosub_arg2))B(default^callee_channel^1(my_gosub_arg1^my_gosub_arg2)))
	same => n,Hangup()

Example: Dial with post-answer subroutine executed on outbound channel

	[my_gosub_routine]

	exten => s,1,NoOp(ARG1=${ARG1} ARG2=${ARG2})
	same => n,Playback(hello)
	same => n,Return()
	[default]

	exten => _X.,1,NoOp()
	same => n,Dial(PJSIP/alice,,U(my_gosub_routine^my_gosub_arg1^my_gosub_arg2))
	same => n,Hangup()

Example: Dial into ConfBridge using 'G' option

	same => n,Dial(PJSIP/alice,,G(jump_to_here))
	same => n(jump_to_here),Goto(confbridge)
	same => n,Goto(confbridge)
	same => n(confbridge),ConfBridge(${EXTEN})

DIALEDTIME - This is the time from dialing a channel until when it is disconnected.
DIALEDTIME_MS - This is the milliseconds version of the DIALEDTIME variable.
ANSWEREDTIME - This is the amount of time for actual call.
ANSWEREDTIME_MS - This is the milliseconds version of the ANSWEREDTIME variable.
RINGTIME - This is the time from creating the channel to the first RINGING event received. Empty if there was no ring.
RINGTIME_MS - This is the milliseconds version of the RINGTIME variable.
PROGRESSTIME - This is the time from creating the channel to the first PROGRESS event received. Empty if there was no such event.
PROGRESSTIME_MS - This is the milliseconds version of the PROGRESSTIME variable.
DIALEDPEERNAME - The name of the outbound channel that answered the call.
DIALEDPEERNUMBER - The number that was dialed for the answered outbound channel.
FORWARDERNAME - If a call forward occurred, the name of the forwarded channel.
DIALSTATUS - This is the status of the call
- CHANUNAVAIL - Either the dialed peer exists but is not currently reachable, e.g. endpoint is not registered, or an attempt was made to call a nonexistent location, e.g. nonexistent DNS hostname.
- CONGESTION - Channel or switching congestion occured when routing the call. This can occur if there is a slow or no response from the remote end.
- NOANSWER - Called party did not answer.
- BUSY - The called party was busy or indicated a busy status. Note that some SIP devices will respond with 486 Busy if their Do Not Disturb modes are active. In this case, you can use DEVICE_STATUS to check if the endpoint is actually in use, if needed.
- ANSWER - The call was answered. Any other result implicitly indicates the call was not answered.
- CANCEL - Dial was cancelled before call was answered or reached some other terminating event.
- DONTCALL - For the Privacy and Screening Modes. Will be set if the called party chooses to send the calling party to the 'Go Away' script.
- TORTURE - For the Privacy and Screening Modes. Will be set if the called party chooses to send the calling party to the 'torture' script.
- INVALIDARGS - Dial failed due to invalid syntax.

Syntax

Dial(Technology/Resource&[Technology2/Resource2[&...]],[timeout,[options,[URL]]]])

Arguments

Technology/Resource
- Technology/Resource - Specification of the device(s) to dial. These must be in the format of Technology/Resource, where Technology represents a particular channel driver, and Resource represents a resource available to that particular channel driver.
- Technology2/Resource2 - Optional extra devices to dial in parallel
  If you need more than one enter them as Technology2/Resource2&Technology3/Resource3&.....
timeout - Specifies the number of seconds we attempt to dial the specified devices.
If not specified, this defaults to 136 years.
options
- A( x:y ) - Play an announcement to the called and/or calling parties, where x is the prompt to be played to the called party and y is the prompt to be played to the caller. The files may be different and will be played to each party simultaneously.
  - x - The file to play to the called party
  - y - The file to play to the calling party
- a - Immediately answer the calling channel when the called channel answers in all cases. Normally, the calling channel is answered when the called channel answers, but when options such as A() and M() are used, the calling channel is not answered until all actions on the called channel (such as playing an announcement) are completed. This option can be used to answer the calling channel before doing anything on the called channel. You will rarely need to use this option, the default behavior is adequate in most cases.
- b( context^exten^priority ) - Before initiating an outgoing call, Gosub to the specified location using the newly created channel. The Gosub will be executed for each destination channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- B( context^exten^priority ) - Before initiating the outgoing call(s), Gosub to the specified location using the current channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- C - Reset the call detail record (CDR) for this call.
- c - If the Dial() application cancels this call, always set HANGUPCAUSE to 'answered elsewhere'
- d - Allow the calling user to dial a 1 digit extension while waiting for a call to be answered. Exit to that extension if it exists in the current context, or the context defined in the EXITCONTEXT variable, if it exists.
  NOTE: Many SIP and ISDN phones cannot send DTMF digits until the call is connected. If you wish to use this option with these phones, you can use the Answer application before dialing.
- D( called:calling:progress:mfprogress:mfwink:sfprogress:sfwink ) - Send the specified DTMF strings after the called party has answered, but before the call gets bridged. The called DTMF string is sent to the called party, and the calling DTMF string is sent to the calling party. Both arguments can be used alone. If progress is specified, its DTMF is sent to the called party immediately after receiving a PROGRESS message.
  See SendDTMF for valid digits.
  If mfprogress is specified, its MF is sent to the called party immediately after receiving a PROGRESS message. If mfwink is specified, its MF is sent to the called party immediately after receiving a WINK message.
  See SendMF for valid digits.
  If sfprogress is specified, its SF is sent to the called party immediately after receiving a PROGRESS message. If sfwink is specified, its SF is sent to the called party immediately after receiving a WINK message.
  See SendSF for valid digits.
  - called
  - calling
  - progress
  - mfprogress
  - mfwink
  - sfprogress
  - sfwink
- E - Enable echoing of sent MF or SF digits back to caller (e.g. "hearpulsing"). Used in conjunction with the D option.
- e - Execute the h extension for peer after the call ends
- f( x ) - If x is not provided, force the CallerID sent on a call-forward or deflection to the dialplan extension of this Dial() using a dialplan hint. For example, some PSTNs do not allow CallerID to be set to anything other than the numbers assigned to you. If x is provided, force the CallerID sent to x.
  - x
- F( context^exten^priority ) - When the caller hangs up, transfer the called party to the specified destination and start execution at that location.
  NOTE: Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('_').
  - context
  - exten
  - priority
- F - When the caller hangs up, transfer the called party to the next priority of the current extension and start execution at that location.
  NOTE: Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('_').
  NOTE: Using this option from a Macro() or GoSub() might not make sense as there would be no return points.
- g - Proceed with dialplan execution at the next priority in the current extension if the destination channel hangs up.
- G( context^exten^priority ) - If the call is answered, transfer the calling party to the specified priority and the called party to the specified priority plus one.
  NOTE: You cannot use any additional action post answer options in conjunction with this option.
  - context
  - exten
  - priority
- h - Allow the called party to hang up by sending the DTMF sequence defined for disconnect in features.conf.
- H - Allow the calling party to hang up by sending the DTMF sequence defined for disconnect in features.conf.
  NOTE: Many SIP and ISDN phones cannot send DTMF digits until the call is connected. If you wish to allow DTMF disconnect before the dialed party answers with these phones, you can use the Answer application before dialing.
- i - Asterisk will ignore any forwarding requests it may receive on this dial attempt.
- I - Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on this dial attempt.
- k - Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
- K - Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
- L( x:y:z ) - Limit the call to x milliseconds. Play a warning when y milliseconds are left. Repeat the warning every z milliseconds until time expires.
  This option is affected by the following variables:
  - LIMIT_PLAYAUDIO_CALLER - If set, this variable causes Asterisk to play the prompts to the caller.
    - YES default: (true)
    - NO
  - LIMIT_PLAYAUDIO_CALLEE - If set, this variable causes Asterisk to play the prompts to the callee.
    - YES
    - NO default: (true)
  - LIMIT_TIMEOUT_FILE - If specified, filename specifies the sound prompt to play when the timeout is reached. If not set, the time remaining will be announced.
    - FILENAME
  - LIMIT_CONNECT_FILE - If specified, filename specifies the sound prompt to play when the call begins. If not set, the time remaining will be announced.
    - FILENAME
  - LIMIT_WARNING_FILE - If specified, filename specifies the sound prompt to play as a warning when time x is reached. If not set, the time remaining will be announced.
    - FILENAME
  - x - Maximum call time, in milliseconds
  - y - Warning time, in milliseconds
  - z - Repeat time, in milliseconds
- m( class ) - Provide hold music to the calling party until a requested channel answers. A specific music on hold class (as defined in musiconhold.conf) can be specified.
  - class
- M( macro^arg ) - Execute the specified macro for the called channel before connecting to the calling channel. Arguments can be specified to the Macro using ^ as a delimiter. The macro can set the variable MACRO_RESULT to specify the following actions after the macro is finished executing:
  NOTE: You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are run on the peer (called) channel, so you will not be able to set timeouts via the TIMEOUT() function in this macro.
  WARNING: Be aware of the limitations that macros have, specifically with regards to use of the WaitExten application. For more information, see the documentation for Macro().
  NOTE: Macros are deprecated, GoSub should be used instead, see the U option.
  - MACRO_RESULT - If set, this action will be taken after the macro finished executing.
    - ABORT - Hangup both legs of the call
    - CONGESTION - Behave as if line congestion was encountered
    - BUSY - Behave as if a busy signal was encountered
    - CONTINUE - Hangup the called party and allow the calling party to continue dialplan execution at the next priority
    - GOTO:[[<CONTEXT>^]<EXTEN>^]<PRIORITY> - Transfer the call to the specified destination.
  - macro - Name of the macro that should be executed.
  - arg - Macro arguments
- n( delete ) - This option is a modifier for the call screening/privacy mode. (See the p and P options.) It specifies that no introductions are to be saved in the directory.
  - delete - With delete either not specified or set to 0, the recorded introduction will not be deleted if the caller hangs up while the remote party has not yet answered.
    With delete set to 1, the introduction will always be deleted.
- N - This option is a modifier for the call screening/privacy mode. It specifies that if CallerID is present, do not screen the call.
- o( x ) - If x is not provided, specify that the CallerID that was present on the calling channel be stored as the CallerID on the called channel. This was the behavior of Asterisk 1.0 and earlier. If x is provided, specify the CallerID stored on the called channel. Note that o(${CALLERID(all)}) is similar to option o without the parameter.
  - x
- O( mode ) - Enables operator services mode. This option only works when bridging a DAHDI channel to another DAHDI channel only. If specified on non-DAHDI interfaces, it will be ignored. When the destination answers (presumably an operator services station), the originator no longer has control of their line. They may hang up, but the switch will not release their line until the destination party (the operator) hangs up.
  - mode - With mode either not specified or set to 1, the originator hanging up will cause the phone to ring back immediately.
    With mode set to 2, when the operator flashes the trunk, it will ring their phone back.
- p - This option enables screening mode. This is basically Privacy mode without memory.
- P( x ) - Enable privacy mode. Use x as the family/key in the AstDB database if it is provided. The current extension is used if a database family/key is not specified.
  - x
- Q( cause ) - Specify the Q.850/Q.931 cause to send on unanswered channels when another channel answers the call. As with Hangup(), cause can be a numeric cause code or a name such as NO_ANSWER, USER_BUSY, CALL_REJECTED or ANSWERED_ELSEWHERE (the default if Q isn't specified). You can also specify 0 or NONE to send no cause. See the causes.h file for the full list of valid causes and names.
  NOTE: chan_sip does not support setting the cause on a CANCEL to anything other than ANSWERED_ELSEWHERE.
  - cause
- r( tone ) - Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. Pass no audio to the calling party until the called channel has answered.
  - tone - Indicate progress to calling party. Send audio 'tone' from the indications.conf tonezone currently in use.
- R - Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. Allow interruption of the ringback if early media is received on the channel.
- S( x ) - Hang up the call x seconds after the called party has answered the call.
  - x
- s( x ) - Force the outgoing CallerID tag parameter to be set to the string x.
  Works with the f option.
  - x
- t - Allow the called party to transfer the calling party by sending the DTMF sequence defined in features.conf. This setting does not perform policy enforcement on transfers initiated by other methods.
- T - Allow the calling party to transfer the called party by sending the DTMF sequence defined in features.conf. This setting does not perform policy enforcement on transfers initiated by other methods.
- U( x^arg ) - Execute via Gosub the routine x for the called channel before connecting to the calling channel. Arguments can be specified to the Gosub using ^ as a delimiter. The Gosub routine can set the variable GOSUB_RESULT to specify the following actions after the Gosub returns.
  NOTE: You cannot use any additional action post answer options in conjunction with this option. Also, pbx services are run on the called channel, so you will not be able to set timeouts via the TIMEOUT() function in this routine.
  - GOSUB_RESULT
    - ABORT - Hangup both legs of the call.
    - CONGESTION - Behave as if line congestion was encountered.
    - BUSY - Behave as if a busy signal was encountered.
    - CONTINUE - Hangup the called party and allow the calling party to continue dialplan execution at the next priority.
    - GOTO:[[<CONTEXT>^]<EXTEN>^]<PRIORITY> - Transfer the call to the specified destination.
  - x - Name of the subroutine context to execute via Gosub. The subroutine execution starts in the named context at the s exten and priority 1.
  - arg - Arguments for the Gosub routine
- u( x ) - Works with the f option.
  - x - Force the outgoing callerid presentation indicator parameter to be set to one of the values passed in x: allowed_not_screened allowed_passed_screen allowed_failed_screen allowed prohib_not_screened prohib_passed_screen prohib_failed_screen prohib unavailable
- w - Allow the called party to enable recording of the call by sending the DTMF sequence defined for one-touch recording in features.conf.
- W - Allow the calling party to enable recording of the call by sending the DTMF sequence defined for one-touch recording in features.conf.
- x - Allow the called party to enable recording of the call by sending the DTMF sequence defined for one-touch automixmonitor in features.conf.
- X - Allow the calling party to enable recording of the call by sending the DTMF sequence defined for one-touch automixmonitor in features.conf.
- z - On a call forward, cancel any dial timeout which has been set for this call.
URL - The optional URL will be sent to the called party if the channel driver supports it.

RetryDial()

Synopsis

Place a call, retrying on failure allowing an optional exit extension.

Description

This application will attempt to place a call using the normal Dial application. If no channel can be reached, the announce file will be played. Then, it will wait sleep number of seconds before retrying the call. After retries number of attempts, the calling channel will continue at the next priority in the dialplan. If the retries setting is set to 0, this application will retry endlessly. While waiting to retry a call, a 1 digit extension may be dialed. If that extension exists in either the context defined in EXITCONTEXT or the current one, The call will jump to that extension immediately. The dialargs are specified in the same format that arguments are provided to the Dial application.

Syntax

RetryDial(announce,sleep,retries,dialargs)

Arguments

announce - Filename of sound that will be played when no channel can be reached
sleep - Number of seconds to wait after a dial attempt failed before a new attempt is made
retries - Number of retries
When this is reached flow will continue at the next priority in the dialplan
dialargs - Same format as arguments provided to the Dial application

LoopPlayback()

Synopsis

Loops audio playback indefinitely or a certain number of times

Description

Plays back given filenames (do not put extension of wav/alaw, etc). If the file is non-existent it will fail.

Options available with Playback are not available with this application.

This application does not automatically answer the channel and should be preceded by Progress or Answer as appropriate.

This application sets the following channel variable upon completion:

LOOPPLAYBACKSTATUS - The status of the playback attempt as a text string.
- SUCCESS
- FAILED

Syntax

LoopPlayback(filename&[filename2[&...]],[times]])

Arguments

filenames
- filename
- filename2
times - Number of times to play specified file(s). If omitted, playback will loop "forever", i.e. until the channel hangs up or it is redirected to a different application. Default is 0 (indefinitely).

AMD()

Synopsis

Attempt to detect answering machines.

Description

This application attempts to detect answering machines at the beginning of outbound calls. Simply call this application after the call has been answered (outbound only, of course).

When loaded, AMD reads amd.conf and uses the parameters specified as default values. Those default values get overwritten when the calling AMD with parameters.

This application sets the following channel variables:

AMDSTATUS - This is the status of the answering machine detection
- MACHINE
- HUMAN
- NOTSURE
- HANGUP
AMDCAUSE - Indicates the cause that led to the conclusion
- TOOLONG - Total Time.
- INITIALSILENCE - Silence Duration - Initial Silence.
- HUMAN - Silence Duration - afterGreetingSilence.
- LONGGREETING - Voice Duration - Greeting.
- MAXWORDLENGTH - Word Length - max length of a single word.
- MAXWORDS - Word Count - maximum number of words.

Syntax

AMD([initialSilence,[greeting,[afterGreetingSilence,[totalAnalysis Time,[miniumWordLength,[betweenWordSilence,[maximumNumberOfWords,[silenceThreshold,[maximumWordLength,[audioFile]]]]]]]]]])

Arguments

initialSilence - Is maximum initial silence duration before greeting.
If this is exceeded, the result is detection as a MACHINE
greeting - is the maximum length of a greeting.
If this is exceeded, the result is detection as a MACHINE
afterGreetingSilence - Is the silence after detecting a greeting.
If this is exceeded, the result is detection as a HUMAN
totalAnalysis Time - Is the maximum time allowed for the algorithm
to decide on whether the audio represents a HUMAN, or a MACHINE
miniumWordLength - Is the minimum duration of Voice considered to be a word
betweenWordSilence - Is the minimum duration of silence after a word to consider the audio that follows to be a new word
maximumNumberOfWords - Is the maximum number of words in a greeting
If this is exceeded, then the result is detection as a MACHINE
silenceThreshold - What is the average level of noise from 0 to 32767 which if not exceeded, should be considered silence?
maximumWordLength - Is the maximum duration of a word to accept.
If exceeded, then the result is detection as a MACHINE
audioFile - Is an audio file to play to the caller while AMD is in progress.
By default, no audio file is played.
If an audio file is configured in amd.conf, then that file will be used if one is not specified here. That file may be overridden by this argument.

GetCPEID()

Synopsis

Get ADSI CPE ID.

Description

Obtains and displays ADSI CPE ID and other information in order to properly setup dahdi.conf for on-hook operations.

SkelGuessNumber()

Synopsis

An example number guessing game

Description

This simple number guessing application is a template to build other applications from. It shows you the basic structure to create your own Asterisk applications.

Syntax

SkelGuessNumber(level,[options])

Arguments

level
options
- c - The computer should cheat
- n - How many games to play before hanging up

Macro()

Synopsis

Macro Implementation.

Description

Executes a macro using the context macro-name, jumping to the s extension of that context and executing each step, then returning when the steps end.

The calling extension, context, and priority are stored in MACRO_EXTEN, MACRO_CONTEXT and MACRO_PRIORITY respectively. Arguments become , , etc in the macro context.

If you Goto out of the Macro context, the Macro will terminate and control will be returned at the location of the Goto.

If MACRO_OFFSET is set at termination, Macro will attempt to continue at priority MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise.

Because of the way Macro is implemented (it executes the priorities contained within it via sub-engine), and a fixed per-thread memory stack allowance, macros are limited to 7 levels of nesting (macro calling macro calling macro, etc.); It may be possible that stack-intensive applications in deeply nested macros could cause asterisk to crash earlier than this limit. It is advised that if you need to deeply nest macro calls, that you use the Gosub application (now allows arguments like a Macro) with explicit Return() calls instead.

Use of the application WaitExten within a macro will not function as expected. Please use the Read application in order to read DTMF from a channel currently executing a macro.

Syntax

Macro(name,arg1,[arg2[,...]]])

Arguments

name - The name of the macro
args
- arg1
- arg2

MacroIf()

Synopsis

Conditional Macro implementation.

Description

Executes macro defined in macroiftrue if expr is true (otherwise macroiffalse if provided)

Arguments and return values as in application Macro()

Syntax

MacroIf(expr:macroiftrue:[macroiffalse])

Arguments

expr
destination
- macroiftrue
- macroiffalse

MacroExclusive()

Synopsis

Exclusive Macro Implementation.

Description

Executes macro defined in the context macro-name. Only one call at a time may run the macro. (we'll wait if another call is busy executing in the Macro)

Arguments and return values as in application Macro()

Syntax

MacroExclusive(name,[arg1,[arg2]])

Arguments

name - The name of the macro
arg1
arg2

MacroExit()

Synopsis

Exit from Macro.

Description

Causes the currently running macro to exit as if it had ended normally by running out of priorities to execute. If used outside a macro, will likely cause unexpected behavior.

ADSIProg()

Synopsis

Load Asterisk ADSI Scripts into phone

Description

This application programs an ADSI Phone with the given script

Syntax

ADSIProg([script])

Arguments

script - adsi script to use. If not given uses the default script asterisk.adsi

Zapateller()

Synopsis

Block telemarketers with SIT.

Description

Generates special information tone to block telemarketers from calling you.

This application will set the following channel variable upon completion:

ZAPATELLERSTATUS - This will contain the last action accomplished by the Zapateller application. Possible values include:
- NOTHING
- ANSWERED
- ZAPPED

Syntax

Zapateller(options)

Arguments

options
- answer - Causes the line to be answered before playing the tone.
- nocallerid - Causes Zapateller to only play the tone if there is no callerid information available.

StoreDTMF()

Synopsis

Stores DTMF digits transmitted or received on a channel.

Description

The StoreDTMF function can be used to obtain digits sent in the TX or RX direction of any channel.

The arguments are:

var_name: Name of variable to which to append digits.

max_digits: The maximum number of digits to store in the variable. Defaults to 0 (no maximum). After reading maximum digits, no more digits will be stored.

Example: Store digits in CDR variable

	same => n,StoreDTMF(TX,CDR(digits))

Example: Store up to 24 digits

	same => n,StoreDTMF(RX,testvar,24)

Example: Disable digit collection

	same => n,StoreDTMF(remove)

Syntax

StoreDTMF(direction)

Arguments

direction - Must be TX or RX to store digits, or remove to disable.

BlindTransfer()

Synopsis

Blind transfer channel(s) to the extension and context provided

Description

Redirect all channels currently bridged to the caller channel to the specified destination.

The result of the application will be reported in the BLINDTRANSFERSTATUS channel variable:

BLINDTRANSFERSTATUS
- SUCCESS - Transfer succeeded.
- FAILURE - Transfer failed.
- INVALID - Transfer invalid.
- NOTPERMITTED - Transfer not permitted.

Syntax

BlindTransfer(exten,[context])

Arguments

exten - Specify extension.
context - Optionally specify a context. By default, Asterisk will use the caller channel context.

FollowMe()

Synopsis

Find-Me/Follow-Me application.

Description

This application performs Find-Me/Follow-Me functionality for the caller as defined in the profile matching the followmeid parameter in followme.conf. If the specified followmeid profile doesn't exist in followme.conf, execution will be returned to the dialplan and call execution will continue at the next priority.

Returns -1 on hangup.

Syntax

FollowMe(followmeid,[options])

Arguments

followmeid
options
- a - Record the caller's name so it can be announced to the callee on each step.
- B( context^exten^priority ) - Before initiating the outgoing call(s), Gosub to the specified location using the current channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- b( context^exten^priority ) - Before initiating an outgoing call, Gosub to the specified location using the newly created channel. The Gosub will be executed for each destination channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- d - Disable the 'Please hold while we try to connect your call' announcement.
- I - Asterisk will ignore any connected line update requests it may receive on this dial attempt.
- l - Disable local call optimization so that applications with audio hooks between the local bridge don't get dropped when the calls get joined directly.
- N - Don't answer the incoming call until we're ready to connect the caller or give up.
- n - Playback the unreachable status message if we've run out of steps or the callee has elected not to be reachable.
- s - Playback the incoming status message prior to starting the follow-me step(s)

ChannelRedirect()

Synopsis

Redirects given channel to a dialplan target

Description

Sends the specified channel to the specified extension priority

This application sets the following channel variables upon completion

CHANNELREDIRECT_STATUS - Are set to the result of the redirection
- NOCHANNEL
- SUCCESS

Syntax

ChannelRedirect(channel,[context,[extension,]]priority)

Arguments

channel
context
extension
priority

Dictate()

Synopsis

Virtual Dictation Machine.

Description

Start dictation machine using optional base_dir for files.

Syntax

Dictate([base_dir,[filename]])

Arguments

base_dir
filename

DialTone()

Synopsis

Reads a telephone number from a user digit by digit, terminating dialing against a digit map.

Description

Reads a telephone number from a user into the given variable. Dialing concludes once an extension match is found in context that returns a positive number.

If context returns a negative number, the absolute value will be used to wait in silence for an additional digit. For example, if the digit map returns -5, the application will wait 5 seconds in silence for an additional digit and complete if it does not receive any.

This application does not automatically answer the channel and should be preceded by Progress or Answer.

Example: Simulated city dial tone

	same => n,DialTone(num,my-digit-map,custom/dialtone,custom/dialsounds/sound${RAND(1,6)},32,,,pr)

Example: Precise dial tone with 5 second interdigit timeout

	same => n,DialTone(num,my-digit-map,dial,,32,5,,ip)

Example: Terminate dialing with # key

	same => n,DialTone(num,my-digit-map,dial,,32,10,,ipt)

Syntax

DialTone(variable,context&filename&[filename2[&...]]&]filename&[filename2[&...]],[maxdigits,[timeout,[leading,[options]]]]])

Arguments

variable - The input digits will be stored in the given variable name.
context - Context to use to as the digit map for this dial tone. The digit map context is a dialplan context with extensions (including pattern matches) that should return a non-zero value to conclude dialing on a match. Returning 0 will continue dialing.
filenames
- filename - file(s) to play before reading first digit or tone with option i
- filename2
filenames2
- filename - file(s) to play before reading subsequent digits or tone with option i
- filename2
maxdigits - Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the # key).
Defaults to 0 - no limit - wait for the user press the # key. Any value below 0 means the same. Max accepted value is 255. This overrides the digit map, and will terminate dialing even if there is no match in the digit map context.
timeout - The number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout. Can be floating point.
leading - Leading digits that should be used to initialize the number dialed. Useful for second dial tones or when additional digits need to be received and use the same digit map.
options
- d - Echo back digits to caller as they are entered, as DTMF.
- i - to play filename as an indication tone from your indications.conf.
- m - Echo back digits to caller as they are entered, as MF.
- p - Parse digit map by performing variable substitution.
- r - Reevaluate the variable substitution of filename2 each digit (for all subsequent digits).
- t - Terminate dialing using the # key. By default, the # key is not treated specially and will not terminate input.

ExternalIVR()

Synopsis

Interfaces with an external IVR application.

Description

Either forks a process to run given command or makes a socket to connect to given host and starts a generator on the channel. The generator's play list is controlled by the external application, which can add and clear entries via simple commands issued over its stdout. The external application will receive all DTMF events received on the channel, and notification if the channel is hung up. The received on the channel, and notification if the channel is hung up. The application will not be forcibly terminated when the channel is hung up. For more information see doc/AST.pdf.

Syntax

ExternalIVR([arg1,[arg2,[options]]])

Arguments

command|ivr://host
- arg1
- arg2
options
- n - Tells ExternalIVR() not to answer the channel.
- i - Tells ExternalIVR() not to send a hangup and exit when the channel receives a hangup, instead it sends an I informative message meaning that the external application MUST hang up the call with an H command.
- d - Tells ExternalIVR() to run on a channel that has been hung up and will not look for hangups. The external application must exit with an E command.

ReadExten()

Synopsis

Read an extension into a variable.

Description

Reads a # terminated string of digits from the user into the given variable.

Will set READEXTENSTATUS on exit with one of the following statuses:

READEXTENSTATUS
- OK - A valid extension exists in ${variable}.
- TIMEOUT - No extension was entered in the specified time. Also sets ${variable} to "t".
- INVALID - An invalid extension, ${INVALID_EXTEN}, was entered. Also sets ${variable} to "i".
- SKIP - Line was not up and the option 's' was specified.
- ERROR - Invalid arguments were passed.

Syntax

ReadExten(variable,[filename,[context,[option,[timeout]]]])

Arguments

variable
filename - File to play before reading digits or tone with option i
context - Context in which to match extensions.
option
- s - Return immediately if the channel is not answered.
- i - Play filename as an indication tone from your indications.conf or a directly specified list of frequencies and durations.
- n - Read digits even if the channel is not answered.
- p - The extension entered will be considered complete when a # is entered.
timeout - An integer number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout.

UserEvent()

Synopsis

Send an arbitrary user-defined event to parties interested in a channel (AMI users and relevant res_stasis applications).

Description

Sends an arbitrary event to interested parties, with an optional body representing additional arguments. The body may be specified as a , delimited list of key:value pairs.

For AMI, each additional argument will be placed on a new line in the event and the format of the event will be:

Event: UserEvent

UserEvent:

[body]

If no body is specified, only Event and UserEvent headers will be present.

For res_stasis applications, the event will be provided as a JSON blob with additional arguments appearing as keys in the object and the eventname under the eventname key.

Syntax

UserEvent(eventname,[body])

Arguments

eventname
body

Exec()

Synopsis

Executes dialplan application.

Description

Allows an arbitrary application to be invoked even when not hard coded into the dialplan. If the underlying application terminates the dialplan, or if the application cannot be found, Exec will terminate the dialplan.

To invoke external applications, see the application System. If you would like to catch any error instead, see TryExec.

Syntax

Exec(arguments)

Arguments

appname
- arguments

TryExec()

Synopsis

Executes dialplan application, always returning.

Description

Allows an arbitrary application to be invoked even when not hard coded into the dialplan. To invoke external applications see the application System. Always returns to the dialplan. The channel variable TRYSTATUS will be set to one of:

TRYSTATUS
- SUCCESS - If the application returned zero.
- FAILED - If the application returned non-zero.
- NOAPP - If the application was not found or was not specified.

Syntax

TryExec(arguments)

Arguments

appname
- arguments

ExecIf()

Synopsis

Executes dialplan application, conditionally.

Description

If expr is true, execute and return the result of appiftrue(args).

If expr is true, but appiftrue is not found, then the application will return a non-zero value.

Syntax

ExecIf(expression:appiftrue:[appiffalse])

Arguments

expression
execapp
- appiftrue
- appiffalse

Record()

Synopsis

Record to a file.

Description

If filename contains %d, these characters will be replaced with a number incremented by one each time the file is recorded. Use to see the available formats on your system User can press # to terminate the recording and continue to the next priority. If the user hangs up during a recording, all data will be lost and the application will terminate.

RECORDED_FILE - Will be set to the final filename of the recording, without an extension.
RECORD_STATUS - This is the final status of the command
- DTMF - A terminating DTMF was received ('#' or '*', depending upon option 't')
- SILENCE - The maximum silence occurred in the recording.
- SKIP - The line was not yet answered and the 's' option was specified.
- TIMEOUT - The maximum length was reached.
- HANGUP - The channel was hung up.
- ERROR - An unrecoverable error occurred, which resulted in a WARNING to the logs.

Syntax

Record(filename.format,[silence,[maxduration,[options]]])

Arguments

filename
- filename
- format - Is the format of the file type to be recorded (wav, gsm, etc).
silence - Is the number of seconds of silence to allow before returning.
maxduration - Is the maximum recording duration in seconds. If missing or 0 there is no maximum.
options
- a - Append to existing recording rather than replacing.
- n - Do not answer, but record anyway if line not yet answered.
- o - Exit when 0 is pressed, setting the variable RECORD_STATUS to OPERATOR instead of DTMF
- q - quiet (do not play a beep tone).
- s - skip recording if the line is not yet answered.
- t - use alternate '*' terminator key (DTMF) instead of default '#'
- u - Don't truncate recorded silence.
- x - Ignore all terminator keys (DTMF) and keep recording until hangup.
- k - Keep recorded file upon hangup.
- y - Terminate recording if *any* DTMF digit is received.

SetMWI()

Synopsis

Message Waiting Indicator management

Description

This application may be used to manually control Message Waiting Indicators.

This can be used for MWI troubleshooting, such as remedying MWI that has not properly cleared, or for manually setting MWI as part of other dialplan functionality.

Syntax

SetMWI([target,[disposition]])

Arguments

target - A list of ampersand-separated mailboxes or devices.
When mailboxes are specified, an MWI notification will be sent to all devices subscribed to that mailbox.
Alternately, if a device is specified, an MWI notification will be sent specifically to that endpoint. This is only supported for PJSIP/SIP endpoints. This can be useful for devices that may not have mailboxes. Note that if you do this, your PJSIP/SIP notify config will need to have clear-mwi and activate-mwi sections configured.
disposition - If specified, truthy (1) to enable MWI and falsy (0) to disable.
If not specified, MWI will be set high if there are new messages in any of the provided mailboxes and 0 otherwise. This is only supported for mailboxes, not devices.

RemoteAccess()

Synopsis

Remote Access

Description

This is an implementation of Remote Access, as used with AT&T/5ESS.

The audio prompts referenced in this module are required for this module to work.

Available features should be defined as extensions (by feature code) in the same extension. A special priority of 1000 is used to Return() the a filename announcing the name of the feature.

These extensions will be invoked using Gosub. Therefore, execution should terminate with a Return.

If the value 0 is returned, this will be handled as an error condition and Remote Access will disconnect. Otherwise, the user is allowed to select another feature.

RAF_NUMBER - The remote access forwarding number, if successfully authenticated.Note this is the number as translated, not entered originally.

Syntax

RemoteAccess([vmcontext,]directory,dbkey,[sub_available,[sub_valid,[saytelnum_dir,[saytelnum_args,[maxnumlen,[options]]]]]])

Arguments

vmcontext - Voicemail context containing users.
PINs for Remote Access will be the voicemail passwords.
directory - Directory containing the prompt set to be used.
Do NOT terminate with a trailing slash.
dbkey - Name of AstDB family/key to use.
Use ^{RAF_NUMBER} in place of the translated Remote Access number.
sub_available - Gosub context to check if Remote Access feature is available.
The EXTEN will be the Remote Access number entered. The voicemail context provided to the application will be provided as ARG1.
The subroutine should return the number to use for DB queries if allowed and empty otherwise. For example, this might return a full 10-digit number instead of an extension.
If this argument is not provided, it is assumed the feature is available for any valid extension, and that the number is the extension entered.
sub_valid - Gosub context to check if a number can be used with Remote Access Forwarding.
ARG1 will be the translated Remote Access number.
The subroutine should return 1 if valid and 0 otherwise.
If not provided, it is assumed that any number may be used.
saytelnum_dir - Directory for SayTelephoneNumber
saytelnum_args - Arguments to SayTelephoneNumber
maxnumlen - Maximum number length for extensions in this voicemail context.
options
- f - Do not provide built-in Remote Access Forwarding

BackgroundDetect()

Synopsis

Background a file with talk detect.

Description

Plays back filename, waiting for interruption from a given digit (the digit must start the beginning of a valid extension, or it will be ignored). During the playback of the file, audio is monitored in the receive direction, and if a period of non-silence which is greater than min ms yet less than max ms is followed by silence for at least sil ms, which occurs during the first analysistime ms, then the audio playback is aborted and processing jumps to the talk extension, if available.

Syntax

BackgroundDetect(filename,[sil,[min,[max,[analysistime]]]])

Arguments

filename
sil - If not specified, defaults to 1000.
min - If not specified, defaults to 100.
max - If not specified, defaults to infinity.
analysistime - If not specified, defaults to infinity.

TddRx()

Synopsis

Enable TDD transmit/receive processing on a channel.

Description

The TddRx application is used to begin listening for TDD tones from the channel. If TDD tones are detected, the received message will be posted via manager/stasis events for this channel.

This application will exit immediately after setting up an audiohook.

Syntax

TddRx([options])

Arguments

options
- b( bufsiz )
  - bufsiz - Specify a custom input buffer size. This controls received character delivery via manager/stasis events (a smaller value means more messages with less rx chars in each). Valid values are 1-256.
- c( correlation )
  - correlation - Provide a correlation string for this channel, will be sent with TddRxMsg events.
- s - Send spaces as underscores in TddRxMsg events.
- m - Replace received audio frames with silence while TDD carrier is active.
- i - Use International TTY @ 50 bps instead of US TTY @ 45.45.

TddTx()

Synopsis

Send message using TDD tones on the current channel.

Description

Sends TDD tones to the channel in the same way as the TddTx manager action.

If TDD processing is not enabled via TddRx, will return an error.

Syntax

TddTx(message)

Arguments

message

System()

Synopsis

Execute a system command.

Description

Executes a command by using system(). If the command fails, the console should report a fallthrough.

Result of execution is returned in the SYSTEMSTATUS channel variable:

SYSTEMSTATUS
- FAILURE - Could not execute the specified command.
- SUCCESS - Specified command successfully executed.

Syntax

System(command)

Arguments

command - Command to execute

TrySystem()

Synopsis

Try executing a system command.

Description

Executes a command by using system().

Result of execution is returned in the SYSTEMSTATUS channel variable:

SYSTEMSTATUS
- FAILURE - Could not execute the specified command.
- SUCCESS - Specified command successfully executed.
- APPERROR - Specified command successfully executed, but returned error code.

Syntax

TrySystem(command)

Arguments

command - Command to execute

SendDTMF()

Synopsis

Sends arbitrary DTMF digits

Description

It will send all digits or terminate if it encounters an error.

Syntax

SendDTMF(digits,[timeout_ms,[duration_ms,[channel,[options]]]])

Arguments

digits - List of digits 0-9,*#,a-d,A-D to send also w for a half second pause, W for a one second pause, and f or F for a flash-hook if the channel supports flash-hook.
timeout_ms - Amount of time to wait in ms between tones. (defaults to .25s)
duration_ms - Duration of each digit
channel - Channel where digits will be played
options
- a - Answer the channel specified by the channel parameter if it is not already up. If no channel parameter is provided, the current channel will be answered.

MeetMe()

Synopsis

MeetMe conference bridge.

Description

Enters the user into a specified MeetMe conference. If the confno is omitted, the user will be prompted to enter one. User can exit the conference by hangup, or if the p option is specified, by pressing #.

The DAHDI kernel modules and a functional DAHDI timing source (see dahdi_test) must be present for conferencing to operate properly. In addition, the chan_dahdi channel driver must be loaded for the i and r options to operate at all.

Syntax

MeetMe([confno,[options,[pin]]])

Arguments

confno - The conference number
options
- a - Set admin mode.
- A - Set marked mode.
- b - Run AGI script specified in MEETME_AGI_BACKGROUND Default: conf-background.agi.
- c - Announce user(s) count on joining a conference.
- C - Continue in dialplan when kicked out of conference.
- d - Dynamically add conference.
- D - Dynamically add conference, prompting for a PIN.
- e - Select an empty conference.
- E - Select an empty pinless conference.
- F - Pass DTMF through the conference.
- G( x ) - Play an intro announcement in conference.
  - x - The file to playback
- i - Announce user join/leave with review.
- I - Announce user join/leave without review.
- k - Close the conference if there's only one active participant left at exit.
- l - Set listen only mode (Listen only, no talking).
- m - Set initially muted.
- M( class ) - Enable music on hold when the conference has a single caller. Optionally, specify a musiconhold class to use. If one is not provided, it will use the channel's currently set music class, or default.
  - class
- n - Disable the denoiser. By default, if func_speex is loaded, Asterisk will apply a denoiser to channels in the MeetMe conference. However, channel drivers that present audio with a varying rate will experience degraded performance with a denoiser attached. This parameter allows a channel joining the conference to choose not to have a denoiser attached without having to unload func_speex.
- o - Set talker optimization - treats talkers who aren't speaking as being muted, meaning (a) No encode is done on transmission and (b) Received audio that is not registered as talking is omitted causing no buildup in background noise.
- p( keys ) - Allow user to exit the conference by pressing # (default) or any of the defined keys. Dial plan execution will continue at the next priority following MeetMe. The key used is set to channel variable MEETME_EXIT_KEY.
  - keys
- P - Always prompt for the pin even if it is specified.
- q - Quiet mode (don't play enter/leave sounds).
- r - Record conference (records as MEETME_RECORDINGFILE using format MEETME_RECORDINGFORMAT. Default filename is meetme-conf-rec-${CONFNO}-${UNIQUEID} and the default format is wav.
- s - Present menu (user or admin) when * is received (send to menu).
- t - Set talk only mode. (Talk only, no listening).
- T - Set talker detection (sent to manager interface and meetme list).
- v( mailbox@[context] ) - Announce when a user is joining or leaving the conference. Use the voicemail greeting as the announcement. If the i or I options are set, the application will fall back to them if no voicemail greeting can be found.
  - mailbox@[context] - The mailbox and voicemail context to play from. If no context provided, assumed context is default.
- w( secs ) - Wait until the marked user enters the conference.
  - secs
- x - Leave the conference when the last marked user leaves.
- X - Allow user to exit the conference by entering a valid single digit extension MEETME_EXIT_CONTEXT or the current context if that variable is not defined.
- 1 - Do not play message when first person enters
- S( x ) - Kick the user x seconds after he entered into the conference.
  - x
- L( x:y:z ) - Limit the conference to x ms. Play a warning when y ms are left. Repeat the warning every z ms. The following special variables can be used with this option:
  - CONF_LIMIT_TIMEOUT_FILE - File to play when time is up.
  - CONF_LIMIT_WARNING_FILE - File to play as warning if y is defined. The default is to say the time remaining.
  - x
  - y
  - z
pin

MeetMeCount()

Synopsis

MeetMe participant count.

Description

Plays back the number of users in the specified MeetMe conference. If var is specified, playback will be skipped and the value will be returned in the variable. Upon application completion, MeetMeCount will hangup the channel, unless priority n+1 exists, in which case priority progress will continue.

Syntax

MeetMeCount(confno,[var])

Arguments

confno - Conference number.
var

MeetMeAdmin()

Synopsis

MeetMe conference administration.

Description

Run admin command for conference confno.

Will additionally set the variable MEETMEADMINSTATUS with one of the following values:

MEETMEADMINSTATUS
- NOPARSE - Invalid arguments.
- NOTFOUND - User specified was not found.
- FAILED - Another failure occurred.
- OK - The operation was completed successfully.

Syntax

MeetMeAdmin(confno,command,[user])

Arguments

confno
command
- e - Eject last user that joined.
- E - Extend conference end time, if scheduled.
- k - Kick one user out of conference.
- K - Kick all users out of conference.
- l - Unlock conference.
- L - Lock conference.
- m - Unmute one user.
- M - Mute one user.
- n - Unmute all users in the conference.
- N - Mute all non-admin users in the conference.
- r - Reset one user's volume settings.
- R - Reset all users volume settings.
- s - Lower entire conference speaking volume.
- S - Raise entire conference speaking volume.
- t - Lower one user's talk volume.
- T - Raise one user's talk volume.
- u - Lower one user's listen volume.
- U - Raise one user's listen volume.
- v - Lower entire conference listening volume.
- V - Raise entire conference listening volume.
user

MeetMeChannelAdmin()

Synopsis

MeetMe conference Administration (channel specific).

Description

Run admin command for a specific channel in any conference.

Syntax

MeetMeChannelAdmin(channel,command)

Arguments

channel
command
- k - Kick the specified user out of the conference he is in.
- m - Unmute the specified user.
- M - Mute the specified user.

SLAStation()

Synopsis

Shared Line Appearance Station.

Description

This application should be executed by an SLA station. The argument depends on how the call was initiated. If the phone was just taken off hook, then the argument station should be just the station name. If the call was initiated by pressing a line key, then the station name should be preceded by an underscore and the trunk name associated with that line button.

For example: station1_line1

On exit, this application will set the variable SLASTATION_STATUS to one of the following values:

SLASTATION_STATUS
- FAILURE
- CONGESTION
- SUCCESS

Syntax

SLAStation(station)

Arguments

station - Station name

SLATrunk()

Synopsis

Shared Line Appearance Trunk.

Description

This application should be executed by an SLA trunk on an inbound call. The channel calling this application should correspond to the SLA trunk with the name trunk that is being passed as an argument.

On exit, this application will set the variable SLATRUNK_STATUS to one of the following values:

SLATRUNK_STATUS
- FAILURE
- SUCCESS
- UNANSWERED
- RINGTIMEOUT

Syntax

SLATrunk(trunk,[options])

Arguments

trunk - Trunk name
options
- M( class ) - Play back the specified MOH class instead of ringing
  - class

Page()

Synopsis

Page series of phones

Description

Places outbound calls to the given technology/resource and dumps them into a conference bridge as muted participants. The original caller is dumped into the conference as a speaker and the room is destroyed when the original caller leaves.

Syntax

Page(Technology/Resource&[Technology2/Resource2[&...]],[options,[timeout]]])

Arguments

Technology/Resource
- Technology/Resource - Specification of the device(s) to dial. These must be in the format of Technology/Resource, where Technology represents a particular channel driver, and Resource represents a resource available to that particular channel driver.
- Technology2/Resource2 - Optional extra devices to dial in parallel
  If you need more than one, enter them as Technology2/Resource2& Technology3/Resource3&.....
options
- b( context^exten^priority ) - Before initiating an outgoing call, Gosub to the specified location using the newly created channel. The Gosub will be executed for each destination channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- B( context^exten^priority ) - Before initiating the outgoing call(s), Gosub to the specified location using the current channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- d - Full duplex audio
- i - Ignore attempts to forward the call
- q - Quiet, do not play beep to caller
- r - Record the page into a file (CONFBRIDGE(bridge,record_conference))
- s - Only dial a channel if its device state says that it is NOT_INUSE
- A( x ) - Play an announcement to all paged participants
  - x - The announcement to playback to all devices
- n - Do not play announcement to caller (alters A(x) behavior)
timeout - Specify the length of time that the system will attempt to connect a call. After this duration, any page calls that have not been answered will be hung up by the system.

Authenticate()

Synopsis

Authenticate a user

Description

This application asks the caller to enter a given password in order to continue dialplan execution.

If the password begins with the / character, it is interpreted as a file which contains a list of valid passwords, listed 1 password per line in the file.

When using a database key, the value associated with the key can be anything.

Users have three attempts to authenticate before the channel is hung up.

Syntax

Authenticate(password,[options,[maxdigits,[prompt]]])

Arguments

password - Password the user should know
options
- a - Set the channels' account code to the password that is entered
- d - Interpret the given path as database key, not a literal file.
- m - Interpret the given path as a file which contains a list of account codes and password hashes delimited with :, listed one per line in the file. When one of the passwords is matched, the channel will have its account code set to the corresponding account code in the file.
- r - Remove the database key upon successful entry (valid with d only)
maxdigits - maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the # key). Defaults to 0 - no limit - wait for the user press the # key.
prompt - Override the agent-pass prompt file.

BridgeWait()

Synopsis

Put a call into the holding bridge.

Description

This application places the incoming channel into a holding bridge. The channel will then wait in the holding bridge until some event occurs which removes it from the holding bridge.

This application will answer calls which haven't already been answered, unless the n option is provided.

Syntax

BridgeWait([name,[role,[options]]])

Arguments

name - Name of the holding bridge to join. This is a handle for BridgeWait only and does not affect the actual bridges that are created. If not provided, the reserved name default will be used.
role - Defines the channel's purpose for entering the holding bridge. Values are case sensitive.
- participant - The channel will enter the holding bridge to be placed on hold until it is removed from the bridge for some reason. (default)
- announcer - The channel will enter the holding bridge to make announcements to channels that are currently in the holding bridge. While an announcer is present, holding for the participants will be suspended.
options
- m( class ) - The specified MOH class will be used/suggested for music on hold operations. This option will only be useful for entertainment modes that use it (m and h).
  - class
- e - Which entertainment mechanism should be used while on hold in the holding bridge. Only the first letter is read.
  - m - Play music on hold (default)
  - r - Ring without pause
  - s - Generate silent audio
  - h - Put the channel on hold
  - n - No entertainment
- S( duration ) - Automatically exit the bridge and return to the PBX after duration seconds.
  - duration
- n - Do not automatically answer the channel.

SMS()

Synopsis

Communicates with SMS service centres and SMS capable analogue phones.

Description

SMS handles exchange of SMS data with a call to/from SMS capable phone or SMS PSTN service center. Can send and/or receive SMS messages. Works to ETSI ES 201 912; compatible with BT SMS PSTN service in UK and Telecom Italia in Italy.

Typical usage is to use to handle calls from the SMS service centre CLI, or to set up a call using outgoing or manager interface to connect service centre to SMS().

"Messages are processed as per text file message queues. smsq (a separate software) is a command to generate message queues and send messages.

The protocol has tight delay bounds. Please use short frames and disable/keep short the jitter buffer on the ATA to make sure that respones (ACK etc.) are received in time.

Syntax

SMS(name,[options,[addr,[body]]])

Arguments

name - The name of the queue used in /var/spool/asterisk/sms
options
- a - Answer, i.e. send initial FSK packet.
- s - Act as service centre talking to a phone.
- t - Use protocol 2 (default used is protocol 1).
- p - Set the initial delay to N ms (default is 300). addr and body are a deprecated format to send messages out.
- r - Set the Status Report Request (SRR) bit.
- o - The body should be coded as octets not 7-bit symbols.
- n - Do not log any SMS content to log file (privacy).
addr
body

SendText()

Synopsis

Send a Text Message on a channel.

Description

Sends text to the current channel.

The following variables can be set:

Result of transmission will be stored in the following variables:

Examples:

If the channel driver supports enhanced messaging (currently only chan_pjsip), you can set additional variables:

current channel could be the caller or callee depending on the context in which this application is called.

The text encoding and transmission method is completely at the discretion of the channel driver. chan_pjsip will use in-dialog SIP MESSAGE messages always. chan_sip will use T.140 via RTP if a text media type was negotiated and in-dialog SIP MESSAGE messages otherwise.

Example: Send a simple message

	same => n,SendText(Your Text Here)

Example: Alter the From display name

	same => n,Set(SENDTEXT_FROM_DISPLAYNAME=Really From Bob)
	same => n,SendText(Your Text Here)

Example: Send a JSON String

	same => n,Set(SENDTEXT_CONTENT_TYPE=text/json)
	same => n,SendText({"foo":a, "bar":23})

Example: Send a JSON String (alternate)

	same => n,Set(SENDTEXT_CONTENT_TYPE=text/json)
	same => n,Set(SENDTEXT_BODY={"foo":a, "bar":23})
	same => n,SendText()

SENDTEXT_FROM_DISPLAYNAME - If set and this channel supports enhanced messaging, this value will be used as the From display name.
SENDTEXT_TO_DISPLAYNAME - If set and this channel supports enhanced messaging, this value will be used as the To display name.
SENDTEXT_CONTENT_TYPE - If set and this channel supports enhanced messaging, this value will be used as the message Content-Type. If not specified, the default of text/plain will be used.Warning: Messages of types other than text/* cannot be sent via channel drivers that do not support Enhanced Messaging. An attempt to do so will be ignored and will result in the SENDTEXTSTATUS variable being set to UNSUPPORTED.
SENDTEXT_BODY - If set this value will be used as the message body and any text supplied as a function parameter will be ignored.

Syntax

SendText([text])

Arguments

text

ReceiveText()

Synopsis

Receive a Text Message on a channel.

Description

Waits for timeout seconds on the current channel to receive text.

Result of transmission will be stored in the following variables:

Example: Receive message on channel

	same => n,ReceiveText()
	same => n,NoOp(${RECEIVETEXTMESSAGE})

RECEIVETEXTMESSAGE - The received text message.
RECEIVETEXTSTATUS
- SUCCESS - Transmission succeeded.
- FAILURE - Transmission failed or timed out.

Syntax

ReceiveText([timeout])

Arguments

timeout - Time in seconds to wait for text. Default is 0 (forever).

RequestCallback()

Synopsis

Requests a callback to a local or remote destination.

Description

Request a callback to a local or remote destination.

This can be used to easily implement features such as Busy Redial (a.k.a. Repeat Dialing and Continuous Redial) and Last Call Return.

CALLBACK_REQUEST_STATUS - This indicates the result of the callback origination.
- FAILURE - Failure occured.
- QUEUED - Destination currently busy, but a callback has been queued. This is the first callback.
- ANOTHER - Destination currently busy, but a callback has been queued. This is not the first callback.
- IDLE - Destination currently idle, no callback queued but call may proceed.
- DUPLICATE - Callback to this destination already exists. No callback queued.
- ALREADY - Callback to a destination (but not the requested one) already exists. No callback queued.
- UNSUPPORTED - Callback to a destination is not possible (no route available for busy determination).

Syntax

RequestCallback([callbackcaller,[callbackwatched,[localdevicestate,[remotedialcontext,[number,[caller,[timeout,[ringtime,[poll,[tagname,[options]]]]]]]]]]])

Arguments

callbackcaller - Dialplan context to ring back caller in if callback succeeds.
Extension is the callback number.
callbackwatched - Dialplan context to ring watched number in if callback succeeds.
Extension is the callback number.
localdevicestate - Context providing local device state.
remotedialcontext - Context providing remote device state. Will be dialed using a Local channel. Use Dial in this context if needed.
This will use the TEXT_QUERY function under the hood.
The remote endpoint needs to send a textual transfer of the queried device state, e.g. SendText(${DEVICE_STATE(MYDEVICE)}).
number - The globally unique number to attempt callback against.
caller - The globally unique number performing the callback.
Default is CALLERID(num).
timeout - Time, in seconds, to wait for callback completion.
Default is 1800 (30 minutes).
ringtime - Time, in seconds, to wait for caller to answer on a successful callback.
Default is 30 seconds.
poll - Polling interval of device state. An override will apply to both local and remote intervals. To specify both local and remote interval, delimit using a pipe.
Default is 5 seconds for local destinations and 30 seconds for remote destinations.
WARNING: A low interval for remote polling could significantly increase network traffic.
tagname - An optional tag name to specify the type of service. This allows callbacks for different services to be treated separately.
The s option as well as cancel requests only apply to callbacks with the same tag (including the default "empty" tag).
options
- l - Only initiate callback if the local caller is also idle.
  If this option is not provided and the caller is busy, the callback will complete successfully even if the caller is unable to receive it, which may not be desirable. Specifying this option ensures the caller is called back only if both parties are free. This option should not be used if Call Waiting can be used.
- s - Limit a caller to only a single callback at a time, regardless of destination.

CancelCallback()

Synopsis

Cancels one or more in-progress queued callbacks

Description

Cancels all callbacks currently queued for a caller.

CALLBACK_CANCEL_STATUS - This indicates the result of the callback cancellation.
- FAILURE - No callbacks could be cancelled.
- SUCCESS - All callbacks by this caller (with matching tag) cancelled.

Syntax

CancelCallback([caller,[tag]])

Arguments

caller - The globally unique number performing the callback.
Default is CALLERID(num).
tag - Optional tag name. Only callbacks with the specified tag will be cancelled.
If not provided, only callbacks with no tag name will be cancelled.

Verbose()

Synopsis

Send arbitrary text to verbose output.

Description

Sends an arbitrary text message to verbose output.

Syntax

Verbose([level,]message)

Arguments

level - Must be an integer value. If not specified, defaults to 0.
message - Output text message.

Log()

Synopsis

Send arbitrary text to a selected log level.

Description

Sends an arbitrary text message to a selected log level.

Syntax

Log(level,message)

Arguments

level - Level must be one of ERROR, WARNING, NOTICE, DEBUG, VERBOSE, DTMF, or the name of a custom dynamic logging level.
message - Output text message.

DumpChan()

Synopsis

Dump Info About The Calling Channel.

Description

Displays information on channel and listing of all channel variables. If level is specified, output is only displayed when the verbose level is currently set to that number or greater.

Syntax

DumpChan([level])

Arguments

level - Minimum verbose level

ChanSpy()

Synopsis

Listen to a channel, and optionally whisper into it.

Description

This application is used to listen to the audio from an Asterisk channel. This includes the audio coming in and out of the channel being spied on. If the chanprefix parameter is specified, only channels beginning with this string will be spied upon.

While spying, the following actions may be performed:

- Dialing # cycles the volume level.

- Dialing * will stop spying and look for another channel to spy on.

- Dialing a series of digits followed by # builds a channel name to append to chanprefix. For example, executing ChanSpy(Agent) and then dialing the digits '1234#' while spying will begin spying on the channel 'Agent/1234'. Note that this feature will be overridden if the 'd' or 'u' options are used.

The X option supersedes the three features above in that if a valid single digit extension exists in the correct context ChanSpy will exit to it. This also disables choosing a channel based on chanprefix and a digit sequence.

Syntax

ChanSpy([chanprefix,[options]])

Arguments

chanprefix
options
- b - Only spy on channels involved in a bridged call.
- B - Instead of whispering on a single channel barge in on both channels involved in the call.
- c( digit )
  - digit - Specify a DTMF digit that can be used to spy on the next available channel.
- d - Override the typical numeric DTMF functionality and instead use DTMF to switch between spy modes.
  - 4 - spy mode
  - 5 - whisper mode
  - 6 - barge mode
- e( ext ) - Enable enforced mode, so the spying channel can only monitor extensions whose name is in the ext : delimited list.
  - ext
- E - Exit when the spied-on channel hangs up.
- g( grp )
  - grp - Only spy on channels in which one or more of the groups listed in grp matches one or more groups from the SPYGROUP variable set on the channel to be spied upon.
- l - Allow usage of a long queue to store audio frames.
- n( mailbox@context ) - Say the name of the person being spied on if that person has recorded his/her name. If a context is specified, then that voicemail context will be searched when retrieving the name, otherwise the default context be used when searching for the name (i.e. if SIP/1000 is the channel being spied on and no mailbox is specified, then 1000 will be used when searching for the name).
  - mailbox
  - context
- o - Only listen to audio coming from this channel.
- q - Don't play a beep when beginning to spy on a channel, or speak the selected channel name.
- r( basename ) - Record the session to the monitor spool directory. An optional base for the filename may be specified. The default is chanspy.
  - basename
- s - Skip the playback of the channel type (i.e. SIP, IAX, etc) when speaking the selected channel name.
- S - Stop when no more channels are left to spy on.
- u - The chanprefix parameter is a channel uniqueid or fully specified channel name.
- v( value ) - Adjust the initial volume in the range from -4 to 4. A negative value refers to a quieter setting.
  - value
- w - Enable whisper mode, so the spying channel can talk to the spied-on channel.
- W - Enable private whisper mode, so the spying channel can talk to the spied-on channel but cannot listen to that channel.
- x( digit )
  - digit - Specify a DTMF digit that can be used to exit the application while actively spying on a channel. If there is no channel being spied on, the DTMF digit will be ignored.
- X - Allow the user to exit ChanSpy to a valid single digit numeric extension in the current context or the context specified by the SPY_EXIT_CONTEXT channel variable. The name of the last channel that was spied on will be stored in the SPY_CHANNEL variable.

ExtenSpy()

Synopsis

Listen to a channel, and optionally whisper into it.

Description

This application is used to listen to the audio from an Asterisk channel. This includes the audio coming in and out of the channel being spied on. Only channels created by outgoing calls for the specified extension will be selected for spying. If the optional context is not supplied, the current channel's context will be used.

While spying, the following actions may be performed:

- Dialing # cycles the volume level.

- Dialing * will stop spying and look for another channel to spy on.

Syntax

ExtenSpy(exten@[context,[options]])

Arguments

exten
- exten - Specify extension.
- context - Optionally specify a context, defaults to default.
options
- b - Only spy on channels involved in a bridged call.
- B - Instead of whispering on a single channel barge in on both channels involved in the call.
- c( digit )
  - digit - Specify a DTMF digit that can be used to spy on the next available channel.
- d - Override the typical numeric DTMF functionality and instead use DTMF to switch between spy modes.
  - 4 - spy mode
  - 5 - whisper mode
  - 6 - barge mode
- e( ext ) - Enable enforced mode, so the spying channel can only monitor extensions whose name is in the ext : delimited list.
  - ext
- E - Exit when the spied-on channel hangs up.
- g( grp )
  - grp - Only spy on channels in which one or more of the groups listed in grp matches one or more groups from the SPYGROUP variable set on the channel to be spied upon.
- l - Allow usage of a long queue to store audio frames.
- n( mailbox@context ) - Say the name of the person being spied on if that person has recorded his/her name. If a context is specified, then that voicemail context will be searched when retrieving the name, otherwise the default context be used when searching for the name (i.e. if SIP/1000 is the channel being spied on and no mailbox is specified, then 1000 will be used when searching for the name).
  - mailbox
  - context
- o - Only listen to audio coming from this channel.
- q - Don't play a beep when beginning to spy on a channel, or speak the selected channel name.
- r( basename ) - Record the session to the monitor spool directory. An optional base for the filename may be specified. The default is chanspy.
  - basename
- s - Skip the playback of the channel type (i.e. SIP, IAX, etc) when speaking the selected channel name.
- S - Stop when there are no more extensions left to spy on.
- v( value ) - Adjust the initial volume in the range from -4 to 4. A negative value refers to a quieter setting.
  - value
- w - Enable whisper mode, so the spying channel can talk to the spied-on channel.
- W - Enable private whisper mode, so the spying channel can talk to the spied-on channel but cannot listen to that channel.
- x( digit )
  - digit - Specify a DTMF digit that can be used to exit the application while actively spying on a channel. If there is no channel being spied on, the DTMF digit will be ignored.
- X - Allow the user to exit ChanSpy to a valid single digit numeric extension in the current context or the context specified by the SPY_EXIT_CONTEXT channel variable. The name of the last channel that was spied on will be stored in the SPY_CHANNEL variable.

DAHDIScan()

Synopsis

Scan DAHDI channels to monitor calls.

Description

Allows a call center manager to monitor DAHDI channels in a convenient way. Use # to select the next channel and use * to exit.

Syntax

DAHDIScan([group])

Arguments

group - Limit scanning to a channel group by setting this option.

PlayDigits()

Synopsis

Plays a DTMF or MF sequence using audio files

Description

Plays a DTMF or MF signaling sequence using audio files rather than pure tones.

Numeric digits must have file names corresponding to the digit to be played.

Syntax

PlayDigits(directory,number,[separationtime,[options]])

Arguments

directory - Directory containing the audio set to be used.
Do NOT terminate with a trailing slash.
number - The number to play to the caller.
separationtime - Pause duration, in seconds, between digits.
Default is 250 ms.
options
- a - Custom file(s) to play before digits, relative to the specified directory.
- b - Custom file(s) to play between digits.
- m - Custom prefix for digits. Default is none.
- n - Custom suffix for digits. Default is none.
- p - Custom file to play for pound.
- s - Custom file to play for star.
- z - Custom file(s) to play after digits, relative to the specified directory.

PartialPlayback()

Synopsis

Play a file, between optionally specified start and end offsets.

Description

Plays back a given filename (do not include extension).

This application does not automatically answer the channel.

This application sets the following channel variable upon completion:

PLAYBACKSTATUS - The status of the playback attempt.
- SUCCESS
- FAILED

Syntax

PartialPlayback(filename,[start,[end]])

Arguments

filename - File to play. Do not include extension.
start - Starting time. Default is start of file.
end - Ending time. Default is end of file.

While()

Synopsis

Start a while loop.

Description

Start a While Loop. Execution will return to this point when EndWhile() is called until expr is no longer true.

Syntax

While(expr)

Arguments

expr

EndWhile()

Synopsis

End a while loop.

Description

Return to the previous called While().

ExitWhile()

Synopsis

End a While loop.

Description

Exits a While() loop, whether or not the conditional has been satisfied.

ContinueWhile()

Synopsis

Restart a While loop.

Description

Returns to the top of the while loop and re-evaluates the conditional.

ForkCDR()

Synopsis

Forks the current Call Data Record for this channel.

Description

Causes the Call Data Record engine to fork a new CDR starting from the time the application is executed. The forked CDR will be linked to the end of the CDRs associated with the channel.

Syntax

ForkCDR([options])

Arguments

options
- a - If the channel is answered, set the answer time on the forked CDR to the current time. If this option is not used, the answer time on the forked CDR will be the answer time on the original CDR. If the channel is not answered, this option has no effect.
  Note that this option is implicitly assumed if the r option is used.
- e - End (finalize) the original CDR.
- r - Reset the start and answer times on the forked CDR. This will set the start and answer times (if the channel is answered) to be set to the current time.
  Note that this option implicitly assumes the a option.
- v - Do not copy CDR variables and attributes from the original CDR to the forked CDR.

Broadcast()

Synopsis

Transmit or receive audio to or from multiple channels simultaneously

Description

This application can be used to broadcast audio to multiple channels at once. Any audio received on this channel will be transmitted to all of the specified channels and, optionally, their bridged peers.

It can also be used to aggregate audio from multiple channels at once. Any audio on any of the specified channels, and optionally their bridged peers, will be transmitted to this channel.

Execution of the application continues until either the broadcasting channel hangs up or all specified channels have hung up.

This application is used for one-to-many and many-to-one audio applications where bridge mixing cannot be done synchronously on all the involved channels. This is primarily useful for injecting the same audio stream into multiple channels at once, or doing the reverse, combining the audio from multiple channels into a single stream. This contrasts with using a separate injection channel for each target channel and/or using a conference bridge.

The channel running the Broadcast application must do so synchronously. The specified channels, however, may be doing other things.

Note that in the last example above, this is NOT the same as a conference bridge. The specified channels are not audible to each other, only to the channel running the Broadcast application. The two-way audio is only between the broadcasting channel and each of the specified channels, individually.

Example: Broadcast received audio to three channels and their bridged peers

	same => n,Broadcast(wb,DAHDI/1,DAHDI/3,PJSIP/doorphone)

Example: Broadcast received audio to three channels, only

	same => n,Broadcast(w,DAHDI/1,DAHDI/3,PJSIP/doorphone)

Example: Combine audio from three channels and their bridged peers to us

	same => n,Broadcast(s,DAHDI/1,DAHDI/3,PJSIP/doorphone)

Example: Combine audio from three channels to us

	same => n,Broadcast(so,DAHDI/1,DAHDI/3,PJSIP/doorphone)

Example: Two-way audio with a bunch of channels

	same => n,Broadcast(wbso,DAHDI/1,DAHDI/3,PJSIP/doorphone)

Syntax

Broadcast([options,]channels)

Arguments

options
- b - In addition to broadcasting to target channels, also broadcast to any channels to which target channels are bridged.
- l - Allow usage of a long queue to store audio frames.
- o - Do not mix streams when combining audio from target channels (only applies with s option).
- r - Feed frames to barge channels in "reverse" by injecting them into the primary channel's read queue instead.
  This option is required for barge to work in a n-party bridge (but not for 2-party bridges). Alternately, you can add an intermediate channel by using a non-optimized Local channel, so that the target channel is bridged with a single channel that is connected to the bridge, but it is recommended this option be used instead.
  Note that this option will always feed injected audio to the other party, regardless of whether the target channel is bridged or not.
- s - Rather than broadcast audio to a bunch of channels, receive the combined audio from the target channels.
- w - Broadcast audio received on this channel to other channels.
channels - List of channels for broadcast targets.
Channel names must be the full channel names, not merely device names.
Broadcasting will continue until the broadcasting channel hangs up or all target channels have hung up.

Read()

Synopsis

Read a variable.

Description

Reads a #-terminated string of digits a certain number of times from the user in to the given variable.

This application sets the following channel variable upon completion:

READSTATUS - This is the status of the read operation.
- OK
- ERROR
- HANGUP
- INTERRUPTED
- SKIPPED
- TIMEOUT

Syntax

Read(variable&filename&[filename2[&...]],[maxdigits,[options,[attempts,[timeout]]]]])

Arguments

variable - The input digits will be stored in the given variable name.
filenames
- filename - file(s) to play before reading digits or tone with option i
- filename2
maxdigits - Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the # key).
Defaults to 0 - no limit - wait for the user press the # key. Any value below 0 means the same. Max accepted value is 255.
options
- s - to return immediately if the line is not up.
- i - to play filename as an indication tone from your indications.conf.
- n - to read digits even if the line is not up.
- t - Terminator digit(s) to use for ending input. Default is #. If you need to read the digit # literally, you should remove or change the terminator character. Multiple terminator characters may be specified. If no terminator digit is present, input cannot be ended using digits and you will need to rely on duration and max digits for ending input.
- e - to read the terminator as the digit string if the only digit read is the terminator. This is for cases where the terminator is a valid digit, but only by itself. ie; 1234 and # are valid, but 1234# is not.
attempts - If greater than 1, that many attempts will be made in the event no data is entered.
timeout - The number of seconds to wait for a digit response. If greater than 0, that value will override the default timeout. Can be floating point.

Gosub()

Synopsis

Jump to label, saving return address.

Description

Jumps to the label specified, saving the return address.

Syntax

Gosub([context,[exten,]]arg1[,...]],[argN])

Arguments

context
exten
priority
- arg1
- argN

GosubIf()

Synopsis

Conditionally jump to label, saving return address.

Description

If the condition is true, then jump to labeliftrue. If false, jumps to labeliffalse, if specified. In either case, a jump saves the return point in the dialplan, to be returned to with a Return.

Syntax

GosubIf(condition:[labeliftrue:[labeliffalse]])

Arguments

condition
destination
- labeliftrue - Continue at labeliftrue if the condition is true. Takes the form similar to Goto() of [[context,]extension,]priority.
- labeliffalse - Continue at labeliffalse if the condition is false. Takes the form similar to Goto() of [[context,]extension,]priority.

Return()

Synopsis

Return from gosub routine.

Description

Jumps to the last label on the stack, removing it. The return value, if any, is saved in the channel variable GOSUB_RETVAL.

Syntax

Return([value])

Arguments

value - Return value.

ReturnIf()

Synopsis

Conditionally return from gosub routine.

Description

If expression is true, jumps to the last label on the stack, removing it. The return valueiftrue, if any, is saved in the channel variable GOSUB_RETVAL. If expression is false, and valueiffalse is specified, jumps to the last label on the stack, removing it, and saving valueiffalse in the the channel variable GOSUB_RETVAL.

Syntax

ReturnIf(expression:valueiftrue:[valueiffalse])

Arguments

expression
execapp
- valueiftrue
- valueiffalse

StackPop()

Synopsis

Remove one address from gosub stack.

Description

Removes last label on the stack, discarding it.

DBdeltree()

Synopsis

Delete a family or keytree from the asterisk database.

Description

This application will delete a family or keytree from the Asterisk database.

Syntax

DBdeltree(family,[keytree])

Arguments

family
keytree

ConfBridge()

Synopsis

Conference bridge application.

Description

Enters the user into a specified conference bridge. The user can exit the conference by hangup or DTMF menu option.

This application sets the following channel variable upon completion:

CONFBRIDGE_RESULT
- FAILED - The channel encountered an error and could not enter the conference.
- HANGUP - The channel exited the conference by hanging up.
- KICKED - The channel was kicked from the conference.
- ENDMARKED - The channel left the conference as a result of the last marked user leaving.
- DTMF - The channel pressed a DTMF sequence to exit the conference.
- TIMEOUT - The channel reached its configured timeout.

Syntax

ConfBridge(conference,[bridge_profile,[user_profile,[menu]]])

Arguments

conference - Name of the conference bridge. You are not limited to just numbers.
bridge_profile - The bridge profile name from confbridge.conf. When left blank, a dynamically built bridge profile created by the CONFBRIDGE dialplan function is searched for on the channel and used. If no dynamic profile is present, the 'default_bridge' profile found in confbridge.conf is used.
It is important to note that while user profiles may be unique for each participant, mixing bridge profiles on a single conference is _NOT_ recommended and will produce undefined results.
user_profile - The user profile name from confbridge.conf. When left blank, a dynamically built user profile created by the CONFBRIDGE dialplan function is searched for on the channel and used. If no dynamic profile is present, the 'default_user' profile found in confbridge.conf is used.
menu - The name of the DTMF menu in confbridge.conf to be applied to this channel. When left blank, a dynamically built menu profile created by the CONFBRIDGE dialplan function is searched for on the channel and used. If no dynamic profile is present, the 'default_menu' profile found in confbridge.conf is used.

ConfKick()

Synopsis

Kicks channel(s) from the requested ConfBridge.

Description

Kicks the requested channel(s) from a conference bridge.

CONFKICKSTATUS
- FAILURE - Could not kick any users with the provided arguments.
- SUCCESS - Successfully kicked users from specified conference bridge.

Syntax

ConfKick(conference,[channel])

Arguments

conference
channel - The channel to kick, all to kick all users, or participants to kick all non-admin participants. Default is all.

VoiceMail()

Synopsis

Leave a Voicemail message.

Description

The Voicemail application will exit if any of the following DTMF digits are received:

This application will set the following channel variable upon completion:

VMSTATUS - This indicates the status of the execution of the VoiceMail application.
- SUCCESS
- USEREXIT
- FAILED

Syntax

VoiceMail(mailbox1&[mailbox2[&...]],[options]])

Arguments

mailboxs
- mailbox1
- mailbox2
options
- b - Play the busy greeting to the calling party.
- d( c ) - Accept digits for a new extension in context c, if played during the greeting. Context defaults to the current context.
  - c
- e - Play greetings as early media -- only answer the channel just before accepting the voice message.
- g( # ) - Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB). Only works on supported technologies, which is DAHDI only.
  - #
- s - Skip the playback of instructions for leaving a message to the calling party.
- S - Skip the playback of instructions for leaving a message to the calling party, but only if a greeting has been recorded by the mailbox user.
- t( x ) - Play a custom beep tone to the caller instead of the default one. If this option is used but no file is specified, the beep is suppressed.
  - x
- u - Play the unavailable greeting.
- U - Mark message as URGENT.
- P - Mark message as PRIORITY.

VoiceMailMain()

Synopsis

Check Voicemail messages.

Description

The VoiceMailMain application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VoiceMailMain([mailbox@[context,[options]]])

Arguments

mailbox
- mailbox
- context
options
- p - Consider the mailbox parameter as a prefix to the mailbox that is entered by the caller.
- g( # ) - Use the specified amount of gain when recording a voicemail message. The units are whole-number decibels (dB).
  - #
- r - "Read only". Prevent user from deleting any messages.
  This applies only to specific executions of VoiceMailMain, NOT the mailbox itself.
- s - Skip checking the passcode for the mailbox.
- a( folder ) - Skip folder prompt and go directly to folder specified. Defaults to INBOX (or 0).
  - folder
  - 0 - INBOX
  - 1 - Old
  - 2 - Work
  - 3 - Family
  - 4 - Friends
  - 5 - Cust1
  - 6 - Cust2
  - 7 - Cust3
  - 8 - Cust4
  - 9 - Cust5

VMAuthenticate()

Synopsis

Authenticate with Voicemail passwords.

Description

The VMAuthenticate application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VMAuthenticate([mailbox@[context,[options]]])

Arguments

mailbox
- mailbox
- context
options
- s - Skip playing the initial prompts.

VoiceMailPlayMsg()

Synopsis

Play a single voice mail msg from a mailbox by msg id.

Description

This application sets the following channel variable upon completion:

VOICEMAIL_PLAYBACKSTATUS - The status of the playback attempt as a text string.
- SUCCESS
- FAILED

Syntax

VoiceMailPlayMsg([mailbox@[context,]]msg_id)

Arguments

mailbox
- mailbox
- context
msg_id - The msg id of the msg to play back.

VMSayName()

Synopsis

Play the name of a voicemail user

Description

This application will say the recorded name of the voicemail user specified as the argument to this application. If no context is provided, default is assumed.

Similar to the Background() application, playback of the recorded name can be interrupted by entering an extension, which will be searched for in the current context.

Syntax

VMSayName([mailbox@[context]])

Arguments

mailbox
- mailbox
- context

WaitUntil()

Synopsis

Wait (sleep) until the current time is the given epoch.

Description

Waits until the given epoch.

Sets WAITUNTILSTATUS to one of the following values:

WAITUNTILSTATUS
- OK - Wait succeeded.
- FAILURE - Invalid argument.
- HANGUP - Channel hungup before time elapsed.
- PAST - Time specified had already past.

Syntax

WaitUntil(epoch)

Arguments

epoch

ControlPlayback()

Synopsis

Play a file with fast forward and rewind.

Description

This application will play back the given filename.

It sets the following channel variables upon completion:

CPLAYBACKSTATUS - Contains the status of the attempt as a text string
- SUCCESS
- USERSTOPPED
- REMOTESTOPPED
- ERROR
CPLAYBACKOFFSET - Contains the offset in ms into the file where playback was at when it stopped. -1 is end of file.
CPLAYBACKSTOPKEY - If the playback is stopped by the user this variable contains the key that was pressed.

Syntax

ControlPlayback(filename,[skipms,[ff,[rew,[stop,[pause,[restart,[options]]]]]]])

Arguments

filename
skipms - This is number of milliseconds to skip when rewinding or fast-forwarding.
ff - Fast-forward when this DTMF digit is received. (defaults to #)
rew - Rewind when this DTMF digit is received. (defaults to *)
stop - Stop playback when this DTMF digit is received.
pause - Pause playback when this DTMF digit is received.
restart - Restart playback when this DTMF digit is received.
options
- o( time )
  - time - Start at time ms from the beginning of the file.

WaitForSilence()

Synopsis

Waits for a specified amount of silence.

Description

Waits for up to silencerequired milliseconds of silence, iterations times. An optional timeout specified the number of seconds to return after, even if we do not receive the specified amount of silence. Use timeout with caution, as it may defeat the purpose of this application, which is to wait indefinitely until silence is detected on the line. This is particularly useful for reverse-911-type call broadcast applications where you need to wait for an answering machine to complete its spiel before playing a message.

Typically you will want to include two or more calls to WaitForSilence when dealing with an answering machine; first waiting for the spiel to finish, then waiting for the beep, etc.

Sets the channel variable WAITSTATUS to one of these values:

Example: Wait for half a second of silence, twice

	same => n,WaitForSilence(500,2)

Example: Wait for one second of silence, once

	same => n,WaitForSilence(1000)

Example: Wait for 300 ms of silence, 3 times, and returns after 10 seconds, even if no silence detected

	same => n,WaitForSilence(300,3,10)

WAITSTATUS
- SILENCE - if exited with silence detected.
- TIMEOUT - if exited without silence detected after timeout.

Syntax

WaitForSilence([silencerequired,[iterations,[timeout]]])

Arguments

silencerequired - If not specified, defaults to 1000 milliseconds.
iterations - If not specified, defaults to 1.
timeout - Is specified only to avoid an infinite loop in cases where silence is never achieved.

WaitForNoise()

Synopsis

Waits for a specified amount of noise.

Description

Waits for up to noiserequired milliseconds of noise, iterations times. An optional timeout specified the number of seconds to return after, even if we do not receive the specified amount of noise. Use timeout with caution, as it may defeat the purpose of this application, which is to wait indefinitely until noise is detected on the line.

Syntax

WaitForNoise([noiserequired,[iterations,[timeout]]])

Arguments

noiserequired - If not specified, defaults to 1000 milliseconds.
iterations - If not specified, defaults to 1.
timeout - Is specified only to avoid an infinite loop in cases where silence is never achieved.

IVRDemo()

Synopsis

IVR Demo Application.

Description

This is a skeleton application that shows you the basic structure to create your own asterisk applications and demonstrates the IVR demo.

Syntax

IVRDemo(filename)

Arguments

filename

WaitForCondition()

Synopsis

Wait (sleep) until the given condition is true.

Description

Waits until expression evaluates to true, checking every interval seconds for up to timeout. Default is evaluate expression every 50 milliseconds with no timeout.

Sets WAITFORCONDITIONSTATUS to one of the following values:

Example: Wait for condition dialplan variable/function to become 1 for up to 40 seconds, checking every 500ms

	same => n,WaitForCondition(#,#["#{condition}"="1"],40,0.5)

WAITFORCONDITIONSTATUS
- TRUE - Condition evaluated to true before timeout expired.
- FAILURE - Invalid argument.
- TIMEOUT - Timeout elapsed without condition evaluating to true.
- HANGUP - Channel hung up before condition became true.

Syntax

WaitForCondition(replacementchar,expression,[timeout,[interval]])

Arguments

replacementchar - Specifies the character in the expression used to replace the $ character. This character should not be used anywhere in the expression itself.
expression - A modified logical expression with the $ characters replaced by replacementchar. This is necessary to pass the expression itself into the application, rather than its initial evaluation.
timeout - The maximum amount of time, in seconds, this application should wait for a condition to become true before dialplan execution continues automatically to the next priority. By default, there is no timeout.
interval - The frequency, in seconds, of polling the condition, which can be adjusted depending on how time-sensitive execution needs to be. By default, this is 0.05.

AudioSocket()

Synopsis

Transmit and receive audio between channel and TCP socket

Description

Connects to the given TCP service, then transmits channel audio over that socket. In turn, audio is received from the socket and sent to the channel. Only audio frames will be transmitted.

Protocol is specified at https://wiki.asterisk.org/wiki/display/AST/AudioSocket

This application does not automatically answer and should generally be preceeded by an application such as Answer() or Progress().

Syntax

AudioSocket(uuid,service)

Arguments

uuid - UUID is the universally-unique identifier of the call for the audio socket service. This ID must conform to the string form of a standard UUID.
service - Service is the name or IP address and port number of the audio socket service to which this call should be connected. This should be in the form host:port, such as myserver:9019

SayTelephoneNumber()

Synopsis

Enunciates a telephone number with the proper inflections and intonations

Description

Dynamically enunciates a telephone number to the caller, emulating a standard number announcement drum machine.

This application will properly enunciate a telephone number by alternating inflections on certain digits, to reflect the way that people actually say telephone numbers.

In double-inflection mode, a down inflection is used on pre-pause (e.g. at the end of a number group) digits.

In triple-inflection mode, an up inflection is used on pre-pause digits, except for the last number group (the station number). In this group, the 3rd to last digit receives an up inflection, and the very last digit (and only this digit) will use a down inflection.

In all modes, a pause is added between number groups.

Down inflection digits should be named as the digit only, not including the file extension.

Up-inflection digits should be named as the digit followed by an underscore, not including the file extension. (This is the convention used by the Asterisk sounds library.)

For double up-inflection digits (used only in triple inflection mode), suffix a double-underscore to the filename, not including the file extension.

These suffixes may also be overridden using the appropriate options.

By default, a pause is played between groups of digits. The duration of the pause can be configured. Additionally, if the file blank (or the configured name) exists in the provided directory, it will be used instead of a timed pause.

Double or triple digits may also be provided, such as 00 or 555. The file names thousand and hundred are also used if found and relevant.

The application requires that vanilla numeric (up-inflection) digits exist. However, other files will be preferred if they would be a better match for enunciating particular digits, but the application will gracefully fall back if they do not exist. However, all files must exist for the proper inflections to be used.

Currently only supports North American (NANPA) 7 or 10-digit numbers.

This application does not automatically answer the channel and should be preceded by Answer or Progress as appropriate.

Example: Simple ANAC using built-in prompts

	same => n,SayTelephoneNumber(digits,${CALLERID(num)})

SAYTELNUM_DIGIT - The digit entered, if interrupted.

Syntax

SayTelephoneNumber(directory,number,[separationtime,[options]])

Arguments

directory - Directory containing the prompt set to be used.
Do NOT terminate with a trailing slash.
number - The number to announce to the caller.
Must be alphanumeric. Number may contain letters for the exchange name that will be used if a corresponding file exists.
separationtime - Pause duration, in seconds, between groups of numbers (such as between the area code, prefix, and station number).
Default is 750 ms.
options
- b - Filename to override blank.
- i - Allow DMTF interrupt.
  Additionally, if the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will also allow DTMF interrupt.
  If a digit is entered, it will be contained in the SAYTELNUM_DIGIT variable upon exit.
- m - Enable triple inflection mode, and specifically use MCI inflections. Default is double inflection mode.
- n - Suffix to use for files containing normal or down inflection. Default is nothing.
- p - Filename (in same directory) to play before each digit.
- t - Enable triple inflection mode. Default is double inflection mode.
  Most number announcements use double inflection.
  Use of the m option will override this option.
- u - Suffix to use for files containing up inflection. Default is _ (single underscore).
- v - Suffix to use for files containing double-up inflection. Default is __ (double underscore).
  Double up-inflection is only used in triple inflection mode (either regular or MCI).

KeyPrefetch()

Synopsis

Obtains or updates a public key to accept for incoming IAX2 calls

Description

The IAX2 channel driver allows users to specify a list of names of RSA public keys (or inkeys) to accept for authentication on incoming calls.

This application allows public keys to be automatically downloaded and updated during dialplan execution. It will also add keys to an IAX2 section config for you.

This application sets the following variable:

KEYPREFETCHSTATUS
- NEW - New key downloaded.
- UPDATED - Existing key has been updated.
- UNMODIFIED - Key already exists and was not modified.
- FAILURE - Failure occured.

Syntax

KeyPrefetch(cat,keyname,url,maxage,[options])

Arguments

cat - Category in iax.conf which should accept downloaded inkeys.
keyname - The name of the public key as it should be saved to the file system.
Do not include the extension (e.g. omit .pub).
url - The HTTP (or HTTPS) endpoint to query for the public key. The HTTP request must return a valid RSA public key.
maxage - The maximum age of a key, in seconds, before it will be downloaded again, even if it already exists.
If a key with the same name already exists, it will not be downloaded again, unless it is older than this parameter.
Default is 86400 (24 hours).
options
- d - Do not reload chan_iax2 and res_crypto if a new key is installed. These modules need to be reloaded before any added or modified keys will be accepted for incoming calls.
- n - Do not throw a warning if a public key request is a 404 Not Found.

George()

Synopsis

George, the Interactive answering machine

Description

This is George, the Interactive Answering Machine, a virtual telephone answering device, i.e. "soft" answering machine implementation.

It is based off Evan Doorbell's "George, the Interactive Answering Machine".

It is intended to be used to answer an FXO channel that may be connected to a CO line or other FXS channel.

If Call Waiting is enabled, this application will detect the Call Waiting Subscriber Alert Signal on the channel and automatically try to handle the call waiting. This allows the answering machine to simultaneously service two incoming callers. A single recorded message will be used for the original call and any call waitings that are handled.

This application does not automatically adjust the gain or receive volume on the channel. You may wish to do this to make detection of talking easier or harder.

To use this application, you must provide all of the audio prompts in the app_george.conf config file.

Syntax

George([mailbox,[waitsec,[options]]])

Arguments

mailbox - Voicemail mailbox (mbox[@context]) into which to dump messages.
waitsec - Number of seconds to wait before answering
Default is 0.
options
- c - Support Call Waiting.
  This should only be done for FXS lines with Call Waiting enabled.
  Note that all calls during a single session will be combined into a single recording.
- i - Support Call Waiting Caller ID.
  Support received CWCID spill if the FXS line has Call Waiting Caller ID available.
  Note that nothing is currently done with this information. The first caller's information is what is used as the calling number for the entire recording session.
- j - Allow jumping out to the * extension if it exists in the current context.
  The user can press * at any point, for example to manage the mailbox.
- t - Enable toll saver.
  By default, the call will be answered in half as much time if messages exist.
  You can specify a time to use for toll saver explicitly.
  If Toll Saver is handled elsewhere, you should not use this option.

SendMail()

Synopsis

Sends an email using the system mailer. The recipient and sender info can be customized per invocation, and multiple attachments can be sent.

Description

Sends an email using the system mailer.

Sets MAILSTATUS to one of the following values:

MAILSTATUS
- SUCCESS - Email was successfully sent. This does not necessarily mean delivery will be successful or that the email will not bounce.
- FAILURE - Email was not successfully sent.

Syntax

SendMail(recipient,subject,body,options)

Arguments

recipient - Pipe-separated list of email addresses.
subject
body - The name of the variable contain the body of the message. This should not be the variable itself, only the name of it.
options
- A( filepath:filename:mimetype ) - Pipe-separated list of attachments, using the full path.
  - filepath - The full path to the file to attach.
  - filename - The name of the attached file. The default name is the base file name of the attached file.
  - mimetype - The MIME format of the attachment. There is no default Content-Type header for attachments so some mail clients may not respond well to this. You should include the MIME type if you know what it is (e.g. text/plain).
- d - Delete successfully attached files once the email is sent.
- e - Interpret escaping in the body of the email. This option is required to add tabs and new lines.
- f - Email address from which the email should be sent. This option is required.
- F - Name from which the email should be sent.
- R - Name of the recipient.

SoftHangup()

Synopsis

Hangs up the requested channel.

Description

Hangs up the requested channel. If there are no channels to hangup, the application will report it.

Syntax

SoftHangup(Technology/Resource,[options])

Arguments

Technology/Resource
options
- a - Hang up all channels on a specified device instead of a single resource

Stasis()

Synopsis

Invoke an external Stasis application.

Description

Invoke a Stasis application.

This application will set the following channel variable upon completion:

STASISSTATUS - This indicates the status of the execution of the Stasis application.
- SUCCESS - The channel has exited Stasis without any failures in Stasis.
- FAILED - A failure occurred when executing the Stasis The app registry is not instantiated; The app application. Some (not all) possible reasons for this: requested is not registered; The app requested is not active; Stasis couldn't send a start message.

Syntax

Stasis(app_name,[args])

Arguments

app_name - Name of the application to invoke.
args - Optional comma-delimited arguments for the application invocation.

PreDial()

Synopsis

Send pre-dial headers to an endpoint in a pre-dial handler

Description

This application will, in a pre-dial handler, set up a call on a specific endpoint by sending the necessary IP headers for certain functionality that depends on them.

This can be helpful in abstracting away vendor-specific implementation details from your call processing. Because a pre-dial handler executes on each device that is dialed, this application will be called uniquely for each device that is dialed and sent each device the correct headers, regardless of what headers may be sent to other endpoints.

This application may be called technology-agnostically. Unsupported technologies are silently ignored.

Syntax

PreDial([options])

Arguments

options
- a - Auto answer the call.
- c - Specify a distinctive ringing cadence or ringtone to be used.
  The numeric 1-indexed cadence number should be provided as an argument.

Milliwatt()

Synopsis

Generates a 1004 Hz test tone at 0dbm (mu-law).

Description

Generates a 1004 Hz test tone.

By default, this application does not provide a Milliwatt test tone. It simply plays a 1004 Hz tone, which is not suitable for performing a milliwatt test. The m option should be used so that a real Milliwatt test tone is provided. This will include a 1 second silent interval every 10 seconds.

Previous versions of this application generated a constant tone at 1000 Hz. If for some reason you would prefer that behavior, supply the o option to get the old behavior.

Syntax

Milliwatt([options])

Arguments

options
- m - Generate a 1004 Hz Milliwatt test tone at 0dbm, with a 1 second silent interval. This option must be specified if you are using this for a milliwatt test line.
- o - Generate a constant tone at 1000 Hz like previous version.

AgentLogin()

Synopsis

Description

Login an agent to the system. Any agent authentication is assumed to already be done by dialplan. While logged in, the agent can receive calls and will hear the sound file specified by the config option custom_beep when a new call comes in for the agent. Login failures will continue in the dialplan with AGENT_STATUS set.

Before logging in, you can setup on the real agent channel the CHANNEL(dtmf_features) an agent will have when talking to a caller and you can setup on the channel running this application the CONNECTEDLINE() information the agent will see while waiting for a caller.

AGENT_STATUS enumeration values:

The Agent:AgentId device state is available to monitor the status of the agent.

Syntax

AgentLogin(AgentId,[options])

Arguments

AgentId
options
- s - silent login - do not announce the login ok segment after agent logged on.

AgentRequest()

Synopsis

Request an agent to connect with the channel.

Description

Request an agent to connect with the channel. Failure to find, alert the agent, or acknowledge the call will continue in the dialplan with AGENT_STATUS set.

AGENT_STATUS enumeration values:

Syntax

AgentRequest(AgentId)

Arguments

AgentId

Verify()

Synopsis

Verifies an incoming call

Description

This application verifies an incoming call and stores the result in a dialplan variable. Verification is performed in conjunction with pre-specified parameters and allows spoofed or fradulent calls in a peer-to-peer trunking system to be screened out.

This application may generally only be used with IAX2 channels, except for simple verify methods regex and pattern.

STIR/SHAKEN processing is only supported on SIP/PJSIP channels.

Syntax

Verify([profile,[number]])

Arguments

profile - The profile in verify.conf to use for verification.
number - Number against which to verify. Typically, this should be the contents of the CALLERID(num) variable, and this is the default if unspecified.

OutVerify()

Synopsis

Sets up an outgoing call for downstream verification

Description

This application sets up a call for outgoing verification. As part of this process, any remote variables needed for successful downstream verification are set or obtained, and the call is analyzed in accordance with rules in verify.conf to help prevent certain risky or malicious calls from being completed.

This application may only be used with IAX2 channels.

This application sets the following variable:

OUTVERIFYSTATUS
- PROCEED - Call is okay to proceed.
- FAILURE - Failed to successfully out verify the call.
- MALICIOUS - The destination corresponds to a potentially malicious destination, such as a private IP address.
- QUARANTINEDISA - This is a thru call which should not be allowed to complete the outgoing call.
- QUARANTINEPSTN - This is a PSTN call which should not be allowed to complete the outgoing call.

Syntax

OutVerify([profile,[lookup]])

Arguments

profile - The profile in verify.conf to use.
lookup - IAX2 lookup to analyze for potential malicious dialplan injection, to avoid call fraud.

TestServer()

Synopsis

Execute Interface Test Server.

Description

Perform test server function and write call report. Results stored in /var/log/asterisk/testreports/<testid>-server.txt

TestClient()

Synopsis

Execute Interface Test Client.

Description

Executes test client with given testid. Results stored in /var/log/asterisk/testreports/<testid>-client.txt

Syntax

TestClient(testid)

Arguments

testid - An ID to identify this test.

Signal()

Synopsis

Sends a signal to any waiting channels.

Description

Sends a named signal to any channels that may be waiting for one. Acts as a producer in a simple message queue.

Example: Send a signal named workdone

	same => n,Signal(workdone,Work has completed)

SIGNALSTATUS
- SUCCESS - Signal was successfully sent to at least one listener for processing.
- FAILURE - Signal could not be sent or nobody was listening for this signal.

Syntax

Signal(signalname,[payload])

Arguments

signalname - Name of signal to send.
payload - Payload data to deliver.

WaitForSignal()

Synopsis

Waits for a named signal on a channel.

Description

Waits for signaltimeout seconds on the current channel to receive a signal with name signalname. Acts as a consumer in a simple message queue.

Result of signal wait will be stored in the following variables:

Example: Wait for the workdone signal, indefinitely, and print out payload

	same => n,WaitForSignal(workdone)
	same => n,NoOp(Received: ${WAITFORSIGNALPAYLOAD})

WAITFORSIGNALSTATUS
- SIGNALED - Signal was received.
- TIMEOUT - Timed out waiting for signal.
- HANGUP - Channel hung up before signal was received.
WAITFORSIGNALPAYLOAD - Data payload attached to signal, if it exists

Syntax

WaitForSignal(signalname,[signaltimeout])

Arguments

signalname - Name of signal to send.
signaltimeout - Maximum time, in seconds, to wait for signal.

DISA()

Synopsis

Direct Inward System Access.

Description

The DISA, Direct Inward System Access, application allows someone from outside the telephone switch (PBX) to obtain an internal system dialtone and to place calls from it as if they were placing a call from within the switch. DISA plays a dialtone. The user enters their numeric passcode, followed by the pound sign #. If the passcode is correct, the user is then given system dialtone within context on which a call may be placed. If the user enters an invalid extension and extension i exists in the specified context, it will be used.

Be aware that using this may compromise the security of your PBX.

The arguments to this application (in extensions.conf) allow either specification of a single global passcode (that everyone uses), or individual passcodes contained in a file (filename).

The file that contains the passcodes (if used) allows a complete specification of all of the same arguments available on the command line, with the sole exception of the options. The file may contain blank lines, or comments starting with # or ;.

Syntax

DISA(passcode|filename,[context,[cid@]]mailbox@[context,[options]])

Arguments

passcode|filename - If you need to present a DISA dialtone without entering a password, simply set passcode to no-password
You may specified a filename instead of a passcode, this filename must contain individual passcodes
context - Specifies the dialplan context in which the user-entered extension will be matched. If no context is specified, the DISA application defaults to the disa context. Presumably a normal system will have a special context set up for DISA use with some or a lot of restrictions.
cid - Specifies a new (different) callerid to be used for this call.
mailbox
- mailbox
- context
options
- n - The DISA application will not answer initially.
- p - The extension entered will be considered complete when a # is entered.

SendCWCID()

Synopsis

Sends an in-band Call Waiting Caller ID.

Description

Generates an in-band Call Waiting Caller ID. This can be used if you are handling Call Waiting in the dialplan as opposed to using the channel driver. This application functions using the same idea as an "orange box".

On DAHDI channels, the native channel driver hooks for Call Waiting Caller ID can be used. On all other channels, it will be generated as linear audio.

CWCIDSTATUS
- SUCCESS - Call Waiting Caller ID successfully sent to CPE.
- UNSUPPORTED - CPE does not support off-hook Caller ID. This is not set if the d option is used.
- FAILURE - General failure occured.
- HANGUP - Channel hung up before spill could complete.

Syntax

SendCWCID([number,[name,[presentation,[redirecting,[timezone,[options]]]]]])

Arguments

number - Caller ID number. 15 characters maximum.
Defaults to CALLERID(num).
name - Caller ID name. 15 characters maximum.
Defaults to CALLERID(name).
presentation - Caller ID presentation.
Defaults to CALLERID(pres).
redirecting - Redirecting reason, e.g. REDIRECTING(reason).
Default is none (not sent).
timezone - TZ-format timezone to use for date/time.
Default is the system time zone.
options
- c - Do not generate a CPE Alerting Signal (CAS).
- d - Do not require a DTMF acknowledgment from the CPE.
- l - Send long distance call qualifier.
- n - Use native DAHDI spill method. This may provide more ideal audio when possible.
  This can only be used with FXS channels with DAHDI. Otherwise, it will fall back to using the channel tech-agnostic method.
  This module must be compiled with DAHDI present to enable this option.
- s - Do not generate a Subscriber Alerting Signal (SAS).
  Note that if the c option is used, this option is implicitly true.

PlayTones()

Synopsis

Play a tone list.

Description

Plays a tone list. Execution will continue with the next step in the dialplan immediately while the tones continue to play.

See the sample indications.conf for a description of the specification of a tonelist.

Syntax

PlayTones(arg)

Arguments

arg - Arg is either the tone name defined in the indications.conf configuration file, or a directly specified list of frequencies and durations.

StopPlayTones()

Synopsis

Stop playing a tone list.

Description

Stop playing a tone list, initiated by PlayTones().

StatsD()

Synopsis

Allow statistics to be passed to the StatsD server from the dialplan.

Description

This dialplan application sends statistics to the StatsD server specified inside of statsd.conf.

Syntax

StatsD(metric_type,statistic_name,value,[sample_rate])

Arguments

metric_type - The metric type to be sent to StatsD. Valid metric types are 'g' for gauge, 'c' for counter, 'ms' for timer, and 's' for sets.
statistic_name - The name of the variable to be sent to StatsD. Statistic names cannot contain the pipe (|) character.
value - The value of the variable to be sent to StatsD. Values must be numeric. Values for gauge and counter metrics can be sent with a '+' or '-' to update a value after the value has been initialized. Only counters can be initialized as negative. Sets can send a string as the value parameter, but the string cannot contain the pipe character.
sample_rate - The value of the sample rate to be sent to StatsD. Sample rates less than or equal to 0 will never be sent and sample rates greater than or equal to 1 will always be sent. Any rate between 1 and 0 will be compared to a randomly generated value, and if it is greater than the random value, it will be sent.

ScheduleWakeupCall()

Synopsis

Wakeup Call Scheduler

Description

Wakeup Call Scheduler and Management Interface.

Users can schedule one-time or recurring wakeup calls and, optionally, delete them.

Recurring wakeup calls reschedule themselves when answered, and thus are automatically cancelled if they are unanswered.

This application may require audio prompts in the Pat Fleet Asterisk sounds library that are not present in the default Allison Smith sounds library.

Syntax

ScheduleWakeupCall(destination,[userid,[timezone,[options]]])

Arguments

destination - The extension@context destination to reach wakeup call user.
userid - A unique ID that can be used to delete schedule wakeup calls.
This must contain only alphanumeric characters and hyphens. Underscores and other symbols are not allowed.
timezone - The time zone of the user.
If provided, any time provided will be converted from the user's time zone to the system time zone.
options
- d - Allow deletion of previously scheduled wakeup calls.

ToneSweep()

Synopsis

Tone sweep test

Description

Generates an ascending or descending tone sweep (chirp) between two frequencies.

Syntax

ToneSweep([start,[end,[duration,[vol]]]])

Arguments

start - Starting frequency. Default is 100.
end - Ending frequency. Default is 3500.
duration - Total time for sweep, in seconds. Default is 10 seconds.
vol - Volume reduction factor. Higher number equals softer tone sweep. Default is 1 (loudest).

CCSA()

Synopsis

Make a CCSA (Common Control Switching Arrangement) call

Description

Places an on-net or off-net call over default or specified routes using private facilities.

This module provides a generic Switched Services Network (CCSA, ETN, and EPSCS) implementation that can be used for alternate routing, automatic route selection, facility access control, and off-hook and ringback queuing.

If the caller does not hangup, the call result can be obtained as follows:

WARNING: Please be aware that improper configuration of this module, either in the module configuration file or in your dialplan, can lead to security issues. In particular, improper route definitions and matching can lead to "route leakage" or other unauthorized calls. This module assumes familiarity with configuration of Switched Services Networks.

CCSA_RESULT - Outcome of the CCSA call attempt
- SUCCESS - Successfully completed call, either immediately, with an FRL upgrade, or after an Off Hook Queue
- CBQ - Call was Call Back Queued due to no available preferred routes
- NO_CCSA - No such CCSA
- NO_ROUTES - No routes available for CCSA destination
- UNAUTHORIZED - Not authorized for the available CCSA routes
- AUTH_CODE - Invalid authorization code entered
- OHQ_FAILED - Off Hook Queued for available route but timed out
- CBQ_FAILED - Call Back Queue failed
- PREEMPTED - Call completed but was preempted before its conclusion
- PREEMPTION_FAILED - Preemption attempted but failed due to insufficient precedence to preempt
- FAILED - Other failure not covered above
TCM - The Facility Restriction Level (FRL) is encoded into a Traveling Class Mark (TCM) when sent on inter-tandem tie trunks so that call restrictions can be enforced throughout a network of private facilities.The TCM variable will be set before any outgoing calls. However, this module does not automatically send the TCM on its own. If the TCM is to be sent on a tie trunk, it should be sent as the last digit, after any routing digits. (Of course, it could be conveyed using another means as well, such as out of band using an IAXVAR on IAX2 trunks, if the other end supported that, but on standard in-band DTMF and MF facilities, it is conveyed as the last digit).Hence, if TCM is required on an outgoing call, the dial string for a route should contain the TCM as the last routing digit as appropriate.

Syntax

CCSA(exten,ccsa,[routes,[options]])

Arguments

exten - Destination to be called over CCSA (typically a 7 digit on-net or 11-digit off-net number).
ccsa - CCSA profile to use for call.
routes - Ordered pipe-separated list of routes to use for call.
Any MER routes should be provided last, after non-MER routes.
If not specified, the routes configured for the specified CCSA will be used in the order specified in the config.
options
- a - Call made using Remote Access.
  Remote calls are subject to additional restrictions (e.g. Call Back Queuing is not available).
  Specify this option to indicate a remote call and automatically inhibit Call Back Queuing, as well as to ensure that authorization codes not designated as valid for remote access cannot be used.
- c - Allow Call Back Queuing for this call.
  Call Back Queuing may (should) only be used with main, tandem, and satellite switches/PBXs. It may (should) not be used with tributary PBXs or calls over other private facilities.
- f - Facility Restriction Level (FRL) of caller, possibly derived from Traveling Class Mark (TCM).
  The caller will not be allowed to use routes with a minimum FRL exceeding this FRL, unless an authorization code is provided that has an FRL of at least the FRL required by the facility.
- m - Music on hold class for use with Off Hook Queuing.
- o - Maximum duration, in seconds, for Off-Hook Queuing.
  If not specified, the default, 0, will disable Off-Hook Queuing for this call.
  If specified with no arguments, the default of 60 seconds will be used.
  Off Hook Queuing may be used with any call.
- p - Initial priority of call, from 0-3, in queue if Call Back Queuing is used.
  If not specified, the default priority (0) is used.
  The highest priority (3) is always used for Off Hook Queued calls.
- r - MLPP preemption/priority capabilities for the call (e.g. those used in AUTOVON).
  Should be A (Flash Override), B (Flash), C (Immediate), or D (Priority), if specified.
  Default is no MLPP priority (Routine).

MixMonitor()

Synopsis

Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee the audio file is available for processing during dialplan execution.

Description

Records the audio on the current channel to the specified file.

This application does not automatically answer and should be preceeded by an application such as Answer or Progress().

MixMonitor runs as an audiohook.

If a filename passed to MixMonitor ends with .wav49, Asterisk will silently convert the extension to .WAV for legacy reasons. MIXMONITOR_FILENAME will contain the actual filename that Asterisk is writing to, not necessarily the value that was passed in.

Do not use untrusted strings such as or as part of ANY of the application's parameters. You risk a command injection attack executing arbitrary commands if the untrusted strings aren't filtered to remove dangerous characters. See function .

MIXMONITOR_FILENAME - Will contain the filename used to record.

Syntax

MixMonitor(filename.extension,[options,[command]])

Arguments

file
- filename - If filename is an absolute path, uses that path, otherwise creates the file in the configured monitoring directory from asterisk.conf.
- extension
options
- a - Append to the file instead of overwriting it.
- b - Only save audio to the file while the channel is bridged.
- B( interval ) - Play a periodic beep while this call is being recorded.
  - interval - Interval, in seconds. Default is 15.
- c - Use the real Caller ID from the channel for the voicemail Caller ID.
  By default, the Connected Line is used. If you want the channel caller's real number, you may need to specify this option.
- d - Delete the recording file as soon as MixMonitor is done with it.
  For example, if you use the m option to dispatch the recording to a voicemail box, you can specify this option to delete the original copy of it afterwards.
- v( x ) - Adjust the heard volume by a factor of x (range -4 to 4)
  - x
- V( x ) - Adjust the spoken volume by a factor of x (range -4 to 4)
  - x
- W( x ) - Adjust both, heard and spoken volumes by a factor of x (range -4 to 4)
  - x
- r( file ) - Use the specified file to record the receive audio feed. Like with the basic filename argument, if an absolute path isn't given, it will create the file in the configured monitoring directory.
  - file
- t( file ) - Use the specified file to record the transmit audio feed. Like with the basic filename argument, if an absolute path isn't given, it will create the file in the configured monitoring directory.
  - file
- n - When the r or t option is used, MixMonitor will insert silence into the specified files to maintain synchronization between them. Use this option to disable that behavior.
- i( chanvar ) - Stores the MixMonitor's ID on this channel variable.
  - chanvar
- p - Play a beep on the channel that starts the recording.
- P - Play a beep on the channel that stops the recording.
- m( mailbox ) - Create a copy of the recording as a voicemail in the indicated mailbox(es) separated by commas eg. m(1111@default,2222@default,...). Folders can be optionally specified using the syntax: mailbox@context/folder
  - mailbox
command - Will be executed when the recording is over.
Any strings matching ^{X} will be unescaped to X.
All variables will be evaluated at the time MixMonitor is called.

StopMixMonitor()

Synopsis

Stop recording a call through MixMonitor, and free the recording's file handle.

Description

Stops the audio recording that was started with a call to MixMonitor() on the current channel.

Syntax

StopMixMonitor([MixMonitorID])

Arguments

MixMonitorID - If a valid ID is provided, then this command will stop only that specific MixMonitor.

NoCDR()

Synopsis

Tell Asterisk to not maintain a CDR for this channel.

Description

This application will tell Asterisk not to maintain a CDR for the current channel. This does NOT mean that information is not tracked; rather, if the channel is hung up no CDRs will be created for that channel.

If a subsequent call to ResetCDR occurs, all non-finalized CDRs created for the channel will be enabled.

This application is deprecated. Please use the CDR_PROP function to disable CDRs on a channel.

ResetCDR()

Synopsis

Resets the Call Data Record.

Description

This application causes the Call Data Record to be reset. Depending on the flags passed in, this can have several effects. With no options, a reset does the following:

1. The start time is set to the current time.

2. If the channel is answered, the answer time is set to the current time.

3. All variables are wiped from the CDR. Note that this step can be prevented with the v option.

On the other hand, if the e option is specified, the effects of the NoCDR application will be lifted. CDRs will be re-enabled for this channel.

The e option is deprecated. Please use the CDR_PROP function instead.

Syntax

ResetCDR([options])

Arguments

options
- v - Save the CDR variables during the reset.
- e - Enable the CDRs for this channel only (negate effects of NoCDR).

StreamSilence()

Synopsis

Streams silence to a channel.

Description

Streams silent audio to a channel, for up to a provided number of seconds.

This application will send silent audio to a channel, as opposed to applications like Wait which do not. This guarantees that audiohooks will function properly, even if the channel is not bridged to something that is continously sending frames.

Syntax

StreamSilence([timeout])

Arguments

timeout - The maximum amount of time, in seconds, this application should stream silent audio before dialplan execution continues automatically to the next priority. By default, there is no timeout.

VoiceMail()

Synopsis

Leave a Voicemail message.

Description

The Voicemail application will exit if any of the following DTMF digits are received:

This application will set the following channel variable upon completion:

VMSTATUS - This indicates the status of the execution of the VoiceMail application.
- SUCCESS
- USEREXIT
- FAILED

Syntax

VoiceMail(mailbox1&[mailbox2[&...]],[options]])

Arguments

mailboxs
- mailbox1
- mailbox2
options
- b - Play the busy greeting to the calling party.
- d( c ) - Accept digits for a new extension in context c, if played during the greeting. Context defaults to the current context.
  - c
- e - Play greetings as early media -- only answer the channel just before accepting the voice message.
- g( # ) - Use the specified amount of gain when recording the voicemail message. The units are whole-number decibels (dB). Only works on supported technologies, which is DAHDI only.
  - #
- s - Skip the playback of instructions for leaving a message to the calling party.
- S - Skip the playback of instructions for leaving a message to the calling party, but only if a greeting has been recorded by the mailbox user.
- t( x ) - Play a custom beep tone to the caller instead of the default one. If this option is used but no file is specified, the beep is suppressed.
  - x
- u - Play the unavailable greeting.
- U - Mark message as URGENT.
- P - Mark message as PRIORITY.

VoiceMailMain()

Synopsis

Check Voicemail messages.

Description

The VoiceMailMain application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VoiceMailMain([mailbox@[context,[options]]])

Arguments

mailbox
- mailbox
- context
options
- p - Consider the mailbox parameter as a prefix to the mailbox that is entered by the caller.
- g( # ) - Use the specified amount of gain when recording a voicemail message. The units are whole-number decibels (dB).
  - #
- r - "Read only". Prevent user from deleting any messages.
  This applies only to specific executions of VoiceMailMain, NOT the mailbox itself.
- s - Skip checking the passcode for the mailbox.
- a( folder ) - Skip folder prompt and go directly to folder specified. Defaults to INBOX (or 0).
  - folder
  - 0 - INBOX
  - 1 - Old
  - 2 - Work
  - 3 - Family
  - 4 - Friends
  - 5 - Cust1
  - 6 - Cust2
  - 7 - Cust3
  - 8 - Cust4
  - 9 - Cust5

VMAuthenticate()

Synopsis

Authenticate with Voicemail passwords.

Description

The VMAuthenticate application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

Syntax

VMAuthenticate([mailbox@[context,[options]]])

Arguments

mailbox
- mailbox
- context
options
- s - Skip playing the initial prompts.

VoiceMailPlayMsg()

Synopsis

Play a single voice mail msg from a mailbox by msg id.

Description

This application sets the following channel variable upon completion:

VOICEMAIL_PLAYBACKSTATUS - The status of the playback attempt as a text string.
- SUCCESS
- FAILED

Syntax

VoiceMailPlayMsg([mailbox@[context,]]msg_id)

Arguments

mailbox
- mailbox
- context
msg_id - The msg id of the msg to play back.

VMSayName()

Synopsis

Play the name of a voicemail user

Description

This application will say the recorded name of the voicemail user specified as the argument to this application. If no context is provided, default is assumed.

Similar to the Background() application, playback of the recorded name can be interrupted by entering an extension, which will be searched for in the current context.

Syntax

VMSayName([mailbox@[context]])

Arguments

mailbox
- mailbox
- context

MallocTrim()

Synopsis

Attempts to reclaim unused heap memory.

Description

Attempts to release free memory from the heap.

This application is typically used before the Systemapplication or the SHELL function if system memory conditions prevent these from succeeding ordinarily.

This application may be used to diagnose this memory issue and prevent these calls from failing until the cause of the memory issue is found. You should also build Asterisk with MALLOC_DEBUG to troubleshoot memory issues.

MALLOCTRIMSTATUS
- SUCCESS - Some memory was released back to the system.
- FAILURE - No memory could be released back to the system.
- UNSUPPORTED - This application is not supported on this system.

SpeechCreate()

Synopsis

Create a Speech Structure.

Description

This application creates information to be used by all the other applications. It must be called before doing any speech recognition activities such as activating a grammar. It takes the engine name to use as the argument, if not specified the default engine will be used.

Sets the ERROR channel variable to 1 if the engine cannot be used.

Syntax

SpeechCreate(engine_name)

Arguments

engine_name

SpeechActivateGrammar()

Synopsis

Activate a grammar.

Description

This activates the specified grammar to be recognized by the engine. A grammar tells the speech recognition engine what to recognize, and how to portray it back to you in the dialplan. The grammar name is the only argument to this application.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechActivateGrammar(grammar_name)

Arguments

grammar_name

SpeechStart()

Synopsis

Start recognizing voice in the audio stream.

Description

Tell the speech recognition engine that it should start trying to get results from audio being fed to it.

Hangs up the channel on failure. If this is not desired, use TryExec.

SpeechBackground()

Synopsis

Play a sound file and wait for speech to be recognized.

Description

This application plays a sound file and waits for the person to speak. Once they start speaking playback of the file stops, and silence is heard. Once they stop talking the processing sound is played to indicate the speech recognition engine is working. Once results are available the application returns and results (score and text) are available using dialplan functions.

The first text and score are ${SPEECH_TEXT(0)} AND ${SPEECH_SCORE(0)} while the second are ${SPEECH_TEXT(1)} and ${SPEECH_SCORE(1)}.

The first argument is the sound file and the second is the timeout integer in seconds.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechBackground(sound_file,[timeout,[options]])

Arguments

sound_file
timeout - Timeout integer in seconds. Note the timeout will only start once the sound file has stopped playing.
options
- n - Don't answer the channel if it has not already been answered.

SpeechDeactivateGrammar()

Synopsis

Deactivate a grammar.

Description

This deactivates the specified grammar so that it is no longer recognized.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechDeactivateGrammar(grammar_name)

Arguments

grammar_name - The grammar name to deactivate

SpeechProcessingSound()

Synopsis

Change background processing sound.

Description

This changes the processing sound that SpeechBackground plays back when the speech recognition engine is processing and working to get results.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechProcessingSound(sound_file)

Arguments

sound_file

SpeechDestroy()

Synopsis

End speech recognition.

Description

This destroys the information used by all the other speech recognition applications. If you call this application but end up wanting to recognize more speech, you must call SpeechCreate() again before calling any other application.

Hangs up the channel on failure. If this is not desired, use TryExec.

SpeechLoadGrammar()

Synopsis

Load a grammar.

Description

Load a grammar only on the channel, not globally.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechLoadGrammar(grammar_name,path)

Arguments

grammar_name
path

SpeechUnloadGrammar()

Synopsis

Unload a grammar.

Description

Unload a grammar.

Hangs up the channel on failure. If this is not desired, use TryExec.

Syntax

SpeechUnloadGrammar(grammar_name)

Arguments

grammar_name

ChanIsAvail()

Synopsis

Check channel availability

Description

This application will check to see if any of the specified channels are available.

This application sets the following channel variables:

AVAILCHAN - The name of the available channel, if one exists
AVAILORIGCHAN - The canonical channel name that was used to create the channel
AVAILSTATUS - The device state for the device
AVAILCAUSECODE - The cause code returned when requesting the channel

Syntax

ChanIsAvail(Technology/Resource&[Technology2/Resource2[&...]],[options]])

Arguments

Technology/Resource
- Technology/Resource - Specification of the device(s) to check. These must be in the format of Technology/Resource, where Technology represents a particular channel driver, and Resource represents a resource available to that particular channel driver.
- Technology2/Resource2 - Optional extra devices to check
  If you need more than one enter them as Technology2/Resource2&Technology3/Resource3&.....
options
- a - Check for all available channels, not only the first one
- s - Consider the channel unavailable if the channel is in use at all
- t - Simply checks if specified channels exist in the channel list

AttendedTransfer()

Synopsis

Attended transfer to the extension provided and TRANSFER_CONTEXT

Description

Queue up attended transfer to the specified extension in the TRANSFER_CONTEXT.

Note that the attended transfer only work when two channels have answered and are bridged together.

Make sure to set Attended Transfer DTMF feature atxfer and attended transfer is permitted.

The result of the application will be reported in the ATTENDEDTRANSFERSTATUS channel variable:

ATTENDEDTRANSFERSTATUS
- SUCCESS - Transfer successfully queued.
- FAILURE - Transfer failed.
- NOTPERMITTED - Transfer not permitted.

Syntax

AttendedTransfer(exten)

Arguments

exten - Specify extension.

SayUnixTime()

Synopsis

Says a specified time in a custom format.

Description

Uses some of the sound files stored in to construct a phrase saying the specified date and/or time in the specified format.

Syntax

SayUnixTime([unixtime,[timezone,[format,[options]]]])

Arguments

unixtime - time, in seconds since Jan 1, 1970. May be negative. Defaults to now.
timezone - timezone, see for a list. Defaults to machine default.
format - a format the time is to be said in. See voicemail.conf. Defaults to ABdY "digits/at" IMp
options
- j - Allow the calling user to dial digits to jump to that extension. This option is automatically enabled if SAY_DTMF_INTERRUPT is present on the channel and set to 'true' (case insensitive)

DateTime()

Synopsis

Says a specified time in a custom format.

Description

Say the date and time in a specified format.

Syntax

DateTime([unixtime,[timezone,[format]]])

Arguments

unixtime - time, in seconds since Jan 1, 1970. May be negative. Defaults to now.
timezone - timezone, see /usr/share/zoneinfo for a list. Defaults to machine default.
format - a format the time is to be said in. See voicemail.conf. Defaults to ABdY "digits/at" IMp

Queue()

Synopsis

Queue a call for a call queue.

Description

In addition to transferring the call, a call may be parked and then picked up by another user.

This application will return to the dialplan if the queue does not exist, or any of the join options cause the caller to not enter the queue.

This application does not automatically answer and should be preceeded by an application such as Answer(), Progress(), or Ringing().

This application sets the following channel variables upon completion:

QUEUESTATUS - The status of the call as a text string.
- TIMEOUT
- FULL
- JOINEMPTY
- LEAVEEMPTY
- JOINUNAVAIL
- LEAVEUNAVAIL
- CONTINUE
- WITHDRAW
ABANDONED - If the call was not answered by an agent this variable will be TRUE.
- TRUE
DIALEDPEERNUMBER - Resource of the agent that was dialed set on the outbound channel.
QUEUE_WITHDRAW_INFO - If the call was successfully withdrawn from the queue, and the withdraw request was provided with optional withdraw info, the withdraw info will be stored in this variable.

Syntax

Queue(queuename,[options,[URL&]]filename&[filename2[&...]],[timeout,[AGI,[macro,[gosub,[rule,[position]]]]]]])

Arguments

queuename
options
- b( context^exten^priority ) - Before initiating an outgoing call, Gosub to the specified location using the newly created channel. The Gosub will be executed for each destination channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- B( context^exten^priority ) - Before initiating the outgoing call(s), Gosub to the specified location using the current channel.
  - context
  - exten
  - priority( params )
    - arg1[^arg1...]
    - argN
- C - Mark all calls as "answered elsewhere" when cancelled.
- c - Continue in the dialplan if the callee hangs up.
- d - Data-quality (modem) call (minimum delay).
  This option only applies to DAHDI channels. By default, DTMF is verified by muting audio TX/RX to verify the tone is still present. This option disables that behavior.
- F( context^exten^priority ) - When the caller hangs up, transfer the called member to the specified destination and start execution at that location.
  NOTE: Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('_').
  NOTE: Using this option from a Macro() or GoSub() might not make sense as there would be no return points.
  - context
  - exten
  - priority
- h - Allow callee to hang up by pressing *.
- H - Allow caller to hang up by pressing *.
- i - Ignore call forward requests from queue members and do nothing when they are requested.
- I - Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on this dial attempt.
- k - Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
- K - Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
- m - Custom music on hold class to use, which will override the music on hold class configured in queues.conf, if specified.
  Note that CHANNEL(musicclass), if set, will still override this option.
- n - No retries on the timeout; will exit this application and go to the next step.
- r - Ring instead of playing MOH. Periodic Announcements are still made, if applicable.
- R - Ring instead of playing MOH when a member channel is actually ringing.
- t - Allow the called user to transfer the calling user.
- T - Allow the calling user to transfer the call.
- w - Allow the called user to write the conversation to disk via Monitor.
- W - Allow the calling user to write the conversation to disk via Monitor.
- x - Allow the called user to write the conversation to disk via MixMonitor.
- X - Allow the calling user to write the conversation to disk via MixMonitor.
URL - URL will be sent to the called party if the channel supports it.
announceoverride
- filename - Announcement file(s) to play to agent before bridging call, overriding the announcement(s) configured in queues.conf, if any.
- filename2
timeout - Will cause the queue to fail out after a specified number of seconds, checked between each queues.conf timeout and retry cycle.
AGI - Will setup an AGI script to be executed on the calling party's channel once they are connected to a queue member.
macro - Will run a macro on the called party's channel (the queue member) once the parties are connected.
NOTE: Macros are deprecated, GoSub should be used instead.
gosub - Will run a gosub on the called party's channel (the queue member) once the parties are connected. The subroutine execution starts in the named context at the s exten and priority 1.
rule - Will cause the queue's defaultrule to be overridden by the rule specified.
position - Attempt to enter the caller into the queue at the numerical position specified. 1 would attempt to enter the caller at the head of the queue, and 3 would attempt to place the caller third in the queue.

AddQueueMember()

Synopsis

Dynamically adds queue members.

Description

Dynamically adds interface to an existing queue. If the interface is already in the queue it will return an error.

This application sets the following channel variable upon completion:

AQMSTATUS - The status of the attempt to add a queue member as a text string.
- ADDED
- MEMBERALREADY
- NOSUCHQUEUE

Syntax

AddQueueMember(queuename,[interface,[penalty,[options,[membername,[stateinterface,[wrapuptime]]]]]])

Arguments

queuename
interface
penalty
options
membername
stateinterface
wrapuptime

RemoveQueueMember()

Synopsis

Dynamically removes queue members.

Description

If the interface is NOT in the queue it will return an error.

This application sets the following channel variable upon completion:

Example: Remove queue member

	same => n,RemoveQueueMember(techsupport,SIP/3000)

RQMSTATUS
- REMOVED
- NOTINQUEUE
- NOSUCHQUEUE
- NOTDYNAMIC

Syntax

RemoveQueueMember(queuename,[interface])

Arguments

queuename
interface

PauseQueueMember()

Synopsis

Pauses a queue member.

Description

Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue. This prevents any calls from being sent from the queue to the interface until it is unpaused with UnpauseQueueMember or the manager interface. If no queuename is given, the interface is paused in every queue it is a member of. The application will fail if the interface is not found.

This application sets the following channel variable upon completion:

Example: Pause queue member

	same => n,PauseQueueMember(,SIP/3000)

PQMSTATUS - The status of the attempt to pause a queue member as a text string.
- PAUSED
- NOTFOUND

Syntax

PauseQueueMember([queuename,]interface,[options,[reason]])

Arguments

queuename
interface
options
reason - Is used to add extra information to the appropriate queue_log entries and manager events.

UnpauseQueueMember()

Synopsis

Unpauses a queue member.

Description

Unpauses (resumes calls to) a queue member. This is the counterpart to PauseQueueMember() and operates exactly the same way, except it unpauses instead of pausing the given interface.

This application sets the following channel variable upon completion:

Example: Unpause queue member

	same => n,UnpauseQueueMember(,SIP/3000)

UPQMSTATUS - The status of the attempt to unpause a queue member as a text string.
- UNPAUSED
- NOTFOUND

Syntax

UnpauseQueueMember([queuename,]interface,[options,[reason]])

Arguments

queuename
interface
options
reason - Is used to add extra information to the appropriate queue_log entries and manager events.

QueueLog()

Synopsis

Writes to the queue_log file.

Description

Allows you to write your own events into the queue log.

Example: Log custom queue event

	same => n,QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)

Syntax

QueueLog(queuename,uniqueid,agent,event,[additionalinfo])

Arguments

queuename
uniqueid
agent
event
additionalinfo

QueueUpdate()

Synopsis

Writes to the queue_log file for outbound calls and updates Realtime Data. Is used at h extension to be able to have all the parameters.

Description

Allows you to write Outbound events into the queue log.

Example: Write outbound event into queue log

	exten => h,1,QueueUpdate(${QUEUE}, ${UNIQUEID}, ${AGENT}, ${DIALSTATUS}, ${ANSWEREDTIME}, ${DIALEDTIME} | ${DIALEDNUMBER})

Syntax

QueueUpdate(queuename,uniqueid,agent,status,talktime,[params])

Arguments

queuename
uniqueid
agent
status
talktime
params

ReceiveSF()

Synopsis

Detects SF digits on a channel and saves them to a variable.

Description

Reads SF digits from the user in to the given variable.

This application does not automatically answer the channel and should be preceded with Answer or Progress as needed.

RECEIVESFSTATUS - This is the status of the read operation.
- START
- ERROR
- HANGUP
- MAXDIGITS
- TIMEOUT

Syntax

ReceiveSF(variable,[digits,[timeout,[frequency,[options]]]])

Arguments

variable - The input digits will be stored in the given variable name.
digits - Maximum number of digits to read. Default is unlimited.
timeout - The number of seconds to wait for all digits, if greater than 0. Can be floating point. Default is no timeout.
frequency - The frequency for which to detect pulsed digits. Default is 2600 Hz.
options
- d - Delay audio by a frame to try to extra quelch.
- e - Allow receiving extra pulses 11 through 16.
- m - Mute conference.
- q - Quelch SF from in-band.
- r - "Radio" mode (relaxed SF).

SendSF()

Synopsis

Sends arbitrary SF digits on the current or specified channel.

Description

It will send all digits or terminate if it encounters an error.

Syntax

SendSF(digits,[frequency,[channel]])

Arguments

digits - List of digits 0-9 to send; w for a half-second pause, also f or F for a flash-hook if the channel supports flash-hook, h or H for 250 ms of 2600 Hz, and W for a wink if the channel supports wink.
frequency - Frequency to use. (defaults to 2600 Hz).
channel - Channel where digits will be played

SayCountedNoun()

Synopsis

Say a noun in declined form in order to count things

Description

Selects and plays the proper singular or plural form of a noun when saying things such as "five calls". English has simple rules for deciding when to say "call" and when to say "calls", but other languages have complicated rules which would be extremely difficult to implement in the Asterisk dialplan language.

The correct sound file is selected by examining the number and adding the appropriate suffix to filename. If the channel language is English, then the suffix will be either empty or "s". If the channel language is Russian or some other Slavic language, then the suffix will be empty for nominative, "x1" for genative singular, and "x2" for genative plural.

Note that combining filename with a suffix will not necessarily produce a correctly spelled plural form. For example, SayCountedNoun(2,man) will play the sound file "mans" rather than "men". This behavior is intentional. Since the file name is never seen by the end user, there is no need to implement complicated spelling rules. We simply record the word "men" in the sound file named "mans".

This application does not automatically answer and should be preceeded by an application such as Answer() or Progress.

Syntax

SayCountedNoun(number,filename)

Arguments

number - The number of things
filename - File name stem for the noun that is the name of the things

SayCountedAdj()

Synopsis

Say a adjective in declined form in order to count things

Description

Selects and plays the proper form of an adjective according to the gender and of the noun which it modifies and the number of objects named by the noun-verb combination which have been counted. Used when saying things such as "5 new messages". The various singular and plural forms of the adjective are selected by adding suffixes to filename.

If the channel language is English, then no suffix will ever be added (since, in English, adjectives are not declined). If the channel language is Russian or some other slavic language, then the suffix will the specified gender for nominative, and "x" for genative plural. (The genative singular is not used when counting things.) For example, SayCountedAdj(1,new,f) will play sound file "newa" (containing the word "novaya"), but SayCountedAdj(5,new,f) will play sound file "newx" (containing the word "novikh").

This application does not automatically answer and should be preceeded by an application such as Answer(), Progress(), or Proceeding().

Syntax

SayCountedAdj(number,filename,[gender])

Arguments

number - The number of things
filename - File name stem for the adjective
gender - The gender of the noun modified, one of 'm', 'f', 'n', or 'c'

WaitForFrame()

Synopsis

Waits for a given frame type to be received on a channel.

Description

Waits for a specified frame type to be received before dialplan execution continues, with a configurable timeout. This is useful if the channel needs to wait for a certain type of control frame to be received in order for call setup or progression to continue.

If a digit is dialed during execution and a single-digit extension matches in the current context, execution will continue there.

Example: Inpulsing to a switch using EM signaling

	exten => _X!,1,Progress()
	same => n,WaitForFrame(WINK,10) ; wait up to 10s for a wink on the channel
	same => n,GotoIf($["${WAITFORFRAMESTATUS}" != "SUCCESS"]?fail,s,1)
	same => n,SendMF(*${EXTEN}#)

WAITFORFRAMESTATUS - This is the status of waiting for the frame.
- SUCCESS
- DIGIT
- ERROR
- HANGUP
- TIMEOUT

Syntax

WaitForFrame(frame,[timeout,[times,[file]]])

Arguments

frame - The type of frame for which to wait.
The following frame types may be used:
The following CONTROL frames may also be used:
- DTMF_BEGIN
- DTMF_END
- VOICE
- VIDEO
- NULL
- IAX
- TEXT
- TEXT_DATA
- IMAGE
- HTML
- CNG
- MODEM
- RING
- RINGING
- ANSWER
- BUSY
- TAKEOFFHOOK
- OFFHOOK
- CONGESTION
- FLASH
- WINK
- PROGRESS
- PROCEEDING
- HOLD
- UNHOLD
timeout - The number of seconds to wait for the specified type of frame to be received, if greater than 0. Can be floating point. Default is no timeout (wait forever).
times - The number of frames of this type that must be received before dialplan execution continues, if the timer has not yet expired.
file - Optional audio file to play in a loop while application is running.

SendFrame()

Synopsis

Sends an arbitrary control frame on a channel.

Description

Sends an arbitrary control frame on a channel.

Example: Send Wink

	same => n,SendFrame(WINK)

Syntax

SendFrame(frame)

Arguments

frame - The type of frame for which to wait.
The following CONTROL frames may be sent:
- TAKEOFFHOOK
- OFFHOOK
- FLASH
- WINK
- HOLD
- UNHOLD

Reload()

Synopsis

Reloads an Asterisk module, blocking the channel until the reload has completed.

Description

Reloads the specified (or all) Asterisk modules and reports success or failure. Success is determined by each individual module, and if all reloads are successful, that is considered an aggregate success. If multiple modules are specified and any module fails, then FAILURE will be returned. It is still possible that other modules did successfully reload, however.

Sets RELOADSTATUS to one of the following values:

RELOADSTATUS
- SUCCESS - Specified module(s) reloaded successfully.
- FAILURE - Some or all of the specified modules failed to reload.

Syntax

Reload([module])

Arguments

module - The full name(s) of the target module(s) or resource(s) to reload. If omitted, everything will be reloaded.
The full names MUST be specified (e.g. chan_iax2 to reload IAX2 or pbx_config to reload the dialplan.

Flash()

Synopsis

Flashes a DAHDI Trunk.

Description

Performs a flash on a DAHDI trunk. This can be used to access features provided on an incoming analogue circuit such as conference and call waiting. Use with SendDTMF() to perform external transfers.

SelectiveFeature()

Synopsis

Interactive auto-attendant to control selective calling features

Description

This provides the interactive auto-attendant used for common selective calling features (e.g. Selective Call Rejection or Call Block, Priority Call, Selective or Preferred Call Forwarding, etc.) as implemented on traditional TDM switches (e.g. Lucent 5ESS).

This application allows you to provide the appropriate selective calling feature management interface simply by configuring a feature profile in the configuration file.

Typically, the prompts vary by region, generally by Regional Bell Operating Company at time of Divestiture. You will need to supply your own prompt set to use this application.

Multiple prompts may be specified for a prompt config, ampersand-delimited. Many of the prompts are shared between features and may be specified in a template. You can then easily add new selective calling features by overriding only the feature-specific prompts and specifying the feature-specific configuration info.

This application relies internally on AstDB.

Syntax

SelectiveFeature([profile,[options]])

Arguments

profile - Name of profile in selective.conf to use for providing the requested selective calling feature.
options
- p - Use pulse dialing announcements. Default is tone dialing announcements.
  This should be used when the caller has dialed 11 instead of * to reach the feature, regardless of whether pulse or tone dialing is being used.

RevertivePulse()

Synopsis

Simulates revertive pulsing for a 4-digit number.

Description

Mimics the revertive pulsing sounds characteristic of Panel, Number 1 Crossbar, or Number 5 Crossbar pulsing.

This application uses material sourced from Evan Doorbell tapes. The pulsar sounds directory should be placed directly into the main sounds directory.

Sounds can be obtained from the original tarball at https://octothorpe.info/site/pulsar.

This application does not automatically answer the channel and should be preceded by Progress or Answer as appropriate.

Syntax

RevertivePulse(digits,[switch,[options]])

Arguments

digits - The 4-digit station number.
switch - The type of pulsing to use.
Valid options are panel, 1xb, and 5xb.
Default is panel.
options
- b - Adds 4 pulses to the second revertive pulse digit to simulate B-side exchange.

Pickup()

Synopsis

Directed extension call pickup.

Description

This application can pickup a specified ringing channel. The channel to pickup can be specified in the following ways.

1) If no extension targets are specified, the application will pickup a channel matching the pickup group of the requesting channel.

2) If the extension is specified with a context of the special string PICKUPMARK (for example 10@PICKUPMARK), the application will pickup a channel which has defined the channel variable PICKUPMARK with the same value as extension (in this example, 10).

3) If the extension is specified with or without a context, the channel with a matching extension and context will be picked up. If no context is specified, the current context will be used.

The extension is typically set on matching channels by the dial application that created the channel. The context is set on matching channels by the channel driver for the device.

Syntax

Pickup(extension&[extension2[&...]]])

Arguments

targets
- extension - Specification of the pickup target.
- extension2 - Additional specifications of pickup targets.

PickupChan()

Synopsis

Pickup a ringing channel.

Description

Pickup a specified channel if ringing.

Syntax

PickupChan(channel&[channel2[&...]],[options]])

Arguments

channel
- channel
- channel2
options
- p - Supplied channel names are prefixes. For example, SIP/bob will match SIP/bob-00000000 and SIP/bobby-00000000.

DumpGroups()

Synopsis

Dump all group information to the console

Description

When executed, this will show all group assignments and group variables in the console

HangupCauseClear()

Synopsis

Clears hangup cause information from the channel that is available through HANGUPCAUSE.

Description

Clears all channel-specific hangup cause information from the channel. This is never done automatically (i.e. for new Dial()s).

ClearHash()

Synopsis

Clear the keys from a specified hashname.

Description

Clears all keys out of the specified hashname.

Syntax

ClearHash(hashname)

Arguments

hashname

ODBCFinish()

Synopsis

Clear the resultset of a sucessful multirow query.

Description

For queries which are marked as mode=multirow, this will clear any remaining rows of the specified resultset.

Syntax

ODBCFinish(result-id)

Arguments

result-id

CallCompletionRequest()

Synopsis

Request call completion service for previous call

Description

Request call completion service for a previously failed call attempt.

This application sets the following channel variables:

CC_REQUEST_RESULT - This is the returned status of the request.
- SUCCESS
- FAIL
CC_REQUEST_REASON - This is the reason the request failed.
- NO_CORE_INSTANCE
- NOT_GENERIC
- TOO_MANY_REQUESTS
- UNSPECIFIED

CallCompletionCancel()

Synopsis

Cancel call completion service

Description

Cancel a Call Completion Request.

This application sets the following channel variables:

CC_CANCEL_RESULT - This is the returned status of the cancel.
- SUCCESS
- FAIL
CC_CANCEL_REASON - This is the reason the cancel failed.
- NO_CORE_INSTANCE
- NOT_GENERIC
- UNSPECIFIED

Answer()

Synopsis

Answer a channel if ringing.

Description

If the call has not been answered, this application will answer it. Otherwise, it has no effect on the call.

By default, Asterisk will wait for media for up to 500 ms, or the user specified delay, whichever is longer. If you do not want to wait for media at all, use the i option.

Syntax

Answer([delay,[options]])

Arguments

delay - Asterisk will wait this number of milliseconds before returning to the dialplan after answering the call.
The minimum is 500 ms. To answer immediately without waiting for media, use the i option.
options
- i - Answer the channel immediately without waiting for media.

BackGround()

Synopsis

Play an audio file while waiting for digits of an extension to go to.

Description

This application will play the given list of files (do not put extension) while waiting for an extension to be dialed by the calling channel. To continue waiting for digits after this application has finished playing files, the WaitExten application should be used.

If one of the requested sound files does not exist, call processing will be terminated.

This application sets the following channel variable upon completion:

BACKGROUNDSTATUS - The status of the background attempt as a text string.
- SUCCESS
- FAILED

Syntax

BackGround(filename1&[filename2[&...]],[options,[langoverride,[context]]]])

Arguments

filenames
- filename1
- filename2
options
- s - Causes the playback of the message to be skipped if the channel is not in the up state (i.e. it hasn't been answered yet). If this happens, the application will return immediately.
- n - Don't answer the channel before playing the files.
- m - Only break if a digit hit matches a one digit extension in the destination context.
- p - Do not allow playback to be interrupted with digits.
langoverride - Explicitly specifies which language to attempt to use for the requested sound files.
context - This is the dialplan context that this application will use when exiting to a dialed extension.

Busy()

Synopsis

Indicate the Busy condition.

Description

This application will indicate the busy condition to the calling channel.

Syntax

Busy([timeout])

Arguments

timeout - If specified, the calling channel will be hung up after the specified number of seconds. Otherwise, this application will wait until the calling channel hangs up.

Congestion()

Synopsis

Indicate the Congestion condition.

Description

This application will indicate the congestion condition to the calling channel.

Syntax

Congestion([timeout])

Arguments

timeout - If specified, the calling channel will be hung up after the specified number of seconds. Otherwise, this application will wait until the calling channel hangs up.

ExecIfTime()

Synopsis

Conditional application execution based on the current time.

Description

This application will execute the specified dialplan application, with optional arguments, if the current time matches the given time specification.

Syntax

ExecIfTime(times,weekdays,mdays,months,[timezone,]appargs)

Arguments

day_condition
- times
- weekdays
- mdays
- months
- timezone
appname
- appargs

Goto()

Synopsis

Jump to a particular priority, extension, or context.

Description

This application will set the current context, extension, and priority in the channel structure. After it completes, the pbx engine will continue dialplan execution at the specified location. If no specific extension, or extension and context, are specified, then this application will just set the specified priority of the current extension.

At least a priority is required as an argument, or the goto will return a -1, and the channel and call will be terminated.

If the location that is put into the channel information is bogus, and asterisk cannot find that location in the dialplan, then the execution engine will try to find and execute the code in the i (invalid) extension in the current context. If that does not exist, it will try to execute the h extension. If neither the h nor i extensions have been defined, the channel is hung up, and the execution of instructions on the channel is terminated. What this means is that, for example, you specify a context that does not exist, then it will not be possible to find the h or i extensions, and the call will terminate!

Syntax

Goto([context,[extensions,]]priority)

Arguments

context
extensions
priority

GotoIf()

Synopsis

Conditional goto.

Description

This application will set the current context, extension, and priority in the channel structure based on the evaluation of the given condition. After this application completes, the pbx engine will continue dialplan execution at the specified location in the dialplan. The labels are specified with the same syntax as used within the Goto application. If the label chosen by the condition is omitted, no jump is performed, and the execution passes to the next instruction. If the target location is bogus, and does not exist, the execution engine will try to find and execute the code in the i (invalid) extension in the current context. If that does not exist, it will try to execute the h extension. If neither the h nor i extensions have been defined, the channel is hung up, and the execution of instructions on the channel is terminated. Remember that this command can set the current context, and if the context specified does not exist, then it will not be able to find any 'h' or 'i' extensions there, and the channel and call will both be terminated!.

Syntax

GotoIf(condition:[labeliftrue:[labeliffalse]])

Arguments

condition
destination
- labeliftrue - Continue at labeliftrue if the condition is true. Takes the form similar to Goto() of [[context,]extension,]priority.
- labeliffalse - Continue at labeliffalse if the condition is false. Takes the form similar to Goto() of [[context,]extension,]priority.

GotoIfTime()

Synopsis

Conditional Goto based on the current time.

Description

This application will set the context, extension, and priority in the channel structure based on the evaluation of the given time specification. After this application completes, the pbx engine will continue dialplan execution at the specified location in the dialplan. If the current time is within the given time specification, the channel will continue at labeliftrue. Otherwise the channel will continue at labeliffalse. If the label chosen by the condition is omitted, no jump is performed, and execution passes to the next instruction. If the target jump location is bogus, the same actions would be taken as for Goto. Further information on the time specification can be found in examples illustrating how to do time-based context includes in the dialplan.

Syntax

GotoIfTime(times,weekdays,mdays,months,[timezone:[labeliftrue:[labeliffalse]]])

Arguments

condition
- times
- weekdays
- mdays
- months
- timezone
destination
- labeliftrue - Continue at labeliftrue if the condition is true. Takes the form similar to Goto() of [[context,]extension,]priority.
- labeliffalse - Continue at labeliffalse if the condition is false. Takes the form similar to Goto() of [[context,]extension,]priority.

ImportVar()

Synopsis

Import a variable from a channel into a new variable.

Description

This application imports a variable from the specified channel (as opposed to the current one) and stores it as a variable (newvar) in the current channel (the channel that is calling this application). Variables created by this application have the same inheritance properties as those created with the Set application.

Syntax

ImportVar(newvar,channelname,variable)

Arguments

newvar
vardata
- channelname
- variable

Hangup()

Synopsis

Hang up the calling channel.

Description

This application will hang up the calling channel.

Syntax

Hangup([causecode])

Arguments

causecode - If a causecode is given the channel's hangup cause will be set to the given value.

Incomplete()

Synopsis

Returns AST_PBX_INCOMPLETE value.

Description

Signals the PBX routines that the previous matched extension is incomplete and that further input should be allowed before matching can be considered to be complete. Can be used within a pattern match when certain criteria warrants a longer match.

Syntax

Incomplete([n])

Arguments

n - If specified, then Incomplete will not attempt to answer the channel first.

NoOp()

Synopsis

Do Nothing (No Operation).

Description

This application does nothing. However, it is useful for debugging purposes.

This method can be used to see the evaluations of variables or functions without having any effect.

Syntax

NoOp([text])

Arguments

text - Any text provided can be viewed at the Asterisk CLI.

Proceeding()

Synopsis

Indicate proceeding.

Description

This application will request that a proceeding message be provided to the calling channel.

Progress()

Synopsis

Indicate progress.

Description

This application will request that in-band progress information be provided to the calling channel.

RaiseException()

Synopsis

Handle an exceptional condition.

Description

This application will jump to the e extension in the current context, setting the dialplan function EXCEPTION(). If the e extension does not exist, the call will hangup.

Syntax

RaiseException(reason)

Arguments

reason

Ringing()

Synopsis

Indicate ringing tone.

Description

This application will request that the channel indicate a ringing tone to the user.

SayAlpha()

Synopsis

Say Alpha.

Description

This application will play the sounds that correspond to the letters of the given string. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayAlpha(string)

Arguments

string

SayAlphaCase()

Synopsis

Say Alpha.

Description

This application will play the sounds that correspond to the letters of the given string. Optionally, a casetype may be specified. This will be used for case-insensitive or case-sensitive pronunciations. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayAlphaCase(casetype,string)

Arguments

casetype
string

SayDigits()

Synopsis

Say Digits.

Description

This application will play the sounds that correspond to the digits of the given number. This will use the language that is currently set for the channel. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayDigits(digits)

Arguments

digits

SayMoney()

Synopsis

Say Money.

Description

This application will play the currency sounds for the given floating point number in the current language. Currently only English and US Dollars is supported. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayMoney(dollars)

Arguments

dollars

SayNumber()

Synopsis

Say Number.

Description

This application will play the sounds that correspond to the given digits. Optionally, a gender may be specified. This will use the language that is currently set for the channel. See the CHANNEL() function for more information on setting the language for the channel. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayNumber(digits,[gender])

Arguments

digits
gender

SayOrdinal()

Synopsis

Say Ordinal Number.

Description

This application will play the ordinal sounds that correspond to the given digits (e.g. 1st, 42nd). Currently only English is supported.

Optionally, a gender may be specified. This will use the language that is currently set for the channel. See the CHANNEL() function for more information on setting the language for the channel. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayOrdinal(digits,[gender])

Arguments

digits
gender

SayPhonetic()

Synopsis

Say Phonetic.

Description

This application will play the sounds from the phonetic alphabet that correspond to the letters in the given string. If the channel variable SAY_DTMF_INTERRUPT is set to 'true' (case insensitive), then this application will react to DTMF in the same way as Background.

Syntax

SayPhonetic(string)

Arguments

string

SetAMAFlags()

Synopsis

Set the AMA Flags.

Description

This application will set the channel's AMA Flags for billing purposes.

This application is deprecated. Please use the CHANNEL function instead.

Syntax

SetAMAFlags([flag])

Arguments

flag

Wait()

Synopsis

Waits for some time.

Description

This application waits for a specified number of seconds.

Syntax

Wait(seconds)

Arguments

seconds - Can be passed with fractions of a second. For example, 1.5 will ask the application to wait for 1.5 seconds.

WaitDigit()

Synopsis

Waits for a digit to be entered.

Description

This application waits for the user to press one of the accepted digits for a specified number of seconds.

WAITDIGITSTATUS - This is the final status of the command
- ERROR - Parameters are invalid.
- DTMF - An accepted digit was received.
- TIMEOUT - The timeout passed before any acceptable digits were received.
- CANCEL - The channel has hungup or was redirected.
WAITDIGITRESULT - The digit that was received, only set if WAITDIGITSTATUS is DTMF.

Syntax

WaitDigit([seconds,[digits]])

Arguments

seconds - Can be passed with fractions of a second. For example, 1.5 will ask the application to wait for 1.5 seconds.
digits - Digits to accept, all others are ignored.

WaitExten()

Synopsis

Waits for an extension to be entered.

Description

This application waits for the user to enter a new extension for a specified number of seconds.

Syntax

WaitExten([seconds,[options]])

Arguments

seconds - Can be passed with fractions of a second. For example, 1.5 will ask the application to wait for 1.5 seconds.
options
- m( x ) - Provide music on hold to the caller while waiting for an extension.
  - x - Specify the class for music on hold. CHANNEL(musicclass) will be used instead if set
- d - Play dial indications tone on channel while waiting for digits.

Set()

Synopsis

Set channel variable or function value.

Description

If (and only if), in /etc/asterisk/asterisk.conf, you have a [compat] category, and you have app_set = 1.4 under that, then the behavior of this app changes, and strips surrounding quotes from the right hand side as it did previously in 1.4. The advantages of not stripping out quoting, and not caring about the separator characters (comma and vertical bar) were sufficient to make these changes in 1.6. Confusion about how many backslashes would be needed to properly protect separators and quotes in various database access strings has been greatly reduced by these changes.

Syntax

Set(name,value)

Arguments

name
value

MSet()

Synopsis

Set channel variable(s) or function value(s).

Description

This function can be used to set the value of channel variables or dialplan functions. When setting variables, if the variable name is prefixed with _, the variable will be inherited into channels created from the current channel If the variable name is prefixed with __, the variable will be inherited into channels created from the current channel and all children channels. MSet behaves in a similar fashion to the way Set worked in 1.2/1.4 and is thus prone to doing things that you may not expect. For example, it strips surrounding double-quotes from the right-hand side (value). If you need to put a separator character (comma or vert-bar), you will need to escape them by inserting a backslash before them. Avoid its use if possible.

This application allows up to 99 variables to be set at once.

Syntax

MSet(name1=value1=name2=value2)

Arguments

set1
- name1
- value1
set2
- name2
- value2

MessageSend()

Synopsis

Send a text message.

Description

Send a text message. The body of the message that will be sent is what is currently set to MESSAGE(body). This may he come from an incoming message. The technology chosen for sending the message is determined based on a prefix to the destination parameter.

This application sets the following channel variables:

MESSAGE_SEND_STATUS - This is the message delivery status returned by this application.
- INVALID_PROTOCOL - No handler for the technology part of the URI was found.
- INVALID_URI - The protocol handler reported that the URI was not valid.
- SUCCESS - Successfully passed on to the protocol handler, but delivery has not necessarily been guaranteed.
- FAILURE - The protocol handler reported that it was unabled to deliver the message for some reason.

Syntax

MessageSend(destination,[from,[to]])

Arguments

destination - A To URI for the message.
from - A From URI for the message if needed for the message technology being used to send this message. This can be a SIP(S) URI, such as Alice <sip:[email protected]>, or a string in the format [email protected]. This will override a from specified using the MESSAGE dialplan function or the from that may have been on an incoming message.
to - A To URI for the message if needed for the message technology being used to send this message. This can be a SIP(S) URI, such as Alice <sip:[email protected]>, or a string in the format [email protected]. This will override a to specified using the MESSAGE dialplan function or the to that may have been on an incoming message.

Bridge()

Synopsis

Bridge two channels.

Description

Allows the ability to bridge two channels via the dialplan.

This application sets the following channel variable upon completion:

BRIDGERESULT - The result of the bridge attempt as a text string.
- SUCCESS
- FAILURE
- LOOP
- NONEXISTENT

Syntax

Bridge(channel,[options])

Arguments

channel - The current channel is bridged to the channel identified by the channel name, channel name prefix, or channel uniqueid.
options
- p - Play a courtesy tone to channel.
- F( context^exten^priority ) - When the bridger hangs up, transfer the bridged party to the specified destination and start execution at that location.
  - context
  - exten
  - priority
- F - When the bridger hangs up, transfer the bridged party to the next priority of the current extension and start execution at that location.
- h - Allow the called party to hang up by sending the * DTMF digit.
- H - Allow the calling party to hang up by pressing the * DTMF digit.
- k - Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
- K - Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
- L(x[:y][:z]) - Limit the call to x ms. Play a warning when y ms are left. Repeat the warning every z ms. The following special variables can be used with this option:
  - LIMIT_PLAYAUDIO_CALLER - Play sounds to the caller. yes|no (default yes)
  - LIMIT_PLAYAUDIO_CALLEE - Play sounds to the callee. yes|no
  - LIMIT_TIMEOUT_FILE - File to play when time is up.
  - LIMIT_CONNECT_FILE - File to play when call begins.
  - LIMIT_WARNING_FILE - File to play as warning if y is defined. The default is to say the time remaining.
- n - Do not answer the channel automatically before bridging.
  Additionally, to prevent a bridged channel (the target of the Bridge application) from answering, the BRIDGE_NOANSWER variable can be set to inhibit answering.
- S(x) - Hang up the call after x seconds *after* the called party has answered the call.
- t - Allow the called party to transfer the calling party by sending the DTMF sequence defined in features.conf.
- T - Allow the calling party to transfer the called party by sending the DTMF sequence defined in features.conf.
- w - Allow the called party to enable recording of the call by sending the DTMF sequence defined for one-touch recording in features.conf.
- W - Allow the calling party to enable recording of the call by sending the DTMF sequence defined for one-touch recording in features.conf.
- x - Cause the called party to be hung up after the bridge, instead of being restarted in the dialplan.

IRCSendMessage()

Synopsis

Sends a message to an IRC channel

Description

Sends a message to an IRC channel.

Syntax

IRCSendMessage(channel,message)

Arguments

channel - Should start with # for IRC channels.
message

CoinDisposition()

Synopsis

Signals a TSPS coin disposition

Description

Signals a TSPS coin disposition to a Class 5 end office on an active coin trunk for remote coin control.

This application only performs coin control signaling. The Class 5 office is responsible for acting on these signals to perform the appropriate function.

This application should only be used by Class 4 offices (e.g. TSPS), to signal Class 5 offices, not directly by Class 5 offices.

Syntax

CoinDisposition(disposition,[options])

Arguments

disposition - Coin disposition to signal to the Class 5 end office.
Must be one of the following:
- return - Coin return
  Returns any coins currently in the hopper to the caller.
- collect - Coin collect
  Collects coins currently in the hopper into the coin vault.
- ringback - Coin phone ringback
  Used by the operator to ring back a coin phone, typically if a caller has hung up and additional overtime deposits or charges need to be paid.
- released - Operator released
  Used with dial tone first phones to apply negative battery to the coin line in order to change the mode of the coin totalizer to the local mode, so that readout does not occur in realtime but only when the initial deposit is reached. The telephone keypad is also reenabled, and the keypad has precedence over the totalizer in this mode.
- attached - Operator attached
  Used with dial tone first coin phones to apply positive battery to the coin line in order to change the mode of the coin totalizer to the toll mode, so that deposits of any denomination result in an immediate readout by the totalizer for ACTS or the operator. The telephone keypad is also disabled, and the totalizer has precedence over the keypad in this mode.
  Refer to Bellcore SR-2275-3 6.17.3.4.1 for more information about operator attached and released and the keypad and totalizer.
- collectreleased - Coin Collect and Operator Released
  Performs a coin collect followed by Operator Released.
options
- i - Also send an audible in-band wink, in addition to a WINK control frame.
- m - Use the older multiwink signaling instead of Expanded In-Band Signaling.

WaitForDeposit()

Synopsis

Wait for coins to be deposited

Description

Waits for coin denomination tones to be detected before dialplan execution continues.

The following variables are set by this application:

Accuracy of detection may vary with environment and is not guaranteed.

Nickels, dimes, and quarters are supported, though nickels and dimes work best. Dollar coins are not currently supported.

WAITFORDEPOSITSTATUS - This indicates the result of the wait.Note that coins may have been deposited even if SUCCESS is not returned.
- SUCCESS
- ERROR
- TIMEOUT
- HANGUP
WAITFORDEPOSITAMOUNT - Amount, in cents, that has been deposited.

Syntax

WaitForDeposit([amount,[timeout,[delay,[options]]]])

Arguments

amount - Minimum deposit required (subject to the provided timeout) before returning. Default is 5 cents. If the amount provided is not evenly divisible by 5, it will be rounded up to the nearest nickel.
timeout - Maximum amount of time, in seconds, to wait for specified amount. Default is forever.
delay - Amount of time, in seconds, to wait for further deposits after minimum deposit has been satisfied. When this delay timeout is reached, the application will return. This only takes effect after the number of times requirement has been met. Default is 0 (return immediately).
options
- l - Relax coin denomination tone detection. This option may be necessary for detection of tones present in bidirectional or non-ideal audio.
- s - Target single-frequency totalizers (2200 Hz). Default is dual-frequency 1700 + 2200 Hz.

PhreakNetDial()

Synopsis

Dial a PhreakNet number

Description

Places a PhreakNet call.

This application automatically handles lookup reequests, out-verification, in-band signalling setup, and authentication fallbacks and retries.

Example: Call 5551212

	same => n,PhreakNetDial(5551212)

Syntax

PhreakNetDial([number,[trunkflags,[authflags]]])

Arguments

number - PhreakNet number to call.
trunkflags
- m - Support multifrequency (MF) signalling.
- s - Support singlefrequency (SF) signalling.
authflags
- m - Support MD5 authentication.
- r - Support RSA authentication.

ODBC_Commit()

Synopsis

Commits a currently open database transaction.

Description

Commits the database transaction specified by transaction ID or the current active transaction, if not specified.

Syntax

ODBC_Commit([transaction ID])

Arguments

transaction ID

ODBC_Rollback()

Synopsis

Rollback a currently open database transaction.

Description

Rolls back the database transaction specified by transaction ID or the current active transaction, if not specified.

Syntax

ODBC_Rollback([transaction ID])

Arguments

transaction ID

AGI()

Synopsis

Executes an AGI compliant application.

Description

Executes an Asterisk Gateway Interface compliant program on a channel. AGI allows Asterisk to launch external programs written in any language to control a telephony channel, play audio, read DTMF digits, etc. by communicating with the AGI protocol.

The following variants of AGI exist, and are chosen based on the value passed to command:

This application sets the following channel variable upon completion:

As of 1.6.0, this channel will not stop dialplan execution on hangup inside of this application. Dialplan execution will continue normally, even upon hangup until the AGI application signals a desire to stop (either by exiting or, in the case of a net script, by closing the connection).

A locally executed AGI script will receive SIGHUP on hangup from the channel except when using DeadAGI (or when the channel is already hungup). A fast AGI server will correspondingly receive a HANGUP inline with the command dialog. Both of these signals may be disabled by setting the AGISIGHUP channel variable to no before executing the AGI application. Alternatively, if you would like the AGI application to exit immediately after a channel hangup is detected, set the AGIEXITONHANGUP variable to yes.

Example: Start the AGI script /tmp/my-cool-script.sh, passing it the contents of the channel variable FOO

	same => n,AGI(/tmp/my-cool-script.sh,${FOO})

Example: Start the AGI script my-cool-script.sh located in the astagidir directory, specified in asterisk.conf

	same => n,AGI(my-cool-script.sh)

Example: Connect to the FastAGI server located at 127.0.0.1 and start the script awesome-script

	same => n,AGI(agi://127.0.0.1/awesome-script)

Example: Start AsyncAGI

	same => n,AGI(agi:async)

AGISTATUS - The status of the attempt to the run the AGI script text string, one of:
- SUCCESS
- FAILURE
- NOTFOUND
- HANGUP

Syntax

AGI(command,arg1,[arg2])

Arguments

command - How AGI should be invoked on the channel.
args
- arg1
- arg2

EAGI()

Synopsis

Executes an EAGI compliant application.

Description

Using 'EAGI' provides enhanced AGI, with incoming audio available out of band on file descriptor 3. In all other respects, it behaves in the same fashion as AGI. See the documentation for the AGI dialplan application for more information on invoking AGI on a channel.

This application sets the following channel variable upon completion:

DeadAGI()

Synopsis

Executes AGI on a hungup channel.

Description

Execute AGI on a 'dead' or hungup channel. See the documentation for the AGI dialplan application for more information on invoking AGI on a channel.

This application sets the following channel variable upon completion:

This application is deprecated and may be removed in a future version of Asterisk. Use the replacement application AGI instead of DeadAGI.

JabberSend()

Synopsis

Sends an XMPP message to a buddy.

Description

Sends the content of message as text message from the given account to the buddy identified by jid

The example below sends "Hello world" to [email protected] as an XMPP message from the account asterisk, configured in xmpp.conf.

Example: Send 'Hello world' to Bob

	same => n,JabberSend(asterisk,[email protected],Hello world)

Syntax

JabberSend(account,jid,message)

Arguments

account - The local named account to listen on (specified in xmpp.conf)
jid - Jabber ID of the buddy to send the message to. It can be a bare JID (username@domain) or a full JID (username@domain/resource).
message - The message to send.

JabberSendGroup()

Synopsis

Send a Jabber Message to a specified chat room

Description

Allows user to send a message to a chat room via XMPP.

To be able to send messages to a chat room, a user must have previously joined it. Use the JabberJoin function to do so.

Syntax

JabberSendGroup(Jabber,RoomJID,Message,[Nickname])

Arguments

Jabber - Client or transport Asterisk uses to connect to Jabber.
RoomJID - XMPP/Jabber JID (Name) of chat room.
Message - Message to be sent to the chat room.
Nickname - The nickname Asterisk uses in the chat room.

JabberJoin()

Synopsis

Join a chat room

Description

Allows Asterisk to join a chat room.

Syntax

JabberJoin(Jabber,RoomJID,[Nickname])

Arguments

Jabber - Client or transport Asterisk uses to connect to Jabber.
RoomJID - XMPP/Jabber JID (Name) of chat room.
Nickname - The nickname Asterisk will use in the chat room.

JabberLeave()

Synopsis

Leave a chat room

Description

Allows Asterisk to leave a chat room.

Syntax

JabberLeave(Jabber,RoomJID,[Nickname])

Arguments

Jabber - Client or transport Asterisk uses to connect to Jabber.
RoomJID - XMPP/Jabber JID (Name) of chat room.
Nickname - The nickname Asterisk uses in the chat room.

Monitor()

Synopsis

Monitor a channel.

Description

Used to start monitoring a channel. The channel's input and output voice packets are logged to files until the channel hangs up or monitoring is stopped by the StopMonitor application.

By default, files are stored to /var/spool/asterisk/monitor/. Returns -1 if monitor files can't be opened or if the channel is already monitored, otherwise 0.

Syntax

Monitor(file_format:[urlbase,[fname_base,[options]]])

Arguments

file_format
- file_format - Optional. If not set, defaults to wav
- urlbase
fname_base - If set, changes the filename used to the one specified.
options
- m - When the recording ends mix the two leg files into one and delete the two leg files. If the variable MONITOR_EXEC is set, the application referenced in it will be executed instead of soxmix/sox and the raw leg files will NOT be deleted automatically. soxmix/sox or MONITOR_EXEC is handed 3 arguments, the two leg files and a target mixed file name which is the same as the leg file names only without the in/out designator.
  If MONITOR_EXEC_ARGS is set, the contents will be passed on as additional arguments to MONITOR_EXEC. Both MONITOR_EXEC and the Mix flag can be set from the administrator interface.
- b - Don't begin recording unless a call is bridged to another channel.
- B( interval ) - Play a periodic beep while this call is being recorded.
  - interval - Interval, in seconds. Default is 15.
- i - Skip recording of input stream (disables m option).
- o - Skip recording of output stream (disables m option).

StopMonitor()

Synopsis

Stop monitoring a channel.

Description

Stops monitoring a channel. Has no effect if the channel is not monitored.

ChangeMonitor()

Synopsis

Change monitoring filename of a channel.

Description

Changes monitoring filename of a channel. Has no effect if the channel is not monitored.

Syntax

ChangeMonitor(filename_base)

Arguments

filename_base - The new filename base to use for monitoring this channel.

PauseMonitor()

Synopsis

Pause monitoring of a channel.

Description

Pauses monitoring of a channel until it is re-enabled by a call to UnpauseMonitor.

UnpauseMonitor()

Synopsis

Unpause monitoring of a channel.

Description

Unpauses monitoring of a channel on which monitoring had previously been paused with PauseMonitor.

ReceiveFAX()

Synopsis

Receive a FAX and save as a TIFF/F file.

Description

This application is provided by res_fax, which is a FAX technology agnostic module that utilizes FAX technology resource modules to complete a FAX transmission.

Session arguments can be set by the FAXOPT function and to check results of the ReceiveFax() application.

Syntax

ReceiveFAX(filename,[options])

Arguments

filename
options
- d - Enable FAX debugging.
- f - Allow audio fallback FAX transfer on T.38 capable channels.
- F - Force usage of audio mode on T.38 capable channels.
- s - Send progress Manager events (overrides statusevents setting in res_fax.conf).

SendFAX()

Synopsis

Sends a specified TIFF/F file as a FAX.

Description

This application is provided by res_fax, which is a FAX technology agnostic module that utilizes FAX technology resource modules to complete a FAX transmission.

Session arguments can be set by the FAXOPT function and to check results of the SendFax() application.

Syntax

SendFAX([filename2[&...]],[options]])

Arguments

filename
- filename2 - TIFF file to send as a FAX.
options
- d - Enable FAX debugging.
- f - Allow audio fallback FAX transfer on T.38 capable channels.
- F - Force usage of audio mode on T.38 capable channels.
- s - Send progress Manager events (overrides statusevents setting in res_fax.conf).
- z - Initiate a T.38 reinvite on the channel if the remote end does not.

WaitForTone()

Synopsis

Wait for tone

Description

Waits for a single-frequency tone to be detected before dialplan execution continues.

WAITFORTONESTATUS - This indicates the result of the wait.
- SUCCESS
- ERROR
- TIMEOUT
- HANGUP

Syntax

WaitForTone(freq,[duration_ms,[timeout,[times,[options]]]])

Arguments

freq - Frequency of the tone to wait for.
duration_ms - Minimum duration of tone, in ms. Default is 500ms. Using a minimum duration under 50ms is unlikely to produce accurate results.
timeout - Maximum amount of time, in seconds, to wait for specified tone. Default is forever.
times - Number of times the tone should be detected (subject to the provided timeout) before returning. Default is 1.
options
- d - Custom decibel threshold to use. Default is 16.
- s - Squelch tone.

ToneScan()

Synopsis

Wait for period of time while scanning for call progress tones

Description

Waits for a a distinguishable call progress tone and then exits. Unlike a conventional scanner, this is not currently capable of scanning for modem carriers.

TONESCANSTATUS
- RINGING - Audible ringback tone
- BUSY - Busy tone
- SIT - Special Information Tones
- VOICE - Human voice detected
- DTMF - DTMF digit
- FAX - Fax (answering)
- MODEM - Modem (answering)
- DIALTONE - Dial tone
- NUT - UK Number Unobtainable tone
- TIMEOUT - Timeout reached before any positive detection
- HANGUP - Caller hung up before any positive detection

Syntax

ToneScan([zone,[timeout,[threshold,[options]]]])

Arguments

zone - Call progress zone. Default is the system default.
timeout - Maximum amount of time, in seconds, to wait for call progress or signal tones. Default is forever.
threshold - DSP threshold required for a match. A higher number will require a longer match and may reduce false positives, at the expense of false negatives. Default is 1.
options
- f - Enable fax machine detection. By default, this is disabled.
- v - Enable voice detection. By default, this is disabled.

Park()

Synopsis

Park yourself.

Description

Used to park yourself (typically in combination with an attended transfer to know the parking space).

If you set the PARKINGEXTEN variable to a parking space extension in the parking lot, Park() will attempt to park the call on that extension. If the extension is already in use then execution will continue at the next priority.

If the parkeddynamic option is enabled in res_parking.conf the following variables can be used to dynamically create new parking lots. When using dynamic parking lots, be aware of the conditions as explained in the notes section below.

The PARKINGDYNAMIC variable specifies the parking lot to use as a template to create a dynamic parking lot. It is an error to specify a non-existent parking lot for the template. If not set then the default parking lot is used as the template.

The PARKINGDYNCONTEXT variable specifies the dialplan context to use for the newly created dynamic parking lot. If not set then the context from the parking lot template is used. The context is created if it does not already exist and the new parking lot needs to create extensions.

The PARKINGDYNEXTEN variable specifies the parkext to use for the newly created dynamic parking lot. If not set then the parkext is used from the parking lot template. If the template does not specify a parkext then no extensions are created for the newly created parking lot. The dynamic parking lot cannot be created if it needs to create extensions that overlap existing parking lot extensions. The only exception to this is for the parkext extension and only if neither of the overlaping parking lot's parkext is exclusive.

The PARKINGDYNPOS variable specifies the parking positions to use for the newly created dynamic parking lot. If not set then the parkpos from the parking lot template is used.

This application must be used as the first extension priority to be recognized as a parking access extension for blind transfers. Blind transfers and the DTMF one-touch parking feature need this distinction to operate properly. The parking access extension in this case is treated like a dialplan hint.

Syntax

Park([parking_lot_name,[options]])

Arguments

parking_lot_name - Specify in which parking lot to park a call.
The parking lot used is selected in the following order:
1) parking_lot_name option to this application
2) PARKINGLOT variable
3) CHANNEL(parkinglot) function (Possibly preset by the channel driver.)
4) Default parking lot.
options
- r - Send ringing instead of MOH to the parked call.
- R - Randomize the selection of a parking space.
- s - Silence announcement of the parking space number.
- c( context,extension,priority ) - If the parking times out, go to this place in the dialplan instead of where the parking lot defines the call should go.
  - context
  - extension
  - priority
- t( duration ) - Use a timeout of duration seconds instead of the timeout specified by the parking lot.
  - duration

ParkedCall()

Synopsis

Retrieve a parked call.

Description

Used to retrieve a parked call from a parking lot.

If a parking lot's parkext option is set, then Parking lots will automatically create and manage dialplan extensions in the parking lot context. If that is the case then you will not need to manage parking extensions yourself, just include the parking context of the parking lot.

Syntax

ParkedCall([parking_lot_name,[parking_space]])

Arguments

parking_lot_name - Specify from which parking lot to retrieve a parked call.
The parking lot used is selected in the following order:
1) parking_lot_name option
2) PARKINGLOT variable
3) CHANNEL(parkinglot) function (Possibly preset by the channel driver.)
4) Default parking lot.
parking_space - Parking space to retrieve a parked call from. If not provided then the first available parked call in the parking lot will be retrieved.

ParkAndAnnounce()

Synopsis

Park and Announce.

Description

Park a call into the parkinglot and announce the call to another channel.

The variable PARKEDAT will contain the parking extension into which the call was placed. Use with the Local channel to allow the dialplan to make use of this information.

Syntax

ParkAndAnnounce([parking_lot_name,[options:]]announce:[announce1[:...]],]dial)

Arguments

parking_lot_name - Specify in which parking lot to park a call.
The parking lot used is selected in the following order:
1) parking_lot_name option to this application
2) PARKINGLOT variable
3) CHANNEL(parkinglot) function (Possibly preset by the channel driver.)
4) Default parking lot.
options
- r - Send ringing instead of MOH to the parked call.
- R - Randomize the selection of a parking space.
- c( context,extension,priority ) - If the parking times out, go to this place in the dialplan instead of where the parking lot defines the call should go.
  - context
  - extension
  - priority
- t( duration ) - Use a timeout of duration seconds instead of the timeout specified by the parking lot.
  - duration
announce_template
- announce - Colon-separated list of files to announce. The word PARKED will be replaced by a say_digits of the extension in which the call is parked.
- announce1
dial - The app_dial style resource to call to make the announcement. Console/dsp calls the console.

MusicOnHold()

Synopsis

Play Music On Hold indefinitely.

Description

Plays hold music specified by class. If omitted, the default music source for the channel will be used. Change the default class with Set(CHANNEL(musicclass)=...). If duration is given, hold music will be played specified number of seconds. If duration is omitted, music plays indefinitely. Returns 0 when done, -1 on hangup.

This application does not automatically answer and should be preceeded by an application such as Answer() or Progress().

Syntax

MusicOnHold(class,[duration])

Arguments

class
duration

StartMusicOnHold()

Synopsis

Play Music On Hold.

Description

Starts playing music on hold, uses default music class for channel. Starts playing music specified by class. If omitted, the default music source for the channel will be used. Always returns 0.

Syntax

StartMusicOnHold(class)

Arguments

class

StopMusicOnHold()

Synopsis

Stop playing Music On Hold.

Description

Stops playing music on hold.

PJSIP_DIAL_CONTACTS()

Synopsis

Return a dial string for dialing all contacts on an AOR.

Description

Returns a properly formatted dial string for dialing all contacts on an AOR.

Syntax

PJSIP_DIAL_CONTACTS(endpoint,[aor,[request_user]])

Arguments

endpoint - Name of the endpoint
aor - Name of an AOR to use, if not specified the configured AORs on the endpoint are used
request_user - Optional request user to use in the request URI

PJSIP_MEDIA_OFFER()

Synopsis

Media and codec offerings to be set on an outbound SIP channel prior to dialing.

Description

When read, returns the codecs offered based upon the media choice.

When written, sets the codecs to offer when an outbound dial attempt is made, or when a session refresh is sent using PJSIP_SEND_SESSION_REFRESH.

Syntax

PJSIP_MEDIA_OFFER(media)

Arguments

media - types of media offered

PJSIP_DTMF_MODE()

Synopsis

Get or change the DTMF mode for a SIP call.

Description

When read, returns the current DTMF mode

When written, sets the current DTMF mode

This function uses the same DTMF mode naming as the dtmf_mode configuration option

PJSIP_MOH_PASSTHROUGH()

Synopsis

Get or change the on-hold behavior for a SIP call.

Description

When read, returns the current moh passthrough mode

When written, sets the current moh passthrough mode

If yes, on-hold re-INVITEs are sent. If no, music on hold is generated.

This function can be used to override the moh_passthrough configuration option

PJSIP_SEND_SESSION_REFRESH()

Synopsis

W/O: Initiate a session refresh via an UPDATE or re-INVITE on an established media session

Description

This function will cause the PJSIP stack to immediately refresh the media session for the channel. This will be done using either a re-INVITE (default) or an UPDATE request.

This is most useful when combined with the PJSIP_MEDIA_OFFER dialplan function, as it allows the formats in use on a channel to be re-negotiated after call setup.

The formats the endpoint supports are not checked or enforced by this function. Using this function to offer formats not supported by the endpoint may result in a loss of media.

Example: Re-negotiate format to g722

	; Within some existing extension on an answered channel
	same => n,Set(PJSIP_MEDIA_OFFER(audio)=!all,g722)
	same => n,Set(PJSIP_SEND_SESSION_REFRESH()=invite)

Syntax

PJSIP_SEND_SESSION_REFRESH([update_type])

Arguments

update_type - The type of update to send. Default is invite.
- invite - Send the session refresh as a re-INVITE.
- update - Send the session refresh as an UPDATE.

PJSIP_PARSE_URI()

Synopsis

Parse an uri and return a type part of the URI.

Description

Parse an URI and return a specified part of the URI.

Syntax

PJSIP_PARSE_URI(uri,type)

Arguments

uri - URI to parse
type - The type parameter specifies which URI part to read
- display - Display name.
- scheme - URI scheme.
- user - User part.
- passwd - Password part.
- host - Host part.
- port - Port number, or zero.
- user_param - User parameter.
- method_param - Method parameter.
- transport_param - Transport parameter.
- ttl_param - TTL param, or -1.
- lr_param - Loose routing param, or zero.
- maddr_param - Maddr param.

SIP_PARAMETER()

Synopsis

Gets the specified SIP parameter from the specified SIP header from an incoming INVITE message.

Description

This function returns the value of a SIP parameter in a specified header.

Since there are several headers (such as Via) which can occur multiple times, SIP_PARAMETER takes an optional third argument to specify which header with that name to retrieve. Headers start at offset 1.

Syntax

SIP_PARAMETER(parameter,name,[number])

Arguments

parameter
name
number - If not specified, defaults to 1.

SIP_HEADER()

Synopsis

Gets the specified SIP header from an incoming INVITE message.

Description

Since there are several headers (such as Via) which can occur multiple times, SIP_HEADER takes an optional second argument to specify which header with that name to retrieve. Headers start at offset 1.

This function does not access headers from the REFER message if the call was transferred. To obtain the REFER headers, set the dialplan variable GET_TRANSFERRER_DATA to the prefix of the headers of the REFER message that you need to access; for example, X- to get all headers starting with X-. The variable must be set before a call to the application that starts the channel that may eventually transfer back into the dialplan, and must be inherited by that channel, so prefix it with the _ or __ when setting (or set it in the pre-dial handler executed on the new channel). To get all headers of the REFER message, set the value to *. Headers are returned in the form of a dialplan hash TRANSFER_DATA, and can be accessed with the functions and, e. g., .

Please also note that contents of the SDP (an attachment to the SIP request) can't be accessed with this function.

Syntax

SIP_HEADER(name,[number])

Arguments

name
number - If not specified, defaults to 1.

SIP_HEADERS()

Synopsis

Gets the list of SIP header names from an incoming INVITE message.

Description

Returns a comma-separated list of header names (without values) from the INVITE message that originated the current channel. Multiple headers with the same name are included in the list only once. The returned list can be iterated over using the functions POP() and SIP_HEADER().

For example, ${SIP_HEADERS(Co)} might return Contact,Content-Length,Content-Type. As a practical example, you may use ${SIP_HEADERS(X-)} to enumerate optional extended headers.

This function does not access headers from the incoming SIP REFER message; see the documentation of the function SIP_HEADER for how to access them.

Please observe that contents of the SDP (an attachment to the SIP request) can't be accessed with this function.

Syntax

SIP_HEADERS([prefix])

Arguments

prefix - If specified, only the headers matching the given prefix are returned.

SIPPEER()

Synopsis

Gets SIP peer information.

Description

Syntax

SIPPEER(peername,[item])

Arguments

peername
item

CHECKSIPDOMAIN()

Synopsis

Checks if domain is a local domain.

Description

This function checks if the domain in the argument is configured as a local SIP domain that this Asterisk server is configured to handle. Returns the domain name if it is locally handled, otherwise an empty string. Check the domain= configuration in sip.conf.

Syntax

CHECKSIPDOMAIN(domain)

Arguments

domain

POLARITY()

Synopsis

Set or get the polarity of a DAHDI channel.

Description

The POLARITY function can be used to set the polarity of a DAHDI channel.

Applies only to FXS channels (using FXO signalling) with supporting hardware.

The polarity can be set to the following numeric or named values:

However, when read, the function will always return 0 or 1.

Example: Set idle polarity

	same => n,Set(POLARITY()=0)

Example: Set reverse polarity

	same => n,NoOp(Current Polarity: ${POLARITY()})
	same => n,Set(POLARITY()=reverse)
	same => n,NoOp(New Polarity: ${POLARITY()})

Example: Reverse the polarity from whatever it is currently

	same => n,Set(POLARITY()=${IF($[ "${POLARITY()}" = "1" ]?0:1)})

IAXPEER()

Synopsis

Gets IAX peer information.

Description

Gets information associated with the specified IAX2 peer.

Syntax

IAXPEER(peername,[item])

Arguments

peername
item - If peername is specified, valid items are:
- ip - (default) The IP address.
- status - The peer's status (if qualify=yes)
- mailbox - The configured mailbox.
- context - The configured context.
- expire - The epoch time of the next expire.
- dynamic - Is it dynamic? (yes/no).
- callerid_name - The configured Caller ID name.
- callerid_num - The configured Caller ID number.
- codecs - The configured codecs.
- codec[x] - Preferred codec index number x (beginning with 0)

IAXVAR()

Synopsis

Sets or retrieves a remote variable.

Description

Gets or sets a variable that is sent to a remote IAX2 peer during call setup.

Syntax

IAXVAR(varname)

Arguments

varname

DUNDILOOKUP()

Synopsis

Do a DUNDi lookup of a phone number.

Description

This will do a DUNDi lookup of the given phone number.

This function will return the Technology/Resource found in the first result in the DUNDi lookup. If no results were found, the result will be blank.

Syntax

DUNDILOOKUP(number,[context,[options]])

Arguments

number
context - If not specified the default will be e164.
options
- b - Bypass the internal DUNDi cache

DUNDIQUERY()

Synopsis

Initiate a DUNDi query.

Description

This will do a DUNDi lookup of the given phone number.

The result of this function will be a numeric ID that can be used to retrieve the results with the DUNDIRESULT function.

Syntax

DUNDIQUERY(number,[context,[options]])

Arguments

number
context - If not specified the default will be e164.
options
- b - Bypass the internal DUNDi cache

DUNDIRESULT()

Synopsis

Retrieve results from a DUNDIQUERY.

Description

This function will retrieve results from a previous use\n" of the DUNDIQUERY function.

Syntax

DUNDIRESULT(id,[resultnum])

Arguments

id - The identifier returned by the DUNDIQUERY function.
resultnum
- number - The number of the result that you want to retrieve, this starts at 1
- getnum - The total number of results that are available.

MINIVMCOUNTER()

Synopsis

Reads or sets counters for MiniVoicemail message.

Description

The operation is atomic and the counter is locked while changing the value. The counters are stored as text files in the minivm account directories. It might be better to use realtime functions if you are using a database to operate your Asterisk.

Syntax

MINIVMCOUNTER(account,name,[operand])

Arguments

account - If account is given and it exists, the counter is specific for the account.
If account is a domain and the domain directory exists, counters are specific for a domain.
name - The name of the counter is a string, up to 10 characters.
operand - The counters never goes below zero. Valid operands for changing the value of a counter when assigning a value are:
- i - Increment by value.
- d - Decrement by value.
- s - Set to value.

MINIVMACCOUNT()

Synopsis

Gets MiniVoicemail account information.

Description

Syntax

MINIVMACCOUNT(account,item)

Arguments

account
item - Valid items are:
- path - Path to account mailbox (if account exists, otherwise temporary mailbox).
- hasaccount - 1 is static Minivm account exists, 0 otherwise.
- fullname - Full name of account owner.
- email - Email address used for account.
- etemplate - Email template for account (default template if none is configured).
- ptemplate - Pager template for account (default template if none is configured).
- accountcode - Account code for the voicemail account.
- pincode - Pin code for voicemail account.
- timezone - Time zone for voicemail account.
- language - Language for voicemail account.
- - Channel variable value (set in configuration for account).

VM_INFO()

Synopsis

Returns the selected attribute from a mailbox.

Description

Returns the selected attribute from the specified mailbox. If context is not specified, defaults to the default context. Where the folder can be specified, common folders include INBOX, Old, Work, Family and Friends.

Syntax

VM_INFO(mailbox@[context,]attribute,[folder])

Arguments

mailbox
- mailbox
- context
attribute
- count - Count of messages in specified folder. If folder is not specified, defaults to INBOX.
- email - E-mail address associated with the mailbox.
- exists - Returns a boolean of whether the corresponding mailbox exists.
- fullname - Full name associated with the mailbox.
- language - Mailbox language if overridden, otherwise the language of the channel.
- locale - Mailbox locale if overridden, otherwise global locale.
- pager - Pager e-mail address associated with the mailbox.
- password - Mailbox access password.
- tz - Mailbox timezone if overridden, otherwise global timezone
folder - If not specified, INBOX is assumed.

MEETME_INFO()

Synopsis

Query a given conference of various properties.

Description

Syntax

MEETME_INFO(keyword,confno)

Arguments

keyword - Options:
- lock - Boolean of whether the corresponding conference is locked.
- parties - Number of parties in a given conference
- activity - Duration of conference in seconds.
- dynamic - Boolean of whether the corresponding conference is dynamic.
confno - Conference number to retrieve information from.

LOCAL()

Synopsis

Manage variables local to the gosub stack frame.

Description

Read and write a variable local to the gosub stack frame, once we Return() it will be lost (or it will go back to whatever value it had before the Gosub()).

Syntax

LOCAL(varname)

Arguments

varname

LOCAL_PEEK()

Synopsis

Retrieve variables hidden by the local gosub stack frame.

Description

Read a variable varname hidden by n levels of gosub stack frames. Note that ${LOCAL_PEEK(0,foo)} is the same as , since the value of n peeks under 0 levels of stack frames; in other words, 0 is the current level. If n exceeds the available number of stack frames, then an empty string is returned.

Syntax

LOCAL_PEEK(n,varname)

Arguments

n
varname

STACK_PEEK()

Synopsis

View info about the location which called Gosub

Description

Read the calling context, extension, priority, or label, as specified by which, by going up n frames in the Gosub stack. If suppress is true, then if the number of available stack frames is exceeded, then no error message will be printed.

Syntax

STACK_PEEK(n,which,[suppress])

Arguments

n
which
suppress

CONFBRIDGE()

Synopsis

Set a custom dynamic bridge, user, or menu profile on a channel for the ConfBridge application using the same options available in confbridge.conf.

Description

A custom profile uses the default profile type settings defined in confbridge.conf as defaults if the profile template is not explicitly specified first.

For bridge profiles the default template is default_bridge.

For menu profiles the default template is default_menu.

For user profiles the default template is default_user.

---- Example 1 ----

In this example the custom user profile set on the channel will automatically be used by the ConfBridge application.

; In this example the effect of the following line is

; implied:

---- Example 2 ----

This example shows how to use a predefined user profile in confbridge.conf as a template for a dynamic profile. Here we make an admin/marked user out of the my_user profile that you define in confbridge.conf.

Example: Example 1

	exten => 1,1,Answer()

Example: Example 1b

	same => n,Set(CONFBRIDGE(user,template)=default_user)
	same => n,Set(CONFBRIDGE(user,announce_join_leave)=yes)
	same => n,Set(CONFBRIDGE(user,startmuted)=yes)
	same => n,ConfBridge(1)

Example: Example 2

	exten => 1,1,Answer()
	same => n,Set(CONFBRIDGE(user,template)=my_user)
	same => n,Set(CONFBRIDGE(user,admin)=yes)
	same => n,Set(CONFBRIDGE(user,marked)=yes)
	same => n,ConfBridge(1)

Syntax

CONFBRIDGE(type,option)

Arguments

type - To what type of conference profile the option applies.
- bridge
- menu
- user
option - Option refers to a confbridge.conf option that is being set dynamically on this channel, or clear to remove already applied profile options from the channel.

CONFBRIDGE_INFO()

Synopsis

Get information about a ConfBridge conference.

Description

This function returns a non-negative integer for valid conference names and an empty string for invalid conference names.

Syntax

CONFBRIDGE_INFO(type,conf)

Arguments

type - What conference information is requested.
- admins - Get the number of admin users in the conference.
- locked - Determine if the conference is locked. (0 or 1)
- marked - Get the number of marked users in the conference.
- muted - Determine if the conference is muted. (0 or 1)
- parties - Get the number of users in the conference.
conf - The name of the conference being referenced.

CONFBRIDGE_CHANNELS()

Synopsis

Get a list of channels in a ConfBridge conference.

Description

This function returns a comma-separated list of channels in a ConfBridge conference, optionally filtered by a type of participant.

Syntax

CONFBRIDGE_CHANNELS(type,conf)

Arguments

type - What conference information is requested.
- admins - Get the number of admin users in the conference.
- marked - Get the number of marked users in the conference.
- parties - Get the number of total users in the conference.
- active - Get the number of active users in the conference.
- waiting - Get the number of waiting users in the conference.
conf - The name of the conference being referenced.

VM_INFO()

Synopsis

Returns the selected attribute from a mailbox.

Description

Syntax

VM_INFO(mailbox@[context,]attribute,[folder])

Arguments

mailbox
- mailbox
- context
attribute
- count - Count of messages in specified folder. If folder is not specified, defaults to INBOX.
- email - E-mail address associated with the mailbox.
- exists - Returns a boolean of whether the corresponding mailbox exists.
- fullname - Full name associated with the mailbox.
- language - Mailbox language if overridden, otherwise the language of the channel.
- locale - Mailbox locale if overridden, otherwise global locale.
- pager - Pager e-mail address associated with the mailbox.
- password - Mailbox access password.
- tz - Mailbox timezone if overridden, otherwise global timezone
folder - If not specified, INBOX is assumed.

USER_AGENT()

Synopsis

Retrieve the user agent of the device associated with a channel

Description

This function retrieves the user agent of an endpoint.

Unlike other channel functions, this may be used technology-agnostically.

Syntax

USER_AGENT([device])

Arguments

device - The full tech/device to query for user agent.
Non-IP technologies (e.g. DAHDI) are not supported.
If not provided, the device associated with the current channel will be used.

AGENT()

Synopsis

Gets information about an Agent

Description

Syntax

AGENT(AgentId,[item])

Arguments

AgentId
item - The valid items to retrieve are:
- status - (default) The status of the agent (LOGGEDIN | LOGGEDOUT)
- password - Deprecated. The dialplan handles any agent authentication.
- name - The name of the agent
- mohclass - MusicOnHold class
- channel - The name of the active channel for the Agent (AgentLogin)
- fullchannel - The untruncated name of the active channel for the Agent (AgentLogin)

MIXMONITOR()

Synopsis

Retrieve data pertaining to specific instances of MixMonitor on a channel.

Description

Syntax

MIXMONITOR(id,key)

Arguments

id - The unique ID of the MixMonitor instance. The unique ID can be retrieved through the channel variable used as an argument to the i option to MixMonitor.
key - The piece of data to retrieve from the MixMonitor.
- filename

STREAM_SILENCE()

Synopsis

Stream silent audio on a channel.

Description

Streams silent audio on a channel until disabled. This ensures that audiohooks can be processed constantly even if the channel receives no other frames.

Syntax

STREAM_SILENCE([active])

Arguments

active - 1 to enable or empty to disable.

VM_INFO()

Synopsis

Returns the selected attribute from a mailbox.

Description

Syntax

VM_INFO(mailbox@[context,]attribute,[folder])

Arguments

mailbox
- mailbox
- context
attribute
- count - Count of messages in specified folder. If folder is not specified, defaults to INBOX.
- email - E-mail address associated with the mailbox.
- exists - Returns a boolean of whether the corresponding mailbox exists.
- fullname - Full name associated with the mailbox.
- language - Mailbox language if overridden, otherwise the language of the channel.
- locale - Mailbox locale if overridden, otherwise global locale.
- pager - Pager e-mail address associated with the mailbox.
- password - Mailbox access password.
- tz - Mailbox timezone if overridden, otherwise global timezone
folder - If not specified, INBOX is assumed.

SPEECH_SCORE()

Synopsis

Gets the confidence score of a result.

Description

Gets the confidence score of a result.

Syntax

SPEECH_SCORE([nbest_number,]result_number)

Arguments

nbest_number
result_number

SPEECH_TEXT()

Synopsis

Gets the recognized text of a result.

Description

Gets the recognized text of a result.

Syntax

SPEECH_TEXT([nbest_number,]result_number)

Arguments

nbest_number
result_number

SPEECH_GRAMMAR()

Synopsis

Gets the matched grammar of a result if available.

Description

Gets the matched grammar of a result if available.

Syntax

SPEECH_GRAMMAR([nbest_number,]result_number)

Arguments

nbest_number
result_number

SPEECH_ENGINE()

Synopsis

Get or change a speech engine specific attribute.

Description

Changes a speech engine specific attribute.

Syntax

SPEECH_ENGINE(name)

Arguments

name

SPEECH_RESULTS_TYPE()

Synopsis

Sets the type of results that will be returned.

Description

Sets the type of results that will be returned. Valid options are normal or nbest.

SPEECH()

Synopsis

Gets information about speech recognition results.

Description

Gets information about speech recognition results.

Syntax

SPEECH(argument)

Arguments

argument

QUEUE_VARIABLES()

Synopsis

Return Queue information in variables.

Description

Makes the following queue variables available.

Returns 0 if queue is found and setqueuevar is defined, -1 otherwise.

Syntax

QUEUE_VARIABLES(queuename)

Arguments

queuename

QUEUE_MEMBER()

Synopsis

Provides a count of queue members based on the provided criteria, or updates a queue member's settings.

Description

Allows access to queue counts [R] and member information [R/W].

queuename is required for all read operations.

interface is required for all member operations.

Syntax

QUEUE_MEMBER([queuename,]option,[interface])

Arguments

queuename
option
interface

QUEUE_MEMBER_COUNT()

Synopsis

Count number of members answering a queue.

Description

Returns the number of members currently associated with the specified queuename.

This function has been deprecated in favor of the QUEUE_MEMBER() function

Syntax

QUEUE_MEMBER_COUNT(queuename)

Arguments

queuename

QUEUE_EXISTS()

Synopsis

Check if a named queue exists on this server

Description

Returns 1 if the specified queue exists, 0 if it does not

Syntax

QUEUE_EXISTS([queuename])

Arguments

queuename

QUEUE_GET_CHANNEL()

Synopsis

Return caller at the specified position in a queue.

Description

Returns the caller channel at position in the specified queuename.

If position is unspecified the first channel is returned.

Syntax

QUEUE_GET_CHANNEL(queuename,[position])

Arguments

queuename
position

QUEUE_WAITING_COUNT()

Synopsis

Count number of calls currently waiting in a queue.

Description

Returns the number of callers currently waiting in the specified queuename.

Syntax

QUEUE_WAITING_COUNT([queuename])

Arguments

queuename

QUEUE_MEMBER_LIST()

Synopsis

Returns a list of interfaces on a queue.

Description

Returns a comma-separated list of members associated with the specified queuename.

Syntax

QUEUE_MEMBER_LIST(queuename)

Arguments

queuename

QUEUE_MEMBER_PENALTY()

Synopsis

Gets or sets queue members penalty.

Description

Gets or sets queue members penalty.

This function has been deprecated in favor of the QUEUE_MEMBER() function

Syntax

QUEUE_MEMBER_PENALTY(queuename,interface)

Arguments

queuename
interface

FRAME_TRACE()

Synopsis

View internal ast_frames as they are read and written on a channel.

Description

Examples:

Example: View only DTMF frames

	exten => 1,1,Set(FRAME_TRACE(white)=DTMF_BEGIN,DTMF_END)

Example: View only DTMF frames

	exten => 1,1,Set(FRAME_TRACE()=DTMF_BEGIN,DTMF_END)

Example: View everything except DTMF frames

	exten => 1,1,Set(FRAME_TRACE(black)=DTMF_BEGIN,DTMF_END)

Syntax

FRAME_TRACE(filter list type)

Arguments

filter list type - A filter can be applied to the trace to limit what frames are viewed. This filter can either be a white or black list of frame types. When no filter type is present, white is used. If no arguments are provided at all, all frames will be output.
Below are the different types of frames that can be filtered.
- DTMF_BEGIN
- DTMF_END
- VOICE
- VIDEO
- CONTROL
- NULL
- IAX
- TEXT
- TEXT_DATA
- IMAGE
- HTML
- CNG
- MODEM

DTMF_FLASH()

Synopsis

Intercepts long DTMF frames on a channel and treats them as a hook flash instead

Description

Listens for long DTMF digits and treats a special digit of a certain duration as a hook flash on the channel instead.

This can be useful for IP devices that do not have the capability of sending a hook flash signal natively.

This functionality requires that DTMF emulation be used for the device. This means that a DTMF START event is processed when a user begins holding down a DTMF key and the DTMF END event is not processed until the user has let go of the key. If fixed durations are used for DTMF, this functionality will likely not work for your endpoint.

Example: Intercept star key for greater than 750ms as hook flash

	same => n,Set(LONG_DTMF_INTERCEPT(RX,*,750)=) ; provide hook flash capability via long "*" on IP phones

Syntax

DTMF_FLASH(direction,[digit,[ms]])

Arguments

direction - RX or TX
digit - Digit to intercept. Default is * (star).
ms - Required length (in milliseconds) of digit to intercept. Default is 750.

TECH_EXISTS()

Synopsis

Checks if the specified channel technology exists and is usable.

Description

Returns 1 if the channel technology tech exists, 0 if not.

Syntax

TECH_EXISTS(tech)

Arguments

tech - The name of the channel technology (e.g. DAHDI, PJSIP, IAX2, etc.).

CHANNELS()

Synopsis

Gets the list of channels, optionally filtering by a regular expression.

Description

Gets the list of channels, optionally filtering by a regular_expression. If no argument is provided, all known channels are returned. The regular_expression must correspond to the POSIX.2 specification, as shown in regex(7). The list returned will be space-delimited.

Syntax

CHANNELS([regular_expression])

Arguments

regular_expression

CHANNEL_EXISTS()

Synopsis

Checks if the specified channel exists.

Description

Returns 1 if the channel name_or_uid exists, 0 if not.

Syntax

CHANNEL_EXISTS(name_or_uid)

Arguments

name_or_uid - The name or unique ID of the channel to check.

MASTER_CHANNEL()

Synopsis

Gets or sets variables on the master channel

Description

Allows access to the oldest channel associated with the current channel if it still exists. If the channel is the master channel or the master channel no longer exists then access local channel variables instead. In other words, the master channel is the channel identified by the channel's linkedid.

CHANNEL()

Synopsis

Gets/sets various pieces of information about the channel.

Description

Gets/sets various pieces of information about the channel, additional item may be available from the channel driver; see its documentation for details. Any item requested that is not available on the current channel will return an empty string.

The following channel variables are available as special built-in dialplan channel variables. These variables cannot be set or modified and are read-only.

Example: Standard CHANNEL item examples

	; Push a hangup handler subroutine existing at dialplan
	; location default,s,1 onto the current channel
	same => n,Set(CHANNEL(hangup_handler_push)=default,s,1)
	
	; Set the current tonezone to Germany (de)
	same => n,Set(CHANNEL(tonezone)=de)
	
	; Set the allowed maximum number of forwarding attempts
	same => n,Set(CHANNEL(max_forwards)=10)
	
	; If this channel is ejected from its next bridge, and if
	; the channel is not hung up, begin executing dialplan at
	; location default,after-bridge,1
	same => n,Set(CHANNEL(after_bridge_goto)=default,after-bridge,1)
	
	; Log the current state of the channel
	same => n,Log(NOTICE, This channel is: ${CHANNEL(state)})

CALLINGPRES - Caller ID presentation for incoming calls (PRI channels)
CALLINGANI2 - Caller ANI2 (PRI channels)
CALLINGTON - Caller Type of Number (PRI channels)
CALLINGTNS - Transit Network Selector (PRI channels)
EXTEN - Current extension
CONTEXT - Current context
PRIORITY - Current priority
CHANNEL - Current channel name
UNIQUEID - Current call unique identifier
HANGUPCAUSE - Asterisk cause of hangup (inbound/outbound)

Syntax

CHANNEL(item)

Arguments

item - Standard items (provided by all channel technologies) are:
- amaflags - R/W the Automatic Message Accounting (AMA) flags on the channel. When read from a channel, the integer value will always be returned. When written to a channel, both the string format or integer value is accepted.
  - 1 - OMIT
  - 2 - BILLING
  - 3 - DOCUMENTATION
- accountcode - R/W the channel's account code.
- audioreadformat - R/O format currently being read.
- audionativeformat - R/O format used natively for audio.
- audiowriteformat - R/O format currently being written.
- dtmf_features - R/W The channel's DTMF bridge features. May include one or more of 'T' 'K' 'H' 'W' and 'X' in a similar manner to options in the Dial application. When setting it, the features string must be all upper case.
- callgroup - R/W numeric call pickup groups that this channel is a member.
- pickupgroup - R/W numeric call pickup groups this channel can pickup.
- namedcallgroup - R/W named call pickup groups that this channel is a member.
- namedpickupgroup - R/W named call pickup groups this channel can pickup.
- channeltype - R/O technology used for channel.
- checkhangup - R/O Whether the channel is hanging up (1/0)
- after_bridge_goto - R/W the parseable goto string indicating where the channel is expected to return to in the PBX after exiting the next bridge it joins on the condition that it doesn't hang up. The parseable goto string uses the same syntax as the Goto application.
- hangup_handler_pop - W/O Replace the most recently added hangup handler with a new hangup handler on the channel if supplied. The assigned string is passed to the Gosub application when the channel is hung up. Any optionally omitted context and exten are supplied by the channel pushing the handler before it is pushed.
- hangup_handler_push - W/O Push a hangup handler onto the channel hangup handler stack. The assigned string is passed to the Gosub application when the channel is hung up. Any optionally omitted context and exten are supplied by the channel pushing the handler before it is pushed.
- hangup_handler_wipe - W/O Wipe the entire hangup handler stack and replace with a new hangup handler on the channel if supplied. The assigned string is passed to the Gosub application when the channel is hung up. Any optionally omitted context and exten are supplied by the channel pushing the handler before it is pushed.
- onhold - R/O Whether or not the channel is onhold. (1/0)
- language - R/W language for sounds played.
- musicclass - R/W class (from musiconhold.conf) for hold music.
- name - The name of the channel
- parkinglot - R/W parkinglot for parking.
- rxgain - R/W set rxgain level on channel drivers that support it.
- secure_bridge_signaling - Whether or not channels bridged to this channel require secure signaling (1/0)
- secure_bridge_media - Whether or not channels bridged to this channel require secure media (1/0)
- state - R/O state of the channel
- tonezone - R/W zone for indications played
- transfercapability - R/W ISDN Transfer Capability, one of:
  - SPEECH
  - DIGITAL
  - RESTRICTED_DIGITAL
  - 3K1AUDIO
  - DIGITAL_W_TONES
  - VIDEO
- txgain - R/W set txgain level on channel drivers that support it.
- videonativeformat - R/O format used natively for video
- hangupsource - R/W returns the channel responsible for hangup.
- appname - R/O returns the internal application name.
- appdata - R/O returns the application data if available.
- exten - R/O returns the extension for an outbound channel.
- context - R/O returns the context for an outbound channel.
- lastexten - R/O returns the last unique extension for an outbound channel.
- lastcontext - R/O returns the last unique context for an outbound channel.
- channame - R/O returns the channel name for an outbound channel.
- uniqueid - R/O returns the channel uniqueid.
- linkedid - R/O returns the linkedid if available, otherwise returns the uniqueid.
- max_forwards - R/W The maximum number of forwards allowed.
- callid - R/O Call identifier log tag associated with the channel e.g., [C-00000000].

PJSIP_ENDPOINT()

Synopsis

Get information about a PJSIP endpoint

Description

Syntax

PJSIP_ENDPOINT(name,field)

Arguments

name - The name of the endpoint to query.
field - The configuration option for the endpoint to query for. Supported options are those fields on the endpoint object in pjsip.conf.

SHELL()

Synopsis

Executes a command using the system shell and captures its output.

Description

Collects the output generated by a command executed by the system shell

The command supplied to this function will be executed by the system's shell, typically specified in the SHELL environment variable. There are many different system shells available with somewhat different behaviors, so the output generated by this function may vary between platforms.

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Example: Shell example

	exten => s,1,Set(foo=${SHELL(echo bar)})

Syntax

SHELL(command)

Arguments

command - The command that the shell should execute.

SPRINTF()

Synopsis

Format a variable according to a format string.

Description

Parses the format string specified and returns a string matching that format. Supports most options found in sprintf(3). Returns a shortened string if a format specifier is not recognized.

Syntax

SPRINTF(format,arg1,[arg2,[argN]])

Arguments

format
arg1
arg2
argN

ENUMQUERY()

Synopsis

Initiate an ENUM query.

Description

This will do a ENUM lookup of the given phone number.

Syntax

ENUMQUERY(number,[method-type,[zone-suffix]])

Arguments

number
method-type - If no method-type is given, the default will be sip.
zone-suffix - If no zone-suffix is given, the default will be e164.arpa

ENUMRESULT()

Synopsis

Retrieve results from a ENUMQUERY.

Description

This function will retrieve results from a previous use of the ENUMQUERY function.

Syntax

ENUMRESULT(id,resultnum)

Arguments

id - The identifier returned by the ENUMQUERY function.
resultnum - The number of the result that you want to retrieve.
Results start at 1. If this argument is specified as getnum, then it will return the total number of results that are available or -1 on error.

ENUMLOOKUP()

Synopsis

General or specific querying of NAPTR records for ENUM or ENUM-like DNS pointers.

Description

For more information see doc/AST.pdf.

Syntax

ENUMLOOKUP(number,[method-type,[options,[record#,[zone-suffix]]]])

Arguments

number
method-type - If no method-type is given, the default will be sip.
options
- c - Returns an integer count of the number of NAPTRs of a certain RR type.
  Combination of c and Method-type of ALL will return a count of all NAPTRs for the record or -1 on error.
- u - Returns the full URI and does not strip off the URI-scheme.
- s - Triggers ISN specific rewriting.
- i - Looks for branches into an Infrastructure ENUM tree.
- d - for a direct DNS lookup without any flipping of digits.
record# - If no record# is given, defaults to 1.
zone-suffix - If no zone-suffix is given, the default will be e164.arpa

TXTCIDNAME()

Synopsis

TXTCIDNAME looks up a caller name via DNS.

Description

This function looks up the given phone number in DNS to retrieve the caller id name. The result will either be blank or be the value found in the TXT record in DNS.

Syntax

TXTCIDNAME(number,[zone-suffix])

Arguments

number
zone-suffix - If no zone-suffix is given, the default will be e164.arpa

VERSION()

Synopsis

Return the Version info for this Asterisk.

Description

If there are no arguments, return the version of Asterisk in this format: 18.12.0

Example: Get current version

	same => n,Set(junky=${VERSION()} ; sets junky to 18.12.0, or possibly GITMasterxxxxxx

Syntax

VERSION([info])

Arguments

info - The possible values are:
- ASTERISK_VERSION_NUM - A string of digits is returned, e.g. 10602 for 1.6.2 or 100300 for 10.3.0, or 999999 when using a Git build.
- BUILD_USER - The string representing the user's name whose account was used to configure Asterisk, is returned.
- BUILD_HOSTNAME - The string representing the name of the host on which Asterisk was configured, is returned.
- BUILD_MACHINE - The string representing the type of machine on which Asterisk was configured, is returned.
- BUILD_OS - The string representing the OS of the machine on which Asterisk was configured, is returned.
- BUILD_DATE - The string representing the date on which Asterisk was configured, is returned.
- BUILD_KERNEL - The string representing the kernel version of the machine on which Asterisk was configured, is returned.

TEXT_QUERY()

Synopsis

Remote string querying

Description

Initiate a call and receive a text data transfer.

This function can be used to implement simple remote procedure calls between endpoints that support text frames. For example, you can use this to retrieve the results of certain dialplan functions on a different node as easily as if they were local.

The other end should use SendText to send the data transfer.

Example: Query device state of endpoints at the main branch office

	[rx-node] ; Node A

	exten => rx,1,Set(remotestate=${QUERY(IAX2/mainbranch/2368@device-state-context)})
	same => n,ExecIf($[ "${remotestate}" = "NOT_INUSE" ]?Dial(IAX2/mainbranch/2368@extensions))
	same => n,Hangup()
	[extensions] ; Node B: allow other Asterisk systems to query local device states.

	exten => _2XXX,1,Dial(${HINT(${EXTEN})})
	same => n,Hangup()
	[device-state-context] ; Node B

	exten => _2XXX,1,SendText(${DEVICE_STATE(${HINT(${EXTEN})})})
	same => n,Hangup()

Syntax

TEXT_QUERY(dialstr,[timeout])

Arguments

dialstr - Dial string, such as provided to the Dial application
timeout - Timeout to wait, in seconds. Default is 5 seconds.

URIENCODE()

Synopsis

Encodes a string to URI-safe encoding according to RFC 2396.

Description

Returns the encoded string defined in data.

Syntax

URIENCODE(data)

Arguments

data - Input string to be encoded.

URIDECODE()

Synopsis

Decodes a URI-encoded string according to RFC 2396.

Description

Returns the decoded URI-encoded data string.

Syntax

URIDECODE(data)

Arguments

data - Input string to be decoded.

ENV()

Synopsis

Gets or sets the environment variable specified.

Description

Variables starting with AST_ are reserved to the system and may not be set.

Additionally, the following system variables are available as special built-in dialplan variables. These variables cannot be set or modified and are read-only.

EPOCH - Current unix style epoch
SYSTEMNAME - value of the systemname option from asterisk.conf
ASTCACHEDIR - value of the astcachedir option from asterisk.conf
ASTETCDIR - value of the astetcdir option from asterisk.conf
ASTMODDIR - value of the astmoddir option from asterisk.conf
ASTVARLIBDIR - value of the astvarlib option from asterisk.conf
ASTDBDIR - value of the astdbdir option from asterisk.conf
ASTKEYDIR - value of the astkeydir option from asterisk.conf
ASTDATADIR - value of the astdatadir option from asterisk.conf
ASTAGIDIR - value of the astagidir option from asterisk.conf
ASTSPOOLDIR - value of the astspooldir option from asterisk.conf
ASTRUNDIR - value of the astrundir option from asterisk.conf
ASTLOGDIR - value of the astlogdir option from asterisk.conf
ASTSBINDIR - value of the astsbindir option from asterisk.conf
ENTITYID - Global Entity ID set automatically, or from asterisk.conf

Syntax

ENV(varname)

Arguments

varname - Environment variable name

STAT()

Synopsis

Does a check on the specified file.

Description

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Syntax

STAT(flag,filename)

Arguments

flag - Flag may be one of the following:
d - Checks if the file is a directory.
e - Checks if the file exists.
f - Checks if the file is a regular file.
m - Returns the file mode (in octal)
s - Returns the size (in bytes) of the file
A - Returns the epoch at which the file was last accessed.
C - Returns the epoch at which the inode was last changed.
M - Returns the epoch at which the file was last modified.
filename

FILE()

Synopsis

Read or write text file.

Description

Read and write text file in character and line mode.

Examples:

Read mode (byte):

Read mode (line):

Write mode (byte):

Write mode (line):

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Example: Reads the entire content of the file

	same => n,Set(foo=${FILE(/tmp/test.txt)})

Example: Reads from the 11th byte to the end of the file (i.e. skips the first 10)

	same => n,Set(foo=${FILE(/tmp/test.txt,10)})

Example: Reads from the 11th to 20th byte in the file (i.e. skip the first 10, then read 10 bytes)

	same => n,Set(foo=${FILE(/tmp/test.txt,10,10)})

Example: Reads the 3rd line of the file

	same => n,Set(foo=${FILE(/tmp/test.txt,3,1,l)})

Example: Reads the 3rd and 4th lines of the file

	same => n,Set(foo=${FILE(/tmp/test.txt,3,2,l)})

Example: Reads from the third line to the end of the file

	same => n,Set(foo=${FILE(/tmp/test.txt,3,,l)})

Example: Reads the last three lines of the file

	same => n,Set(foo=${FILE(/tmp/test.txt,-3,,l)})

Example: Reads the 3rd line of a DOS-formatted file

	same => n,Set(foo=${FILE(/tmp/test.txt,3,1,l,d)})

Example: Truncate the file and write bar

	same => n,Set(FILE(/tmp/test.txt)=bar)

Example: Append bar

	same => n,Set(FILE(/tmp/test.txt,,,a)=bar)

Example: Replace the first byte with bar (replaces 1 character with 3)

	same => n,Set(FILE(/tmp/test.txt,0,1)=bar)

Example: Replace 10 bytes beginning at the 21st byte of the file with bar

	same => n,Set(FILE(/tmp/test.txt,20,10)=bar)

Example: Replace all bytes from the 21st with bar

	same => n,Set(FILE(/tmp/test.txt,20)=bar)

Example: Insert bar after the 4th character

	same => n,Set(FILE(/tmp/test.txt,4,0)=bar)

Example: Replace the first line of the file with bar

	same => n,Set(FILE(/tmp/foo.txt,0,1,l)=bar)

Example: Replace the last line of the file with bar

	same => n,Set(FILE(/tmp/foo.txt,-1,,l)=bar)

Example: Append bar to the file with a newline

	same => n,Set(FILE(/tmp/foo.txt,,,al)=bar)

Syntax

FILE(filename,[offset,[length,[options,[format]]]])

Arguments

filename
offset - Maybe specified as any number. If negative, offset specifies the number of bytes back from the end of the file.
length - If specified, will limit the length of the data read to that size. If negative, trims length bytes from the end of the file.
options
- l - Line mode: offset and length are assumed to be measured in lines, instead of byte offsets.
- a - In write mode only, the append option is used to append to the end of the file, instead of overwriting the existing file.
- d - In write mode and line mode only, this option does not automatically append a newline string to the end of a value. This is useful for deleting lines, instead of setting them to blank.
format
- u - Unix newline format.
- d - DOS newline format.
- m - Macintosh newline format.

FILE_COUNT_LINE()

Synopsis

Obtains the number of lines of a text file.

Description

Returns the number of lines, or -1 on error.

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Syntax

FILE_COUNT_LINE(filename,[format])

Arguments

filename
format
- u - Unix newline format.
- d - DOS newline format.
- m - Macintosh newline format.

FILE_FORMAT()

Synopsis

Return the newline format of a text file.

Description

Return the line terminator type:

'u' - Unix "\n" format

'd' - DOS "\r\n" format

'm' - Macintosh "\r" format

'x' - Cannot be determined

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Syntax

FILE_FORMAT(filename)

Arguments

filename

BASENAME()

Synopsis

Return the name of a file.

Description

Return the base file name, given a full file path.

Example: Directory name

	same => n,Set(basename=${BASENAME(/etc/asterisk/extensions.conf)})
	same => n,NoOp(${basename}) ; outputs extensions.conf

Syntax

BASENAME(filename)

Arguments

filename

DIRNAME()

Synopsis

Return the directory of a file.

Description

Return the directory of a file, given a full file path.

Example: Directory name

	same => n,Set(dirname=${DIRNAME(/etc/asterisk/extensions.conf)})
	same => n,NoOp(${dirname}) ; outputs /etc/asterisk

Syntax

DIRNAME(filename)

Arguments

filename

GROUP_COUNT()

Synopsis

Counts the number of channels in the specified group.

Description

Calculates the group count for the specified group, or uses the channel's current group if not specified (and non-empty).

Syntax

GROUP_COUNT([groupname,[category]])

Arguments

groupname - Group name.
category - Category name

GROUP_MATCH_LIST_START()

Synopsis

Start a find of groups by regular expression

Description

Once GROUP_MATCH_LIST_START is executed with a search, then each call to GROUP_MATCH_LIST_NEXT() will return a matched group. This search will look at all known groups and filter by the regex provided.

It is possible to only specify @category_regex, and it is also possible to pass in nothing for the search.

If only the category_regex is specified, then it will only return group@category that matches this category search.

If the search regex is entirely empty, all groups will be returned.

The return value is the number of groups found. Calling GROUP_MATCH_LIST_NEXT() more times than there are matches will result in an empty value being returned.

This function is useful to use instead of GROUP_MATCH_LIST if you would prefer to process the results one by one. If your group/category names contain a comma, then this is better to avoid parse issues

GROUP_CHANNEL_LIST does not support regex, but GROUP_MATCH_LIST_START does

Note: the search is executed and stored at the time of calling this function. If GROUP() assignments change during successive calls to the _NEXT function, you will need to call _START again to see the new groups. An empty string is returned to indicate the end of the list.

Uses standard regular expression matching (see regex(7)).

Example: Group SubString Match

	Find groups containing the string 'foo'
	On any Channel:
	Set(GROUP()=groupName)
	Set(GROUP()=foobarbaz)
	Set(GROUP()=foobarbill)
	On any Channel:
	Assuming that channels still exist that have the above associated GROUP() assignents
	Set(group_match_found_qty=${GROUP_MATCH_LIST_START(.*foo.*)})
	Given the above:
	This will find the groups 'foobarbaz' and 'foobarbill' since they both match .*foo.* regex against the group name

Example: Category SubString Match

	Find groups containing category name of 'bar'
	
	On any Channel:
	Set(GROUP()=groupName@categoryName)
	Set(GROUP()=foo@barbaz)
	Set(GROUP()=foo@barbill)
	On any Channel:
	Assuming that channels still exist that have the above associated GROUP() assignents
	Set(group_match_found_qty=${GROUP_MATCH_LIST_START(@.*bar.*)})
	
	Given the above:
	This will find the groups 'foo@barbaz' and 'foo@barbill' since they both match .*bar.* regex against the category name

Example: Group and Category SubString Match

	Find groups containing 'foo' and category name of 'bar'
	
	On any Channel:
	Set(GROUP()=group@category)
	Set(GROUP()=foo@barbaz)
	Set(GROUP()=foo@barbill)
	On any Channel:
	Assuming that channels still exist that have the above associated GROUP() assignents
	Set(group_match_found_qty=${GROUP_MATCH_LIST_START(.*foo.*@.*bar.*)})
	
	Given the above:
	This will find the groups 'foo@barbaz' and 'foo@barbill' since they both match .*foo*. against the group name and .*bar.* regex against the category name

Syntax

GROUP_MATCH_LIST_START([group_regex,[category_regex]])

Arguments

group_regex
category_regex

GROUP_MATCH_LIST_NEXT()

Synopsis

Get a match from the GROUP_MATCH_LIST_START search currently loaded

Description

The return value is the number of groups found. Calling GROUP_MATCH_LIST_NEXT() more times than there are matches will result in an empty value being returned.

Uses standard regular expression matching (see regex(7)).

Example: Start a search and return the number of groups found

	Set(group_found=${GROUP_MATCH_LIST_NEXT()})

GROUP_CHANNEL_LIST()

Synopsis

Start a find of groups by regular expression

Description

It is possible to only specify @category_regex, and it is also possible to pass in nothing for the search.

If only the category_regex is specified, then it will only return group@category that matches this category search.

If the search regex is entirely empty, all groups will be returned.

The return value is the number of groups found. Calling GROUP_MATCH_LIST_NEXT() more times than there are matches will result in an empty value being returned.

Uses standard regular expression matching (see regex(7)).

Syntax

GROUP_CHANNEL_LIST([group_regex,[category_regex]])

Arguments

group_regex
category_regex

GROUP_MATCH_COUNT()

Synopsis

Counts the number of channels in the groups matching the specified pattern.

Description

Calculates the group count for all groups that match the specified pattern. Note: category matching is applied after matching based on group. Uses standard regular expression matching on both parameters (see regex(7)).

Syntax

GROUP_MATCH_COUNT([group_match,[category_match]])

Arguments

group_match - A standard regular expression used to match a group name.
category_match - A standard regular expression used to match a category name.

GROUP()

Synopsis

Gets or sets the channel group.

Description

category can be employed for more fine grained group management. Each channel can only be member of exactly one group per category. Once a group is assigned to a channel, per-group variables can then be assigned via GROUP_VAR()

Syntax

GROUP([group,[category]])

Arguments

group - Group name.
category - Category name.

GROUP_VAR()

Synopsis

Gets or sets a variable on a channel group.

Description

Once a GROUP() is assinged to a channel, variables can then be attached to that group. As long as the group exists, these variables will exist. When the group no longer exists, the variables will be cleaned up automatically.

These variables can be considered 'globals for a group of channels'. These variables are like a SHARED() variable but for a collection of channels.

Example: On Channel 1

	Set(GROUP()=foo)
	Set(GROUP_VAR(foo,savethis)=123)

Example: On Channel 2

	(Assuming Channel1 exists and GROUP() 'foo' still exists)
	Set(GROUP()=foo)
	NoOp(${GROUP_VAR(foo,savethis) <-- This prints '123'

Syntax

GROUP_VAR([category])

Arguments

category - Category name.

GROUP_LIST()

Synopsis

Gets a list of the groups set on a channel.

Description

Gets a list of the groups set on a channel.

SCRAMBLE()

Synopsis

Scrambles audio on a channel.

Description

Scrambles audio on a channel using whole spectrum inversion. This is not intended to be used for securely scrambling audio. It merely renders obfuscates audio on a channel to render it unintelligible, as a privacy enhancement.

Syntax

SCRAMBLE([direction])

Arguments

direction - Must be TX or RX to limit to a specific direction, or both for both directions. remove will remove an existing scrambler.

AES_ENCRYPT()

Synopsis

Encrypt a string with AES given a 16 character key.

Description

Returns an AES encrypted string encoded in base64.

Syntax

AES_ENCRYPT(key,string)

Arguments

key - AES Key
string - Input string

AES_DECRYPT()

Synopsis

Decrypt a string encoded in base64 with AES given a 16 character key.

Description

Returns the plain text string.

Syntax

AES_DECRYPT(key,string)

Arguments

key - AES Key
string - Input string.

CURL()

Synopsis

Retrieve content from a remote web or ftp server

Description

When this function is read, a HTTP GET (by default) will be used to retrieve the contents of the provided url. The contents are returned as the result of the function.

When this function is written to, a HTTP GET will be used to retrieve the contents of the provided url. The value written to the function specifies the destination file of the cURL'd resource.

If live_dangerously in asterisk.conf is set to no, this function can only be written to from the dialplan, and not directly from external protocols. Read operations are unaffected.

Example: Displaying contents of a page

	exten => s,1,Verbose(0, ${CURL(http://localhost:8088/static/astman.css)})

Example: Retrieving a file

	exten => s,1,Set(CURL(http://localhost:8088/static/astman.css)=/var/spool/asterisk/tmp/astman.css))

Syntax

CURL(url,[post-data])

Arguments

url - The full URL for the resource to retrieve.
post-data - Read Only
If specified, an HTTP POST will be performed with the content of post-data, instead of an HTTP GET (default).

CURLOPT()

Synopsis

Sets various options for future invocations of CURL.

Description

Options may be set globally or per channel. Per-channel settings will override global settings. Only HTTP headers are added instead of overriding

Syntax

CURLOPT([key])

Arguments

key

MD5()

Synopsis

Computes an MD5 digest.

Description

Computes an MD5 digest.

Syntax

MD5(data)

Arguments

data

RAND()

Synopsis

Choose a random number in a range.

Description

Choose a random number between min and max. min defaults to 0, if not specified, while max defaults to RAND_MAX (2147483647 on many systems).

Example: Set random number between 1 and 8, inclusive

	exten => s,1,Set(junky=${RAND(1,8)})

Syntax

RAND([min,[max]])

Arguments

min
max

DIALPLAN_EXISTS()

Synopsis

Checks the existence of a dialplan target.

Description

This function returns 1 if the target exits. Otherwise, it returns 0.

Syntax

DIALPLAN_EXISTS(context,[extension,[priority]])

Arguments

context
extension
priority

VALID_EXTEN()

Synopsis

Determine whether an extension exists or not.

Description

Returns a true value if the indicated context, extension, and priority exist.

This function has been deprecated in favor of the DIALPLAN_EXISTS() function

Syntax

VALID_EXTEN([context,]extension,[priority])

Arguments

context - Defaults to the current context
extension
priority - Priority defaults to 1.

SAYFILES()

Synopsis

Returns the ampersand-delimited file names that would be played by the Say applications (e.g. SayAlpha, SayDigits).

Description

Returns the files that would be played by a Say application. These filenames could then be passed directly into Playback, BackGround, Read, Queue, or any application which supports playback of multiple ampersand-delimited files.

Example: Read using the number 123

	same => n,Read(response,${SAYFILES(123,number)})

Syntax

SAYFILES(value,[type])

Arguments

value - The value to be translated to filenames.
type - Say application type.
- alpha - Files played by SayAlpha(). Default if none is specified.
- digits - Files played by SayDigits().
- money - Files played by SayMoney(). Currently supported for English and US dollars only.
- number - Files played by SayNumber(). Currently supported for English only.
- ordinal - Files played by SayOrdinal(). Currently supported for English only.
- phonetic - Files played by SayPhonetic().

TALK_DETECT()

Synopsis

Raises notifications when Asterisk detects silence or talking on a channel.

Description

The TALK_DETECT function enables events on the channel it is applied to. These events can be emitted over AMI, ARI, and potentially other Asterisk modules that listen for the internal notification.

The function has two parameters that can optionally be passed when set on a channel: dsp_talking_threshold and dsp_silence_threshold.

dsp_talking_threshold is the time in milliseconds of sound above what the dsp has established as base line silence for a user before a user is considered to be talking. By default, the value of silencethreshold from dsp.conf is used. If this value is set too tight events may be falsely triggered by variants in room noise.

Valid values are 1 through 2^31.

dsp_silence_threshold is the time in milliseconds of sound falling within what the dsp has established as baseline silence before a user is considered be silent. If this value is set too low events indicating the user has stopped talking may get falsely sent out when the user briefly pauses during mid sentence.

The best way to approach this option is to set it slightly above the maximum amount of ms of silence a user may generate during natural speech.

By default this value is 2500ms. Valid values are 1 through 2^31.

This function will set the following variables:

The TALK_DETECT function uses an audiohook to inspect the voice media frames on a channel. Other functions, such as JITTERBUFFER, DENOISE, and AGC use a similar mechanism. Audiohooks are processed in the order in which they are placed on the channel. As such, it typically makes sense to place functions that modify the voice media data prior to placing the TALK_DETECT function, as this will yield better results.

Example: Enable talk detection

	same => n,Set(TALK_DETECT(set)=)

Example: Update existing talk detection's silence threshold to 1200 ms

	same => n,Set(TALK_DETECT(set)=1200)

Example: Remove talk detection

	same => n,Set(TALK_DETECT(remove)=)

Example: Enable and set talk threshold to 128

	same => n,Set(TALK_DETECT(set)=,128)

Example: Denoise and then perform talk detection

	same => n,Set(DENOISE(rx)=on)    ; Denoise received audio
	same => n,Set(TALK_DETECT(set)=) ; Perform talk detection on the denoised received audio

Syntax

TALK_DETECT(action)

Arguments

action
- remove - W/O. Remove talk detection from the channel.
- set( dsp_silence_threshold dsp_talking_threshold ) - W/O. Enable TALK_DETECT and/or configure talk detection parameters. Can be called multiple times to change parameters on a channel with talk detection already enabled.
  - dsp_silence_threshold - The time in milliseconds of sound falling below the dsp_talking_threshold option when a user is considered to stop talking. The default value is 2500.
  - dsp_talking_threshold - The minimum average magnitude per sample in a frame for the DSP to consider talking/noise present. A value below this level is considered silence. If not specified, the value comes from the dsp.conf silencethreshold option or 256 if dsp.conf doesn't exist or the silencethreshold option is not set.

PRESENCE_STATE()

Synopsis

Get or Set a presence state.

Description

The PRESENCE_STATE function can be used to retrieve the presence from any presence provider. For example:

NoOp(SIP/mypeer has presence ${PRESENCE_STATE(SIP/mypeer,value)})

NoOp(Conference number 1234 has presence message ${PRESENCE_STATE(MeetMe:1234,message)})

The PRESENCE_STATE function can also be used to set custom presence state from the dialplan. The CustomPresence: prefix must be used. For example:

Set(PRESENCE_STATE(CustomPresence:lamp1)=away,temporary,Out to lunch)

Set(PRESENCE_STATE(CustomPresence:lamp2)=dnd,,Trying to get work done)

Set(PRESENCE_STATE(CustomPresence:lamp3)=xa,T24gdmFjYXRpb24=,,e)

Set(BASE64_LAMP3_PRESENCE=${PRESENCE_STATE(CustomPresence:lamp3,subtype,e)})

You can subscribe to the status of a custom presence state using a hint in the dialplan:

exten => 1234,hint,,CustomPresence:lamp1

The possible values for both uses of this function are:

Syntax

PRESENCE_STATE(provider,field,[options])

Arguments

provider - The provider of the presence, such as CustomPresence
field
- value - The current presence, such as away
- subtype - Further information about the current presence
- message - A custom message that may indicate further details about the presence
options
- e - On Write - Use this option when the subtype and message provided are Base64 encoded. The values will be stored encoded within Asterisk, but all consumers of the presence state (e.g. the SIP presence event package) will receive decoded values.
  On Read - Retrieves unencoded message/subtype in Base64 encoded form.

NOTCH_FILTER()

Synopsis

Apply a notch filter to a channel.

Description

The NOTCH_FILTER function attenuates a specified frequency using the provided bandwidth.

For example:

Example: Filter out 2600 Hz in the TX direction, with bandwidth of 10 Hz

	same => n,Set(NOTCH_FILTER(2600,t)=10.0)

Example: Filter out 1004 Hz in both directions, with bandwidth of 5 Hz

	same => n,Set(NOTCH_FILTER(1004)=5.0)

Example: Filter out 2400 Hz in the RX direction, with bandwidth of 15 Hz

	same => n,Set(NOTCH_FILTER(2400,r)=15.0)

Example: Filter out 1004 Hz in the RX direction, with bandwidth of 10 Hz

	same => n,Set(NOTCH_FILTER(1004,r)=10.0)

Example: Disable filtering of 1004 Hz

	same => n,Set(NOTCH_FILTER(1004,d)=)

Syntax

NOTCH_FILTER(frequency,[options])

Arguments

frequency - Must be the frequency to attenuate.
options
- d - Destroy the existing notch filter.
- r - Apply the notch filter for received frames, rather than transmitted frames. Default is both directions.
- t - Apply the notch filter for transmitted frames, rather than received frames. Default is both directions.

AST_CONFIG()

Synopsis

Retrieve a variable from a configuration file.

Description

This function reads a variable from an Asterisk configuration file.

Syntax

AST_CONFIG(config_file,category,variable_name,[index])

Arguments

config_file
category
variable_name
index - If there are multiple variables with the same name, you can specify 0 for the first item (default), -1 for the last item, or any other number for that specific item. -1 is useful when the variable is derived from a template and you want the effective value (the last occurrence), not the value from the template (the first occurrence).

HANGUPCAUSE()

Synopsis

Gets per-channel hangupcause information from the channel.

Description

Gets technology-specific or translated Asterisk cause code information from the channel for the specified channel that resulted from a dial.

Syntax

HANGUPCAUSE(channel,type)

Arguments

channel - The name of the channel for which to retrieve cause information.
type - Parameter describing which type of information is requested. Types are:
- tech - Technology-specific cause information
- ast - Translated Asterisk cause code

HANGUPCAUSE_KEYS()

Synopsis

Gets the list of channels for which hangup causes are available.

Description

Returns a comma-separated list of channel names to be used with the HANGUPCAUSE function.

PERIODIC_HOOK()

Synopsis

Execute a periodic dialplan hook into the audio of a call.

Description

For example, you could use this function to enable playing a periodic beep sound in a call.

It is important to note that the hook does not actually run on the channel itself. It runs asynchronously on a new channel. Any audio generated by the hook gets injected into the call for the channel PERIODIC_HOOK() was set on.

The hook dialplan will have two variables available. HOOK_CHANNEL is the channel the hook is enabled on. HOOK_ID is the hook ID for enabling or disabling the hook.

Example: To turn on

	same => n,Set(BEEPID=${PERIODIC_HOOK(hooks,beep,180)})

Example: To turn off

	same => n,Set(PERIODIC_HOOK(${BEEPID})=off)

Example: To turn back on again later

	same => n,Set(PERIODIC_HOOK(${BEEPID})=on)

Syntax

PERIODIC_HOOK(context,extension,interval,hook_id)

Arguments

context - (On Read Only) Context for the hook extension.
extension - (On Read Only) The hook extension.
interval - (On Read Only) Number of seconds in between hook runs. Whole seconds only.
hook_id - (On Write Only) The hook ID.

PITCH_SHIFT()

Synopsis

Pitch shift both tx and rx audio streams on a channel.

Description

Examples:

Example: Raises pitch an octave

	exten => 1,1,Set(PITCH_SHIFT(tx)=highest)

Example: Raises pitch more

	exten => 1,1,Set(PITCH_SHIFT(rx)=higher)

Example: Raises pitch

	exten => 1,1,Set(PITCH_SHIFT(both)=high)

Example: Lowers pitch

	exten => 1,1,Set(PITCH_SHIFT(rx)=low)

Example: Lowers pitch more

	exten => 1,1,Set(PITCH_SHIFT(tx)=lower)

Example: Lowers pitch an octave

	exten => 1,1,Set(PITCH_SHIFT(both)=lowest)

Example: Lowers pitch

	exten => 1,1,Set(PITCH_SHIFT(rx)=0.8)

Example: Raises pitch

	exten => 1,1,Set(PITCH_SHIFT(tx)=1.5)

Syntax

PITCH_SHIFT(channel direction)

Arguments

channel direction - Direction can be either rx, tx, or both. The direction can either be set to a valid floating point number between 0.1 and 4.0 or one of the enum values listed below. A value of 1.0 has no effect. Greater than 1 raises the pitch. Lower than 1 lowers the pitch.
The pitch amount can also be set by the following values
- highest
- higher
- high
- low
- lower
- lowest

DB_CHANNEL()

Synopsis

Return the name of the oldest alive channel in an AstDB family where the values correspond to channels.

Description

Returns the key corresponding to the first channel that is still alive in a DB family or comma-separated list of DB families of keys corresponding to sequentially ordered IDs and values corresponding to channel names or unique IDs. Channels that no longer exist will be automatically purged if they are older than the first match. If no match is found or the DB family does not exist, an empty string is returned.

This function is designed to facilitate easy search operations when channels are stored in AstDB and the oldest existing channel needs to be found.

Syntax

DB_CHANNEL(families)

Arguments

families

DB_CHANNEL_PRUNE()

Synopsis

Deletes all entries in a family or families whose values are channels that no longer exist.

Description

Iterates through a DB family or comma-separated list of DB families and deletes any key-value pairs where the value is no longer a valid channel name or unique ID. Returns the number of key/value pairs that were deleted from the database.

Syntax

DB_CHANNEL_PRUNE(families)

Arguments

families - AstDB families. Individual families can be pipe-separated to delete an entry with the same key in the second family if an entry in the first family is deleted (synchronized delete).

DB_CHANNEL_PRUNE_TIME()

Synopsis

Deletes all entries in a DB family or families whose keys are epoch times older than the specified epoch. Note that unlike the other DB_CHANNEL functions, this requires that keys follow a certain format (i.e. that they correspond to an epoch timestamp).

Description

Iterates through a DB family or comma-separated list of DB families and deletes any key-value pairs where the key is an epoch timestamp older than a specified epoch.

This function should NOT be used if keys do not correspond to epochs.

Syntax

DB_CHANNEL_PRUNE_TIME(epoch,families)

Arguments

epoch
families - AstDB families. Individual families can be pipe-separated to delete an entry with the same key in the second family if an entry in the first family is deleted (synchronized delete).

DB_MINKEY()

Synopsis

Retrieves the smallest numerical key within specified comma-separated families

Description

Returns the family/key of the smallest numerical key from a list of AstDB families.

Syntax

DB_MINKEY(families)

Arguments

families - AstDB families.

DB_MAXKEY()

Synopsis

Retrieves the largest numerical key within specified comma-separated families

Description

Returns the family/key of the largest numerical key from a list of AstDB families.

Syntax

DB_MAXKEY(families)

Arguments

families - AstDB families.

DB_UNIQUE()

Synopsis

Returns a unique DB key that can be used to store a value in AstDB.

Description

Computes a unique DB key name by using familyandkey as base and adding a unique zero-padded suffix, beginning with 0.

This can be used to input data into AstDB with a guaranteed new/unique key name that will sort later than any existing keys with the same base key name.

If this function is read, it will return a unique key name (NOT including the family name). If this function is written to, it will store a value at the determined unique key name, reducing the chances of data being overwritten due to a collision.

This function will search up to suffix 999, after which time the function will abort the search for a unique key name.

Syntax

DB_UNIQUE(familyandkey)

Arguments

familyandkey - The family/key to use as the base for the unique keyname.

DIALGROUP()

Synopsis

Manages a group of users for dialing.

Description

Presents an interface meant to be used in concert with the Dial application, by presenting a list of channels which should be dialled when referenced.

When DIALGROUP is read from, the argument is interpreted as the particular group for which a dial should be attempted. When DIALGROUP is written to with no arguments, the entire list is replaced with the argument specified.

Functionality is similar to a queue, except that when no interfaces are available, execution may continue in the dialplan. This is useful when you want certain people to be the first to answer any calls, with immediate fallback to a queue when the front line people are busy or unavailable, but you still want front line people to log in and out of that group, just like a queue.

Example: Add 2 endpoints to a dial group

	exten => 1,1,Set(DIALGROUP(mygroup,add)=SIP/10)
	same => n,Set(DIALGROUP(mygroup,add)=SIP/20)
	same => n,Dial(${DIALGROUP(mygroup)})

Syntax

DIALGROUP(group,[op])

Arguments

group
op - The operation name, possible values are:
add - add a channel name or interface (write-only)
del - remove a channel name or interface (write-only)

CALLCOMPLETION()

Synopsis

Get or set a call completion configuration parameter for a channel.

Description

The CALLCOMPLETION function can be used to get or set a call completion configuration parameter for a channel. Note that setting a configuration parameter will only change the parameter for the duration of the call. For more information see doc/AST.pdf. For more information on call completion parameters, see configs/ccss.conf.sample.

Syntax

CALLCOMPLETION(option)

Arguments

option - The allowable options are:
- cc_agent_policy
- cc_monitor_policy
- cc_offer_timer
- ccnr_available_timer
- ccbs_available_timer
- cc_recall_timer
- cc_max_agents
- cc_max_monitors
- cc_callback_macro
- cc_agent_dialstring

GLOBAL()

Synopsis

Gets or sets the global variable specified.

Description

Set or get the value of a global variable specified in varname

Syntax

GLOBAL(varname)

Arguments

varname - Global variable name

SHARED()

Synopsis

Gets or sets the shared variable specified.

Description

Implements a shared variable area, in which you may share variables between channels.

The variables used in this space are separate from the general namespace of the channel and thus and represent two completely different variables, despite sharing the same name.

Finally, realize that there is an inherent race between channels operating at the same time, fiddling with each others' internal variables, which is why this special variable namespace exists; it is to remind you that variables in the SHARED namespace may change at any time, without warning. You should therefore take special care to ensure that when using the SHARED namespace, you retrieve the variable and store it in a regular channel variable before using it in a set of calculations (or you might be surprised by the result).

Syntax

SHARED(varname,[channel])

Arguments

varname - Variable name
channel - If not specified will default to current channel. It is the complete channel name: SIP/12-abcd1234 or the prefix only SIP/12.

LOCK()

Synopsis

Attempt to obtain a named mutex.

Description

Attempts to grab a named lock exclusively, and prevents other channels from obtaining the same lock. LOCK will wait for the lock to become available. Returns 1 if the lock was obtained or 0 on error.

To avoid the possibility of a deadlock, LOCK will only attempt to obtain the lock for 3 seconds if the channel already has another lock.

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Syntax

LOCK(lockname)

Arguments

lockname

TRYLOCK()

Synopsis

Attempt to obtain a named mutex.

Description

Attempts to grab a named lock exclusively, and prevents other channels from obtaining the same lock. Returns 1 if the lock was available or 0 otherwise.

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Syntax

TRYLOCK(lockname)

Arguments

lockname

UNLOCK()

Synopsis

Unlocks a named mutex.

Description

Unlocks a previously locked mutex. Returns 1 if the channel had a lock or 0 otherwise.

It is generally unnecessary to unlock in a hangup routine, as any locks held are automatically freed when the channel is destroyed.

If live_dangerously in asterisk.conf is set to no, this function can only be executed from the dialplan, and not directly from external protocols.

Syntax

UNLOCK(lockname)

Arguments

lockname

EXPORT()

Synopsis

Set variables or dialplan functions on any arbitrary channel that exists.

Description

Allows setting variables or functions on any existing channel if it exists.

Syntax

EXPORT(channel,var)

Arguments

channel - The complete channel name: SIP/12-abcd1234.
var - Variable name

ICONV()

Synopsis

Converts charsets of strings.

Description

Converts string from in-charset into out-charset. For available charsets, use iconv -l on your shell command line.

Due to limitations within the API, ICONV will not currently work with charsets with embedded NULLs. If found, the string will terminate.

Syntax

ICONV(in-charset,out-charset,string)

Arguments

in-charset - Input charset
out-charset - Output charset
string - String to convert, from in-charset to out-charset

SORT()

Synopsis

Sorts a list of key/vals into a list of keys, based upon the vals.

Description

Takes a comma-separated list of keys and values, each separated by a colon, and returns a comma-separated list of the keys, sorted by their values. Values will be evaluated as floating-point numbers.

Syntax

SORT(key1:val1:key2:val2)

Arguments

keyval
- key1
- val1
keyvaln
- key2
- val2

CUT()

Synopsis

Slices and dices strings, based upon a named delimiter.

Description

Cut out information from a string (varname), based upon a named delimiter.

Syntax

CUT(varname,char-delim,range-spec)

Arguments

varname - Variable you want cut
char-delim - Delimiter, defaults to -
range-spec - Number of the field you want (1-based offset), may also be specified as a range (with -) or group of ranges and fields (with &)

IFMODULE()

Synopsis

Checks if an Asterisk module is loaded in memory.

Description

Checks if a module is loaded. Use the full module name as shown by the list in module list. Returns 1 if module exists in memory, otherwise 0

Syntax

IFMODULE(modulename.so)

Arguments

modulename.so - Module name complete with .so

REALTIME()

Synopsis

RealTime Read/Write Functions.

Description

This function will read or write values from/to a RealTime repository. REALTIME(....) will read names/values from the repository, and REALTIME(....)= will write a new value/field to the repository. On a read, this function returns a delimited text string. The name/value pairs are delimited by delim1, and the name and value are delimited between each other with delim2. If there is no match, NULL will be returned by the function. On a write, this function will always return NULL.

Syntax

REALTIME(family,fieldmatch,[matchvalue,[delim1|field,[delim2]]])

Arguments

family
fieldmatch
matchvalue
delim1|field - Use delim1 with delim2 on read and field without delim2 on write
If we are reading and delim1 is not specified, defaults to ,
delim2 - Parameter only used when reading, if not specified defaults to =

REALTIME_STORE()

Synopsis

RealTime Store Function.

Description

This function will insert a new set of values into the RealTime repository. If RT engine provides an unique ID of the stored record, REALTIME_STORE(...)=.. creates channel variable named RTSTOREID, which contains value of unique ID. Currently, a maximum of 30 field/value pairs is supported.

Syntax

REALTIME_STORE(family,field1,fieldN,field30)

Arguments

family
field1
fieldN
field30

REALTIME_DESTROY()

Synopsis

RealTime Destroy Function.

Description

This function acts in the same way as REALTIME(....) does, except that it destroys the matched record in the RT engine.

If live_dangerously in asterisk.conf is set to no, this function can only be read from the dialplan, and not directly from external protocols. It can, however, be executed as a write operation (REALTIME_DESTROY(family, fieldmatch)=ignored)

Syntax

REALTIME_DESTROY(family,fieldmatch,[matchvalue,[delim1,[delim2]]])

Arguments

family
fieldmatch
matchvalue
delim1
delim2

REALTIME_FIELD()

Synopsis

RealTime query function.

Description

This function retrieves a single item, fieldname from the RT engine, where fieldmatch contains the value matchvalue. When written to, the REALTIME_FIELD() function performs identically to the REALTIME() function.

Syntax

REALTIME_FIELD(family,fieldmatch,matchvalue,fieldname)

Arguments

family
fieldmatch
matchvalue
fieldname

REALTIME_HASH()

Synopsis

RealTime query function.

Description

This function retrieves a single record from the RT engine, where fieldmatch contains the value matchvalue and formats the output suitably, such that it can be assigned to the HASH() function. The HASH() function then provides a suitable method for retrieving each field value of the record.

Syntax

REALTIME_HASH(family,fieldmatch,matchvalue)

Arguments

family
fieldmatch
matchvalue

VMCOUNT()

Synopsis

Count the voicemails in a specified mailbox or mailboxes.

Description

Count the number of voicemails in a specified mailbox, you could also specify the mailbox folder.

An ampersand-separated list of mailboxes may be specified to count voicemails in multiple mailboxes. If a folder is specified, this will apply to all mailboxes specified.

Example: Mailbox folder count

	exten => s,1,Set(foo=${VMCOUNT(125@default)})

Example: Multiple mailbox inbox count

	same => n,NoOp(${VMCOUNT(1234@default&1235@default&1236@default,INBOX)})

Syntax

VMCOUNT(vmbox,[folder])

Arguments

vmbox - A mailbox or list of mailboxes
folder - If not specified, defaults to INBOX

CDR()

Synopsis

Gets or sets a CDR variable.

Description

All of the CDR field names are read-only, except for accountcode, userfield, and amaflags. You may, however, supply a name not on the above list, and create your own variable, whose value can be changed with this function, and this variable will be stored on the CDR.

CDRs can only be modified before the bridge between two channels is torn down. For example, CDRs may not be modified after the Dial application has returned.

Example: Set the userfield

	exten => 1,1,Set(CDR(userfield)=test)

Syntax

CDR(name,[options])

Arguments

name - CDR field name:
- clid - Caller ID.
- lastdata - Last application arguments.
- disposition - The final state of the CDR.
  - 0 - NO ANSWER
  - 1 - NO ANSWER (NULL record)
  - 2 - FAILED
  - 4 - BUSY
  - 8 - ANSWERED
  - 16 - CONGESTION
- src - Source.
- start - Time the call started.
- amaflags - R/W the Automatic Message Accounting (AMA) flags on the channel. When read from a channel, the integer value will always be returned. When written to a channel, both the string format or integer value is accepted.
  - 1 - OMIT
  - 2 - BILLING
  - 3 - DOCUMENTATION
- dst - Destination.
- answer - Time the call was answered.
- accountcode - The channel's account code.
- dcontext - Destination context.
- end - Time the call ended.
- uniqueid - The channel's unique id.
- dstchannel - Destination channel.
- duration - Duration of the call.
- userfield - The channel's user specified field.
- lastapp - Last application.
- billsec - Duration of the call once it was answered.
- channel - Channel name.
- sequence - CDR sequence number.
options
- f - Returns billsec or duration fields as floating point values.
- u - Retrieves the raw, unprocessed value.
  For example, 'start', 'answer', and 'end' will be retrieved as epoch values, when the u option is passed, but formatted as YYYY-MM-DD HH:MM:SS otherwise. Similarly, disposition and amaflags will return their raw integral values.

CDR_PROP()

Synopsis

Set a property on a channel's CDR.

Description

This function sets a property on a channel's CDR. Properties alter the behavior of how the CDR operates for that channel.

Syntax

CDR_PROP(name)

Arguments

name - The property to set on the CDR.
- party_a - Set this channel as the preferred Party A when channels are associated together.
  Write-Only
- disable - Setting to 1 will disable CDRs for this channel. Setting to 0 will enable CDRs for this channel.
  Write-Only

NANPA()

Synopsis

Retrieve information about a North American Numbering Plan area.

Description

This function will return information about a Numbering Plan Area (area code).

By default, it will return the base (original) area code of the specified NPA.

Syntax

NANPA(npa,property)

Arguments

npa - Numbering Plan Area (i.e. area code)
property - Must be one of the following:
- base - The base NPA.
  This is the original NPA in overlaid areas with more than one NPA.
- overlaid - Whether or not the area code is overlaid.
- zip - ZIP code corresponding to the area code.
  Note that the ZIP code returned is, while in the NPA, somewhat arbitrary, though often in a prominent city in the NPA.
- cityid - OpenWeatherMap City ID of a prominent city in this NPA.
- tz - TZ format time zone of this NPA.
- city - Filename (for use with Playback) of prominent city in this NPA.
- state - Filename (for use with Playback) of NPA's state/region.

FIELDQTY()

Synopsis

Count the fields with an arbitrary delimiter

Description

The delimiter may be specified as a special or extended ASCII character, by encoding it. The characters \n, \r, and \t are all recognized as the newline, carriage return, and tab characters, respectively. Also, octal and hexadecimal specifications are recognized by the patterns \0nnn and \xHH, respectively. For example, if you wanted to encode a comma as the delimiter, you could use either \054 or \x2C.

Example: Prints 3

	exten => s,1,Set(example=ex-amp-le)
	same => n,NoOp(${FIELDQTY(example,-)})

Syntax

FIELDQTY(varname,delim)

Arguments

varname
delim

FIELDNUM()

Synopsis

Return the 1-based offset of a field in a list

Description

Search the variable named varname for the string value delimited by delim and return a 1-based offset as to its location. If not found or an error occured, return 0.

Example: Prints 2

	exten => s,1,Set(example=ex-amp-le)
	same => n,NoOp(${FIELDNUM(example,-,amp)})

Syntax

FIELDNUM(varname,delim,value)

Arguments

varname
delim
value

LISTFILTER()

Synopsis

Remove an item from a list, by name.

Description

Remove value from the list contained in the varname variable, where the list delimiter is specified by the delim parameter. This is very useful for removing a single channel name from a list of channels, for example.

Syntax

LISTFILTER(varname,delim,value)

Arguments

varname
delim
value

FILTER()

Synopsis

Filter the string to include only the allowed characters

Description

Permits all characters listed in allowed-chars, filtering all others outs. In addition to literally listing the characters, you may also use ranges of characters (delimited by a -

Hexadecimal characters started with a \x(i.e. \x20)

Octal characters started with a \0 (i.e. \040)

Also \t,\n and \r are recognized.

If you want the - character it needs to be prefixed with a \

Syntax

FILTER(allowed-chars,string)

Arguments

allowed-chars
string

REPLACE()

Synopsis

Replace a set of characters in a given string with another character.

Description

Iterates through a string replacing all the find-chars with replace-char. replace-char may be either empty or contain one character. If empty, all find-chars will be deleted from the output.

The replacement only occurs in the output. The original variable is not altered.

Syntax

REPLACE(varname,find-chars,[replace-char])

Arguments

varname
find-chars
replace-char

STRREPLACE()

Synopsis

Replace instances of a substring within a string with another string.

Description

Searches for all instances of the find-string in provided variable and replaces them with replace-string. If replace-string is an empty string, this will effectively delete that substring. If max-replacements is specified, this function will stop after performing replacements max-replacements times.

The replacement only occurs in the output. The original variable is not altered.

Syntax

STRREPLACE(varname,find-string,[replace-string,[max-replacements]])

Arguments

varname
find-string
replace-string
max-replacements

STRBETWEEN()

Synopsis

Inserts a substring between each character in a string.

Description

Inserts a substring find-string between each character in varname.

The replacement only occurs in the output. The original variable is not altered.

Example: Add half-second pause between dialed digits

	same => n,Set(digits=5551212)
	same => n,SendDTMF(${STRBETWEEN(digits,w)) ; this will send 5w5w5w1w2w1w2

Syntax

STRBETWEEN(varname,insert-string)

Arguments

varname
insert-string

TRIM()

Synopsis

Trim leading and trailing whitespace in a string

Description

Replaces all leading and trailing whitespace in the provided string.

Syntax

TRIM(string)

Arguments

string

LTRIM()

Synopsis

Trim leading whitespace in a string

Description

Replaces all leading whitespace in the provided string.

Syntax

LTRIM(string)

Arguments

string

RTRIM()

Synopsis

Trim trailing whitespace in a string

Description

Replaces all trailing whitespace in the provided string.

Syntax

RTRIM(string)

Arguments

string

PASSTHRU()

Synopsis

Pass the given argument back as a value.

Description

Literally returns the given string. The intent is to permit other dialplan functions which take a variable name as an argument to be able to take a literal string, instead.

The functions which take a variable name need to be passed var and not ${var}. Similarly, use PASSTHRU() and not ${PASSTHRU()}.

Example: Prints 321

	exten => s,1,NoOp(${CHANNEL}) ; contains SIP/321-1
	same => n,NoOp(${CUT(PASSTHRU(${CUT(CHANNEL,-,1)}),/,2)})

Syntax

PASSTHRU([string])

Arguments

string

REGEX()

Synopsis

Check string against a regular expression.

Description

Return 1 on regular expression match or 0 otherwise

Please note that the space following the double quotes separating the regex from the data is optional and if present, is skipped. If a space is desired at the beginning of the data, then put two spaces there; the second will not be skipped.

Syntax

REGEX("regular expression",string)

Arguments

"regular expression"
string

HASH()

Synopsis

Implementation of a dialplan associative array

Description

In two arguments mode, gets and sets values to corresponding keys within a named associative array. The single-argument mode will only work when assigned to from a function defined by func_odbc

Syntax

HASH(hashname,[hashkey])

Arguments

hashname
hashkey

HASHKEYS()

Synopsis

Retrieve the keys of the HASH() function.

Description

Returns a comma-delimited list of the current keys of the associative array defined by the HASH() function. Note that if you iterate over the keys of the result, adding keys during iteration will cause the result of the HASHKEYS() function to change.

Syntax

HASHKEYS(hashname)

Arguments

hashname

KEYPADHASH()

Synopsis

Hash the letters in string into equivalent keypad numbers.

Description

Example: Returns 537

	exten => s,1,Return(${KEYPADHASH(Les)})

Syntax

KEYPADHASH(string)

Arguments

string

ARRAY()

Synopsis

Allows setting multiple variables at once.

Description

The comma-delimited list passed as a value to which the function is set will be interpreted as a set of values to which the comma-delimited list of variable names in the argument should be set.

Example: Set var1 to 1 and var2 to 2

	same => n,Set(ARRAY(var1,var2)=1,2)

Syntax

ARRAY(var1,[var2,[varN]])

Arguments

var1
var2
varN

STRPTIME()

Synopsis

Returns the epoch of the arbitrary date/time string structured as described by the format.

Description

This is useful for converting a date into EPOCH time, possibly to pass to an application like SayUnixTime or to calculate the difference between the two date strings

Example: Prints 1141219835

	same => n,NoOp(${STRPTIME(2006-03-01 07:30:35,America/Chicago,%Y-%m-%d %H:%M:%S)})

Syntax

STRPTIME(datetime,timezone,format)

Arguments

datetime
timezone
format

STRFTIME()

Synopsis

Returns the current date/time in the specified format.

Description

STRFTIME supports all of the same formats as the underlying C function strftime(3). It also supports the following format: %[n]q - fractions of a second, with leading zeros.

Example: %3q will give milliseconds and %1q will give tenths of a second. The default is set at milliseconds (n=3). The common case is to use it in combination with %S, as in %S.%3q.

Syntax

STRFTIME([epoch,[timezone,[format]]])

Arguments

epoch
timezone
format

EVAL()

Synopsis

Evaluate stored variables

Description

Using EVAL basically causes a string to be evaluated twice. When a variable or expression is in the dialplan, it will be evaluated at runtime. However, if the results of the evaluation is in fact another variable or expression, using EVAL will have it evaluated a second time.

Example: If the MYVAR contains OTHERVAR, then the result of ${EVAL( MYVAR)} in the dialplan will be the contents of OTHERVAR. Normally just putting MYVAR in the dialplan the result would be OTHERVAR.

Syntax

EVAL(variable)

Arguments

variable

TOUPPER()

Synopsis

Convert string to all uppercase letters.

Description

Example: Prints EXAMPLE

	exten => s,1,NoOp(${TOUPPER(Example)})

Syntax

TOUPPER(string)

Arguments

string

TOLOWER()

Synopsis

Convert string to all lowercase letters.

Description

Example: Prints example

	exten => s,1,NoOp(${TOLOWER(Example)})

Syntax

TOLOWER(string)

Arguments

string

LEN()

Synopsis

Return the length of the string given.

Description

Example: Prints 7

	exten => s,1,NoOp(${LEN(example)})

Syntax

LEN(string)

Arguments

string

QUOTE()

Synopsis

Quotes a given string, escaping embedded quotes as necessary

Description

Example: ${QUOTE(ab"c"de)} will return ""ab\"c\"de""

Syntax

QUOTE(string)

Arguments

string

CSV_QUOTE()

Synopsis

Quotes a given string for use in a CSV file, escaping embedded quotes as necessary

Description

Example: ${CSV_QUOTE("a,b" 123)} will return """a,b"" 123"

Syntax

CSV_QUOTE(string)

Arguments

string

SHIFT()

Synopsis

Removes and returns the first item off of a variable containing delimited text

Description

This would iterate over each value in array, left to right, and would result in NoOp(var is one), NoOp(var is two), and NoOp(var is three) being executed.

Example: SHIFT example

	exten => s,1,Set(array=one,two,three)

	exten => s,n,While($["${SET(var=${SHIFT(array)})}" != ""])

	exten => s,n,NoOp(var is ${var})

	exten => s,n,EndWhile

Syntax

SHIFT(varname,[delimiter])

Arguments

varname
delimiter

POP()

Synopsis

Removes and returns the last item off of a variable containing delimited text

Description

This would iterate over each value in array, right to left, and would result in NoOp(var is three), NoOp(var is two), and NoOp(var is one) being executed.

Example: POP example

	exten => s,1,Set(array=one,two,three)

	exten => s,n,While($["${SET(var=${POP(array)})}" != ""])

	exten => s,n,NoOp(var is ${var})

	exten => s,n,EndWhile

Syntax

POP(varname,[delimiter])

Arguments

varname
delimiter

PUSH()

Synopsis

Appends one or more values to the end of a variable containing delimited text

Description

This would append one, two, and three to the end of the values stored in the variable "array".

Example: PUSH example

	exten => s,1,Set(PUSH(array)=one,two,three)

Syntax

PUSH(varname,[delimiter])

Arguments

varname
delimiter

UNSHIFT()

Synopsis

Inserts one or more values to the beginning of a variable containing delimited text

Description

This would insert one, two, and three before the values stored in the variable "array".

Example: UNSHIFT example

	exten => s,1,Set(UNSHIFT(array)=one,two,three)

Syntax

UNSHIFT(varname,[delimiter])

Arguments

varname
delimiter

NUM2DEVICE()

Synopsis

Translates a telephone number into a dialable device

Description

Translates a telephone number into a tech/device that can be used with Dial.

This function requires no additional configuration to use. However, it is highly recommend that you configure and use hints instead of this function (see the HINT function for usage).

Example: Dial 5551212

	same => n,Dial(${NUM2DEVICE(5551212)})

Example: Dial extension

	exten => _X!,1,Dial(${NUM2DEVICE(${EXTEN})})

Syntax

NUM2DEVICE([number,[index,[options]]])

Arguments

number - Number to use. Number must be the Caller ID defined in the relevant channel driver config file.
index - Index (starting with 1) of match to return, if multiple are found. Default is 1 (first match).
options
- d - Check DAHDI.
- i - Check IAX2.
- p - Check PJSIP.
- s - Check SIP. Note that SIP is deprecated, and this option will eventually be removed.

PJSIP_AOR()

Synopsis

Get information about a PJSIP AOR

Description

Syntax

PJSIP_AOR(name,field)

Arguments

name - The name of the AOR to query.
field - The configuration option for the AOR to query for. Supported options are those fields on the aor object in pjsip.conf.

CALLERID()

Synopsis

Gets or sets Caller*ID data on the channel.

Description

Gets or sets Caller*ID data on the channel. Uses channel callerid by default or optional callerid, if specified.

The pres field gets/sets a combined value for name-pres and num-pres.

The allowable values for the name-charset field are the following:

The allowable values for the num-pres, name-pres, and pres fields are the following:

CALL_QUALIFIER - This is a special Caller ID-related variable that can be used to enable sending the Call Qualifier parameter in MDMF (Multiple Data Message Format) Caller ID spills.This variable is not automatically set by Asterisk. You are responsible for setting it if/when needed.Supporting Caller ID units will display the LDC (Long Distance Call) indicator when they receive this parameter.This option must be used with a channel driver that allows Asterisk to generate the Caller ID spill, which currently only includes chan_dahdi.

Syntax

CALLERID(datatype,[CID])

Arguments

datatype - The allowable datatypes are:
- all
- name
- name-valid
- name-charset
- name-pres
- num
- num-valid
- num-plan
- num-pres
- pres
- subaddr
- subaddr-valid
- subaddr-type
- subaddr-odd
- tag
- priv-all
- priv-name
- priv-name-valid
- priv-name-charset
- priv-name-pres
- priv-num
- priv-num-valid
- priv-num-plan
- priv-num-pres
- priv-subaddr
- priv-subaddr-valid
- priv-subaddr-type
- priv-subaddr-odd
- priv-tag
- ANI-all
- ANI-name
- ANI-name-valid
- ANI-name-charset
- ANI-name-pres
- ANI-num
- ANI-num-valid
- ANI-num-plan
- ANI-num-pres
- ANI-tag
- RDNIS
- DNID
- dnid-num-plan
- dnid-subaddr
- dnid-subaddr-valid
- dnid-subaddr-type
- dnid-subaddr-odd
CID - Optional Caller*ID to parse instead of using the Caller*ID from the channel. This parameter is only optional when reading the Caller*ID.

CONNECTEDLINE()

Synopsis

Gets or sets Connected Line data on the channel.

Description

Gets or sets Connected Line data on the channel.

The pres field gets/sets a combined value for name-pres and num-pres.

The allowable values for the name-charset field are the following:

The allowable values for the num-pres, name-pres, and pres fields are the following:

Syntax

CONNECTEDLINE(datatype,[i])

Arguments

datatype - The allowable datatypes are:
- all
- name
- name-valid
- name-charset
- name-pres
- num
- num-valid
- num-plan
- num-pres
- pres
- subaddr
- subaddr-valid
- subaddr-type
- subaddr-odd
- tag
- priv-all
- priv-name
- priv-name-valid
- priv-name-charset
- priv-name-pres
- priv-num
- priv-num-valid
- priv-num-plan
- priv-num-pres
- priv-subaddr
- priv-subaddr-valid
- priv-subaddr-type
- priv-subaddr-odd
- priv-tag
i - If set, this will prevent the channel from sending out protocol messages because of the value being set

REDIRECTING()

Synopsis

Gets or sets Redirecting data on the channel.

Description

Gets or sets Redirecting data on the channel.

The orig-pres, from-pres and to-pres fields get/set a combined value for the corresponding ...-name-pres and ...-num-pres fields.

The recognized values for the reason and orig-reason fields are the following:

The allowable values for the xxx-name-charset field are the following:

You can set a user defined reason string that SIP can send/receive instead. The user defined reason string my need to be quoted depending upon SIP or the peer's requirements. These strings are treated as unknown by the non-SIP channel drivers.

Syntax

REDIRECTING(datatype,[i])

Arguments

datatype - The allowable datatypes are:
- orig-all
- orig-name
- orig-name-valid
- orig-name-charset
- orig-name-pres
- orig-num
- orig-num-valid
- orig-num-plan
- orig-num-pres
- orig-pres
- orig-subaddr
- orig-subaddr-valid
- orig-subaddr-type
- orig-subaddr-odd
- orig-tag
- orig-reason
- from-all
- from-name
- from-name-valid
- from-name-charset
- from-name-pres
- from-num
- from-num-valid
- from-num-plan
- from-num-pres
- from-pres
- from-subaddr
- from-subaddr-valid
- from-subaddr-type
- from-subaddr-odd
- from-tag
- to-all
- to-name
- to-name-valid
- to-name-charset
- to-name-pres
- to-num
- to-num-valid
- to-num-plan
- to-num-pres
- to-pres
- to-subaddr
- to-subaddr-valid
- to-subaddr-type
- to-subaddr-odd
- to-tag
- priv-orig-all
- priv-orig-name
- priv-orig-name-valid
- priv-orig-name-charset
- priv-orig-name-pres
- priv-orig-num
- priv-orig-num-valid
- priv-orig-num-plan
- priv-orig-num-pres
- priv-orig-subaddr
- priv-orig-subaddr-valid
- priv-orig-subaddr-type
- priv-orig-subaddr-odd
- priv-orig-tag
- priv-from-all
- priv-from-name
- priv-from-name-valid
- priv-from-name-charset
- priv-from-name-pres
- priv-from-num
- priv-from-num-valid
- priv-from-num-plan
- priv-from-num-pres
- priv-from-subaddr
- priv-from-subaddr-valid
- priv-from-subaddr-type
- priv-from-subaddr-odd
- priv-from-tag
- priv-to-all
- priv-to-name
- priv-to-name-valid
- priv-to-name-charset
- priv-to-name-pres
- priv-to-num
- priv-to-num-valid
- priv-to-num-plan
- priv-to-num-pres
- priv-to-subaddr
- priv-to-subaddr-valid
- priv-to-subaddr-type
- priv-to-subaddr-odd
- priv-to-tag
- reason
- count
i - If set, this will prevent the channel from sending out protocol messages because of the value being set

HOLD_INTERCEPT()

Synopsis

Intercepts hold frames on a channel and raises an event instead of passing the frame on

Description

Syntax

HOLD_INTERCEPT(action)

Arguments

action
- remove - W/O. Removes the hold interception function.
- set - W/O. Enable hold interception on the channel. When enabled, the channel will intercept any hold action that is signalled from the device, and instead simply raise an event (AMI/ARI) indicating that the channel wanted to put other parties on hold.

BLACKLIST()

Synopsis

Check if the callerid is on the blacklist.

Description

Uses astdb to check if the Caller*ID is in family blacklist. Returns 1 or 0.

ISNULL()

Synopsis

Check if a value is NULL.

Description

Returns 1 if NULL or 0 otherwise.

Syntax

ISNULL(data)

Arguments

data

SET()

Synopsis

SET assigns a value to a channel variable.

Description

Syntax

SET(varname,[value])

Arguments

varname
value

EXISTS()

Synopsis

Test the existence of a value.

Description

Returns 1 if exists, 0 otherwise.

Syntax

EXISTS(data)

Arguments

data

IF()

Synopsis

Check for an expression.

Description

Returns the data following ? if true, else the data following :

Syntax

IF(expression:[true:[false]])

Arguments

expression
retvalue
- true
- false

IFTIME()

Synopsis

Temporal Conditional.

Description

Returns the data following ? if true, else the data following :

Syntax

IFTIME(timespec:[true:[false]])

Arguments

timespec
retvalue
- true
- false

IMPORT()

Synopsis

Retrieve the value of a variable from another channel.

Description

Syntax

IMPORT(channel,variable)

Arguments

channel
variable

BASE64_ENCODE()

Synopsis

Encode a string in base64.

Description

Returns the base64 string.

Syntax

BASE64_ENCODE(string)

Arguments

string - Input string

BASE64_DECODE()

Synopsis

Decode a base64 string.

Description

Returns the plain text string.

Syntax

BASE64_DECODE(string)

Arguments

string - Input string.

DTMF_TRACE()

Synopsis

View DTMF digits as they are sent or received on a channel.

Description

Subsequent function invocations will replace earlier ones.

Examples:

Example: View only received DTMF digits

	exten => 1,1,Set(DTMF_TRACE(RX)=1)

Example: Disable DTMF trace

	exten => 1,1,Set(DTMF_TRACE(TX)=0)

Syntax

DTMF_TRACE([direction])

Arguments

direction - TX or RX to limit the direction.
Default is both directions.

AST_SORCERY()

Synopsis

Get a field from a sorcery object

Description

Syntax

AST_SORCERY(module_name,object_type,object_id,field_name,[retrieval_method,[retrieval_details]])

Arguments

module_name - The name of the module owning the sorcery instance.
object_type - The type of object to query.
object_id - The id of the object to query.
field_name - The name of the field.
retrieval_method - Fields that have multiple occurrences may be retrieved in two ways.
The default is concat with separator ,.
- concat - Returns all matching fields concatenated in a single string separated by separator which defaults to ,.
- single - Returns the nth occurrence of the field as specified by occurrence_number which defaults to 1.
retrieval_details - Specifies either the separator for concat or the occurrence number for single.

AGC()

Synopsis

Apply automatic gain control to audio on a channel.

Description

The AGC function will apply automatic gain control to the audio on the channel that it is executed on. Using rx for audio received and tx for audio transmitted to the channel. When using this function you set a target audio level. It is primarily intended for use with analog lines, but could be useful for other channels as well. The target volume is set with a number between 1-32768. The larger the number the louder (more gain) the channel will receive.

Example: Apply automatic gain control

	exten => 1,1,Set(AGC(rx)=8000)

	exten => 1,2,Set(AGC(tx)=off)

Syntax

AGC(channeldirection)

Arguments

channeldirection - This can be either rx or tx

DENOISE()

Synopsis

Apply noise reduction to audio on a channel.

Description

The DENOISE function will apply noise reduction to audio on the channel that it is executed on. It is very useful for noisy analog lines, especially when adjusting gains or using AGC. Use rx for audio received from the channel and tx to apply the filter to the audio being sent to the channel.

Example: Apply noise reduction

	exten => 1,1,Set(DENOISE(rx)=on)

	exten => 1,2,Set(DENOISE(tx)=off)

Syntax

DENOISE(channeldirection)

Arguments

channeldirection - This can be either rx or tx the values that can be set to this are either on and off

PJSIP_CONTACT()

Synopsis

Get information about a PJSIP contact

Description

Syntax

PJSIP_CONTACT(name,field)

Arguments

name - The name of the contact to query.
field - The configuration option for the contact to query for. Supported options are those fields on the contact object.
- rtt - The RTT of the last qualify
- status - Status of the contact

SHA1()

Synopsis

Computes a SHA1 digest.

Description

Generate a SHA1 digest via the SHA1 algorythm.

The example above sets the asterisk variable sha1hash to the string 60fa5675b9303eb62f99a9cd47f9f5837d18f9a0 which is known as its hash

Example: Set sha1hash variable to SHA1 hash of junky

	exten => s,1,Set(sha1hash=${SHA1(junky)})

Syntax

SHA1(data)

Arguments

data - Input string

EXTENSION_STATE()

Synopsis

Get an extension's state.

Description

The EXTENSION_STATE function can be used to retrieve the state from any hinted extension. For example:

NoOp(1234@default has state ${EXTENSION_STATE(1234)})

NoOp(4567@home has state ${EXTENSION_STATE(4567@home)})

The possible values returned by this function are:

Syntax

EXTENSION_STATE(extension,[context])

Arguments

extension
context - If it is not specified defaults to default.

FRAME_DROP()

Synopsis

Drops specific frame types in the TX or RX direction on a channel.

Description

Examples:

Example: Drop only DTMF frames towards this channel

	exten => 1,1,Set(FRAME_DROP(TX)=DTMF_BEGIN,DTMF_END)

Example: Drop only Answer control frames towards this channel

	exten => 1,1,Set(FRAME_DROP(TX)=ANSWER)

Example: Drop only DTMF frames received on this channel

	exten => 1,1,Set(FRAME_DROP(RX)=DTMF_BEGIN,DTMF_END)

Syntax

FRAME_DROP(direction)

Arguments

direction - List of frame types to be dropped for the specified direction. Direction can be TX or RX. The TX direction will prevent Asterisk from sending frames to a channel, and the RX direction will prevent Asterisk from receiving frames from a channel.
Subsequent calls to this function will replace previous settings, allowing certain frames to be dropped only temporarily, for instance.
Below are the different types of frames that can be dropped. Other actions may need to be taken in conjunction with use of this function: for instance, if you drop ANSWER control frames, you should explicitly use Progress() for your call or undesired behavior may occur.
The following CONTROL frames can also be dropped:
- DTMF_BEGIN
- DTMF_END
- VOICE
- VIDEO
- CONTROL
- NULL
- IAX
- TEXT
- TEXT_DATA
- IMAGE
- HTML
- CNG
- MODEM
- RING
- RINGING
- ANSWER
- BUSY
- TAKEOFFHOOK
- OFFHOOK
- CONGESTION
- FLASH
- WINK
- PROGRESS
- PROCEEDING
- HOLD
- UNHOLD
- VIDUPDATE
- CONNECTED_LINE
- REDIRECTING

DEVICE_STATE()

Synopsis

Get or Set a device state.

Description

The DEVICE_STATE function can be used to retrieve the device state from any device state provider. For example:

NoOp(SIP/mypeer has state ${DEVICE_STATE(SIP/mypeer)})

NoOp(Conference number 1234 has state ${DEVICE_STATE(MeetMe:1234)})

The DEVICE_STATE function can also be used to set custom device state from the dialplan. The Custom: prefix must be used. For example:

Set(DEVICE_STATE(Custom:lamp1)=BUSY)

Set(DEVICE_STATE(Custom:lamp2)=NOT_INUSE)

You can subscribe to the status of a custom device state using a hint in the dialplan:

exten => 1234,hint,Custom:lamp1

The possible values for both uses of this function are:

Syntax

DEVICE_STATE(device)

Arguments

device

HINT()

Synopsis

Get the devices set for a dialplan hint.

Description

The HINT function can be used to retrieve the list of devices that are mapped to a dialplan hint.

Example: Hint for extension 1234

	same => n,NoOp(Hint for Extension 1234 is ${HINT(1234)})

Syntax

HINT(extension@[context,[options]])

Arguments

extension
- extension
- context
options
- n - Retrieve name on the hint instead of list of devices.

JITTERBUFFER()

Synopsis

Add a Jitterbuffer to the Read side of the channel. This dejitters the audio stream before it reaches the Asterisk core. This is a write only function.

Description

Jitterbuffers are constructed in two different ways. The first always take four arguments: max_size, resync_threshold, target_extra, and sync_video. Alternatively, a single argument of default can be provided, which will construct the default jitterbuffer for the given jitterbuffer type.

The arguments are:

max_size: Length in milliseconds of the buffer. Defaults to 200 ms.

resync_threshold: The length in milliseconds over which a timestamp difference will result in resyncing the jitterbuffer. Defaults to 1000ms.

target_extra: This option only affects the adaptive jitterbuffer. It represents the amount time in milliseconds by which the new jitter buffer will pad its size. Defaults to 40ms.

sync_video: This option enables video synchronization with the audio stream. It can be turned on and off. Defaults to off.

If a channel specifies a jitterbuffer due to channel driver configuration and the JITTERBUFFER function has set a jitterbuffer for that channel, the jitterbuffer set by the JITTERBUFFER function will take priority and the jitterbuffer set by the channel configuration will not be applied.

Example: Fixed with defaults

	exten => 1,1,Set(JITTERBUFFER(fixed)=default)

Example: Fixed with 200ms max size

	exten => 1,1,Set(JITTERBUFFER(fixed)=200)

Example: Fixed with 200ms max size and video sync support

	exten => 1,1,Set(JITTERBUFFER(fixed)=200,,,yes)

Example: Fixed with 200ms max size, resync threshold 1500

	exten => 1,1,Set(JITTERBUFFER(fixed)=200,1500)

Example: Adaptive with defaults

	exten => 1,1,Set(JITTERBUFFER(adaptive)=default)

Example: Adaptive with 200ms max size, 60ms target extra

	exten => 1,1,Set(JITTERBUFFER(adaptive)=200,,60)

Example: Adaptive with 200ms max size and video sync support

	exten => 1,1,Set(JITTERBUFFER(adaptive)=200,,,yes)

Example: Set a fixed jitterbuffer with defaults; then remove it

	exten => 1,1,Set(JITTERBUFFER(fixed)=default)

	exten => 1,n,Set(JITTERBUFFER(disabled)=)

Syntax

JITTERBUFFER(jitterbuffer type)

Arguments

jitterbuffer type
- fixed - Set a fixed jitterbuffer on the channel.
- adaptive - Set an adaptive jitterbuffer on the channel.
- disabled - Remove a previously set jitterbuffer from the channel.

DB()

Synopsis

Read from or write to the Asterisk database.

Description

This function will read from or write a value to the Asterisk database. On a read, this function returns the corresponding value from the database, or blank if it does not exist. Reading a database value will also set the variable DB_RESULT. If you wish to find out if an entry exists, use the DB_EXISTS function.

Syntax

DB(family,key)

Arguments

family
key

DB_EXISTS()

Synopsis

Check to see if a key exists in the Asterisk database.

Description

This function will check to see if a key exists in the Asterisk database. If it exists, the function will return 1. If not, it will return 0. Checking for existence of a database key will also set the variable DB_RESULT to the key's value if it exists.

Syntax

DB_EXISTS(family,key)

Arguments

family
key

DB_KEYS()

Synopsis

Obtain a list of keys within the Asterisk database.

Description

This function will return a comma-separated list of keys existing at the prefix specified within the Asterisk database. If no argument is provided, then a list of key families will be returned.

Syntax

DB_KEYS([prefix])

Arguments

prefix

DB_KEYCOUNT()

Synopsis

Obtain the number of keys at a prefix within the Asterisk database.

Description

This function will return the number of keys that exist at the prefix specified within the Asterisk database. If no argument is provided, then the number of all key families will be returned.

Syntax

DB_KEYCOUNT([prefix])

Arguments

prefix

DB_DELETE()

Synopsis

Return a value from the database and delete it.

Description

This function will retrieve a value from the Asterisk database and then remove that key from the database. DB_RESULT will be set to the key's value if it exists.

Syntax

DB_DELETE(family,key)

Arguments

family
key

MATH()

Synopsis

Performs Mathematical Functions.

Description

Performs mathematical functions based on two parameters and an operator. The returned value type is type

Example: Sets var i to 11

	same => n,Set(i=${MATH(123%16,int)})

Syntax

MATH(expression,[type])

Arguments

expression - Is of the form: number1opnumber2 where the possible values for op are:
+,-,/,*,%,<<,>>,^,AND,OR,XOR,<,>,<=,>=,== (and behave as their C equivalents)
type - Wanted type of result:
f, float - float(default)
i, int - integer
h, hex - hex
c, char - char

INC()

Synopsis

Increments the value of a variable, while returning the updated value to the dialplan

Description

Increments the value of a variable, while returning the updated value to the dialplan

Example: INC(MyVAR) - Increments MyVar

Note: INC(${MyVAR}) - Is wrong, as INC expects the variable name, not its value

Syntax

INC(variable)

Arguments

variable - The variable name to be manipulated, without the braces.

DEC()

Synopsis

Decrements the value of a variable, while returning the updated value to the dialplan

Description

Decrements the value of a variable, while returning the updated value to the dialplan

DEC(${MyVAR}) is wrong, as DEC expects the variable name, not its value

Example: Decrements MyVAR

	same => n,NoOp(${DEC(MyVAR)})

Syntax

DEC(variable)

Arguments

variable - The variable name to be manipulated, without the braces.

MIN()

Synopsis

Returns the minimum of two numbers.

Description

Returns the minimum of two numbers num1 and num2.

Example: Sets the min variable equal to 4

	same => n,Set(min=${MIN(7,4)})

Syntax

MIN([num1,[num2]])

Arguments

num1
num2

MAX()

Synopsis

Returns the maximum of two numbers.

Description

Returns the maximum of two numbers num1 and num2.

Example: Sets the max variable equal to 13

	same => n,Set(max=${MAX(4,7)})

Syntax

MAX([num1,[num2]])

Arguments

num1
num2

ABS()

Synopsis

Returns absolute value of a number.

Description

Returns the absolute value of a number num.

Example: Sets the absval variable equal to 13

	same => n,Set(absval=${ABS(-13)})

Syntax

ABS([num])

Arguments

num

SYSINFO()

Synopsis

Returns system information specified by parameter.

Description

Returns information from a given parameter.

Syntax

SYSINFO(parameter)

Arguments

parameter

EVAL_EXTEN()

Synopsis

Evaluates the contents of a dialplan extension and returns it as a string.

Description

The EVAL_EXTEN function looks up a dialplan entry by context,extension,priority, evaluates the contents of a Return statement to resolve any variable or function references, and returns the result as a string.

You can use this function to create simple user-defined lookup tables or user-defined functions.

Any variables in the evaluated data will be resolved in the context of that extension. For example, ${EXTEN} would refer to the EVAL_EXTEN extension, not the extension in the context invoking the function. This behavior is similar to other applications, e.g. Gosub.

Extensions on which EVAL_EXTEN is invoked are not different from other extensions. However, the application at that extension is not executed. Only the application data is parsed and evaluated.

A limitation of this function is that the application at the specified extension isn't actually executed, and thus unlike a Gosub, you can't pass arguments in the EVAL_EXTEN function.

Example: Custom dialplan functions

	[call-types]

	exten => _1NNN,1,Return(internal)

	exten => _NXXNXXXXXX,1,Return(external)
	
	[udf]

	exten => calleridlen,1,Return(${LEN(${CALLERID(num)})})
	
	[default]

	exten => _X!,1,Verbose(Call type ${EVAL_EXTEN(call-types,${EXTEN},1)} - ${EVAL_EXTEN(udf,calleridlen,1)})

Example: Choosing which prompt to use

	same => n,Read(input,${EVAL_EXTEN(prompts,${CALLERID(num)},1)})
	
	[prompts]

	exten => _X!,1,Return(default)

	exten => _20X,1,Return(welcome)

	exten => _2XX,1,Return(${DB(promptsettings/${EXTEN})})

	exten => _3XX,1,Return(${ODBC_MYFUNC(${EXTEN})})

Syntax

EVAL_EXTEN([context,[extensions,]]priority)

Arguments

context
extensions
priority

TIMEOUT()

Synopsis

Gets or sets timeouts on the channel. Timeout values are in seconds.

Description

The timeouts that can be manipulated are:

absolute: The absolute maximum amount of time permitted for a call. Setting of 0 disables the timeout.

digit: The maximum amount of time permitted between digits when the user is typing in an extension. When this timeout expires, after the user has started to type in an extension, the extension will be considered complete, and will be interpreted. Note that if an extension typed in is valid, it will not have to timeout to be tested, so typically at the expiry of this timeout, the extension will be considered invalid (and thus control would be passed to the i extension, or if it doesn't exist the call would be terminated). The default timeout is 5 seconds.

response: The maximum amount of time permitted after falling through a series of priorities for a channel in which the user may begin typing an extension. If the user does not type an extension in this amount of time, control will pass to the t extension if it exists, and if not the call would be terminated. The default timeout is 10 seconds.

Syntax

TIMEOUT(timeouttype)

Arguments

timeouttype - The timeout that will be manipulated. The possible timeout types are: absolute, digit or response

JSON_DECODE()

Synopsis

Returns the string value of a JSON object key from a string containing a JSON array.

Description

The JSON_DECODE function retrieves the value of the given variable name and parses it as JSON, returning the value at a specified key. If the key cannot be found, an empty string is returned.

Syntax

JSON_DECODE(varname,item,[separator,[options]])

Arguments

varname - The name of the variable containing the JSON string to parse.
item - The name of the key whose value to return.
Multiple keys can be listed separated by a hierarchy delimeter, which will recursively index into a nested JSON string to retrieve a specific subkey's value.
separator - A single character that delimits a key hierarchy for nested indexing. Default is a period (.)
This value should not appear in the key or hierarchy of keys itself, except to delimit the hierarchy of keys.
options
- c - For keys that reference a JSON array, return the number of items in the array.
  This option has no effect on any other type of value.

RESONANCE_FILTER()

Synopsis

Apply a resonance filter to a channel.

Description

Applies a resonance filter to a channel in either the receive or transmit direction.

Specify the frequency at which to operate the filter or empty to remove an existing filter.

For example:

Example: Resonance filter at 3700 Hz in the TX direction

	same => n,Set(RESONANCE_FILTER(t)=3700)

Example: Disable filtering at 3700 Hz

	same => n,Set(RESONANCE_FILTER(t)=)

Syntax

RESONANCE_FILTER(frequency,[options])

Arguments

frequency - Must be the frequency to attenuate.
options
- r - Apply the resonance filter for received frames, rather than transmitted frames. Default is both directions.
- t - Apply the resonance filter for transmitted frames, rather than received frames. Default is both directions.

SRVQUERY()

Synopsis

Initiate an SRV query.

Description

This will do an SRV lookup of the given service.

Syntax

SRVQUERY(service)

Arguments

service - The service for which to look up SRV records. An example would be something like _sip._udp.example.com

SRVRESULT()

Synopsis

Retrieve results from an SRVQUERY.

Description

This function will retrieve results from a previous use of the SRVQUERY function.

Syntax

SRVRESULT(id,resultnum,[field])

Arguments

id - The identifier returned by the SRVQUERY function.
resultnum - The number of the result that you want to retrieve.
Results start at 1. If this argument is specified as getnum, then it will return the total number of results that are available.
field - The field of the result to retrieve.
The fields that can be retrieved are:
- host
- port
- priority
- weight

ODBC_FETCH()

Synopsis

Fetch a row from a multirow query.

Description

For queries which are marked as mode=multirow, the original query returns a result-id from which results may be fetched. This function implements the actual fetch of the results.

This also sets ODBC_FETCH_STATUS.

ODBC_FETCH_STATUS
- SUCESS - If rows are available.
- FAILURE - If no rows are available.

Syntax

ODBC_FETCH(result-id)

Arguments

result-id

SQL_ESC()

Synopsis

Escapes single ticks for use in SQL statements.

Description

Used in SQL templates to escape data which may contain single ticks ' which are otherwise used to delimit data.

Example: Escape example

	SELECT foo FROM bar WHERE baz='${SQL_ESC(${ARG1})}'

Syntax

SQL_ESC(string)

Arguments

string

SQL_ESC_BACKSLASHES()

Synopsis

Escapes backslashes for use in SQL statements.

Description

Used in SQL templates to escape data which may contain backslashes \ which are otherwise used to escape data.

Example: Escape with backslashes example

	SELECT foo FROM bar WHERE baz='${SQL_ESC(${SQL_ESC_BACKSLASHES(${ARG1})})}'

Syntax

SQL_ESC_BACKSLASHES(string)

Arguments

string

VOLUME()

Synopsis

Set or get the TX or RX volume of a channel.

Description

The VOLUME function can be used to increase or decrease the tx or rx gain of any channel.

Example: Increase volume

	same => n,Set(VOLUME(TX)=3)

Example: Increase volume

	same => n,Set(VOLUME(RX)=2)

Example: Increase volume with DTMF control

	same => n,Set(VOLUME(TX,p)=3)

Example: Increase RX volume with DTMF control

	same => n,Set(VOLUME(RX,p)=3)

Example: Decrease RX volume

	same => n,Set(VOLUME(RX)=-4)

Example: Reset to normal

	same => n,Set(VOLUME(RX)=0)

Syntax

VOLUME(direction,[options])

Arguments

direction - Must be TX or RX.
options
- p - Enable DTMF volume control

AMI_CLIENT()

Synopsis

Checks attributes of manager accounts

Description

Currently, the only supported parameter is "sessions" which will return the current number of active sessions for this AMI account.

Syntax

AMI_CLIENT(loginname,field)

Arguments

loginname - Login name, specified in manager.conf
field - The manager account attribute to return
- sessions - The number of sessions for this AMI account

EXCEPTION()

Synopsis

Retrieve the details of the current dialplan exception.

Description

Retrieve the details (specified field) of the current dialplan exception.

Syntax

EXCEPTION(field)

Arguments

field - The following fields are available for retrieval:
- reason - INVALID, ERROR, RESPONSETIMEOUT, ABSOLUTETIMEOUT, or custom value set by the RaiseException() application
- context - The context executing when the exception occurred.
- exten - The extension executing when the exception occurred.
- priority - The numeric priority executing when the exception occurred.

TESTTIME()

Synopsis

Sets a time to be used with the channel to test logical conditions.

Description

To test dialplan timing conditions at times other than the current time, use this function to set an alternate date and time. For example, you may wish to evaluate whether a location will correctly identify to callers that the area is closed on Christmas Day, when Christmas would otherwise fall on a day when the office is normally open.

Syntax

TESTTIME(date,time,[zone])

Arguments

date - Date in ISO 8601 format
time - Time in HH:MM:SS format (24-hour time)
zone - Timezone name

FEATURE()

Synopsis

Get or set a feature option on a channel.

Description

When this function is used as a read, it will get the current value of the specified feature option for this channel. It will be the value of this option configured in features.conf if a channel specific value has not been set. This function can also be used to set a channel specific value for the supported feature options.

Syntax

FEATURE(option_name)

Arguments

option_name - The allowed values are:
- inherit - Inherit feature settings made in FEATURE or FEATUREMAP to child channels.
- featuredigittimeout
- transferdigittimeout
- atxfernoanswertimeout
- atxferdropcall
- atxferloopdelay
- atxfercallbackretries
- xfersound
- xferfailsound
- atxferabort
- atxfercomplete
- atxferthreeway
- pickupexten
- pickupsound
- pickupfailsound
- courtesytone
- recordingfailsound
- transferdialattempts
- transferretrysound
- transferinvalidsound
- transferannouncesound

FEATUREMAP()

Synopsis

Get or set a feature map to a given value on a specific channel.

Description

When this function is used as a read, it will get the current digit sequence mapped to the specified feature for this channel. This value will be the one configured in features.conf if a channel specific value has not been set. This function can also be used to set a channel specific value for a feature mapping.

Syntax

FEATUREMAP(feature_name)

Arguments

feature_name - The allowed values are:
- atxfer - Attended Transfer
- blindxfer - Blind Transfer
- automon - Auto Monitor
- disconnect - Call Disconnect
- parkcall - Park Call
- automixmon - Auto MixMonitor

MESSAGE()

Synopsis

Create a message or read fields from a message.

Description

This function will read from or write a value to a text message. It is used both to read the data out of an incoming message, as well as modify or create a message that will be sent outbound.

Syntax

MESSAGE(argument)

Arguments

argument - Field of the message to get or set.
- to - When processing an incoming message, this will be set to the destination listed as the recipient of the message that was received by Asterisk.
  
  For an ourgoing message, this will set the To header in the outgoing SIP message. This may be overridden by the "to" parameter of MessageSend.
- from - When processing an incoming message, this will be set to the source of the message.
  
  For an ourgoing message, this will set the From header in the outgoing SIP message. This may be overridden by the "from" parameter of MessageSend.
- custom_data - Write-only. Mark or unmark all message headers for an outgoing message. The following values can be set:
  - mark_all_outbound - Mark all headers for an outgoing message.
  - clear_all_outbound - Unmark all headers for an outgoing message.
- body - Read/Write. The message body. When processing an incoming message, this includes the body of the message that Asterisk received. When MessageSend() is executed, the contents of this field are used as the body of the outgoing message. The body will always be UTF-8.

MESSAGE_DATA()

Synopsis

Read or write custom data attached to a message.

Description

This function will read from or write a value to a text message. It is used both to read the data out of an incoming message, as well as modify a message that will be sent outbound.

If you want to set an outbound message to carry data in the current message, do Set(MESSAGE_DATA(key)=${MESSAGE_DATA(key)}).

Syntax

MESSAGE_DATA(argument)

Arguments

argument - Field of the message to get or set.

PP_EACH_EXTENSION()

Synopsis

Execute specified template for each extension.

Description

Output the specified template for each extension associated with the specified MAC address.

Syntax

PP_EACH_EXTENSION(mac,template_file)

Arguments

mac
template_file

PP_EACH_USER()

Synopsis

Generate a string for each phoneprov user.

Description

Pass in a string, with phoneprov variables you want substituted in the format of %{VARNAME}, and you will get the string rendered for each user in phoneprov excluding ones with MAC address exclude_mac. Probably not useful outside of res_phoneprov.

Example: ${PP_EACH_USER(%{DISPLAY_NAME}|${MAC})

Syntax

PP_EACH_USER(string,exclude_mac)

Arguments

string
exclude_mac

MUTEAUDIO()

Synopsis

Muting audio streams in the channel

Description

The MUTEAUDIO function can be used to mute inbound (to the PBX) or outbound audio in a call.

Example: Mute incoming audio

	exten => s,1,Set(MUTEAUDIO(in)=on)

Example: Do not mute incoming audio

	exten => s,1,Set(MUTEAUDIO(in)=off)

Syntax

MUTEAUDIO(direction)

Arguments

direction - Must be one of
- in - Inbound stream (to the PBX)
- out - Outbound stream (from the PBX)
- all - Both streams

SMDI_MSG_RETRIEVE()

Synopsis

Retrieve an SMDI message.

Description

This function is used to retrieve an incoming SMDI message. It returns an ID which can be used with the SMDI_MSG() function to access details of the message. Note that this is a destructive function in the sense that once an SMDI message is retrieved using this function, it is no longer in the global SMDI message queue, and can not be accessed by any other Asterisk channels. The timeout for this function is optional, and the default is 3 seconds. When providing a timeout, it should be in milliseconds.

The default search is done on the forwarding station ID. However, if you set one of the search key options in the options field, you can change this behavior.

Syntax

SMDI_MSG_RETRIEVE(smdi port,search key,[timeout,[options]])

Arguments

smdi port
search key
timeout
options

SMDI_MSG()

Synopsis

Retrieve details about an SMDI message.

Description

This function is used to access details of an SMDI message that was pulled from the incoming SMDI message queue using the SMDI_MSG_RETRIEVE() function.

Syntax

SMDI_MSG(message_id,component)

Arguments

message_id
component - Valid message components are:
- number - The message desk number
- terminal - The message desk terminal
- station - The forwarding station
- callerid - The callerID of the calling party that was forwarded
- type - The call type. The value here is the exact character that came in on the SMDI link. Typically, example values are:
  Options:
  - D - Direct Calls
  - A - Forward All Calls
  - B - Forward Busy Calls
  - N - Forward No Answer Calls

COIN_DETECT()

Synopsis

Asynchronously detect coin deposits

Description

The COIN_DETECT function detects coin denomination tones and keeps track of how many times the tone has been detected.

When reading this function (instead of writing), supply tx to get the number of times a tone has been detected in the TX direction and rx to get the number of times a tone has been detected in the RX direction.

Accuracy of detection may vary with environment and is not guaranteed.

Nickels, dimes, and quarters are supported, though nickels and dimes work best. Dollar coins are not currently supported.

Example: intercept2600

	same => n,Set(COIN_DETECT(a(10)d(5)g(got-2600,s,1))=) ; wait for 10 cents, with 5 second grace period
	for overtime deposits, and redirect to got-2600,s,1 afterwards
	same => n,Wait(15) ; wait 15 seconds for deposits
	same => n,NoOp(${COIN_DETECT(rx)}) ; amount, in cents, that has been deposited

Example: removedetector

	same => n,Set(COIN_DETECT(x)=) ; remove the detector from the channel

Syntax

COIN_DETECT([options])

Arguments

options
- a - Minimum deposit required (subject to the provided timeout) before going to the destination provided in the g or h option. Default is none (collect deposits indefinitely).
- d - Delay threshold to use after the condition has matched to allow for additional deposits to be received. Default is 0 (no delay).
- f - Flexible detection: if 3 are more coin denomination beeps are detected in a single instance, round up as a quarter. This can be helpful if quarters are underdetected.
- g - Go to the specified context,exten,priority if tone is received on this channel. Detection will not end automatically.
- h - Go to the specified context,exten,priority if tone is transmitted on this channel. Detection will not end automatically.
- l - Relax coin denomination tone detection. This option may be necessary for detection of tones present in bidirectional or non-ideal audio.
- r - Apply to received frames only. Default is both directions.
- s - Target single-frequency totalizers (2200 Hz). Default is dual-frequency 1700 + 2200 Hz.
- t - Apply to transmitted frames only. Default is both directions.
- x - Destroy the detector (stop detection).

COIN_EIS()

Synopsis

Set up a channel for Expanded In-Band Signaling

Description

The COIN_EIS function setups an asynchronous framehook that activates Expanded In-Band Signaling on the channel. This should only be used on the slave end of an EIS Feature Group C trunk, at a Class 5 office. For the master end (Class 4 office), use CoinDisposition instead.

When a coin disposition is received from the master side of the trunk, a CoinDisposition AMI event is emitted. This can then be used to control the appropriate coin controller interface of the line associated with the slave channel, according to the disposition.

Example: Enable EIS on a slave channel

	same => n,Set(COIN_EIS()=TX) ; enable EIS signaling

Syntax

COIN_EIS([direction])

Arguments

direction - Direction for EIS.
- TX - TX direction. This is on audio transmitted towards the caller, or in other words, audio received from the called party (far end). This is the default.
- RX - RX direction. This is on audio received from the caller, or in other words, audio transmitted to the called party.
- remove - Remove an existing EIS hook.

PHREAKNET()

Synopsis

PhreakNet lookup and CDR function

Description

Usage varies depending on the property chosen.

Example: Enable PhreakNet CDR on a channel

	same => n,Set(PHREAKNET(CDR)=${EXTEN})

Syntax

PHREAKNET(property,args)

Arguments

property - Must be one of the following:
- lookup - Perform a lookup for a PhreakNet number
- cdr - Enable PhreakNet CDR on the channel
args - Argument to the above property.

ODBC()

Synopsis

Controls ODBC transaction properties.

Description

The ODBC() function allows setting several properties to influence how a connected database processes transactions.

Syntax

ODBC(property,[argument])

Arguments

property
argument

JABBER_RECEIVE()

Synopsis

Reads XMPP messages.

Description

Receives a text message on the given account from the buddy identified by jid and returns the contents.

The example below returns an XMPP message sent from [email protected] (or nothing in case of a time out), to the asterisk XMPP account configured in xmpp.conf.

Example: Receive a message

	same => n,Set(msg=${JABBER_RECEIVE(asterisk,[email protected])})

Syntax

JABBER_RECEIVE(account,jid,[timeout])

Arguments

account - The local named account to listen on (specified in xmpp.conf)
jid - Jabber ID of the buddy to receive message from. It can be a bare JID (username@domain) or a full JID (username@domain/resource).
timeout - In seconds, defaults to 20.

JABBER_STATUS()

Synopsis

Retrieves a buddy's status.

Description

Retrieves the numeric status associated with the buddy identified by jid. The return value will be one of the following.

Syntax

JABBER_STATUS(account,jid)

Arguments

account - The local named account to listen on (specified in xmpp.conf)
jid - Jabber ID of the buddy to receive message from. It can be a bare JID (username@domain) or a full JID (username@domain/resource).

CALENDAR_BUSY()

Synopsis

Determine if the calendar is marked busy at this time.

Description

Check the specified calendar's current busy status.

Syntax

CALENDAR_BUSY(calendar)

Arguments

calendar

CALENDAR_EVENT()

Synopsis

Get calendar event notification data from a notification call.

Description

Whenever a calendar event notification call is made, the event data may be accessed with this function.

Syntax

CALENDAR_EVENT(field)

Arguments

field

CALENDAR_QUERY()

Synopsis

Query a calendar server and store the data on a channel

Description

Get a list of events in the currently accessible timeframe of the calendar The function returns the id for accessing the result with CALENDAR_QUERY_RESULT()

Syntax

CALENDAR_QUERY(calendar,[start,[end]])

Arguments

calendar - The calendar that should be queried
start - The start time of the query (in seconds since epoch)
end - The end time of the query (in seconds since epoch)

CALENDAR_QUERY_RESULT()

Synopsis

Retrieve data from a previously run CALENDAR_QUERY() call

Description

After running CALENDAR_QUERY and getting a result id, calling CALENDAR_QUERY with that id and a field will return the data for that field. If multiple events matched the query, and entry is provided, information from that event will be returned.

Syntax

CALENDAR_QUERY_RESULT(id,field,[entry])

Arguments

id - The query ID returned by CALENDAR_QUERY
field
entry - Return data from a specific event returned by the query

CALENDAR_WRITE()

Synopsis

Write an event to a calendar

Description

The field and value arguments can easily be set/passed using the HASHKEYS() and HASH() functions

Example: Set calendar fields

	same => n,Set(CALENDAR_WRITE(calendar,field1,field2,field3)=val1,val2,val3)

CALENDAR_SUCCESS - The status of the write operation to the calendar
- 1 - The event was successfully written to the calendar.
- 0 - The event was not written to the calendar due to network issues, permissions, etc.

Syntax

CALENDAR_WRITE(calendar,field)

Arguments

calendar - The calendar to write to
field

FAXOPT()

Synopsis

Gets/sets various pieces of information about a fax session.

Description

FAXOPT can be used to override the settings for a FAX session listed in res_fax.conf, it can also be used to retrieve information about a FAX session that has finished eg. pages/status.

Syntax

FAXOPT(item)

Arguments

item

TONE_DETECT()

Synopsis

Asynchronously detects a tone

Description

The TONE_DETECT function detects a single-frequency tone and keeps track of how many times the tone has been detected.

Example: intercept2600

	same => n,Set(TONE_DETECT(2600,1000,g(got-2600,s,1))=) ; detect 2600 Hz
	same => n,Wait(15)
	same => n,NoOp(${TONE_DETECT(rx)})

Example: dropondialtone

	same => n,Set(TONE_DETECT(0,,bg(my-hangup,s,1))=) ; disconnect a call if we hear a busy signal
	same => n,Goto(somewhere-else)
	same => n(myhangup),Hangup()

Example: removedetector

	same => n,Set(TONE_DETECT(0,,x)=) ; remove the detector from the channel

Syntax

TONE_DETECT(freq,[duration_ms,[options]])

Arguments

freq - Frequency of the tone to detect. To disable frequency detection completely (e.g. for signal detection only), specify 0 for the frequency.
duration_ms - Minimum duration of tone, in ms. Default is 500ms. Using a minimum duration under 50ms is unlikely to produce accurate results.
options
- a - Match immediately on Special Information Tones, instead of or in addition to a particular frequency.
- b - Match immediately on a busy signal, instead of or in addition to a particular frequency.
- c - Match immediately on a dial tone, instead of or in addition to a particular frequency.
- d - Custom decibel threshold to use. Default is 16.
- g - Go to the specified context,exten,priority if tone is received on this channel. Detection will not end automatically.
- h - Go to the specified context,exten,priority if tone is transmitted on this channel. Detection will not end automatically.
- n - Number of times the tone should be detected (subject to the provided timeout) before going to the destination provided in the g or h option. Default is 1.
- p - Match immediately on audible ringback tone, instead of or in addition to a particular frequency.
- r - Apply to received frames only. Default is both directions.
- s - Squelch tone.
- t - Apply to transmitted frames only. Default is both directions.
- x - Destroy the detector (stop detection).

STIR_SHAKEN()

Synopsis

Gets the number of STIR/SHAKEN results or a specific STIR/SHAKEN value from a result on the channel.

Description

This function will either return the number of STIR/SHAKEN identities, or return information on the specified identity. To get the number of identities, just pass 'count' as the only parameter to the function. If you want to get information on a specific STIR/SHAKEN identity, you can get the number of identities and then pass an index as the first parameter and one of the values you would like to retrieve as the second parameter.

Example: Get count and retrieve value

	same => n,NoOp(Number of STIR/SHAKEN identities: ${STIR_SHAKEN(count)})
	same => n,NoOp(Identity ${STIR_SHAKEN(0, identity)} has attestation level ${STIR_SHAKEN(0, attestation)})

Syntax

STIR_SHAKEN(index,[value])

Arguments

index - The index of the STIR/SHAKEN result to get. If only 'count' is passed in, gets the number of STIR/SHAKEN results instead.
value - The value to get from the STIR/SHAKEN result. Only used when an index is passed in (instead of 'count'). Allowable values:
- identity
- attestation
- verify_result

PARK_GET_CHANNEL()

Synopsis

Get the channel name of an occupied parking space in a parking lot.

Description

This function returns the channel of the specified parking space if the parking lot space is occupied.

Syntax

PARK_GET_CHANNEL(parking_space,parking_lot)

Arguments

parking_space
parking_lot

PJSIP_HEADER()

Synopsis

Gets headers from an inbound PJSIP channel. Adds, updates or removes the specified SIP header from an outbound PJSIP channel.

Description

PJSIP_HEADER allows you to read specific SIP headers from the inbound PJSIP channel as well as write(add, update, remove) headers on the outbound channel. One exception is that you can read headers that you have already added on the outbound channel.

Examples:

The remove action can be called by reading or writing PJSIP_HEADER.

If you call PJSIP_HEADER in a normal dialplan context you'll be operating on the caller's (incoming) channel which may not be what you want. To operate on the callee's (outgoing) channel call PJSIP_HEADER in a pre-dial handler.

Example: Set somevar to the value of the From header

	exten => 1,1,Set(somevar=${PJSIP_HEADER(read,From)})

Example: Set via2 to the value of the 2nd Via header

	exten => 1,1,Set(via2=${PJSIP_HEADER(read,Via,2)})

Example: Set xhdr to the value of the 1st X-header

	exten => 1,1,Set(xhdr=${PJSIP_HEADER(read,X-*,1)})

Example: Add an X-Myheader header with the value of myvalue

	exten => 1,1,Set(PJSIP_HEADER(add,X-MyHeader)=myvalue)

Example: Add an X-Myheader header with an empty value

	exten => 1,1,Set(PJSIP_HEADER(add,X-MyHeader)=)

Example: Update the value of the header named X-Myheader to newvalue

	; 'X-Myheader' must already exist or the call will fail.

	exten => 1,1,Set(PJSIP_HEADER(update,X-MyHeader)=newvalue)

Example: Remove all headers whose names exactly match X-MyHeader

	exten => 1,1,Set(PJSIP_HEADER(remove,X-MyHeader)=)

Example: Remove all headers that begin with X-My

	exten => 1,1,Set(PJSIP_HEADER(remove,X-My*)=)

Example: Remove all previously added headers

	exten => 1,1,Set(PJSIP_HEADER(remove,*)=)

Example: Display the number of headers removed

	exten => 1,1,Verbose( Removed ${PJSIP_HEADER(remove,X-MyHeader)} headers)

Example: Set a variable to the number of headers removed

	exten => 1,1,Set(count=${PJSIP_HEADER(remove,X-MyHeader)})

Example: Just remove them ignoring any count

	exten => 1,1,Set(=${PJSIP_HEADER(remove,X-MyHeader)})

	exten => 1,1,Set(PJSIP_HEADER(remove,X-MyHeader)=)

Example: Set headers on callee channel

	[handler]

	exten => addheader,1,Set(PJSIP_HEADER(add,X-MyHeader)=myvalue)

	exten => addheader,2,Set(PJSIP_HEADER(add,X-MyHeader2)=myvalue2)
	
	[somecontext]

	exten => 1,1,Dial(PJSIP/${EXTEN},,b(handler^addheader^1))

Syntax

PJSIP_HEADER(action,name,[number])

Arguments

action
name - The name of the header.
number - If there's more than 1 header with the same name, this specifies which header to read or update. If not specified, defaults to 1 meaning the first matching header. Not valid for add or remove.

PJSIP_HEADERS()

Synopsis

Gets the list of SIP header names from an INVITE message.

Description

Returns a comma-separated list of header names (without values) from the INVITE message. Multiple headers with the same name are included in the list only once.

For example, ${PJSIP_HEADERS(Co)} might return Contact,Content-Length,Content-Type. As a practical example, you may use ${PJSIP_HEADERS(X-)} to enumerate optional extended headers.

Syntax

PJSIP_HEADERS([prefix])

Arguments

prefix - If specified, only the headers matching the given prefix are returned.

PJSIP_RESPONSE_HEADER()

Synopsis

Gets headers of 200 response from an outbound PJSIP channel.

Description

PJSIP_RESPONSE_HEADER allows you to read specific SIP headers of 200 response from the outbound PJSIP channel.

Examples:

If you call PJSIP_RESPONSE_HEADER in a normal dialplan context you'll be operating on the caller's (incoming) channel which may not be what you want. To operate on the callee's (outgoing) channel call PJSIP_RESPONSE_HEADER in a pre-connect handler.

Example: Set 'somevar' to the value of the 'From' header

	exten => 1,1,Set(somevar=${PJSIP_RESPONSE_HEADER(read,From)})

Example: Set 'via2' to the value of the 2nd 'Via' header

	exten => 1,1,Set(via2=${PJSIP_RESPONSE_HEADER(read,Via,2)})

Example: Set 'xhdr' to the value of the 1sx X-header

	exten => 1,1,Set(xhdr=${PJSIP_RESPONSE_HEADER(read,X-*,1)})

Example: Usage on pre-connect handler

	[handler]

	exten => readheader,1,NoOp(PJSIP_RESPONSE_HEADER(read,X-MyHeader))
	[somecontext]

	exten => 1,1,Dial(PJSIP/${EXTEN},,U(handler^readheader^1))

Syntax

PJSIP_RESPONSE_HEADER(action,name,[number])

Arguments

action
name - The name of the response header. A * can be appended to the name to iterate over all response headers beginning with name.
number - If there's more than 1 header with the same name, this specifies which header to read. If not specified, defaults to 1 meaning the first matching header.

PJSIP_RESPONSE_HEADERS()

Synopsis

Gets the list of SIP header names from the 200 response of INVITE message.

Description

Returns a comma-separated list of header names (without values) from the 200 response of INVITE message. Multiple headers with the same name are included in the list only once.

For example, ${PJSIP_RESPONSE_HEADERS(Co)} might return Contact,Content-Length,Content-Type. As a practical example, you may use ${PJSIP_RESPONSE_HEADERS(X-)} to enumerate optional extended headers.

Syntax

PJSIP_RESPONSE_HEADERS([prefix])

Arguments

prefix - If specified, only the headers matching the given prefix are returned.

PJSIP_HEADER_PARAM()

Synopsis

Get or set header/URI parameters on a PJSIP channel.

Description

PJSIP_HEADER_PARAM allows you to read or set parameters in a SIP header on a PJSIP channel.

Both URI parameters and header parameters can be read and set using this function. URI parameters appear in the URI (inside the <> in the header) while header parameters appear afterwards.

If you call PJSIP_HEADER_PARAM in a normal dialplan context you'll be operating on the caller's (incoming) channel which may not be what you want. To operate on the callee's (outgoing) channel call PJSIP_HEADER_PARAM in a pre-dial handler.

Example: Set URI parameter in From header on outbound channel

	[handler]

	exten => addheader,1,Set(PJSIP_HEADER_PARAM(From,uri,isup-oli)=27)
	same => n,Return()
	[somecontext]

	exten => 1,1,Dial(PJSIP/${EXTEN},,b(handler^addheader^1))

Example: Read URI parameter in From header on inbound channel

	same => n,Set(value=${PJSIP_HEADER_PARAM(From,uri,isup-oli)})

Syntax

PJSIP_HEADER_PARAM(header_name,parameter_type,parameter_name)

Arguments

header_name - Header in which parameter should be read or set.
Currently, the only supported header is From.
parameter_type - The type of parameter to get or set.
Default is header parameter.
- header - Header parameter.
- uri - URI parameter.
parameter_name - Name of parameter.

GEOLOC_PROFILE()

Synopsis

Get or Set a field in a geolocation profile

Description

When used to set a parameter on a profile, if the profile doesn't already exist, a new one will be created automatically.

The ${GEOLOCPROFILESTATUS} channel variable will be set with a return code indicating the result of the operation. Possible values are:

Syntax

GEOLOC_PROFILE(parameter,[options])

Arguments

parameter - The profile parameter to operate on. The following fields from the Location and Profile objects are supported.
Additionally, the inheritable field may be set to true or false to control whether the profile will be passed to the outgoing channel.
- id
- location_reference
- method
- allow_routing_use
- profile_precedence
- format
- pidf_element
- location_source
- notes
- location_info
- location_info_refinement
- location_variables
- effective_location
- usage_rules
- confidence
options
- a - Append provided value to the specified parameter instead of replacing the existing value. This only applies to variable list parameters like location_info_refinement.
- r - Before reading or after writing the specified parameter, re-resolve the effective_location and usage_rules parameters using the location_variables parameter and the variables set on the channel in effect at the time this function is called.

SIPpeers

Synopsis

List SIP peers (text format).

Description

Lists SIP peers in text format with details on current status. Peerlist will follow as separate events, followed by a final event called PeerlistComplete.

SIPshowpeer

Synopsis

show SIP peer (text format).

Description

Show one SIP peer with details on current status.

Syntax

SIPshowpeer(Peer)

Arguments

Peer - The peer name you want to check.

SIPqualifypeer

Synopsis

Qualify SIP peers.

Description

Qualify a SIP peer.

Syntax

SIPqualifypeer(Peer)

Arguments

Peer - The peer name you want to qualify.

SIPshowregistry

Synopsis

Show SIP registrations (text format).

Description

Lists all registration requests and status. Registrations will follow as separate events followed by a final event called RegistrationsComplete.

SIPnotify

Synopsis

Send a SIP notify.

Description

Sends a SIP Notify event.

All parameters for this event must be specified in the body of this request via multiple Variable: name=value sequences.

Syntax

SIPnotify(Channel,Variable,[Call-ID])

Arguments

Channel - Peer to receive the notify.
Variable - At least one variable pair must be specified. name=value
Call-ID - When specified, SIP notity will be sent as a part of an existing dialog.

SIPpeerstatus

Synopsis

Show the status of one or all of the sip peers.

Description

Retrieves the status of one or all of the sip peers. If no peer name is specified, status for all of the sip peers will be retrieved.

Syntax

SIPpeerstatus([Peer])

Arguments

Peer - The peer name you want to check.

DAHDITransfer

Synopsis

Transfer DAHDI Channel.

Description

Simulate a flash hook event by the user connected to the channel.

Valid only for analog channels.

Syntax

DAHDITransfer(DAHDIChannel)

Arguments

DAHDIChannel - DAHDI channel number to transfer.

DAHDIHangup

Synopsis

Hangup DAHDI Channel.

Description

Simulate an on-hook event by the user connected to the channel.

Valid only for analog channels.

Syntax

DAHDIHangup(DAHDIChannel)

Arguments

DAHDIChannel - DAHDI channel number to hangup.

DAHDIDialOffhook

Synopsis

Dial over DAHDI channel while offhook.

Description

Generate DTMF control frames to the bridged peer.

Syntax

DAHDIDialOffhook(DAHDIChannel,Number)

Arguments

DAHDIChannel - DAHDI channel number to dial digits.
Number - Digits to dial.

DAHDIDNDon

Synopsis

Toggle DAHDI channel Do Not Disturb status ON.

Description

Equivalent to the CLI command "dahdi set dnd on".

Feature only supported by analog channels.

Syntax

DAHDIDNDon(DAHDIChannel)

Arguments

DAHDIChannel - DAHDI channel number to set DND on.

DAHDIDNDoff

Synopsis

Toggle DAHDI channel Do Not Disturb status OFF.

Description

Equivalent to the CLI command "dahdi set dnd off".

Feature only supported by analog channels.

Syntax

DAHDIDNDoff(DAHDIChannel)

Arguments

DAHDIChannel - DAHDI channel number to set DND off.

DAHDIShowChannels

Synopsis

Show status of DAHDI channels.

Description

Similar to the CLI command "dahdi show channels".

Syntax

DAHDIShowChannels([DAHDIChannel])

Arguments

DAHDIChannel - Specify the specific channel number to show. Show all channels if zero or not present.

DAHDIRestart

Synopsis

Fully Restart DAHDI channels (terminates calls).

Description

Equivalent to the CLI command "dahdi restart".

PRIShowSpans

Synopsis

Show status of PRI spans.

Description

Similar to the CLI command "pri show spans".

Syntax

PRIShowSpans([Span])

Arguments

Span - Specify the specific span to show. Show all spans if zero or not present.

PRIDebugSet

Synopsis

Set PRI debug levels for a span

Description

Equivalent to the CLI command "pri set debug span ".

Syntax

PRIDebugSet(Span,Level)

Arguments

Span - Which span to affect.
Level - What debug level to set. May be a numerical value or a text value from the list below
- off
- on
- hex
- intense

PRIDebugFileSet

Synopsis

Set the file used for PRI debug message output

Description

Equivalent to the CLI command "pri set debug file "

Syntax

PRIDebugFileSet(File)

Arguments

File - Path of file to write debug output.

PRIDebugFileUnset

Synopsis

Disables file output for PRI debug messages

Description

SKINNYdevices

Synopsis

List SKINNY devices (text format).

Description

Lists Skinny devices in text format with details on current status. Devicelist will follow as separate events, followed by a final event called DevicelistComplete.

SKINNYshowdevice

Synopsis

Show SKINNY device (text format).

Description

Show one SKINNY device with details on current status.

Syntax

SKINNYshowdevice(Device)

Arguments

Device - The device name you want to check.

SKINNYlines

Synopsis

List SKINNY lines (text format).

Description

Lists Skinny lines in text format with details on current status. Linelist will follow as separate events, followed by a final event called LinelistComplete.

SKINNYshowline

Synopsis

Show SKINNY line (text format).

Description

Show one SKINNY line with details on current status.

Syntax

SKINNYshowline(Line)

Arguments

Line - The line name you want to check.

IAXpeers

Synopsis

List IAX peers.

Description

IAXpeerlist

Synopsis

List IAX Peers.

Description

List all the IAX peers.

IAXnetstats

Synopsis

Show IAX Netstats.

Description

Show IAX channels network statistics.

IAXregistry

Synopsis

Show IAX registrations.

Description

Show IAX registrations.

DialplanExtensionAdd

Synopsis

Add an extension to the dialplan

Description

Syntax

DialplanExtensionAdd(Context,Extension,Priority,Application,[ApplicationData,[Replace]])

Arguments

Context - Context where the extension will be created. The context will be created if it does not already exist.
Extension - Name of the extension that will be created (may include callerid match by separating with '/')
Priority - Priority being added to this extension. Must be either hint or a numerical value.
Application - The application to use for this extension at the requested priority
ApplicationData - Arguments to the application.
Replace - If set to 'yes', '1', 'true' or any of the other values we evaluate as true, then if an extension already exists at the requested context, extension, and priority it will be overwritten. Otherwise, the existing extension will remain and the action will fail.

DialplanExtensionRemove

Synopsis

Remove an extension from the dialplan

Description

Syntax

DialplanExtensionRemove(Context,Extension,[Priority])

Arguments

Context - Context of the extension being removed
Extension - Name of the extension being removed (may include callerid match by separating with '/')
Priority - If provided, only remove this priority from the extension instead of all priorities in the extension.

VoicemailUsersList

Synopsis

List All Voicemail User Information.

Description

VoicemailUserStatus

Synopsis

Show the status of given voicemail user's info.

Description

Retrieves the status of the given voicemail user.

Syntax

VoicemailUserStatus(Context,Mailbox)

Arguments

Context - The context you want to check.
Mailbox - The mailbox you want to check.

VoicemailRefresh

Synopsis

Tell Asterisk to poll mailboxes for a change

Description

Normally, MWI indicators are only sent when Asterisk itself changes a mailbox. With external programs that modify the content of a mailbox from outside the application, an option exists called pollmailboxes that will cause voicemail to continually scan all mailboxes on a system for changes. This can cause a large amount of load on a system. This command allows external applications to signal when a particular mailbox has changed, thus permitting external applications to modify mailboxes and MWI to work without introducing considerable CPU load.

If Context is not specified, all mailboxes on the system will be polled for changes. If Context is specified, but Mailbox is omitted, then all mailboxes within Context will be polled. Otherwise, only a single mailbox will be polled for changes.

Syntax

VoicemailRefresh([Context,[Mailbox]])

Arguments

Context
Mailbox

PlayMF

Synopsis

Play MF digit on a specific channel.

Description

Plays an MF digit on the specified channel.

Syntax

PlayMF(Channel,Digit,[Duration])

Arguments

Channel - Channel name to send digit to.
Digit - The MF digit to play.
Duration - The duration, in milliseconds, of the digit to be played.

TddTx

Synopsis

Send a TDD message on a channel.

Description

This action sends a message via TDD/TTY tones on the current channel. If TDD processing is not enabled on the channel an error will be returned.

Syntax

TddTx(Channel,Message)

Arguments

Channel - The name of the channel to send on.
Message - The message to be sent.

TddRx

Synopsis

Enable TDD transmit/receive processing on a channel.

Description

This action is exactly the same as the dialplan command of the same name - it enables TDD processing on the specified channel.

Syntax

TddRx(Channel,[Options])

Arguments

Channel - The name of the channel to enable TDD processing on.
Options - Options string, using the same syntax as the TddRx dialplan app.

PlayDTMF

Synopsis

Play DTMF signal on a specific channel.

Description

Plays a dtmf digit on the specified channel.

Syntax

PlayDTMF(Channel,Digit,[Duration,[Receive]])

Arguments

Channel - Channel name to send digit to.
Digit - The DTMF digit to play.
Duration - The duration, in milliseconds, of the digit to be played.
Receive - Emulate receiving DTMF on this channel instead of sending it out.

SendFlash

Synopsis

Send a hook flash on a specific channel.

Description

Sends a hook flash on the specified channel.

Syntax

SendFlash(Channel,[Receive])

Arguments

Channel - Channel name to send hook flash to.
Receive - Emulate receiving a hook flash on this channel instead of sending it out.

MeetmeMute

Synopsis

Mute a Meetme user.

Description

Syntax

MeetmeMute(Meetme,Usernum)

Arguments

Meetme
Usernum

MeetmeUnmute

Synopsis

Unmute a Meetme user.

Description

Syntax

MeetmeUnmute(Meetme,Usernum)

Arguments

Meetme
Usernum

MeetmeList

Synopsis

List participants in a conference.

Description

Lists all users in a particular MeetMe conference. MeetmeList will follow as separate events, followed by a final event called MeetmeListComplete.

Syntax

MeetmeList([Conference])

Arguments

Conference - Conference number.

MeetmeListRooms

Synopsis

List active conferences.

Description

Lists data about all active conferences. MeetmeListRooms will follow as separate events, followed by a final event called MeetmeListRoomsComplete.

ConfbridgeList

Synopsis

List participants in a conference.

Description

Lists all users in a particular ConfBridge conference. ConfbridgeList will follow as separate events, followed by a final event called ConfbridgeListComplete.

Syntax

ConfbridgeList(Conference)

Arguments

Conference - Conference number.

ConfbridgeListRooms

Synopsis

List active conferences.

Description

Lists data about all active conferences. ConfbridgeListRooms will follow as separate events, followed by a final event called ConfbridgeListRoomsComplete.

ConfbridgeMute

Synopsis

Mute a Confbridge user.

Description

Syntax

ConfbridgeMute(Conference,Channel)

Arguments

Conference
Channel - If this parameter is not a complete channel name, the first channel with this prefix will be used.
If this parameter is "all", all channels will be muted.
If this parameter is "participants", all non-admin channels will be muted.

ConfbridgeUnmute

Synopsis

Unmute a Confbridge user.

Description

Syntax

ConfbridgeUnmute(Conference,Channel)

Arguments

Conference
Channel - If this parameter is not a complete channel name, the first channel with this prefix will be used.
If this parameter is "all", all channels will be unmuted.
If this parameter is "participants", all non-admin channels will be unmuted.

ConfbridgeKick

Synopsis

Kick a Confbridge user.

Description

Syntax

ConfbridgeKick(Conference,Channel)

Arguments

Conference
Channel - If this parameter is "all", all channels will be kicked from the conference.
If this parameter is "participants", all non-admin channels will be kicked from the conference.

ConfbridgeLock

Synopsis

Lock a Confbridge conference.

Description

Syntax

ConfbridgeLock(Conference)

Arguments

Conference

ConfbridgeUnlock

Synopsis

Unlock a Confbridge conference.

Description

Syntax

ConfbridgeUnlock(Conference)

Arguments

Conference

ConfbridgeStartRecord

Synopsis

Start recording a Confbridge conference.

Description

Start recording a conference. If recording is already present an error will be returned. If RecordFile is not provided, the default record file specified in the conference's bridge profile will be used, if that is not present either a file will automatically be generated in the monitor directory.

Syntax

ConfbridgeStartRecord(Conference,[RecordFile])

Arguments

Conference
RecordFile

ConfbridgeStopRecord

Synopsis

Stop recording a Confbridge conference.

Description

Syntax

ConfbridgeStopRecord(Conference)

Arguments

Conference

ConfbridgeSetSingleVideoSrc

Synopsis

Set a conference user as the single video source distributed to all other participants.

Description

Syntax

ConfbridgeSetSingleVideoSrc(Conference,Channel)

Arguments

Conference
Channel - If this parameter is not a complete channel name, the first channel with this prefix will be used.

VoicemailUsersList

Synopsis

List All Voicemail User Information.

Description

VoicemailUserStatus

Synopsis

Show the status of given voicemail user's info.

Description

Retrieves the status of the given voicemail user.

Syntax

VoicemailUserStatus(Context,Mailbox)

Arguments

Context - The context you want to check.
Mailbox - The mailbox you want to check.

VoicemailRefresh

Synopsis

Tell Asterisk to poll mailboxes for a change

Description

Syntax

VoicemailRefresh([Context,[Mailbox]])

Arguments

Context
Mailbox

ControlPlayback

Synopsis

Control the playback of a file being played to a channel.

Description

Control the operation of a media file being played back to a channel. Note that this AMI action does not initiate playback of media to channel, but rather controls the operation of a media operation that was already initiated on the channel.

The pause and restart Control options will stop a playback operation if that operation was not initiated from the ControlPlayback application or the control stream file AGI command.

Syntax

ControlPlayback(Channel,Control)

Arguments

Channel - The name of the channel that currently has a file being played back to it.
Control

Agents

Synopsis

Lists agents and their status.

Description

Will list info about all defined agents.

AgentLogoff

Synopsis

Sets an agent as no longer logged in.

Description

Sets an agent as no longer logged in.

Syntax

AgentLogoff(Agent,[Soft])

Arguments

Agent - Agent ID of the agent to log off.
Soft - Set to true to not hangup existing calls.

MixMonitorMute

Synopsis

Mute / unMute a Mixmonitor recording.

Description

This action may be used to mute a MixMonitor recording.

Syntax

MixMonitorMute(Channel,[Direction,[State]])

Arguments

Channel - Used to specify the channel to mute.
Direction - Which part of the recording to mute: read, write or both (from channel, to channel or both channels).
State - Turn mute on or off : 1 to turn on, 0 to turn off.

MixMonitor

Synopsis

Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee the audio file is available for processing during dialplan execution.

Description

This action records the audio on the current channel to the specified file.

MIXMONITOR_FILENAME - Will contain the filename used to record the mixed stream.

Syntax

MixMonitor(Channel,[File,[options,[Command]]])

Arguments

Channel - Used to specify the channel to record.
File - Is the name of the file created in the monitor spool directory. Defaults to the same name as the channel (with slashes replaced with dashes). This argument is optional if you specify to record unidirectional audio with either the r(filename) or t(filename) options in the options field. If neither MIXMONITOR_FILENAME or this parameter is set, the mixed stream won't be recorded.
options - Options that apply to the MixMonitor in the same way as they would apply if invoked from the MixMonitor application. For a list of available options, see the documentation for the mixmonitor application.
Command - Will be executed when the recording is over. Any strings matching ^{X} will be unescaped to X. All variables will be evaluated at the time MixMonitor is called.

StopMixMonitor

Synopsis

Stop recording a call through MixMonitor, and free the recording's file handle.

Description

This action stops the audio recording that was started with the MixMonitor action on the current channel.

Syntax

StopMixMonitor(Channel,[MixMonitorID])

Arguments

Channel - The name of the channel monitored.
MixMonitorID - If a valid ID is provided, then this command will stop only that specific MixMonitor.

VoicemailUsersList

Synopsis

List All Voicemail User Information.

Description

VoicemailUserStatus

Synopsis

Show the status of given voicemail user's info.

Description

Retrieves the status of the given voicemail user.

Syntax

VoicemailUserStatus(Context,Mailbox)

Arguments

Context - The context you want to check.
Mailbox - The mailbox you want to check.

VoicemailRefresh

Synopsis

Tell Asterisk to poll mailboxes for a change

Description

Syntax

VoicemailRefresh([Context,[Mailbox]])

Arguments

Context
Mailbox

QueueStatus

Synopsis

Show queue status.

Description

Check the status of one or more queues.

Syntax

QueueStatus([Queue,[Member]])

Arguments

Queue - Limit the response to the status of the specified queue.
Member - Limit the response to the status of the specified member.

QueueSummary

Synopsis

Show queue summary.

Description

Request the manager to send a QueueSummary event.

Syntax

QueueSummary([Queue])

Arguments

Queue - Queue for which the summary is requested.

QueueAdd

Synopsis

Add interface to queue.

Description

Syntax

QueueAdd(Queue,Interface,[Penalty,[Paused,[MemberName,[StateInterface]]]])

Arguments

Queue - Queue's name.
Interface - The name of the interface (tech/name) to add to the queue.
Penalty - A penalty (number) to apply to this member. Asterisk will distribute calls to members with higher penalties only after attempting to distribute calls to those with lower penalty.
Paused - To pause or not the member initially (true/false or 1/0).
MemberName - Text alias for the interface.
StateInterface

QueueRemove

Synopsis

Remove interface from queue.

Description

Syntax

QueueRemove(Queue,Interface)

Arguments

Queue - The name of the queue to take action on.
Interface - The interface (tech/name) to remove from queue.

QueuePause

Synopsis

Makes a queue member temporarily unavailable.

Description

Pause or unpause a member in a queue.

Syntax

QueuePause(Interface,Paused,[Queue,[Reason]])

Arguments

Interface - The name of the interface (tech/name) to pause or unpause.
Paused - Pause or unpause the interface. Set to 'true' to pause the member or 'false' to unpause.
Queue - The name of the queue in which to pause or unpause this member. If not specified, the member will be paused or unpaused in all the queues it is a member of.
Reason - Text description, returned in the event QueueMemberPaused.

QueueLog

Synopsis

Adds custom entry in queue_log.

Description

Syntax

QueueLog(Queue,Event,[Uniqueid,[Interface,[Message]]])

Arguments

Queue
Event
Uniqueid
Interface
Message

QueuePenalty

Synopsis

Set the penalty for a queue member.

Description

Change the penalty of a queue member

Syntax

QueuePenalty(Interface,Penalty,[Queue])

Arguments

Interface - The interface (tech/name) of the member whose penalty to change.
Penalty - The new penalty (number) for the member. Must be nonnegative.
Queue - If specified, only set the penalty for the member of this queue. Otherwise, set the penalty for the member in all queues to which the member belongs.

QueueMemberRingInUse

Synopsis

Set the ringinuse value for a queue member.

Description

Syntax

QueueMemberRingInUse(Interface,RingInUse,[Queue])

Arguments

Interface
RingInUse
Queue

QueueRule

Synopsis

Queue Rules.

Description

List queue rules defined in queuerules.conf

Syntax

QueueRule([Rule])

Arguments

Rule - The name of the rule in queuerules.conf whose contents to list.

QueueReload

Synopsis

Reload a queue, queues, or any sub-section of a queue or queues.

Description

Syntax

QueueReload([Queue,[Members,[Rules,[Parameters]]]])

Arguments

Queue - The name of the queue to take action on. If no queue name is specified, then all queues are affected.
Members - Whether to reload the queue's members.
- yes
- no
Rules - Whether to reload queuerules.conf
- yes
- no
Parameters - Whether to reload the other queue options.
- yes
- no

QueueReset

Synopsis

Reset queue statistics.

Description

Reset the statistics for a queue.

Syntax

QueueReset([Queue])

Arguments

Queue - The name of the queue on which to reset statistics.

QueueChangePriorityCaller

Synopsis

Change priority of a caller on queue.

Description

Syntax

QueueChangePriorityCaller(Queue,Caller,Priority)

Arguments

Queue - The name of the queue to take action on.
Caller - The caller (channel) to change priority on queue.
Priority - Priority value for change for caller on queue.

QueueWithdrawCaller

Synopsis

Request to withdraw a caller from the queue back to the dialplan.

Description

Syntax

QueueWithdrawCaller(Queue,Caller,[WithdrawInfo])

Arguments

Queue - The name of the queue to take action on.
Caller - The caller (channel) to withdraw from the queue.
WithdrawInfo - Optional info to store. If the call is successfully withdrawn from the queue, this information will be available in the QUEUE_WITHDRAW_INFO variable.

GroupSet

Synopsis

Add channel group assignments

Description

For more information, see the dialplan function GROUP()

Syntax

GroupSet([channel,[group,[category]]])

Arguments

channel - Channel to operate on.
group - Group name to set.
category - Category name to set.

GroupRemove

Synopsis

Remove channel group assignments

Description

For more information, see the dialplan function GROUP()

Syntax

GroupRemove([channel,[group,[category]]])

Arguments

channel - Channel to operate on.
group - Group name to remove.
category - Category name to remove.

GroupVarGet

Synopsis

Get channel group variables.

Description

At a minimum, either group or category must be provided. For more information, see the dialplan function GROUP_VAR().

Syntax

GroupVarGet([Group,[Category,]]Variable)

Arguments

Group
Category
Variable

GroupVarSet

Synopsis

Set channel group variables.

Description

At a minimum, either group or category must be provided. For more information, see the dialplan function GROUP_VAR().

Syntax

GroupVarSet([Group,[Category,]]Variable,[Value])

Arguments

Group
Category
Variable
Value

GroupsShow

Synopsis

Show channel groups. With optional filtering

Description

This will return a list of channel groups that are in use. For more information, see the dialplan function GROUP().

Syntax

GroupsShow([Group,[Category]])

Arguments

Group - The exact group name to find, or to use a regular expression: set this parameter to: /regex/
Category - The exact category to find, or to use a regular expression: set this parameter to: /regex/

GroupsShowChannels

Synopsis

Show group channel assignments. With optional filtering

Description

This will return a list the channels that are within each group. For more information, see the dialplan function GROUP().

Syntax

GroupsShowChannels([Group,[Category]])

Arguments

Group - The exact group name to find, or to use a regular expression: set this parameter to: /regex/
Category - The exact category to find, or to use a regular expression: set this parameter to: /regex/

GroupsShowVariables

Synopsis

Show group channel variable assignments.

Description

This will return a list of groups and the variables assigned in each group. For more information, see the dialplan function GROUP_VAR().

BridgeTechnologyList

Synopsis

List available bridging technologies and their statuses.

Description

Returns detailed information about the available bridging technologies.

BridgeTechnologySuspend

Synopsis

Suspend a bridging technology.

Description

Marks a bridging technology as suspended, which prevents subsequently created bridges from using it.

Syntax

BridgeTechnologySuspend(BridgeTechnology)

Arguments

BridgeTechnology - The name of the bridging technology to suspend.

BridgeTechnologyUnsuspend

Synopsis

Unsuspend a bridging technology.

Description

Clears a previously suspended bridging technology, which allows subsequently created bridges to use it.

Syntax

BridgeTechnologyUnsuspend(BridgeTechnology)

Arguments

BridgeTechnology - The name of the bridging technology to unsuspend.

BridgeList

Synopsis

Get a list of bridges in the system.

Description

Returns a list of bridges, optionally filtering on a bridge type.

Syntax

BridgeList([BridgeType])

Arguments

BridgeType - Optional type for filtering the resulting list of bridges.

BridgeInfo

Synopsis

Get information about a bridge.

Description

Returns detailed information about a bridge and the channels in it.

Syntax

BridgeInfo(BridgeUniqueid)

Arguments

BridgeUniqueid - The unique ID of the bridge about which to retrieve information.

BridgeDestroy

Synopsis

Destroy a bridge.

Description

Deletes the bridge, causing channels to continue or hang up.

Syntax

BridgeDestroy(BridgeUniqueid)

Arguments

BridgeUniqueid - The unique ID of the bridge to destroy.

BridgeKick

Synopsis

Kick a channel from a bridge.

Description

The channel is removed from the bridge.

Syntax

BridgeKick([BridgeUniqueid,]Channel)

Arguments

BridgeUniqueid - The unique ID of the bridge containing the channel to destroy. This parameter can be omitted, or supplied to insure that the channel is not removed from the wrong bridge.
Channel - The channel to kick out of a bridge.

Ping

Synopsis

Keepalive command.

Description

A 'Ping' action will elicit a 'Pong' response. Used to keep the manager connection open.

Events

Synopsis

Control Event Flow.

Description

Enable/Disable sending of events to this manager client.

Syntax

Events(EventMask)

Arguments

EventMask

Logoff

Synopsis

Logoff Manager.

Description

Logoff the current manager session.

Login

Synopsis

Description

Syntax

Login([ActionID,]Username,[Secret])

Arguments

ActionID - ActionID for this transaction. Will be returned.
Username - Username to login with as specified in manager.conf.
Secret - Secret to login with as specified in manager.conf.

Challenge

Synopsis

Generate Challenge for MD5 Auth.

Description

Generate a challenge for MD5 authentication.

Syntax

Challenge(AuthType)

Arguments

AuthType - Digest algorithm to use in the challenge. Valid values are:
- MD5

Hangup

Synopsis

Hangup channel.

Description

Hangup a channel.

Syntax

Hangup(Channel,[Cause])

Arguments

Channel - The exact channel name to be hungup, or to use a regular expression, set this parameter to: /regex/
Example exact channel: SIP/provider-0000012a
Example regular expression: /^SIP/provider-.*$/
Cause - Numeric hangup cause.

Status

Synopsis

List channel status.

Description

Will return the status information of each channel along with the value for the specified channel variables.

Syntax

Status([Channel,[Variables,[AllVariables]]])

Arguments

Channel - The name of the channel to query for status.
Variables - Comma , separated list of variable to include.
AllVariables - If set to "true", the Status event will include all channel variables for the requested channel(s).
- true
- false

Setvar

Synopsis

Sets a channel variable or function value.

Description

This command can be used to set the value of channel variables or dialplan functions.

If a channel name is not provided then the variable is considered global.

Syntax

Setvar([Channel,]Variable,Value)

Arguments

Channel - Channel to set variable for.
Variable - Variable name, function or expression.
Value - Variable or function value.

Getvar

Synopsis

Gets a channel variable or function value.

Description

Get the value of a channel variable or function return.

If a channel name is not provided then the variable is considered global.

Syntax

Getvar([Channel,]Variable)

Arguments

Channel - Channel to read variable from.
Variable - Variable name, function or expression.

GetConfig

Synopsis

Retrieve configuration.

Description

This action will dump the contents of a configuration file by category and contents or optionally by specified category only. In the case where a category name is non-unique, a filter may be specified to match only categories with matching variable values.

Syntax

GetConfig(Filename,[Category,[Filter]])

Arguments

Filename - Configuration filename (e.g. foo.conf).
Category - Category in configuration file.
Filter - A comma separated list of name_regex=value_regex expressions which will cause only categories whose variables match all expressions to be considered. The special variable name TEMPLATES can be used to control whether templates are included. Passing include as the value will include templates along with normal categories. Passing restrict as the value will restrict the operation to ONLY templates. Not specifying a TEMPLATES expression results in the default behavior which is to not include templates.

GetConfigJSON

Synopsis

Retrieve configuration (JSON format).

Description

This action will dump the contents of a configuration file by category and contents in JSON format or optionally by specified category only. This only makes sense to be used using rawman over the HTTP interface. In the case where a category name is non-unique, a filter may be specified to match only categories with matching variable values.

Syntax

GetConfigJSON(Filename,[Category,[Filter]])

Arguments

Filename - Configuration filename (e.g. foo.conf).
Category - Category in configuration file.
Filter

UpdateConfig

Synopsis

Update basic configuration.

Description

This action will modify, create, or delete configuration elements in Asterisk configuration files.

Syntax

UpdateConfig(SrcFilename,DstFilename,[Reload,[PreserveEffectiveContext,[Action-000000,[Cat-000000,[Var-000000,[Value-000000,[Match-000000,[Line-000000,[Options-000000]]]]]]]]])

Arguments

SrcFilename - Configuration filename to read (e.g. foo.conf).
DstFilename - Configuration filename to write (e.g. foo.conf)
Reload - Whether or not a reload should take place (or name of specific module).
PreserveEffectiveContext - Whether the effective category contents should be preserved on template change. Default is true (pre 13.2 behavior).
Action-000000 - Action to take.
0's represent 6 digit number beginning with 000000.
- NewCat
- RenameCat
- DelCat
- EmptyCat
- Update
- Delete
- Append
- Insert
Cat-000000 - Category to operate on.
Var-000000 - Variable to work on.
Value-000000 - Value to work on.
Match-000000 - Extra match required to match line.
Line-000000 - Line in category to operate on (used with delete and insert actions).
Options-000000 - A comma separated list of action-specific options.

The following actions share the same options...
- NewCat - One or more of the following...
  - allowdups - Allow duplicate category names.
  - template - This category is a template.
  - inherit="template[,...]" - Templates from which to inherit.
- RenameCat
- DelCat
- EmptyCat
- Update
- Delete
- Append
- Insert
  - catfilter="[,...]"

CreateConfig

Synopsis

Creates an empty file in the configuration directory.

Description

This action will create an empty file in the configuration directory. This action is intended to be used before an UpdateConfig action.

Syntax

CreateConfig(Filename)

Arguments

Filename - The configuration filename to create (e.g. foo.conf).

Redirect

Synopsis

Redirect (transfer) a call.

Description

Redirect (transfer) a call.

Syntax

Redirect(Channel,[ExtraChannel,]Exten,[ExtraExten,]Context,[ExtraContext,]Priority,[ExtraPriority])

Arguments

Channel - Channel to redirect.
ExtraChannel - Second call leg to transfer (optional).
Exten - Extension to transfer to.
ExtraExten - Extension to transfer extrachannel to (optional).
Context - Context to transfer to.
ExtraContext - Context to transfer extrachannel to (optional).
Priority - Priority to transfer to.
ExtraPriority - Priority to transfer extrachannel to (optional).

Atxfer

Synopsis

Attended transfer.

Description

Attended transfer.

Syntax

Atxfer(Channel,Exten,[Context])

Arguments

Channel - Transferer's channel.
Exten - Extension to transfer to.
Context - Context to transfer to.

CancelAtxfer

Synopsis

Cancel an attended transfer.

Description

Cancel an attended transfer. Note, this uses the configured cancel attended transfer feature option (atxferabort) to cancel the transfer. If not available this action will fail.

Syntax

CancelAtxfer(Channel)

Arguments

Channel - The transferer channel.

Originate

Synopsis

Originate a call.

Description

Generates an outgoing call to a Extension/Context/Priority or Application/Data

Syntax

Originate(Channel,[Exten,[Context,[Priority,[Application,[Data,[Timeout,[CallerID,[Variable,[Account,[EarlyMedia,[Async,[Codecs,[ChannelId,[OtherChannelId]]]]]]]]]]]]]])

Arguments

Channel - Channel name to call.
Exten - Extension to use (requires Context and Priority)
Context - Context to use (requires Exten and Priority)
Priority - Priority to use (requires Exten and Context)
Application - Application to execute.
Data - Data to use (requires Application).
Timeout - How long to wait for call to be answered (in ms.).
CallerID - Caller ID to be set on the outgoing channel.
Variable - Channel variable to set, multiple Variable: headers are allowed.
Account - Account code.
EarlyMedia - Set to true to force call bridge on early media..
Async - Set to true for fast origination.
Codecs - Comma-separated list of codecs to use for this call.
ChannelId - Channel UniqueId to be set on the channel.
OtherChannelId - Channel UniqueId to be set on the second local channel.

Command

Synopsis

Execute Asterisk CLI Command.

Description

Run a CLI command.

Syntax

Command(Command)

Arguments

Command - Asterisk CLI command to run.

ExtensionState

Synopsis

Check Extension Status.

Description

Report the extension state for given extension. If the extension has a hint, will use devicestate to check the status of the device connected to the extension.

Will return an Extension Status message. The response will include the hint for the extension and the status.

Syntax

ExtensionState(Exten,Context)

Arguments

Exten - Extension to check state on.
Context - Context for extension.

PresenceState

Synopsis

Check Presence State

Description

Report the presence state for the given presence provider.

Will return a Presence State message. The response will include the presence state and, if set, a presence subtype and custom message.

Syntax

PresenceState(Provider)

Arguments

Provider - Presence Provider to check the state of

AbsoluteTimeout

Synopsis

Set absolute timeout.

Description

Hangup a channel after a certain time. Acknowledges set time with Timeout Set message.

Syntax

AbsoluteTimeout(Channel,Timeout)

Arguments

Channel - Channel name to hangup.
Timeout - Maximum duration of the call (sec).

MailboxStatus

Synopsis

Check mailbox.

Description

Checks a voicemail account for status.

Returns whether there are messages waiting.

Message: Mailbox Status.

Mailbox: mailboxid.

Waiting: 0 if messages waiting, 1 if no messages waiting.

Syntax

MailboxStatus(Mailbox)

Arguments

Mailbox - Full mailbox ID mailbox@vm-context.

MailboxCount

Synopsis

Check Mailbox Message Count.

Description

Checks a voicemail account for new messages.

Returns number of urgent, new and old messages.

Message: Mailbox Message Count

Mailbox: mailboxid

UrgentMessages: count

NewMessages: count

OldMessages: count

Syntax

MailboxCount(Mailbox)

Arguments

Mailbox - Full mailbox ID mailbox@vm-context.

ListCommands

Synopsis

List available manager commands.

Description

Returns the action name and synopsis for every action that is available to the user.

SendText

Synopsis

Sends a text message to channel. A content type can be optionally specified. If not set it is set to an empty string allowing a custom handler to default it as it sees fit.

Description

Sends A Text Message to a channel while in a call.

Syntax

SendText(Channel,Message,[Content-Type])

Arguments

Channel - Channel to send message to.
Message - Message to send.
Content-Type - The type of content in the message

UserEvent

Synopsis

Send an arbitrary event.

Description

Send an event to manager sessions.

Syntax

UserEvent(UserEvent,[Header1,[HeaderN]])

Arguments

UserEvent - Event string to send.
Header1 - Content1.
HeaderN - ContentN.

WaitEvent

Synopsis

Wait for an event to occur.

Description

This action will elicit a Success response. Whenever a manager event is queued. Once WaitEvent has been called on an HTTP manager session, events will be generated and queued.

Syntax

WaitEvent(Timeout)

Arguments

Timeout - Maximum time (in seconds) to wait for events, -1 means forever.

CoreSettings

Synopsis

Show PBX core settings (version etc).

Description

Query for Core PBX settings.

CoreStatus

Synopsis

Show PBX core status variables.

Description

Query for Core PBX status.

Reload

Synopsis

Send a reload event.

Description

Send a reload event.

Syntax

Reload([Module])

Arguments

Module - Name of the module to reload.

CoreShowChannels

Synopsis

List currently active channels.

Description

List currently defined channels and some information about them.

CoreShowChannelMap

Synopsis

List all channels connected to the specified channel.

Description

List all channels currently connected to the specified channel. This can be any channel, including Local channels, and Local channels will be followed through to their other half.

Syntax

CoreShowChannelMap([Channel])

Arguments

Channel - The channel to get the mapping for. Requires a channel name.

LoggerRotate

Synopsis

Reload and rotate the Asterisk logger.

Description

Reload and rotate the logger. Analogous to the CLI command 'logger rotate'.

ModuleLoad

Synopsis

Module management.

Description

Loads, unloads or reloads an Asterisk module in a running system.

Syntax

ModuleLoad([Module,]LoadType)

Arguments

Module - Asterisk module name (including .so extension) or subsystem identifier:
- cdr
- dnsmgr
- extconfig
- enum
- acl
- manager
- http
- logger
- features
- dsp
- udptl
- indications
- cel
- plc
LoadType - The operation to be done on module. Subsystem identifiers may only be reloaded.
If no module is specified for a reload loadtype, all modules are reloaded.
- load
- unload
- reload

ModuleCheck

Synopsis

Check if module is loaded.

Description

Checks if Asterisk module is loaded. Will return Success/Failure. An empty Version header is also returned (which doesn't contain the module revision number).

Syntax

ModuleCheck(Module)

Arguments

Module - Asterisk module name (not including extension).

AOCMessage

Synopsis

Generate an Advice of Charge message on a channel.

Description

Generates an AOC-S, AOC-D or AOC-E message on a channel.

Syntax

AOCMessage([Channel,[ChannelPrefix,]]MsgType,[ChargeType,[UnitAmount(0),[UnitType(0),[CurrencyName,[CurrencyAmount,[CurrencyMultiplier,[TotalType,[AOCBillingId,[ChargingAssociationId,[ChargingAssociationNumber,[ChargingAssociationPlan,[ChargedItem,[RateType,[Time,[TimeScale,[Granularity,[GranularityTimeScale,[ChargingType,[VolumeUnit,[Code]]]]]]]]]]]]]]]]]]]])

Arguments

Channel - Channel name to generate the AOC message on. This value is required unless ChannelPrefix is given.
ChannelPrefix - Partial channel prefix. By using this option one can match the beginning part of a channel name without having to put the entire name in. For example if a channel name is SIP/snom-00000001 and this value is set to SIP/snom, then that channel matches and the message will be sent. Note however that only the first matched channel has the message sent on it.
MsgType - Defines what type of AOC message to create, AOC-S, AOC-D or AOC-E
- S
- D
- E
ChargeType - Defines what kind of charge this message represents for AOC-D and AOC-E.
- NA
- FREE
- Currency
- Unit
UnitAmount(0) - This represents the amount of units charged. The ETSI AOC standard specifies that this value along with the optional UnitType value are entries in a list. To accommodate this these values take an index value starting at 0 which can be used to generate this list of unit entries. For Example, If two unit entires were required this could be achieved by setting the paramter UnitAmount(0)=1234 and UnitAmount(1)=5678. Note that UnitAmount at index 0 is required when ChargeType=Unit, all other entries in the list are optional.
UnitType(0) - Defines the type of unit. ETSI AOC standard specifies this as an integer value between 1 and 16, but this value is left open to accept any positive integer. Like the UnitAmount parameter, this value represents a list entry and has an index parameter that starts at 0.
CurrencyName - Specifies the currency's name. Note that this value is truncated after 10 characters.
CurrencyAmount - Specifies the charge unit amount as a positive integer. This value is required when ChargeType==Currency (AOC-D or AOC-E) or RateType==Duration/Flat/Volume (AOC-S).
CurrencyMultiplier - Specifies the currency multiplier. This value is required when CurrencyAmount is given.
- OneThousandth
- OneHundredth
- OneTenth
- One
- Ten
- Hundred
- Thousand
TotalType - Defines what kind of AOC-D total is represented.
- Total
- SubTotal
AOCBillingId - Represents a billing ID associated with an AOC-D or AOC-E message. Note that only the first 3 items of the enum are valid AOC-D billing IDs
- Normal
- ReverseCharge
- CreditCard
- CallFwdUnconditional
- CallFwdBusy
- CallFwdNoReply
- CallDeflection
- CallTransfer
ChargingAssociationId - Charging association identifier. This is optional for AOC-E and can be set to any value between -32768 and 32767
ChargingAssociationNumber - Represents the charging association party number. This value is optional for AOC-E.
ChargingAssociationPlan - Integer representing the charging plan associated with the ChargingAssociationNumber. The value is bits 7 through 1 of the Q.931 octet containing the type-of-number and numbering-plan-identification fields.
ChargedItem - Defines what part of the call is charged in AOC-S. Usually this is set to BasicCommunication, which refers to the time after the call is answered, but establishment (CallAttempt) or successful establishment (CallSetup) of a call can also be used. Other options are available, but these generally do not carry enough information to actually calculate the price of a call. It is possible to have multiple ChargedItem entries for a single call -- for example to charge for both the establishment of the call and the actual call. In this case, each ChargedItem is described by a ChargedItem: header and all other headers that follow it up to the next ChargedItem: header.
- NA
- SpecialArrangement
- BasicCommunication
- CallAttempt
- CallSetup
- UserUserInfo
- SupplementaryService
RateType - Defines how an AOC-S ChargedItem is charged. The Duration option is only available when ChargedItem==BasicCommunication.
- NA
- Free
- FreeFromBeginning
- Duration
- Flat
- Volume
- SpecialCode
Time - Specifies a positive integer which is the amount of time is paid for by one CurrencyAmount. This value is required when RateType==Duration.
TimeScale - Specifies the time multiplier. This value is required when Time is given.
- OneHundredthSecond
- OneTenthSecond
- Second
- TenSeconds
- Minute
- Hour
- Day
Granularity - Specifies a positive integer which is the size of the charged time increments. This value is optional when RateType==Duration and ChargingType==StepFunction.
GranularityTimeScale - Specifies the granularity time multiplier. This value is required when Granularity is given.
- OneHundredthSecond
- OneTenthSecond
- Second
- TenSeconds
- Minute
- Hour
- Day
ChargingType - Specifies whether the charge increases continuously with time or in increments of Time or, if provided, Granularity. This value is required when RateType==Duration.
- ContinuousCharging
- StepFunction
VolumeUnit - Specifies the quantity of which one unit is paid for by one CurrencyAmount. This value is required when RateType==Volume.
- Octet
- Segment
- Message
Code - Specifies the charging code, which can be set to a value between 1 and 10. This value is required when ChargedItem==SpecialArrangement or RateType==SpecialCode.

Filter

Synopsis

Dynamically add filters for the current manager session.

Description

The filters added are only used for the current session. Once the connection is closed the filters are removed.

This comand requires the system permission because this command can be used to create filters that may bypass filters defined in manager.conf

Syntax

Filter([Operation,[Filter]])

Arguments

Operation
Filter - Filters can be whitelist or blacklist
Example whitelist filter: "Event: Newchannel"
Example blacklist filter: "!Channel: DAHDI.*"
This filter option is used to whitelist or blacklist events per user to be reported with regular expressions and are allowed if both the regex matches and the user has read access as defined in manager.conf. Filters are assumed to be for whitelisting unless preceeded by an exclamation point, which marks it as being black. Evaluation of the filters is as follows:
- If no filters are configured all events are reported as normal.
- If there are white filters only: implied black all filter processed first, then white filters.
- If there are black filters only: implied white all filter processed first, then black filters.
- If there are both white and black filters: implied black all filter processed first, then white filters, and lastly black filters.

BlindTransfer

Synopsis

Blind transfer channel(s) to the given destination

Description

Redirect all channels currently bridged to the specified channel to the specified destination.

Syntax

BlindTransfer(Channel,[Context,[Exten]])

Arguments

Channel
Context
Exten

DBGet

Synopsis

Get DB Entry.

Description

Syntax

DBGet(Family,Key)

Arguments

Family
Key

DBGetTree

Synopsis

Get DB entries, optionally at a particular family/key

Description

Syntax

DBGetTree([Family,[Key]])

Arguments

Family
Key

DBPut

Synopsis

Put DB entry.

Description

Syntax

DBPut(Family,Key,[Val])

Arguments

Family
Key
Val

DBDel

Synopsis

Delete DB entry.

Description

Syntax

DBDel(Family,Key)

Arguments

Family
Key

DBDelTree

Synopsis

Delete DB Tree.

Description

Syntax

DBDelTree(Family,[Key])

Arguments

Family
Key

ShowDialPlan

Synopsis

Show dialplan contexts and extensions

Description

Show dialplan contexts and extensions. Be aware that showing the full dialplan may take a lot of capacity.

Syntax

ShowDialPlan([Extension,[Context]])

Arguments

Extension - Show a specific extension.
Context - Show a specific context.

ExtensionStateList

Synopsis

List the current known extension states.

Description

This will list out all known extension states in a sequence of ExtensionStatus events. When finished, a ExtensionStateListComplete event will be emitted.

LocalOptimizeAway

Synopsis

Optimize away a local channel when possible.

Description

A local channel created with "/n" will not automatically optimize away. Calling this command on the local channel will clear that flag and allow it to optimize away if it's bridged or when it becomes bridged.

Syntax

LocalOptimizeAway(Channel)

Arguments

Channel - The channel name to optimize away.

MessageSend

Synopsis

Send an out of call message to an endpoint.

Description

Syntax

MessageSend([Destination,[To,[From,[Body,[Base64Body,[Variable]]]]]])

Arguments

Destination - A To URI for the message. If Destination is provided, the To parameter can also be supplied and may alter the message based on the specified message technology.
For backwards compatibility, if Destination is not provided, the To parameter must be provided and will be used as the message destination.
To - A To URI for the message if needed for the message technology being used to send this message. This can be a SIP(S) URI, such as Alice <sip:[email protected]>, or a string in the format [email protected].
This parameter is required if the Destination parameter is not provided.
From - A From URI for the message if needed for the message technology being used to send this message.
Body - The message body text. This must not contain any newlines as that conflicts with the AMI protocol.
Base64Body - Text bodies requiring the use of newlines have to be base64 encoded in this field. Base64Body will be decoded before being sent out. Base64Body takes precedence over Body.
Variable - Message variable to set, multiple Variable: headers are allowed. The header value is a comma separated list of name=value pairs.

Bridge

Synopsis

Bridge two channels already in the PBX.

Description

Bridge together two channels already in the PBX.

Syntax

Bridge(Channel1,Channel2,[Tone])

Arguments

Channel1 - Channel to Bridge to Channel2.
Channel2 - Channel to Bridge to Channel1.
Tone - Play courtesy tone to Channel 2.
- no
- Channel1
- Channel2
- Both

MuteAudio

Synopsis

Mute an audio stream.

Description

Mute an incoming or outgoing audio stream on a channel.

Syntax

MuteAudio(Channel,Direction,State)

Arguments

Channel - The channel you want to mute.
Direction
State

IRCSendMessage

Synopsis

Sends a message to an IRC channel

Description

This action sends a message to an IRC channel using the built-in IRC client.

If the IRC client is not already present in the specified channel, the action will silently fail.

Syntax

IRCSendMessage(Channel,Message)

Arguments

Channel - The name of the IRC channel.
Message - The message to be sent.

PJSIPUnregister

Synopsis

Unregister an outbound registration.

Description

Unregisters the specified (or all) outbound registration(s) and stops future registration attempts. Call PJSIPRegister to start registration and schedule re-registrations according to configuration.

Syntax

PJSIPUnregister(Registration)

Arguments

Registration - The outbound registration to unregister or '*all' to unregister them all.

PJSIPRegister

Synopsis

Description

Unregisters the specified (or all) outbound registration(s) then starts registration and schedules re-registrations according to configuration.

Syntax

PJSIPRegister(Registration)

Arguments

Registration - The outbound registration to register or '*all' to register them all.

PJSIPShowRegistrationsOutbound

Synopsis

Lists PJSIP outbound registrations.

Description

In response OutboundRegistrationDetail events showing configuration and status information are raised for each outbound registration object. AuthDetail events are raised for each associated auth object as well. Once all events are completed an OutboundRegistrationDetailComplete is issued.

PJSIPShowSubscriptionsInbound

Synopsis

Lists subscriptions.

Description

Provides a listing of all inbound subscriptions. An event InboundSubscriptionDetail is issued for each subscription object. Once all detail events are completed an InboundSubscriptionDetailComplete event is issued.

PJSIPShowSubscriptionsOutbound

Synopsis

Lists subscriptions.

Description

Provides a listing of all outbound subscriptions. An event OutboundSubscriptionDetail is issued for each subscription object. Once all detail events are completed an OutboundSubscriptionDetailComplete event is issued.

PJSIPShowResourceLists

Synopsis

Displays settings for configured resource lists.

Description

Provides a listing of all resource lists. An event ResourceListDetail is issued for each resource list object. Once all detail events are completed a ResourceListDetailComplete event is issued.

SorceryMemoryCacheExpireObject

Synopsis

Expire (remove) an object from a sorcery memory cache.

Description

Expires (removes) an object from a sorcery memory cache. If full backend caching is enabled this action is not available and will fail. In this case the SorceryMemoryCachePopulate or SorceryMemoryCacheExpire AMI actions must be used instead.

Syntax

SorceryMemoryCacheExpireObject(Cache,Object)

Arguments

Cache - The name of the cache to expire the object from.
Object - The name of the object to expire.

SorceryMemoryCacheExpire

Synopsis

Expire (remove) ALL objects from a sorcery memory cache.

Description

Expires (removes) ALL objects from a sorcery memory cache.

Syntax

SorceryMemoryCacheExpire(Cache)

Arguments

Cache - The name of the cache to expire all objects from.

SorceryMemoryCacheStaleObject

Synopsis

Mark an object in a sorcery memory cache as stale.

Description

Marks an object as stale within a sorcery memory cache.

Syntax

SorceryMemoryCacheStaleObject(Cache,Object,[Reload])

Arguments

Cache - The name of the cache to mark the object as stale in.
Object - The name of the object to mark as stale.
Reload - If true, then immediately reload the object from the backend cache instead of waiting for the next retrieval

SorceryMemoryCacheStale

Synopsis

Marks ALL objects in a sorcery memory cache as stale.

Description

Marks ALL objects in a sorcery memory cache as stale.

Syntax

SorceryMemoryCacheStale(Cache)

Arguments

Cache - The name of the cache to mark all object as stale in.

SorceryMemoryCachePopulate

Synopsis

Expire all objects from a memory cache and populate it with all objects from the backend.

Description

Expires all objects from a memory cache and populate it with all objects from the backend.

Syntax

SorceryMemoryCachePopulate(Cache)

Arguments

Cache - The name of the cache to populate.

PJSIPNotify

Synopsis

Send a NOTIFY to either an endpoint, an arbitrary URI, or inside a SIP dialog.

Description

Sends a NOTIFY to an endpoint, an arbitrary URI, or inside a SIP dialog.

All parameters for this event must be specified in the body of this request via multiple Variable: name=value sequences.

One (and only one) of Endpoint, URI, or Channel must be specified. If URI is used, the default outbound endpoint will be used to send the message. If the default outbound endpoint isn't configured, this command can not send to an arbitrary URI.

Syntax

PJSIPNotify([Endpoint,[URI,[channel,[Option,[Variable]]]]])

Arguments

Endpoint - The endpoint to which to send the NOTIFY.
URI - Abritrary URI to which to send the NOTIFY.
channel - Channel name to send the NOTIFY. Must be a PJSIP channel.
Option - The config section name from pjsip_notify.conf to use.
One of Option or Variable must be specified.
Variable - Appends variables as headers/content to the NOTIFY. If the variable is named Content, then the value will compose the body of the message if another variable sets Content-Type. name=value
One of Option or Variable must be specified.

PJSIPShowRegistrationsInbound

Synopsis

Lists PJSIP inbound registrations.

Description

In response, InboundRegistrationDetail events showing configuration and status information are raised for all contacts, static or dynamic. Once all events are completed an InboundRegistrationDetailComplete is issued.

This command just dumps all coonfigured AORs with contacts, even if the contact is a permanent one. To really get just inbound registrations, use PJSIPShowRegistrationInboundContactStatuses.

PJSIPShowRegistrationInboundContactStatuses

Synopsis

Lists ContactStatuses for PJSIP inbound registrations.

Description

In response, ContactStatusDetail events showing status information are raised for each inbound registration (dynamic contact) object. Once all events are completed a ContactStatusDetailComplete event is issued.

AGI

Synopsis

Add an AGI command to execute by Async AGI.

Description

Add an AGI command to the execute queue of the channel in Async AGI.

Syntax

AGI(Channel,Command,[CommandID])

Arguments

Channel - Channel that is currently in Async AGI.
Command - Application to execute.
CommandID - This will be sent back in CommandID header of AsyncAGI exec event notification.

JabberSend

Synopsis

Sends a message to a Jabber Client.

Description

Sends a message to a Jabber Client.

Syntax

JabberSend(Jabber,JID,Message)

Arguments

Jabber - Client or transport Asterisk uses to connect to JABBER.
JID - XMPP/Jabber JID (Name) of recipient.
Message - Message to be sent to the buddy.

MWIGet

Synopsis

Get selected mailboxes with message counts.

Description

Get a list of mailboxes with their message counts.

Syntax

MWIGet(Mailbox)

Arguments

Mailbox - Mailbox ID in the form of /regex/ for all mailboxes matching the regular expression. Otherwise it is for a specific mailbox.

MWIDelete

Synopsis

Delete selected mailboxes.

Description

Delete the specified mailboxes.

MWIUpdate

Synopsis

Update the mailbox message counts.

Description

Update the mailbox message counts.

Syntax

MWIUpdate(Mailbox,[OldMessages,[NewMessages]])

Arguments

Mailbox - Specific mailbox ID.
OldMessages - The number of old messages in the mailbox. Defaults to zero if missing.
NewMessages - The number of new messages in the mailbox. Defaults to zero if missing.

DeviceStateList

Synopsis

List the current known device states.

Description

This will list out all known device states in a sequence of DeviceStateChange events. When finished, a DeviceStateListComplete event will be emitted.

Monitor

Synopsis

Monitor a channel.

Description

This action may be used to record the audio on a specified channel.

Syntax

Monitor(Channel,[File,[Format,[Mix]]])

Arguments

Channel - Used to specify the channel to record.
File - Is the name of the file created in the monitor spool directory. Defaults to the same name as the channel (with slashes replaced with dashes).
Format - Is the audio recording format. Defaults to wav.
Mix - Boolean parameter as to whether to mix the input and output channels together after the recording is finished.

StopMonitor

Synopsis

Stop monitoring a channel.

Description

This action may be used to end a previously started 'Monitor' action.

Syntax

StopMonitor(Channel)

Arguments

Channel - The name of the channel monitored.

ChangeMonitor

Synopsis

Change monitoring filename of a channel.

Description

This action may be used to change the file started by a previous 'Monitor' action.

Syntax

ChangeMonitor(Channel,File)

Arguments

Channel - Used to specify the channel to record.
File - Is the new name of the file created in the monitor spool directory.

PauseMonitor

Synopsis

Pause monitoring of a channel.

Description

This action may be used to temporarily stop the recording of a channel.

Syntax

PauseMonitor(Channel)

Arguments

Channel - Used to specify the channel to record.

UnpauseMonitor

Synopsis

Unpause monitoring of a channel.

Description

This action may be used to re-enable recording of a channel after calling PauseMonitor.

Syntax

UnpauseMonitor(Channel)

Arguments

Channel - Used to specify the channel to record.

FAXSessions

Synopsis

Lists active FAX sessions

Description

Will generate a series of FAXSession events with information about each FAXSession. Closes with a FAXSessionsComplete event which includes a count of the included FAX sessions. This action works in the same manner as the CLI command 'fax show sessions'

FAXSession

Synopsis

Responds with a detailed description of a single FAX session

Description

Provides details about a specific FAX session. The response will include a common subset of the output from the CLI command 'fax show session ' for each technology. If the FAX technolgy used by this session does not include a handler for FAXSession, then this action will fail.

Syntax

FAXSession(SessionNumber)

Arguments

SessionNumber - The session ID of the fax the user is interested in.

FAXStats

Synopsis

Responds with fax statistics

Description

Provides FAX statistics including the number of active sessions, reserved sessions, completed sessions, failed sessions, and the number of receive/transmit attempts. This command provides all of the non-technology specific information provided by the CLI command 'fax show stats'

Parkinglots

Synopsis

Get a list of parking lots

Description

List all parking lots as a series of AMI events

ParkedCalls

Synopsis

List parked calls.

Description

List parked calls.

Syntax

ParkedCalls([ParkingLot])

Arguments

ParkingLot - If specified, only show parked calls from the parking lot with this name.

Park

Synopsis

Park a channel.

Description

Park an arbitrary channel with optional arguments for specifying the parking lot used, how long the channel should remain parked, and what dial string to use as the parker if the call times out.

Syntax

Park(Channel,[TimeoutChannel,[AnnounceChannel,[Timeout,[Parkinglot,[ParkingSpace]]]]])

Arguments

Channel - Channel name to park.
TimeoutChannel - Channel name to use when constructing the dial string that will be dialed if the parked channel times out. If TimeoutChannel is in a two party bridge with Channel, then TimeoutChannel will receive an announcement and be treated as having parked Channel in the same manner as the Park Call DTMF feature.
AnnounceChannel - If specified, then this channel will receive an announcement when Channel is parked if AnnounceChannel is in a state where it can receive announcements (AnnounceChannel must be bridged). AnnounceChannel has no bearing on the actual state of the parked call.
Timeout - Overrides the timeout of the parking lot for this park action. Specified in milliseconds, but will be converted to seconds. Use a value of 0 to disable the timeout.
Parkinglot - The parking lot to use when parking the channel
ParkingSpace - The parking space extension in the parking lot. If the space is already in use then execution will continue at the next priority.

PresenceStateList

Synopsis

List the current known presence states.

Description

This will list out all known presence states in a sequence of PresenceStateChange events. When finished, a PresenceStateListComplete event will be emitted.

PJSIPQualify

Synopsis

Qualify a chan_pjsip endpoint.

Description

Qualify a chan_pjsip endpoint.

Syntax

PJSIPQualify(Endpoint)

Arguments

Endpoint - The endpoint you want to qualify.

PJSIPShowEndpoints

Synopsis

Lists PJSIP endpoints.

Description

Provides a listing of all endpoints. For each endpoint an EndpointList event is raised that contains relevant attributes and status information. Once all endpoints have been listed an EndpointListComplete event is issued.

PJSIPShowEndpoint

Synopsis

Detail listing of an endpoint and its objects.

Description

Provides a detailed listing of options for a given endpoint. Events are issued showing the configuration and status of the endpoint and associated objects. These events include EndpointDetail, AorDetail, AuthDetail, TransportDetail, and IdentifyDetail. Some events may be listed multiple times if multiple objects are associated (for instance AoRs). Once all detail events have been raised a final EndpointDetailComplete event is issued.

Syntax

PJSIPShowEndpoint(Endpoint)

Arguments

Endpoint - The endpoint to list.

PJSIPShowAors

Synopsis

Lists PJSIP AORs.

Description

Provides a listing of all AORs. For each AOR an AorList event is raised that contains relevant attributes and status information. Once all aors have been listed an AorListComplete event is issued.

PJSIPShowAuths

Synopsis

Lists PJSIP Auths.

Description

Provides a listing of all Auths. For each Auth an AuthList event is raised that contains relevant attributes and status information. Once all auths have been listed an AuthListComplete event is issued.

PJSIPShowContacts

Synopsis

Lists PJSIP Contacts.

Description

Provides a listing of all Contacts. For each Contact a ContactList event is raised that contains relevant attributes and status information. Once all contacts have been listed a ContactListComplete event is issued.

SIPQualifyPeerDone

Synopsis

Description

SessionTimeout

Synopsis

Description

AlarmClear

Synopsis

Description

SpanAlarmClear

Synopsis

Description

DNDState

Synopsis

Description

Alarm

Synopsis

Description

SpanAlarm

Synopsis

Description

DAHDIChannel

Synopsis

Description

MCID

Synopsis

Description

MiniVoiceMail

Synopsis

Description

ConfbridgeStart

Synopsis

Description

ConfbridgeEnd

Synopsis

Description

ConfbridgeJoin

Synopsis

Description

ConfbridgeLeave

Synopsis

Description

ConfbridgeRecord

Synopsis

Description

ConfbridgeStopRecord

Synopsis

Description

ConfbridgeMute

Synopsis

Description

ConfbridgeUnmute

Synopsis

Description

ConfbridgeTalking

Synopsis

Description

TddRxMsg

Synopsis

Description

TddStart

Synopsis

Description

TddStop

Synopsis

Description

MeetmeJoin

Synopsis

Description

MeetmeLeave

Synopsis

Description

MeetmeEnd

Synopsis

Description

MeetmeTalkRequest

Synopsis

Description

MeetmeTalking

Synopsis

Description

MeetmeMute

Synopsis

Description

MeetmeList

Synopsis

Description

MeetmeListRooms

Synopsis

Description

VarSet

Synopsis

Description

ConfbridgeList

Synopsis

Description

ConfbridgeListRooms

Synopsis

Description

Agents

Synopsis

Description

AgentsComplete

Synopsis

Description

MixMonitorStart

Synopsis

Description

MixMonitorStop

Synopsis

Description

MixMonitorMute

Synopsis

Description

QueueParams

Synopsis

Description

QueueEntry

Synopsis

Description

QueueMemberStatus

Synopsis

Description

QueueMemberAdded

Synopsis

Description

QueueMemberRemoved

Synopsis

Description

QueueMemberPause

Synopsis

Description

QueueMemberPenalty

Synopsis

Description

QueueMemberRinginuse

Synopsis

Description

QueueCallerJoin

Synopsis

Description

QueueCallerLeave

Synopsis

Description

QueueCallerAbandon

Synopsis

Description

AgentCalled

Synopsis

Description

AgentRingNoAnswer

Synopsis

Description

AgentComplete

Synopsis

Description

AgentDump

Synopsis

Description

AgentConnect

Synopsis

Description

Cdr

Synopsis

Description

CEL

Synopsis

Description

GroupVarGetResponse

Synopsis

Description

VarSet

Synopsis

Description

RTCPSent

Synopsis

Description

RTCPReceived

Synopsis

Description

Pickup

Synopsis

Description

BridgeCreate

Synopsis

Description

BridgeDestroy

Synopsis

Description

BridgeEnter

Synopsis

Description

BridgeLeave

Synopsis

Description

BridgeVideoSourceUpdate

Synopsis

Description

PresenceStateChange

Synopsis

Description

Status

Synopsis

Description

StatusComplete

Synopsis

Description

OriginateResponse

Synopsis

Description

CoreShowChannel

Synopsis

Description

CoreShowChannelsComplete

Synopsis

Description

CoreShowChannelMapComplete

Synopsis

Description

ExtensionStatus

Synopsis

Description

PresenceStatus

Synopsis

Description

Newchannel

Synopsis

Description

Newstate

Synopsis

Description

Hangup

Synopsis

Description

HangupRequest

Synopsis

Description

SoftHangupRequest

Synopsis

Description

NewExten

Synopsis

Description

NewCallerid

Synopsis

Description

NewConnectedLine

Synopsis

Description

NewAccountCode

Synopsis

Description

DialBegin

Synopsis

Description

DialState

Synopsis

Description

DialEnd

Synopsis

Description

Hold

Synopsis

Description

Unhold

Synopsis

Description

ChanSpyStart

Synopsis

Description

ChanSpyStop

Synopsis

Description

HangupHandlerRun

Synopsis

Description

HangupHandlerPop

Synopsis

Description

HangupHandlerPush

Synopsis

Description

FAXStatus

Synopsis

Description

ReceiveFAX

Synopsis

Description

SendFAX

Synopsis

Description

MusicOnHoldStart

Synopsis

Description

MusicOnHoldStop

Synopsis

Description

MonitorStart

Synopsis

Description

MonitorStop

Synopsis

Description

Reload

Synopsis

Description

Load

Synopsis

Description

Unload

Synopsis

Description

VarSet

Synopsis

Description

AgentLogin

Synopsis

Description

AgentLogoff

Synopsis

Description

ChannelTalkingStart

Synopsis

Description

ChannelTalkingStop

Synopsis

Description

GroupCreate

Synopsis

Description

GroupChannelAdd

Synopsis

Description

GroupVarSet

Synopsis

Description

GroupChannelRemove

Synopsis

Description

GroupDestroy

Synopsis

Description

DeadlockStart

Synopsis

Description

DeviceStateChange

Synopsis

Description

BlindTransfer

Synopsis

Description

AttendedTransfer

Synopsis

Description

FullyBooted

Synopsis

Description

Shutdown

Synopsis

Description

PeerStatus

Synopsis

Description

ContactStatus

Synopsis

Description

UserEvent

Synopsis

Description

LocalBridge

Synopsis

Description

LocalOptimizationBegin

Synopsis

Description

LocalOptimizationEnd

Synopsis

Description

AOC-S

Synopsis

Description

AOC-D

Synopsis

Description

AOC-E

Synopsis

Description

Registry

Synopsis

Description

FailedACL

Synopsis

Description

InvalidAccountID

Synopsis

Description

SessionLimit

Synopsis

Description

MemoryLimit

Synopsis

Description

LoadAverageLimit

Synopsis

Description

RequestNotSupported

Synopsis

Description

RequestNotAllowed

Synopsis

Description

AuthMethodNotAllowed

Synopsis

Description

RequestBadFormat

Synopsis

Description

SuccessfulAuth

Synopsis

Description

UnexpectedAddress

Synopsis

Description

ChallengeResponseFailed

Synopsis

Description

InvalidPassword

Synopsis

Description

ChallengeSent

Synopsis

Description

InvalidTransport

Synopsis

Description

AsyncAGIStart

Synopsis

Description

AsyncAGIEnd

Synopsis

Description

AsyncAGIExec

Synopsis

Description

AGIExecStart

Synopsis

Description

AGIExecEnd

Synopsis

Description

MWIGet

Synopsis

Description

MWIGetComplete

Synopsis

Description

FAXSessionsEntry

Synopsis

Description

FAXSessionsComplete

Synopsis

Description

FAXSession

Synopsis

Description

FAXStats

Synopsis

Description

ParkedCall

Synopsis

Description

ParkedCallTimeOut

Synopsis

Description

ParkedCallGiveUp

Synopsis

Description

UnParkedCall

Synopsis

Description

ParkedCallSwap

Synopsis

Description

IdentifyDetail

Synopsis

Description

AorDetail

Synopsis

Description

AuthDetail

Synopsis

Description

TransportDetail

Synopsis

Description

EndpointDetail

Synopsis

Description

AorList

Synopsis

Description

AuthList

Synopsis

Description

ContactList

Synopsis

Description

ContactStatusDetail

Synopsis

Description

EndpointList

Synopsis

Description

GOSUB

Synopsis

Cause the channel to execute the specified dialplan subroutine.

Description

Cause the channel to execute the specified dialplan subroutine, returning to the dialplan with execution of a Return().

Syntax

GOSUB CONTEXT EXTENSION PRIORITY OPTIONAL-ARGUMENT

Arguments

context
extension
priority
optional-argument

ANSWER

Synopsis

Answer channel

Description

Answers channel if not already in answer state. Returns -1 on channel failure, or 0 if successful.

Syntax

ANSWER

ASYNCAGI BREAK

Synopsis

Interrupts Async AGI

Description

Interrupts expected flow of Async AGI commands and returns control to previous source (typically, the PBX dialplan).

Syntax

ASYNCAGI BREAK

CHANNEL STATUS

Synopsis

Returns status of the connected channel.

Description

Returns the status of the specified channelname. If no channel name is given then returns the status of the current channel.

Return values:

Syntax

CHANNEL STATUS CHANNELNAME

Arguments

channelname

CONTROL STREAM FILE

Synopsis

Sends audio file on channel and allows the listener to control the stream.

Description

Send the given file, allowing playback to be controlled by the given digits, if any. Use double quotes for the digits if you wish none to be permitted. If offsetms is provided then the audio will seek to offsetms before play starts. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed, or -1 on error or if the channel was disconnected. Returns the position where playback was terminated as endpos.

It sets the following channel variables upon completion:

CPLAYBACKSTATUS - Contains the status of the attempt as a text string
- SUCCESS
- USERSTOPPED
- REMOTESTOPPED
- ERROR
CPLAYBACKOFFSET - Contains the offset in ms into the file where playback was at when it stopped. -1 is end of file.
CPLAYBACKSTOPKEY - If the playback is stopped by the user this variable contains the key that was pressed.

Syntax

CONTROL STREAM FILE FILENAME ESCAPE_DIGITS SKIPMS FFCHAR REWCHR PAUSECHR OFFSETMS

Arguments

filename - The file extension must not be included in the filename.
escape_digits
skipms
ffchar - Defaults to #
rewchr - Defaults to *
pausechr
offsetms - Offset, in milliseconds, to start the audio playback

DATABASE DEL

Synopsis

Removes database key/value

Description

Deletes an entry in the Asterisk database for a given family and key.

Returns 1 if successful, 0 otherwise.

Syntax

DATABASE DEL FAMILY KEY

Arguments

family
key

DATABASE DELTREE

Synopsis

Removes database keytree/value

Description

Deletes a family or specific keytree within a family in the Asterisk database.

Returns 1 if successful, 0 otherwise.

Syntax

DATABASE DELTREE FAMILY KEYTREE

Arguments

family
keytree

DATABASE GET

Synopsis

Gets database value

Description

Retrieves an entry in the Asterisk database for a given family and key.

Returns 0 if key is not set. Returns 1 if key is set and returns the variable in parenthesis.

Example return code: 200 result=1 (testvariable)

Syntax

DATABASE GET FAMILY KEY

Arguments

family
key

DATABASE PUT

Synopsis

Adds/updates database value

Description

Adds or updates an entry in the Asterisk database for a given family, key, and value.

Returns 1 if successful, 0 otherwise.

Syntax

DATABASE PUT FAMILY KEY VALUE

Arguments

family
key
value

EXEC

Synopsis

Executes a given Application

Description

Executes application with given options.

Returns whatever the application returns, or -2 on failure to find application.

exec does not evaluate dialplan functions and variables unless it is explicitly enabled by setting the AGIEXECFULL variable to yes.

Syntax

EXEC APPLICATION OPTIONS

Arguments

application
options

GET DATA

Synopsis

Prompts for DTMF on a channel

Description

Stream the given file, and receive DTMF data.

Returns the digits received from the channel at the other end.

Syntax

GET DATA FILE TIMEOUT MAXDIGITS

Arguments

file
timeout
maxdigits

GET FULL VARIABLE

Synopsis

Evaluates a channel expression

Description

Evaluates the given expression against the channel specified by channelname, or the current channel if channelname is not provided.

Unlike GET VARIABLE, the expression is processed in a manner similar to dialplan evaluation, allowing complex and built-in variables to be accessed, e.g. The time is ${EPOCH}

Returns 0 if no channel matching channelname exists, 1 otherwise.

Example return code: 200 result=1 (The time is 1578493800)

Syntax

GET FULL VARIABLE EXPRESSION CHANNELNAME

Arguments

expression
channelname

GET OPTION

Synopsis

Stream file, prompt for DTMF, with timeout.

Description

Behaves similar to STREAM FILE but used with a timeout option.

Syntax

GET OPTION FILENAME ESCAPE_DIGITS TIMEOUT

Arguments

filename
escape_digits
timeout

GET VARIABLE

Synopsis

Gets a channel variable.

Description

Returns 0 if variablename is not set. Returns 1 if variablename is set and returns the variable in parentheses.

Example return code: 200 result=1 (testvariable)

Syntax

GET VARIABLE VARIABLENAME

Arguments

variablename

HANGUP

Synopsis

Hangup a channel.

Description

Hangs up the specified channel. If no channel name is given, hangs up the current channel

Syntax

HANGUP CHANNELNAME

Arguments

channelname

NOOP

Synopsis

Does nothing.

Description

Does nothing.

Syntax

NOOP

RECEIVE CHAR

Synopsis

Receives one character from channels supporting it.

Description

Receives a character of text on a channel. Most channels do not support the reception of text. Returns the decimal value of the character if one is received, or 0 if the channel does not support text reception. Returns -1 only on error/hangup.

Syntax

RECEIVE CHAR TIMEOUT

Arguments

timeout - The maximum time to wait for input in milliseconds, or 0 for infinite. Most channels

RECEIVE TEXT

Synopsis

Receives text from channels supporting it.

Description

Receives a string of text on a channel. Most channels do not support the reception of text. Returns -1 for failure or 1 for success, and the string in parenthesis.

Syntax

RECEIVE TEXT TIMEOUT

Arguments

timeout - The timeout to be the maximum time to wait for input in milliseconds, or 0 for infinite.

RECORD FILE

Synopsis

Records to a given file.

Description

Record to a file until a given dtmf digit in the sequence is received. Returns -1 on hangup or error. The format will specify what kind of file will be recorded. The timeout is the maximum record time in milliseconds, or -1 for no timeout. offset samples is optional, and, if provided, will seek to the offset without exceeding the end of the file. beep can take any value, and causes Asterisk to play a beep to the channel that is about to be recorded. silence is the number of seconds of silence allowed before the function returns despite the lack of dtmf digits or reaching timeout. silence value must be preceded by s= and is also optional.

Syntax

RECORD FILE FILENAME FORMAT ESCAPE_DIGITS TIMEOUT OFFSET_SAMPLES BEEP S=SILENCE N=NOISE

Arguments

filename - The destination filename of the recorded audio.
format - The audio format in which to save the resulting file.
escape_digits - The DTMF digits that will terminate the recording process.
timeout - The maximum recording time in milliseconds. Set to -1 for no limit.
offset_samples - Causes the recording to first seek to the specified offset before recording begins.
beep - Causes Asterisk to play a beep as recording begins. This argument can take any value.
s=silence - The number of seconds of silence that are permitted before the recording is terminated, regardless of the escape_digits or timeout arguments. If specified, this parameter must be preceded by s=.
n=noise - The number of milliseconds of noise that are required before the silence detection is enabled, regardless of the escape_digits or timeout arguments. If specified, this parameter must be preceded by n=.

SAY ALPHA

Synopsis

Says a given character string.

Description

Say a given character string, returning early if any of the given DTMF digits are received on the channel. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.

Syntax

SAY ALPHA NUMBER ESCAPE_DIGITS

Arguments

number
escape_digits

SAY DIGITS

Synopsis

Says a given digit string.

Description

Say a given digit string, returning early if any of the given DTMF digits are received on the channel. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.

Syntax

SAY DIGITS NUMBER ESCAPE_DIGITS

Arguments

number
escape_digits

SAY NUMBER

Synopsis

Says a given number.

Description

Say a given number, returning early if any of the given DTMF digits are received on the channel. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.

Syntax

SAY NUMBER NUMBER ESCAPE_DIGITS GENDER

Arguments

number
escape_digits
gender

SAY PHONETIC

Synopsis

Says a given character string with phonetics.

Description

Say a given character string with phonetics, returning early if any of the given DTMF digits are received on the channel. Returns 0 if playback completes without a digit pressed, the ASCII numerical value of the digit if one was pressed, or -1 on error/hangup.

Syntax

SAY PHONETIC STRING ESCAPE_DIGITS

Arguments

string
escape_digits

SAY DATE

Synopsis

Says a given date.

Description

Say a given date, returning early if any of the given DTMF digits are received on the channel. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.

Syntax

SAY DATE DATE ESCAPE_DIGITS

Arguments

date - Is number of seconds elapsed since 00:00:00 on January 1, 1970. Coordinated Universal Time (UTC).
escape_digits

SAY TIME

Synopsis

Says a given time.

Description

Say a given time, returning early if any of the given DTMF digits are received on the channel. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.

Syntax

SAY TIME TIME ESCAPE_DIGITS

Arguments

time - Is number of seconds elapsed since 00:00:00 on January 1, 1970. Coordinated Universal Time (UTC).
escape_digits

SAY DATETIME

Synopsis

Says a given time as specified by the format given.

Description

Syntax

SAY DATETIME TIME ESCAPE_DIGITS FORMAT TIMEZONE

Arguments

time - Is number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)
escape_digits
format - Is the format the time should be said in. See voicemail.conf (defaults to ABdY 'digits/at' IMp).
timezone - Acceptable values can be found in /usr/share/zoneinfo Defaults to machine default.

SEND IMAGE

Synopsis

Sends images to channels supporting it.

Description

Sends the given image on a channel. Most channels do not support the transmission of images. Returns 0 if image is sent, or if the channel does not support image transmission. Returns -1 only on error/hangup. Image names should not include extensions.

Syntax

SEND IMAGE IMAGE

Arguments

image

SEND TEXT

Synopsis

Sends text to channels supporting it.

Description

Sends the given text on a channel. Most channels do not support the transmission of text. Returns 0 if text is sent, or if the channel does not support text transmission. Returns -1 only on error/hangup.

Syntax

SEND TEXT TEXT TO SEND

Arguments

text to send - Text consisting of greater than one word should be placed in quotes since the command only accepts a single argument.

SET AUTOHANGUP

Synopsis

Autohangup channel in some time.

Description

Cause the channel to automatically hangup at time seconds in the future. Of course it can be hungup before then as well. Setting to 0 will cause the autohangup feature to be disabled on this channel.

Syntax

SET AUTOHANGUP TIME

Arguments

time

SET CALLERID

Synopsis

Sets callerid for the current channel.

Description

Changes the callerid of the current channel.

Syntax

SET CALLERID NUMBER

Arguments

number

SET CONTEXT

Synopsis

Sets channel context.

Description

Sets the context for continuation upon exiting the application.

Syntax

SET CONTEXT DESIRED CONTEXT

Arguments

desired context

SET EXTENSION

Synopsis

Changes channel extension.

Description

Changes the extension for continuation upon exiting the application.

Syntax

SET EXTENSION NEW EXTENSION

Arguments

new extension

SET MUSIC

Synopsis

Enable/Disable Music on hold generator

Description

Enables/Disables the music on hold generator. If class is not specified, then the default music on hold class will be used. This generator will be stopped automatically when playing a file.

Always returns 0.

Syntax

SET MUSIC BOOLEAN CLASS

Arguments

boolean
class

SET PRIORITY

Synopsis

Set channel dialplan priority.

Description

Changes the priority for continuation upon exiting the application. The priority must be a valid priority or label.

Syntax

SET PRIORITY PRIORITY

Arguments

priority

SET VARIABLE

Synopsis

Sets a channel variable.

Description

Sets a variable to the current channel.

Syntax

SET VARIABLE VARIABLENAME VALUE

Arguments

variablename
value

STREAM FILE

Synopsis

Sends audio file on channel.

Description

Send the given file, allowing playback to be interrupted by the given digits, if any. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed, or -1 on error or if the channel was disconnected. If musiconhold is playing before calling stream file it will be automatically stopped and will not be restarted after completion.

It sets the following channel variables upon completion:

PLAYBACKSTATUS - The status of the playback attempt as a text string.
- SUCCESS
- FAILED

Syntax

STREAM FILE FILENAME ESCAPE_DIGITS SAMPLE OFFSET

Arguments

filename - File name to play. The file extension must not be included in the filename.
escape_digits - Use double quotes for the digits if you wish none to be permitted.
sample offset - If sample offset is provided then the audio will seek to sample offset before play starts.

TDD MODE

Synopsis

Toggles TDD mode (for the deaf).

Description

Enable/Disable TDD transmission/reception on a channel. Returns 1 if successful, or 0 if channel is not TDD-capable.

Syntax

TDD MODE BOOLEAN

Arguments

boolean

VERBOSE

Synopsis

Logs a message to the asterisk verbose log.

Description

Sends message to the console via verbose message system. level is the verbose level (1-4). Always returns 1

Syntax

VERBOSE MESSAGE LEVEL

Arguments

message
level

WAIT FOR DIGIT

Synopsis

Waits for a digit to be pressed.

Description

Waits up to timeout milliseconds for channel to receive a DTMF digit. Returns -1 on channel failure, 0 if no digit is received in the timeout, or the numerical value of the ascii of the digit if one is received. Use -1 for the timeout value if you desire the call to block indefinitely.

Syntax

WAIT FOR DIGIT TIMEOUT

Arguments

timeout

SPEECH CREATE

Synopsis

Creates a speech object.

Description

Create a speech object to be used by the other Speech AGI commands.

Syntax

SPEECH CREATE ENGINE

Arguments

engine

SPEECH SET

Synopsis

Sets a speech engine setting.

Description

Set an engine-specific setting.

Syntax

SPEECH SET NAME VALUE

Arguments

name
value

SPEECH DESTROY

Synopsis

Destroys a speech object.

Description

Destroy the speech object created by SPEECH CREATE.

Syntax

SPEECH DESTROY

SPEECH LOAD GRAMMAR

Synopsis

Loads a grammar.

Description

Loads the specified grammar as the specified name.

Syntax

SPEECH LOAD GRAMMAR GRAMMAR NAME PATH TO GRAMMAR

Arguments

grammar name
path to grammar

SPEECH UNLOAD GRAMMAR

Synopsis

Unloads a grammar.

Description

Unloads the specified grammar.

Syntax

SPEECH UNLOAD GRAMMAR GRAMMAR NAME

Arguments

grammar name

SPEECH ACTIVATE GRAMMAR

Synopsis

Activates a grammar.

Description

Activates the specified grammar on the speech object.

Syntax

SPEECH ACTIVATE GRAMMAR GRAMMAR NAME

Arguments

grammar name

SPEECH DEACTIVATE GRAMMAR

Synopsis

Deactivates a grammar.

Description

Deactivates the specified grammar on the speech object.

Syntax

SPEECH DEACTIVATE GRAMMAR GRAMMAR NAME

Arguments

grammar name

SPEECH RECOGNIZE

Synopsis

Recognizes speech.

Description

Plays back given prompt while listening for speech and dtmf.

Syntax

SPEECH RECOGNIZE PROMPT TIMEOUT OFFSET

Arguments

prompt
timeout
offset