dialplan_application.rst 92 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. #####################
  2. Dialplan Application
  3. #####################
  4. Dialplan Application uses FreeSWITCH **show application** to build the dropdown lists that are found in FusionPBX dialplans.
  5. This is a list from a default install and the list can change depending on how many FreeSWITCH modules are installed.
  6. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  7. | name | description | syntax | ikey | |
  8. +================================+========================================================+=================================================================================================================================================================+=====================+===+
  9. | answer | Answer the call | | mod_dptools | |
  10. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  11. | att_xfer | Attended Transfer | <channel_url> | mod_dptools | |
  12. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  13. | bgsystem | Execute a system command in the background | <command> | mod_dptools | |
  14. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  15. | bind_digit_action | bind a key sequence or regex to an action | <realm>,<digits|~regex>,<string>[,<value>][,<dtmf target leg>][,<event target leg>] | mod_dptools | |
  16. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  17. | bind_meta_app | Bind a key to an application | <key> [a|b|ab] [a|b|o|s|i|1] <app> | mod_dptools | |
  18. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  19. | block_dtmf | Block DTMF | | mod_dptools | |
  20. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  21. | break | Break | | mod_dptools | |
  22. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  23. | bridge | Bridge Audio | <channel_url> | mod_dptools | |
  24. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  25. | bridge_export | Export a channel variable across a bridge | <varname>=<value> | mod_dptools | |
  26. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  27. | callcenter | CallCenter | queue_name | mod_callcenter | |
  28. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  29. | capture | capture data into a var | <varname>|<data>|<regex> | mod_dptools | |
  30. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  31. | check_acl | Check an ip against an ACL list | <ip> <acl | cidr> [<hangup_cause>] | mod_dptools | |
  32. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  33. | clear_digit_action | clear all digit bindings | <realm>|all[,target] | mod_dptools | |
  34. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  35. | clear_speech_cache | Clear Speech Handle Cache | | mod_dptools | |
  36. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  37. | cng_plc | Do PLC on CNG frames | | mod_dptools | |
  38. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  39. | conference | conference | | mod_conference | |
  40. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  41. | conference_set_auto_outcall | conference_set_auto_outcall | | mod_conference | |
  42. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  43. | db | Insert to the db | [insert|delete]/<realm>/<key>/<val> | mod_db | |
  44. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  45. | decode_video | decode picture | [max_pictures] | mod_fsv | |
  46. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  47. | deduplicate_dtmf | Prevent duplicate inband + 2833 dtmf | [only_rtp] | mod_dptools | |
  48. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  49. | deflect | Send call deflect | <deflect_data> | mod_dptools | |
  50. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  51. | delay_echo | echo audio at a specified delay | <delay ms> | mod_dptools | |
  52. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  53. | detect_audio | detect_audio | <threshold> <audio_hits> <timeout_ms> [<file>] | mod_dptools | |
  54. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  55. | detect_silence | detect_silence | <threshold> <silence_hits> <timeout_ms> [<file>] | mod_dptools | |
  56. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  57. | detect_speech | Detect speech | <mod_name> <gram_name> <gram_path> [<addr>] OR grammar <gram_name> [<path>] OR nogrammar <gram_name> OR grammaron/grammaroff <gram_name> OR grammarsalloff | mod_dptools | |
  58. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  59. | | OR pause OR resume OR start_input_timers OR stop OR param <name> <value> |
  60. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  61. | digit_action_set_realm | change binding realm | <realm>[,<target>] | mod_dptools | |
  62. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  63. | displace_session | Displace File | <path> [<flags>] [+time_limit_ms] | mod_dptools | |
  64. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  65. | early_hangup | Enable early hangup | | mod_dptools | |
  66. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  67. | eavesdrop | eavesdrop on a uuid | [all | <uuid>] | mod_dptools | |
  68. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  69. | echo | Echo | | mod_dptools | |
  70. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  71. | enable_heartbeat | Enable Media Heartbeat | [0|<seconds>] | mod_dptools | |
  72. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  73. | enable_keepalive | Enable Keepalive | [0|<seconds>] | mod_dptools | |
  74. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  75. | endless_playback | Playback File Endlessly | <path> | mod_dptools | |
  76. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  77. | enum | Perform an ENUM lookup | [reload | <number> [<root>]] | mod_enum | |
  78. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  79. | eval | Do Nothing | | mod_dptools | |
  80. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  81. | event | Fire an event | | mod_dptools | |
  82. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  83. | execute_extension | Execute an extension | <extension> <dialplan> <context> | mod_dptools | |
  84. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  85. | export | Export a channel variable across a bridge | <varname>=<value> | mod_dptools | |
  86. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  87. | fax_detect | Detect faxes | | mod_dptools | |
  88. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  89. | fifo | Park with FIFO | <fifo name>[!<importance_number>] [in [<announce file>|undef] [<music file>|undef] | out [wait|nowait] [<announce file>|undef] [<music file>|undef]] | mod_fifo | |
  90. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  91. | fifo_track_call | Count a call as a fifo call in the manual_calls queue | <fifo_outbound_uuid> | mod_fifo | |
  92. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  93. | fire | fire the message | | mod_sms | |
  94. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  95. | flush_dtmf | flush any queued dtmf | | mod_dptools | |
  96. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  97. | gentones | Generate Tones | <tgml_script>[|<loops>] | mod_dptools | |
  98. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  99. | group | Manage a group | [insert|delete]:<group name>:<val> | mod_db | |
  100. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  101. | hangup | Hangup the call | [<cause>] | mod_dptools | |
  102. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  103. | hash | Insert into the hashtable | [insert|insert_ifempty|delete|delete_ifmatch]/<realm>/<key>/<val> | mod_hash | |
  104. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  105. | hold | Send a hold message | [<display message>] | mod_dptools | |
  106. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  107. | info | Display Call Info | | mod_sms | |
  108. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  109. | info | Display Call Info | | mod_dptools | |
  110. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  111. | intercept | intercept | [-bleg] <uuid> | mod_dptools | |
  112. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  113. | ivr | Run an ivr menu | | mod_dptools | |
  114. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  115. | jitterbuffer | Send session jitterbuffer | <jitterbuffer_data> | mod_dptools | |
  116. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  117. | limit | Limit | <backend> <realm> <id> [<max>[/interval]] [number [dialplan [context]]] | mod_dptools | |
  118. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  119. | limit_execute | Limit | <backend> <realm> <id> <max>[/interval] <application> [application arguments] | mod_dptools | |
  120. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  121. | limit_hash | Limit | <realm> <id> [<max>[/interval]] [number [dialplan [context]]] | mod_dptools | |
  122. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  123. | limit_hash_execute | Limit | <realm> <id> <max>[/interval] <application> [application arguments] | mod_dptools | |
  124. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  125. | log | Logs to the logger | <log_level> <log_string> | mod_dptools | |
  126. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  127. | loop_playback | Playback File looply | [+loops] <path> | mod_dptools | |
  128. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  129. | media_reset | Reset all bypass/proxy media flags | | mod_dptools | |
  130. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  131. | mkdir | Create a directory | <path> | mod_dptools | |
  132. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  133. | multiset | Set many channel variables | [^^<delim>]<varname>=<value> <var2>=<val2> | mod_dptools | |
  134. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  135. | multiunset | Unset many channel variables | [^^<delim>]<varname> <var2> <var3> | mod_dptools | |
  136. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  137. | mutex | block on a call flow only allowing one at a time | <keyname>[ on|off] | mod_dptools | |
  138. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  139. | novideo | Refuse Inbound Video | | mod_dptools | |
  140. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  141. | park | Park | | mod_dptools | |
  142. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  143. | park_state | Park State | | mod_dptools | |
  144. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  145. | phrase | Say a Phrase | <macro_name>,<data> | mod_dptools | |
  146. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  147. | pickup | Pickup | [<key>] | mod_dptools | |
  148. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  149. | play_and_detect_speech | Play and do speech recognition | <file> detect:<engine> {param1=val1,param2=val2}<grammar> | mod_dptools | |
  150. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  151. | play_and_get_digits | Play and get Digits | <min> <max> <tries> <timeout> <terminators> <file> <invalid_file> <var_name> <regexp> [<digit_timeout>] ['<failure_ext> [failure_dp [failure_context]]'] | mod_dptools | |
  152. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  153. | play_fsv | play a fsv file | <file> | mod_fsv | |
  154. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  155. | play_yuv | play a yvv file | <file> [width] [height] | mod_fsv | |
  156. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  157. | playback | Playback File | <path> | mod_dptools | |
  158. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  159. | pre_answer | Pre-Answer the call | | mod_dptools | |
  160. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  161. | preprocess | pre-process | | mod_dptools | |
  162. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  163. | presence | Send Presence | <rpid> <status> [<id>] | mod_dptools | |
  164. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  165. | privacy | Set privacy on calls | off|on|name|full|number | mod_dptools | |
  166. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  167. | push | Set a channel variable | <varname>=<value> | mod_dptools | |
  168. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  169. | queue_dtmf | Queue dtmf to be sent | <dtmf_data> | mod_dptools | |
  170. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  171. | read | Read Digits | <min> <max> <file> <var_name> <timeout> <terminators> <digit_timeout> | mod_dptools | |
  172. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  173. | record | Record File | <path> [<time_limit_secs>] [<silence_thresh>] [<silence_hits>] | mod_dptools | |
  174. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  175. | record_fsv | record an fsv file | <file> | mod_fsv | |
  176. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  177. | record_session | Record Session | <path> [+<timeout>] | mod_dptools | |
  178. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  179. | record_session_mask | Mask audio in recording | <path> | mod_dptools | |
  180. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  181. | record_session_unmask | Resume recording | <path> | mod_dptools | |
  182. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  183. | recovery_refresh | Send call recovery_refresh | | mod_dptools | |
  184. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  185. | redirect | Send session redirect | <redirect_data> | mod_dptools | |
  186. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  187. | remove_bugs | Remove media bugs | [<function>] | mod_dptools | |
  188. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  189. | rename | Rename file | <from_path> <to_path> | mod_dptools | |
  190. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  191. | reply | reply to a message | | mod_sms | |
  192. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  193. | respond | Send session respond | <respond_data> | mod_dptools | |
  194. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  195. | ring_ready | Indicate Ring_Ready | | mod_dptools | |
  196. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  197. | rxfax | FAX Receive Application | <filename> | mod_spandsp | |
  198. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  199. | say | say | <module_name>[:<lang>] <say_type> <say_method> [<say_gender>] <text> | mod_dptools | |
  200. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  201. | sched_broadcast | Schedule a broadcast in the future | [+]<time> <path> [aleg|bleg|both] | mod_dptools | |
  202. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  203. | sched_cancel | cancel scheduled tasks | [group] | mod_dptools | |
  204. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  205. | sched_hangup | Schedule a hangup in the future | [+]<time> [<cause>] | mod_dptools | |
  206. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  207. | sched_heartbeat | Enable Scheduled Heartbeat | [0|<seconds>] | mod_dptools | |
  208. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  209. | sched_transfer | Schedule a transfer in the future | [+]<time> <extension> <dialplan> <context> | mod_dptools | |
  210. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  211. | send | send the message as-is | | mod_sms | |
  212. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  213. | send_display | Send session a new display | <text> | mod_dptools | |
  214. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  215. | send_dtmf | Send dtmf to be sent | <dtmf_data> | mod_dptools | |
  216. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  217. | send_info | Send info | <info> | mod_dptools | |
  218. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  219. | session_loglevel | session_loglevel | <level> | mod_dptools | |
  220. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  221. | set | set a variable | | mod_sms | |
  222. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  223. | set | Set a channel variable | <varname>=<value> | mod_dptools | |
  224. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  225. | set_audio_level | set volume | | mod_dptools | |
  226. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  227. | set_global | Set a global variable | <varname>=<value> | mod_dptools | |
  228. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  229. | set_media_stats | Set Media Stats | | mod_dptools | |
  230. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  231. | set_mute | set mute | | mod_dptools | |
  232. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  233. | set_name | Name the channel | <name> | mod_dptools | |
  234. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  235. | set_profile_var | Set a caller profile variable | <varname>=<value> | mod_dptools | |
  236. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  237. | set_user | Set a User | <user>@<domain> [prefix] | mod_dptools | |
  238. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  239. | set_zombie_exec | Enable Zombie Execution | | mod_dptools | |
  240. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  241. | sleep | Pause a channel | <pausemilliseconds> | mod_dptools | |
  242. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  243. | socket | Connect to a socket | <ip>[:<port>] | mod_event_socket | |
  244. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  245. | sofia_sla | private sofia sla function | <uuid> | mod_sofia | |
  246. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  247. | soft_hold | Put a bridged channel on hold | <unhold key> [<moh_a>] [<moh_b>] | mod_dptools | |
  248. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  249. | sound_test | Analyze Audio | | mod_dptools | |
  250. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  251. | spandsp_detect_tdd | Detect TDD data | | mod_spandsp | |
  252. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  253. | spandsp_inject_tdd | Send TDD data | | mod_spandsp | |
  254. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  255. | spandsp_send_tdd | Send TDD data | | mod_spandsp | |
  256. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  257. | spandsp_start_dtmf | Detect dtmf | | mod_spandsp | |
  258. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  259. | spandsp_start_fax_detect | start fax detect | <app>[ <arg>][ <timeout>][ <tone_type>] | mod_spandsp | |
  260. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  261. | spandsp_start_tone_detect | Start background tone detection with cadence | <name> | mod_spandsp | |
  262. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  263. | spandsp_stop_detect_tdd | stop sending tdd | | mod_spandsp | |
  264. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  265. | spandsp_stop_dtmf | stop inband dtmf | | mod_spandsp | |
  266. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  267. | spandsp_stop_fax_detect | stop fax detect | | mod_spandsp | |
  268. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  269. | spandsp_stop_inject_tdd | stop sending tdd | | mod_spandsp | |
  270. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  271. | spandsp_stop_tone_detect | Stop background tone detection with cadence | | mod_spandsp | |
  272. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  273. | speak | Speak text | <engine>|<voice>|<text> | mod_dptools | |
  274. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  275. | start_dtmf | Detect dtmf | | mod_dptools | |
  276. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  277. | start_dtmf_generate | Generate dtmf | | mod_dptools | |
  278. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  279. | stop | stop execution | | mod_sms | |
  280. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  281. | stop | Do Nothing | | mod_dptools | |
  282. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  283. | stop_displace_session | Stop Displace File | <path> | mod_dptools | |
  284. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  285. | stop_dtmf | stop inband dtmf | | mod_dptools | |
  286. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  287. | stop_dtmf_generate | stop inband dtmf generation | [write] | mod_dptools | |
  288. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  289. | stop_record_session | Stop Record Session | <path> | mod_dptools | |
  290. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  291. | stop_tone_detect | stop detecting tones | | mod_dptools | |
  292. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  293. | stop_video_write_overlay | Stop video write overlay | <path> | mod_dptools | |
  294. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  295. | stopfax | Stop FAX Application | | mod_spandsp | |
  296. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  297. | strftime | strftime | [<epoch>|]<format string> | mod_dptools | |
  298. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  299. | system | execute a system command | | mod_sms | |
  300. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  301. | system | Execute a system command | <command> | mod_dptools | |
  302. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  303. | t38_gateway | Convert to T38 Gateway if tones are heard | | mod_spandsp | |
  304. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  305. | three_way | three way call with a uuid | <uuid> | mod_dptools | |
  306. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  307. | tone_detect | Detect tones | | mod_dptools | |
  308. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  309. | transfer | Transfer a channel | <exten> [<dialplan> <context>] | mod_dptools | |
  310. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  311. | transfer_vars | Transfer variables | <~variable_prefix|variable> | mod_dptools | |
  312. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  313. | txfax | FAX Transmit Application | <filename> | mod_spandsp | |
  314. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  315. | unbind_meta_app | Unbind a key from an application | [<key>] | mod_dptools | |
  316. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  317. | unblock_dtmf | Stop blocking DTMF | | mod_dptools | |
  318. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  319. | unhold | Send a un-hold message | | mod_dptools | |
  320. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  321. | unloop | Tell loopback to unfold | | mod_loopback | |
  322. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  323. | unset | unset a variable | | mod_sms | |
  324. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  325. | unset | Unset a channel variable | <varname> | mod_dptools | |
  326. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  327. | unshift | Set a channel variable | <varname>=<value> | mod_dptools | |
  328. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  329. | valet_park | valet_park | <lotname> <extension>|[ask [<min>] [<max>] [<to>] [<prompt>]|auto [in|out] [min] [max]] | mod_valet_parking | |
  330. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  331. | verbose_events | Make ALL Events verbose. | | mod_dptools | |
  332. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  333. | video_decode | Set video decode. | [[on|wait]|off] | mod_dptools | |
  334. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  335. | video_refresh | Send video refresh. | [manual|auto] | mod_dptools | |
  336. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  337. | video_write_overlay | Video write overlay | <path> [<pos>] [<alpha>] | mod_dptools | |
  338. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  339. | wait_for_answer | Wait for call to be answered | | mod_dptools | |
  340. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+
  341. | wait_for_silence | wait_for_silence | <silence_thresh> <silence_hits> <listen_hits> <timeout_ms> [<file>] | mod_dptools | |
  342. +--------------------------------+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---+