# interfaces

type: api
name: fsctl
description: FS control messages
ikey: mod_commands
filename: /home/server/switch/freeswitch/mod/mod_commands.so
hostname: debian12
syntax:
  [api_expansion [on|off]|recover|send_sighup|hupall|pause [inbound|outbound]|resume [inbound|outbound]|shutdown [cancel|elegant|asap|now|restart]|sps|sps_peak_reset|sync_clock|sync_clock_when_idle|reclaim_mem|max_sessions|min_dtmf_duration [num]|max_dtmf_duration [num]|default_dtmf_duration [num]|min_idle_cpu|loglevel [level]|debug_level [level]|mdns_resolve [enable|disable]]


type: api
name: originate
description: Originate a call
ikey: mod_commands
filename: /home/server/switch/freeswitch/mod/mod_commands.so
hostname: debian12
syntax:
  <call url> <exten>|&<application_name>(<app_args>) [<dialplan>] [<context>] [<cid_name>] [<cid_num>] [<timeout_sec>]


type: api
name: show
description: Show various reports
ikey: mod_commands
filename: /home/server/switch/freeswitch/mod/mod_commands.so
hostname: debian12
syntax:
  codec|endpoint|application|api|dialplan|file|timer|calls [count]|channels [count|like <match string>]|calls|detailed_calls|bridged_calls|detailed_bridged_calls|aliases|complete|chat|management|modules|nat_map|say|interfaces|interface_types|tasks|limits|status


type: application
name: curl
description: Perform a http request
ikey: mod_curl
filename: /home/server/switch/freeswitch/mod/mod_curl.so
hostname: debian12
syntax:
  curl url [headers|json|content-type <mime-type>|connect-timeout <seconds>|timeout <seconds>|append_headers <header_name:header_value>[|append_headers <header_name:header_value>]|insecure|secure|[proxy <http://proxy:port>]] [get|head|post|delete|put [data]]


type: application
name: curl_sendfile
description: Send a file and some optional post variables via HTTP
ikey: mod_curl
filename: /home/server/switch/freeswitch/mod/mod_curl.so
hostname: debian12
syntax:
  <url> <filenameParamName=filepath> [nopost|postparam1=foo&postparam2=bar... [event|none  [identifier ]]]


type: api
name: curl_sendfile
description: curl_sendfile API
ikey: mod_curl
filename: /home/server/switch/freeswitch/mod/mod_curl.so
hostname: debian12
syntax:
  <url> <filenameParamName=filepath> [nopost|postparam1=foo&postparam2=bar... [event|stream|both|none  [identifier ]]]


type: application
name: detect_speech
description: Detect speech
ikey: mod_dptools
filename: /home/server/switch/freeswitch/mod/mod_dptools.so
hostname: debian12
syntax:
  <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>


type: application
name: play_and_get_digits
description: Play and get Digits
ikey: mod_dptools
filename: /home/server/switch/freeswitch/mod/mod_dptools.so
hostname: debian12
syntax:
  	<min> <max> <tries> <timeout> <terminators> <file> <invalid_file> <var_name> <regexp> [<digit_timeout>] ['<failure_ext> [failure_dp [failure_context]]']


type: application
name: fifo
description: Park with FIFO
ikey: mod_fifo
filename: /home/server/switch/freeswitch/mod/mod_fifo.so
hostname: debian12
syntax:
  <fifo name>[!<importance_number>] [in [<announce file>|undef] [<music file>|undef] [early|noans] | out [wait|nowait] [<announce file>|undef] [<music file>|undef]]


type: api
name: fifo_member
description: Add members to a fifo
ikey: mod_fifo
filename: /home/server/switch/freeswitch/mod/mod_fifo.so
hostname: debian12
syntax:
  [add <fifo_name> <originate_string> [<simo_count>] [<timeout>] [<lag>] [<expires>] [<taking_calls>] | del <fifo_name> <originate_string>]


