FreeSWITCH applications
| name | description | ikey | syntax |
|---|---|---|---|
| AvoidingDeadlock | Avoid | mod_dialplan_asterisk | Avoid |
| Dial | Dial | mod_dialplan_asterisk | Dial |
| Goto | Goto | mod_dialplan_asterisk | Goto |
| answer | Answer the call | mod_dptools | |
| att_xfer | Attended Transfer | mod_dptools | <channel_url> |
| bgsystem | Execute a system command in the background | mod_dptools | <command> |
| bind_digit_action | bind a key sequence or regex to an action | mod_dptools | <realm>,<digits|~regex>,<string>[,<value>][,<dtmf target leg>][,<event target leg>] |
| bind_meta_app | Bind a key to an application | mod_dptools | <key> [a|b|ab] [a|b|o|s|i|1] <app> |
| blind_transfer_ack | mod_dptools | [true|false] | |
| block_dtmf | Block DTMF | mod_dptools | |
| break | Break | mod_dptools | |
| bridge | Bridge Audio | mod_dptools | <channel_url> |
| bridge_export | Export a channel variable across a bridge | mod_dptools | <varname>=<value> |
| capture | capture data into a var | mod_dptools | <varname>|<data>|<regex> |
| check_acl | Check an ip against an ACL list | mod_dptools | <ip> <acl | cidr> [<hangup_cause>] |
| clear_digit_action | clear all digit bindings | mod_dptools | <realm>|all[,target] |
| clear_speech_cache | Clear Speech Handle Cache | mod_dptools | |
| cng_plc | Do PLC on CNG frames | mod_dptools | |
| conference | conference | mod_conference | |
| conference_set_auto_outcall | conference_set_auto_outcall | mod_conference | |
| db | Insert to the db | mod_db | [insert|delete]/<realm>/<key>/<val> |
| decode_video | decode picture | mod_fsv | [max_pictures] |
| deduplicate_dtmf | Prevent duplicate inband + 2833 dtmf | mod_dptools | [only_rtp] |
| deflect | Send call deflect | mod_dptools | <deflect_data> |
| delay_echo | echo audio at a specified delay | mod_dptools | <delay ms> |
| detect_speech | Detect speech | mod_dptools | <mod_name> <gram_name> <gram_path> [<addr>] OR grammar <gram_name> [<path>] OR nogrammar <gram_name> OR grammaron/grammaroff <gram_name> OR grammarsalloff OR pause OR resume OR start_input_timers OR stop OR param <name> <value> |
| digit_action_set_realm | change binding realm | mod_dptools | <realm>[,<target>] |
| displace_session | Displace File | mod_dptools | <path> [<flags>] [+time_limit_ms] |
| early_hangup | Enable early hangup | mod_dptools | |
| eavesdrop | eavesdrop on a uuid | mod_dptools | [all | <uuid>] |
| echo | Echo | mod_dptools | |
| enable_heartbeat | Enable Media Heartbeat | mod_dptools | [0|<seconds>] |
| enable_keepalive | Enable Keepalive | mod_dptools | [0|<seconds>] |
| endless_playback | Playback File Endlessly | mod_dptools | <path> |
| enum | Perform an ENUM lookup | mod_enum | [reload | <number> [<root>]] |
| esf_page_group | mod_esf | ||
| eval | Do Nothing | mod_dptools | |
| event | Fire an event | mod_dptools | |
| execute_extension | Execute an extension | mod_dptools | <extension> <dialplan> <context> |
| export | Export a channel variable across a bridge | mod_dptools | <varname>=<value> |
| fax_detect | Detect faxes | mod_dptools | |
| fifo | Park with FIFO | mod_fifo | <fifo name>[!<importance_number>] [in [<announce file>|undef] [<music file>|undef] | out [wait|nowait] [<announce file>|undef] [<music file>|undef]] |
| fifo_track_call | Count a call as a fifo call in the manual_calls queue | mod_fifo | <fifo_outbound_uuid> |
| flush_dtmf | flush any queued dtmf | mod_dptools | |
| gentones | Generate Tones | mod_dptools | <tgml_script>[|<loops>] |
| group | Manage a group | mod_db | [insert|delete]:<group name>:<val> |
| hangup | Hangup the call | mod_dptools | [<cause>] |
| hash | Insert into the hashtable | mod_hash | [insert|insert_ifempty|delete|delete_ifmatch]/<realm>/<key>/<val> |
| hold | Send a hold message | mod_dptools | [<display message>] |
| httapi | HT-TAPI Hypertext Telephony API | mod_httapi | {<param1>=<val1>} |
| info | Display Call Info | mod_dptools | |
| intercept | intercept | mod_dptools | [-bleg] <uuid> |
| ivr | Run an ivr menu | mod_dptools | <menu_name> |
| jitterbuffer | Send session jitterbuffer | mod_dptools | <jitterbuffer_data> |
| limit | Limit | mod_dptools | <backend> <realm> <id> [<max>[/interval]] [number [dialplan [context]]] |
| limit_execute | Limit | mod_dptools | <backend> <realm> <id> <max>[/interval] <application> [application arguments] |
| limit_hash | Limit | mod_dptools | <realm> <id> [<max>[/interval]] [number [dialplan [context]]] |
| limit_hash_execute | Limit | mod_dptools | <realm> <id> <max>[/interval] <application> [application arguments] |
| log | Logs to the logger | mod_dptools | <log_level> <log_string> |
| loop_playback | Playback File looply | mod_dptools | [+loops] <path> |
| lua | Launch LUA ivr | mod_lua | <script> |
| lua | execute a lua script | mod_lua | <script> |
| media_reset | Reset all bypass/proxy media flags | mod_dptools | |
| mkdir | Create a directory | mod_dptools | <path> |
| multiset | Set many channel variables | mod_dptools | [^^<delim>]<varname>=<value> <var2>=<val2> |
| multiunset | Unset many channel variables | mod_dptools | [^^<delim>]<varname> <var2> <var3> |
| mutex | block on a call flow only allowing one at a time | mod_dptools | <keyname>[ on|off] |
| novideo | Refuse Inbound Video | mod_dptools | |
| page | mod_dptools | <var1=val1,var2=val2><chan1>[:_:<chanN>] | |
| park | Park | mod_dptools | |
| park_state | Park State | mod_dptools | |
| phrase | Say a Phrase | mod_dptools | <macro_name>,<data> |
| pickup | Pickup | mod_dptools | [<key>] |
| play_and_detect_speech | Play and do speech recognition | mod_dptools | <file> detect:<engine> {param1=val1,param2=val2}<grammar> |
| play_and_get_digits | Play and get Digits | mod_dptools | <min> <max> <tries> <timeout> <terminators> <file> <invalid_file> <var_name> <regexp> [<digit_timeout>] ['<failure_ext> [failure_dp [failure_context]]'] |
| play_fsv | play a fsv file | mod_fsv | <file> |
| play_yuv | play a yvv file | mod_fsv | <file> [width] [height] |
| playback | Playback File | mod_dptools | <path> |
| pre_answer | Pre-Answer the call | mod_dptools | |
| preprocess | pre-process | mod_dptools | |
| presence | Send Presence | mod_dptools | <rpid> <status> [<id>] |
| privacy | Set privacy on calls | mod_dptools | off|on|name|full|number |
| push | Set a channel variable | mod_dptools | <varname>=<value> |
| queue_dtmf | Queue dtmf to be sent | mod_dptools | <dtmf_data> |
| read | Read Digits | mod_dptools | <min> <max> <file> <var_name> <timeout> <terminators> <digit_timeout> |
| record | Record File | mod_dptools | <path> [<time_limit_secs>] [<silence_thresh>] [<silence_hits>] |
| record_fsv | record an fsv file | mod_fsv | <file> |
| record_session | Record Session | mod_dptools | <path> [+<timeout>] |
| record_session_mask | Mask audio in recording | mod_dptools | <path> |
| record_session_unmask | Resume recording | mod_dptools | <path> |
| recovery_refresh | Send call recovery_refresh | mod_dptools | |
| redirect | Send session redirect | mod_dptools | <redirect_data> |
| remove_bugs | Remove media bugs | mod_dptools | [<function>] |
| rename | Rename file | mod_dptools | <from_path> <to_path> |
| respond | Send session respond | mod_dptools | <respond_data> |
| ring_ready | Indicate Ring_Ready | mod_dptools | |
| rxfax | FAX Receive Application | mod_spandsp | <filename> |
| say | say | mod_dptools | <module_name>[:<lang>] <say_type> <say_method> [<say_gender>] <text> |
| sched_broadcast | Schedule a broadcast in the future | mod_dptools | [+]<time> <path> [aleg|bleg|both] |
| sched_cancel | cancel scheduled tasks | mod_dptools | [group] |
| sched_hangup | Schedule a hangup in the future | mod_dptools | [+]<time> [<cause>] |
| sched_heartbeat | Enable Scheduled Heartbeat | mod_dptools | [0|<seconds>] |
| sched_transfer | Schedule a transfer in the future | mod_dptools | [+]<time> <extension> <dialplan> <context> |
| send_display | Send session a new display | mod_dptools | <text> |
| send_dtmf | Send dtmf to be sent | mod_dptools | <dtmf_data> |
| send_info | Send info | mod_dptools | <info> |
| session_loglevel | session_loglevel | mod_dptools | <level> |
| set | Set a channel variable | mod_dptools | <varname>=<value> |
| set_audio_level | set volume | mod_dptools | |
| set_global | Set a global variable | mod_dptools | <varname>=<value> |
| set_media_stats | Set Media Stats | mod_dptools | |
| set_mute | set mute | mod_dptools | |
| set_name | Name the channel | mod_dptools | <name> |
| set_profile_var | Set a caller profile variable | mod_dptools | <varname>=<value> |
| set_user | Set a User | mod_dptools | <user>@<domain> [prefix] |
| set_zombie_exec | Enable Zombie Execution | mod_dptools | |
| sleep | Pause a channel | mod_dptools | <pausemilliseconds> |
| socket | Connect to a socket | mod_event_socket | <ip>[:<port>] |
| sofia_sla | private sofia sla function | mod_sofia | <uuid> |
| soft_hold | Put a bridged channel on hold | mod_dptools | <unhold key> [<moh_a>] [<moh_b>] |
| sound_test | Analyze Audio | mod_dptools | |
| spandsp_detect_tdd | Detect TDD data | mod_spandsp | |
| spandsp_inject_tdd | Send TDD data | mod_spandsp | |
| spandsp_send_tdd | Send TDD data | mod_spandsp | |
| spandsp_start_dtmf | Detect dtmf | mod_spandsp | |
| spandsp_start_fax_detect | start fax detect | mod_spandsp | <app>[ <arg>][ <timeout>][ <tone_type>] |
| spandsp_start_tone_detect | Start background tone detection with cadence | mod_spandsp | <name> |
| spandsp_stop_detect_tdd | stop sending tdd | mod_spandsp | |
| spandsp_stop_dtmf | stop inband dtmf | mod_spandsp | |
| spandsp_stop_fax_detect | stop fax detect | mod_spandsp | |
| spandsp_stop_inject_tdd | stop sending tdd | mod_spandsp | |
| spandsp_stop_tone_detect | Stop background tone detection with cadence | mod_spandsp | |
| speak | Speak text | mod_dptools | <engine>|<voice>|<text> |
| start_dtmf | Detect dtmf | mod_dptools | |
| start_dtmf_generate | Generate dtmf | mod_dptools | |
| stop | Do Nothing | mod_dptools | |
| stop_displace_session | Stop Displace File | mod_dptools | <path> |
| stop_dtmf | stop inband dtmf | mod_dptools | |
| stop_dtmf_generate | stop inband dtmf generation | mod_dptools | [write] |
| stop_record_session | Stop Record Session | mod_dptools | <path> |
| stop_tone_detect | stop detecting tones | mod_dptools | |
| stop_video_write_overlay | Stop video write overlay | mod_dptools | <path> |
| stopfax | Stop FAX Application | mod_spandsp | |
| strftime | strftime | mod_dptools | [<epoch>|]<format string> |
| system | Execute a system command | mod_dptools | <command> |
| t38_gateway | Convert to T38 Gateway if tones are heard | mod_spandsp | |
| three_way | three way call with a uuid | mod_dptools | <uuid> |
| tone_detect | Detect tones | mod_dptools | |
| transfer | Transfer a channel | mod_dptools | <exten> [<dialplan> <context>] |
| transfer_vars | Transfer variables | mod_dptools | <~variable_prefix|variable> |
| txfax | FAX Transmit Application | mod_spandsp | <filename> |
| unbind_meta_app | Unbind a key from an application | mod_dptools | [<key>] |
| unblock_dtmf | Stop blocking DTMF | mod_dptools | |
| unhold | Send a un-hold message | mod_dptools | |
| unloop | Tell loopback to unfold | mod_loopback | |
| unset | Unset a channel variable | mod_dptools | <varname> |
| unshift | Set a channel variable | mod_dptools | <varname>=<value> |
| valet_park | valet_park | mod_valet_parking | <lotname> <extension>|[ask [<min>] [<max>] [<to>] [<prompt>]|auto [in|out] [min] [max]] |
| verbose_events | Make ALL Events verbose. | mod_dptools | |
| video_refresh | Send video refresh. | mod_dptools | |
| video_write_overlay | Video write overlay | mod_dptools | <path> [<pos>] [<alpha>] |
| voicemail | Voicemail | mod_voicemail | [check] [auth] <profile_name> <domain_name> [<id>] [uuid] |
| wait_for_answer | Wait for call to be answered | mod_dptools | |
| wait_for_silence | wait_for_silence | mod_dptools | <silence_thresh> <silence_hits> <listen_hits> <timeout_ms> [<file>] |