FreeSWITCH Commands
FreeSWITCH
Commands
https://freeswitch.org/confluence/display/FREESWITCH/mod_commands
https://freeswitch.org/confluence/pages/viewpage.action?pageId=1048948
https://freeswitch.org/confluence/display/FREESWITCH/mod_console#Command-Line_Editing
|
||||
|
"slash" command |
Description |
Examples |
Notes |
|
|
/quit |
These all result
in disconnecting from the FreeSWITCH command line. |
/quit |
||
|
/bye |
/bye |
|||
|
/exit |
/exit |
|||
|
/event |
Subscribe to FreeSWITCH events. |
/event all |
This command corresponds to the event command
in mod_event_socket. |
|
|
/noevents |
Unsubscribe from all events (previously subscribed to using /event). |
/noevents |
This command corresponds to the noevents command
in mod_event_socket. |
|
|
/nixevent |
Suppress the specified type of event. Useful when you
want to allow /event all followed
by nixevent <some_event> to see all
but one type of event. |
/nixevent HEARTBEAT |
This command corresponds to the nixevent command
in mod_event_socket. |
|
|
/log |
Set log level of the
FreeSWITCH deamon. 0 - CONSOLE 1 - ALERT 2 - CRIT 3 - ERR 4 - WARNING 5 - NOTICE 6 - INFO 7 - DEBUG |
/log alert /log 1 |
This command corresponds to the log command
in mod_event_socket. TODO So what
is the point of console loglevel <level> ? The default
log level is stated when fs_cli is started
(which is 7 for debug), but console loglevel will
report NOTICE (i.e., 5). |
|
|
/nolog |
Disable logging. |
/nolog |
This command corresponds to the nolog command
in mod_event_socket. |
|
|
/uuid |
Filter logs for a single call (specified by its UUID). |
/uuid 6936d2ad-bea3-40b3-9de3-34024404e8d4 |
||
|
/filter |
Specify what events to listen to by event header value. /filter
<EventHeader> <ValueToFilter> |
/filter Event-Name HEARTBEAT /filter Unique-ID
d29a070f-40ff-43d8-8b9d-d369b2389dfe |
This command corresponds to the filter command
in mod_event_socket. |
|
|
/filter delete |
Delete previously set event filters. /filter
delete <EventHeader> <ValueToFilter> If <ValueToFilter> is omitted,
the command will delete all filters previously set for the specified event
header. |
/filter delete
Event-Name HEARTBEAT /filter delete
Unique-ID d29a070f-40ff-43d8-8b9d-d369b2389dfe /filter delete
Unique-ID |
This command corresponds to the filter delete command
in mod_event_socket. |
|
|
/logfilter <string> |
Filter the logs by the given <string> . (The log
levels are set by /log , see above.) TODO What is the
exact syntax? Does it accept regexes as well? I know that it takes anything
that follows /logfilter literally,
because adding double quotes to a string with space will actually look for
double quotes in the log entries. |
/logfilter Codec Activated |
||
|
/logfilter |
Disable all logfilters. |
/logfilter |
||
|
/help |
List available fs_cli commands. |
/help |
||
|
/debug <debug_level> |
There are 8 debug levels (from 0 to 7) and the higher the number the
more verbose the logs will become. /debug
<debug_level> is equivalent to
|
/debug 3 |
||
|
/debug |
Same as /debug 0 |
/debug |
||
Change the log level to debug so that all loggers below debug as well as debug
will be displayed
In vars.xml
<X-PRE-PROCESS cmd="set"
data="console_loglevel=info"/>
Now run
reloadxml command in fs_cli
or “fsctl loglevel debug” in fs_cli
Important commands
----------------
https://blog.katastros.com/a?ID=00700-03b958aa-a48f-4f4c-8b56-0bcf263685cc
Provisioning
------------
load <modulename>
unload <modulename>
list_users
xml configuration
-------------------
sofia xmlstatus
reloadxml
sip stack debugging
--------------
sofia profile
sofia status
sofia loglevel all 9
sofia tracelevel debug
Debug traces
---------------
sofia global siptrace on
sofia tracelevel debug
fsctl loglevel debug
console loglevel 7
call
-----
api originate sofia/external/1002@192.168.23.81
1003
bgapi originate
sofia/external/1002@192.168.23.81 1003
conference 3001
dial sofia/external/5001@192.168.6.90
show calls
show channels
show registrations
hupall
list_users
timer
------
msleep
Memory stats
-----------
memory
pool_stats
thread checking
-----
fsctl debug_pool
termination
--------
shutdown
All commands description
-----------------
freeswitch@ip-172-18-1-221> help
Valid
Commands:
...,,Shutdown,mod_commands
acl,<ip>
<list_name>,Compare an ip to an acl list,mod_commands
alias,[add|stickyadd]
<alias> <command> | del [<alias>|*],Alias,mod_commands
av,debug
[on|off] | show <formats | codecs>,AV general commands,mod_av
banner,,Return
the system banner,mod_commands
bg_spawn,<command>,Execute
a spawn command in the background,mod_commands
bg_system,<command>,Execute
a system command in the background,mod_commands
bgapi,<command>[
<arg>],Execute an api command in a thread,mod_commands
break,<uuid>
[all],uuid_break,mod_commands
cdr_csv,parameters,cdr_csv
controls,mod_cdr_csv
chat,<proto>|<from>|<to>|<message>|[<content-type>],chat,mod_dptools
coalesce,[^^<delim>]<value1>,<value2>,...,Return
first nonempty parameter,mod_commands
complete,add
<word>|del [<word>|*],Complete,mod_commands
cond,<expr>
? <true val> : <false val>,Evaluate a conditional,mod_commands
conference,,Conference
module commands,mod_conference
console,loglevel
[level]|colorize [on|toggle|off]|uuid [on|toggle|off]|json
[on|toggle|off],Console,mod_console
console_complete,<line>,,mod_commands
console_complete_xml,<line>,,mod_commands
create_uuid,<uuid>
<other_uuid>,Create a uuid,mod_commands
db,[insert|delete|select|exists|count|list]/<realm>/<key>/<value>,db
get/set,mod_db
db_cache,status,Manage
db cache,mod_commands
domain_data,<domain>
[var|param|attr] <name>,Find domain data,mod_commands
domain_exists,<domain>,Check
if a domain exists,mod_commands
echo,<data>,Echo,mod_commands
enum,,ENUM,mod_enum
enum_auto,,ENUM,mod_enum
escape,<data>,Escape
a string,mod_commands
eval,[uuid:<uuid>
]<expression>,eval (noop),mod_commands
event_channel_broadcast,<channel>
<json>,Broadcast,mod_commands
event_sink,<web
data>,event_sink,mod_event_socket
expand,[uuid:<uuid>
]<cmd> <args>,Execute an api with variable expansion,mod_commands
expr,<expr>,Eval
an expression,mod_expr
fifo,list|list_verbose|count|debug|status|has_outbound|importance
[<fifo name>]|reparse [del_all],Return data about a fifo,mod_fifo
fifo_add_outbound,<node>
<url> [<priority>],Add outbound members to a fifo,mod_fifo
fifo_check_bridge,<uuid>|<outbound_id>,check
if uuid is in a bridge,mod_fifo
fifo_member,[add
<fifo_name> <originate_string> [<simo_count>]
[<timeout>] [<lag>] [<expires>] [<taking_calls>] | del
<fifo_name> <originate_string>],Add members to a fifo,mod_fifo
file_exists,<file>,Check
if a file exists on server,mod_commands
find_user_xml,<key>
<user> <domain>,Find a user,mod_commands
fsctl,[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]],FS control
messages,mod_commands
getcputime,[reset],Gets
CPU time in milliseconds (user,kernel),mod_commands
getenv,<name>,getenv,mod_commands
gethost,,gethostbyname,mod_commands
global_getvar,<var>,Get
global var,mod_commands
global_setvar,<var>=<value>
[=<value2>],Set global var,mod_commands
group,[insert|delete|call]:<group
name>:<url>,group [insert|delete|call],mod_db
group_call,<group>[@<domain>],Generate
a dial string to call a group,mod_commands
hash,[insert|delete|select]/<realm>/<key>/<value>,hash
get/set,mod_hash
hash_dump,all|limit|db
[<realm>],dump hash/limit_hash data (used for synchronization),mod_hash
hash_remote,list|kill
[name]|rescan,hash remote,mod_hash
help,,Show
help for all the api commands,mod_commands
host_lookup,<hostname>,Lookup
host,mod_commands
hostname,,Return
the system hostname,mod_commands
httapi,[debug_on|debug_off],HT-TAPI
Hypertext Telephony API,mod_httapi
hupall,<cause>
[<var> <value>] [<var2> <value2>],hupall,mod_commands
in_group,<user>[@<domain>]
<group_name>,Determine if a user is in a group,mod_commands
interface_ip,[auto|ipv4|ipv6]
<ifname>,Return the primary IP of an interface,mod_commands
is_lan_addr,<ip>,See
if an ip is a lan addr,mod_commands
json,JSON,JSON
API,mod_commands
limit_hash_usage,<realm>
<id>,Deprecated: gets the usage count of a limited resource,mod_commands
limit_interval_reset,<backend>
<realm> <resource>,Reset the interval counter for a limited
resource,mod_commands
limit_reset,<backend>,Reset
the counters of a limit backend,mod_commands
limit_status,<backend>,Get
the status of a limit backend,mod_commands
limit_usage,<backend>
<realm> <id>,Get the usage count of a limited resource,mod_commands
list_users,[group
<group>] [domain <domain>] [user <user>] [context
<context>],List Users configured in Directory,mod_commands
load,<mod_name>,Load
Module,mod_commands
local_stream,<show|start|reload|stop|hup>
<local_stream_name>,manage local streams,mod_local_stream
log,<level>
<message>,Log,mod_commands
lua,<script>,run
a script as an api function,mod_lua
luarun,<script>,run
a script,mod_lua
md5,<data>,Return
md5 hash,mod_commands
memory,memory,Memory
usage statistics,mod_commands
module_exists,<module>,Check
if module exists,mod_commands
msleep,<milliseconds>,Sleep
N milliseconds,mod_commands
msrp,debug
<on|off>|restart,MSRP Functions,mod_commands
nat_map,[status|republish|reinit]
| [add|del] <port> [tcp|udp] [static],Manage NAT,mod_commands
opus_debug,<on|off>,Set
OPUS Debug,mod_opus
originate,<call
url> <exten>|&<application_name>(<app_args>)
[<dialplan>] [<context>] [<cid_name>] [<cid_num>]
[<timeout_sec>],Originate a call,mod_commands
page,(var1=val1,var2=val2)<var1=val1,var2=val2><chan1>[:_:<chanN>],Send
a file as a page,mod_dptools
pause,<uuid>
<on|off>,Pause media on a channel,mod_commands
pool_stats,Core
pool memory usage.,Core pool memory usage,mod_commands
presence,[in|out]
<user> <rpid> <message>,presence,mod_dptools
quote_shell_arg,<data>,Quote/escape
a string for use on shell command line,mod_commands
reg_url,<user>@<realm>,,mod_commands
regex,<data>|<pattern>[|<subst
string>][n|b],Evaluate a regex,mod_commands
reload,[-f]
<mod_name>,Reload module,mod_commands
reloadacl,,Reload
XML,mod_commands
reloadxml,,Reload
XML,mod_commands
replace,<data>|<string1>|<string2>,Replace
a string,mod_commands
say_string,<module_name>[.<ext>]
<lang>[.<ext>] <say_type> <say_method>
[<say_gender>] <text>,,mod_commands
sched_api,[+@]<time>
<group_name> <command_string>[&],Schedule an api
command,mod_commands
sched_broadcast,[[+]<time>|@time]
<uuid> <path> [aleg|bleg|both],Schedule a broadcast event to a
running call,mod_commands
sched_del,<task_id>|<group_id>,Delete
a scheduled task,mod_commands
sched_hangup,[+]<time>
<uuid> [<cause>],Schedule a running call to hangup,mod_commands
sched_transfer,[+]<time>
<uuid> <extension> [<dialplan>] [<context>],Schedule a
transfer for a running call,mod_commands
show,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,Show
various reports,mod_commands
shutdown,,Shutdown,mod_commands
sndfile_debug,<on|off>,Set
sndfile debug,mod_sndfile
sofia,<cmd>
<args>,Sofia Controls,mod_sofia
sofia_contact,[profile/]<user>@<domain>,Sofia
Contacts,mod_sofia
sofia_count_reg,[profile/]<user>@<domain>,Count
Sofia registration,mod_sofia
sofia_dig,<url>,SIP
DIG,mod_sofia
sofia_gateway_data,<gateway_name>
[ivar|ovar|var] <name>,Get data from a sofia gateway,mod_sofia
sofia_presence_data,[list|status|rpid|user_agent]
[profile/]<user>@domain,Sofia Presence Data,mod_sofia
sofia_username_of,[profile/]<user>@<domain>,Sofia
Username Lookup,mod_sofia
spandsp_start_tone_detect,<uuid>
<name>,Start background tone detection with cadence,mod_spandsp
spandsp_stop_tone_detect,<uuid>,Stop
background tone detection with cadence,mod_spandsp
spawn,<command>,Execute
a spawn command without capturing it's output,mod_commands
spawn_stream,<command>,Execute
a spawn command and capture it's output,mod_commands
sql_escape,<string>,Escape
a string to prevent sql injection,mod_commands
start_tdd_detect,<uuid>,Start
background tdd detection,mod_spandsp
status,,Show
current status,mod_commands
stop_tdd_detect,<uuid>,Stop
background tdd detection,mod_spandsp
strepoch,<string>,Convert
a date string into epoch time,mod_dptools
strftime,<format_string>,strftime,mod_dptools
strftime_tz,<timezone_name>
[<epoch>|][format string],Display formatted time of timezone,mod_commands
strmicroepoch,<string>,Convert
a date string into micoepoch time,mod_dptools
stun,<stun_server>[:port]
[<source_ip>[:<source_port]],Execute STUN lookup,mod_commands
switchname,,Return
the switch name,mod_commands
system,<command>,Execute
a system command,mod_commands
time_test,<mss>
[count],Show time jitter,mod_commands
timer_test,<10|20|40|60|120>
[<1..200>] [<timer_name>],Exercise FS timer,mod_commands
tolower,<string>,Lower
Case a string,mod_commands
tone_detect,<uuid>
<key> <tone_spec> [<flags> <timeout> <app>
<args> <hits>],Start tone detection on a channel,mod_commands
toupper,<string>,Upper
Case a string,mod_commands
unload,[-f]
<mod_name>,Unload module,mod_commands
unsched_api,<task_id>,Unschedule
an api command,mod_commands
uptime,[us|ms|s|m|h|d|microseconds|milliseconds|seconds|minutes|hours|days],Show
uptime,mod_commands
url_decode,<string>,Url
decode a string,mod_commands
url_encode,<string>,Url
encode a string,mod_commands
user_data,<user>@<domain>
[var|param|attr] <name>,Find user data,mod_commands
user_exists,<key>
<user> <domain>,Find a user,mod_commands
uuid_answer,<uuid>,answer,mod_commands
uuid_audio,<uuid>
[start [read|write] [mute|level <level>]|stop],uuid_audio,mod_commands
uuid_break,<uuid>
[all],Break out of media sent to channel,mod_commands
uuid_bridge,,Bridge
call legs,mod_commands
uuid_broadcast,<uuid>
<path> [aleg|bleg|holdb|both],Execute dialplan application,mod_commands
uuid_buglist,<uuid>,List
media bugs on a session,mod_commands
uuid_capture_text,<uuid>
<on|off>,start/stop capture_text,mod_commands
uuid_chat,<uuid>
<text>,Send a chat message,mod_commands
uuid_codec_debug,<uuid>
audio|video <level>,Send codec a debug message,mod_commands
uuid_codec_param,<uuid>
audio|video read|write <param> <val>,Send codec a
param,mod_commands
uuid_debug_media,<uuid>
<read|write|both|vread|vwrite|vboth|all> <on|off>,Debug
media,mod_commands
uuid_deflect,<uuid>
<uri>,Send a deflect,mod_commands
uuid_displace,<uuid>
[start|stop] <path> [<limit>] [mux],Displace audio,mod_commands
uuid_display,<uuid>
<display>,Update phone display,mod_commands
uuid_drop_dtmf,<uuid>
[on | off ] [ mask_digits <digits> | mask_file <file>],Drop all
DTMF or replace it with a mask,mod_commands
uuid_dual_transfer,<uuid>
<A-dest-exten>[/<A-dialplan>][/<A-context>]
<B-dest-exten>[/<B-dialplan>][/<B-context>],Transfer a
session and its partner,mod_commands
uuid_dump,<uuid>
[format],Dump session vars,mod_commands
uuid_early_ok,<uuid>,stop
ignoring early media,mod_commands
uuid_exists,<uuid>,Check
if a uuid exists,mod_commands
uuid_fileman,<uuid>
<cmd>:<val>,Manage session audio,mod_commands
uuid_flush_dtmf,<uuid>,Flush
dtmf on a given uuid,mod_commands
uuid_getvar,<uuid>
<var>,Get a variable from a channel,mod_commands
uuid_hold,[off|toggle]
<uuid> [<display>],Place call on hold,mod_commands
uuid_jitterbuffer,<uuid>
[0|<min_msec>[:<max_msec>]],uuid_jitterbuffer,mod_commands
uuid_kill,<uuid>
[cause],Kill channel,mod_commands
uuid_limit,<uuid>
<backend> <realm> <resource> [<max>[/interval]] [number
[dialplan [context]]],Increase limit resource,mod_commands
uuid_limit_release,<uuid>
<backend> [realm] [resource],Release limit resource,mod_commands
uuid_loglevel,<uuid>
<level>,Set loglevel on session,mod_commands
uuid_media,[off]
<uuid>,Reinvite FS in or out of media path,mod_commands
uuid_media_3p,[off]
<uuid>,Reinvite FS in or out of media path using 3pcc,mod_commands
uuid_media_params,<uuid>
<json>,Update remote vid params,mod_commands
uuid_media_reneg,<uuid>[
<codec_string>],Media negotiation,mod_commands
uuid_msrp_send,<msg>,send
msrp text,mod_commands
uuid_outgoing_answer,<uuid>,Answer
outgoing channel,mod_commands
uuid_park,<uuid>,Park
channel,mod_commands
uuid_pause,<uuid>
<on|off>,Pause media on a channel,mod_commands
uuid_phone_event,<uuid>,Send
an event to the phone,mod_commands
uuid_pre_answer,<uuid>,pre_answer,mod_commands
uuid_preprocess,<>,Pre-process
Channel,mod_commands
uuid_record,<uuid>
[start|stop|mask|unmask] <path> [<limit>]
[<recording_vars>],Record session audio,mod_commands
uuid_recovery_refresh,<uuid>
<uri>,Send a recovery_refresh,mod_commands
uuid_recv_dtmf,<uuid>
<dtmf_data>,Receive dtmf digits,mod_commands
uuid_redirect,<uuid>
<uri>,Send a redirect,mod_commands
uuid_ring_ready,<uuid>
[queued],Sending ringing to a channel,mod_commands
uuid_send_dtmf,<uuid>
<dtmf_data>,Send dtmf digits,mod_commands
uuid_send_info,<uuid>
[<mime_type> <mime_subtype>] <message>,Send info to the
endpoint,mod_commands
uuid_send_message,<uuid>
<message>,Send MESSAGE to the endpoint,mod_commands
uuid_send_tdd,<uuid>
<text>,send tdd data to a uuid,mod_spandsp
uuid_send_text,<uuid>
<text>,Send text in real-time,mod_commands
uuid_session_heartbeat,<uuid>
[sched] [0|<seconds>],uuid_session_heartbeat,mod_commands
uuid_set_media_stats,<uuid>,Set
media stats,mod_commands
uuid_setvar,<uuid>
<var> [value],Set a variable,mod_commands
uuid_setvar_multi,<uuid>
<var>=<value>;<var>=<value>...,Set multiple
variables,mod_commands
uuid_simplify,<uuid>,Try
to cut out of a call path / attended xfer,mod_commands
uuid_transfer,<uuid>
[-bleg|-both] <dest-exten> [<dialplan>] [<context>],Transfer
a session,mod_commands
uuid_video_bandwidth,<uuid>
<bitrate>,Send video bandwidth,mod_commands
uuid_video_bitrate,<uuid>
<bitrate>,Send video bitrate req.,mod_commands
uuid_video_refresh,<uuid>
[auto|manual],Send video refresh.,mod_commands
uuid_write_png,,grab
an image from a call,mod_png
uuid_xfer_zombie,<uuid>,Allow
A leg to hangup and continue originating,mod_commands
uuid_zombie_exec,<uuid>,Set
zombie_exec flag on the specified uuid,mod_commands
valet_info,[<lot
name>],Valet Parking Info,mod_valet_parking
version,[short],Version,mod_commands
verto,syntax,Verto
API,mod_verto
verto_contact,user@domain,Generate
a verto endpoint dialstring,mod_verto
vm_boxcount,[profile/]<user>@<domain>[|[new|saved|new-urgent|saved-urgent|all]],vm_boxcount,mod_voicemail
vm_delete,<id>@<domain>[/profile]
[<uuid>],vm_delete,mod_voicemail
vm_fsdb_auth_login,<profile>
<domain> <user> <password>,vm_fsdb_auth_login,mod_voicemail
vm_fsdb_msg_count,<format>
<profile> <domain> <user>
<folder>,vm_fsdb_msg_count,mod_voicemail
vm_fsdb_msg_delete,<profile>
<domain> <user> <uuid>,vm_fsdb_msg_delete,mod_voicemail
vm_fsdb_msg_email,<profile>
<domain> <user> <uuid>
<email>,vm_fsdb_msg_email,mod_voicemail
vm_fsdb_msg_forward,<profile>
<domain> <user> <uuid> <dst_domain> <dst_user>
[prepend_file_location],vm_fsdb_msg_forward,mod_voicemail
vm_fsdb_msg_get,<format>
<profile> <domain> <user>
<uuid>,vm_fsdb_msg_get,mod_voicemail
vm_fsdb_msg_list,<format>
<profile> <domain> <user> <folder> <filter>
[msg-order = ASC | DESC],vm_fsdb_msg_list,mod_voicemail
vm_fsdb_msg_purge,<profile>
<domain> <user>,vm_fsdb_msg_purge,mod_voicemail
vm_fsdb_msg_save,<profile>
<domain> <user> <uuid>,vm_fsdb_msg_save,mod_voicemail
vm_fsdb_msg_undelete,<profile>
<domain> <user> <uuid>,vm_fsdb_msg_undelete,mod_voicemail
vm_fsdb_pref_greeting_get,<format>
<profile> <domain> <user>
[slot],vm_fsdb_pref_greeting_get,mod_voicemail
vm_fsdb_pref_greeting_set,<profile>
<domain> <user> <slot>
[file-path],vm_fsdb_pref_greeting_set,mod_voicemail
vm_fsdb_pref_password_set,<profile>
<domain> <user> <password>,vm_fsdb_pref_password_set,mod_voicemail
vm_fsdb_pref_recname_set,<profile>
<domain> <user>
<file-path>,vm_fsdb_pref_recname_set,mod_voicemail
vm_inject,[group=<group>[@domain]|domain=<domain>|<box>[@<domain>]]
<sound_file> [<cid_num>] [<cid_name>],vm_inject,mod_voicemail
vm_list,<id>@<domain>[/profile]
[xml],vm_list,mod_voicemail
vm_prefs,[profile/]<user>@<domain>[|[name_path|greeting_path|password]],vm_prefs,mod_voicemail
vm_read,<id>@<domain>[/profile]
<read|unread> [<uuid>],vm_read,mod_voicemail
voicemail,rss
[<host> <port> <uri> <user> <domain>] |
[load|unload|reload] <profile> [reloadxml],voicemail,mod_voicemail
voicemail_inject,[group=<group>[@domain]|domain=<domain>|<box>[@<domain>]]
<sound_file> [<cid_num>]
[<cid_name>],voicemail_inject,mod_voicemail
vpx,<reload|debug
<on|off>>,VPX API,CORE_VPX_MODULE
xml_flush_cache,<id>
<key> <val>,Clear xml cache,mod_commands
xml_locate,[root
| <section> <tag> <tag_attr_name> <tag_attr_val>],Find
some xml,mod_commands
xml_wrap,<command>
<args>,Wrap another api command in xml,mod_commands
freeswitch@ip-172-18-1-221> show api
name,description,syntax,ikey
...,Shutdown,,mod_commands
acl,Compare
an ip to an acl list,<ip> <list_name>,mod_commands
alias,Alias,[add|stickyadd]
<alias> <command> | del [<alias>|*],mod_commands
av,AV
general commands,debug [on|off] | show <formats | codecs>,mod_av
banner,Return
the system banner,,mod_commands
bg_spawn,Execute
a spawn command in the background,<command>,mod_commands
bg_system,Execute
a system command in the background,<command>,mod_commands
bgapi,Execute
an api command in a thread,<command>[ <arg>],mod_commands
break,uuid_break,<uuid>
[all],mod_commands
cdr_csv,cdr_csv
controls,parameters,mod_cdr_csv
chat,chat,<proto>|<from>|<to>|<message>|[<content-type>],mod_dptools
coalesce,Return
first nonempty
parameter,[^^<delim>]<value1>,<value2>,...,mod_commands
complete,Complete,add
<word>|del [<word>|*],mod_commands
cond,Evaluate
a conditional,<expr> ? <true val> : <false val>,mod_commands
conference,Conference
module commands,,mod_conference
console,Console,loglevel
[level]|colorize [on|toggle|off]|uuid [on|toggle|off]|json
[on|toggle|off],mod_console
create_uuid,Create
a uuid,<uuid> <other_uuid>,mod_commands
db,db
get/set,[insert|delete|select|exists|count|list]/<realm>/<key>/<value>,mod_db
db_cache,Manage
db cache,status,mod_commands
domain_data,Find
domain data,<domain> [var|param|attr] <name>,mod_commands
domain_exists,Check
if a domain exists,<domain>,mod_commands
echo,Echo,<data>,mod_commands
enum,ENUM,,mod_enum
enum_auto,ENUM,,mod_enum
escape,Escape
a string,<data>,mod_commands
eval,eval
(noop),[uuid:<uuid> ]<expression>,mod_commands
event_channel_broadcast,Broadcast,<channel>
<json>,mod_commands
event_sink,event_sink,<web
data>,mod_event_socket
expand,Execute
an api with variable expansion,[uuid:<uuid> ]<cmd>
<args>,mod_commands
expr,Eval
an expression,<expr>,mod_expr
fifo,Return
data about a fifo,list|list_verbose|count|debug|status|has_outbound|importance
[<fifo name>]|reparse [del_all],mod_fifo
fifo_add_outbound,Add
outbound members to a fifo,<node> <url> [<priority>],mod_fifo
fifo_check_bridge,check
if uuid is in a bridge,<uuid>|<outbound_id>,mod_fifo
fifo_member,Add
members to a fifo,[add <fifo_name> <originate_string>
[<simo_count>] [<timeout>] [<lag>] [<expires>]
[<taking_calls>] | del <fifo_name>
<originate_string>],mod_fifo
file_exists,Check
if a file exists on server,<file>,mod_commands
find_user_xml,Find
a user,<key> <user> <domain>,mod_commands
fsctl,FS
control messages,[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]],mod_commands
getcputime,Gets
CPU time in milliseconds (user,kernel),[reset],mod_commands
getenv,getenv,<name>,mod_commands
gethost,gethostbyname,,mod_commands
global_getvar,Get
global var,<var>,mod_commands
global_setvar,Set
global var,<var>=<value> [=<value2>],mod_commands
group,group
[insert|delete|call],[insert|delete|call]:<group name>:<url>,mod_db
group_call,Generate
a dial string to call a group,<group>[@<domain>],mod_commands
hash,hash
get/set,[insert|delete|select]/<realm>/<key>/<value>,mod_hash
hash_dump,dump
hash/limit_hash data (used for synchronization),all|limit|db
[<realm>],mod_hash
hash_remote,hash
remote,list|kill [name]|rescan,mod_hash
help,Show
help for all the api commands,,mod_commands
host_lookup,Lookup
host,<hostname>,mod_commands
hostname,Return
the system hostname,,mod_commands
httapi,HT-TAPI
Hypertext Telephony API,[debug_on|debug_off],mod_httapi
hupall,hupall,<cause>
[<var> <value>] [<var2> <value2>],mod_commands
in_group,Determine
if a user is in a group,<user>[@<domain>]
<group_name>,mod_commands
interface_ip,Return
the primary IP of an interface,[auto|ipv4|ipv6] <ifname>,mod_commands
is_lan_addr,See
if an ip is a lan addr,<ip>,mod_commands
json,JSON
API,JSON,mod_commands
limit_hash_usage,Deprecated:
gets the usage count of a limited resource,<realm>
<id>,mod_commands
limit_interval_reset,Reset
the interval counter for a limited resource,<backend> <realm>
<resource>,mod_commands
limit_reset,Reset
the counters of a limit backend,<backend>,mod_commands
limit_status,Get
the status of a limit backend,<backend>,mod_commands
limit_usage,Get
the usage count of a limited resource,<backend> <realm>
<id>,mod_commands
list_users,List
Users configured in Directory,[group <group>] [domain <domain>]
[user <user>] [context <context>],mod_commands
load,Load
Module,<mod_name>,mod_commands
local_stream,manage
local streams,<show|start|reload|stop|hup>
<local_stream_name>,mod_local_stream
log,Log,<level>
<message>,mod_commands
lua,run
a script as an api function,<script>,mod_lua
luarun,run
a script,<script>,mod_lua
md5,Return
md5 hash,<data>,mod_commands
memory,Memory
usage statistics,memory,mod_commands
module_exists,Check
if module exists,<module>,mod_commands
msleep,Sleep
N milliseconds,<milliseconds>,mod_commands
msrp,MSRP
Functions,debug <on|off>|restart,mod_commands
nat_map,Manage
NAT,[status|republish|reinit] | [add|del] <port> [tcp|udp]
[static],mod_commands
opus_debug,Set
OPUS Debug,<on|off>,mod_opus
originate,Originate
a call,<call url> <exten>|&<application_name>(<app_args>)
[<dialplan>] [<context>] [<cid_name>] [<cid_num>]
[<timeout_sec>],mod_commands
page,Send
a file as a
page,(var1=val1,var2=val2)<var1=val1,var2=val2><chan1>[:_:<chanN>],mod_dptools
pause,Pause
media on a channel,<uuid> <on|off>,mod_commands
pool_stats,Core
pool memory usage,Core pool memory usage.,mod_commands
presence,presence,[in|out]
<user> <rpid> <message>,mod_dptools
quote_shell_arg,Quote/escape
a string for use on shell command line,<data>,mod_commands
regex,Evaluate
a regex,<data>|<pattern>[|<subst string>][n|b],mod_commands
reload,Reload
module,[-f] <mod_name>,mod_commands
reloadacl,Reload
XML,,mod_commands
reloadxml,Reload
XML,,mod_commands
replace,Replace
a string,<data>|<string1>|<string2>,mod_commands
sched_api,Schedule
an api command,[+@]<time> <group_name>
<command_string>[&],mod_commands
sched_broadcast,Schedule
a broadcast event to a running call,[[+]<time>|@time] <uuid>
<path> [aleg|bleg|both],mod_commands
sched_del,Delete
a scheduled task,<task_id>|<group_id>,mod_commands
sched_hangup,Schedule
a running call to hangup,[+]<time> <uuid>
[<cause>],mod_commands
sched_transfer,Schedule
a transfer for a running call,[+]<time> <uuid> <extension>
[<dialplan>] [<context>],mod_commands
show,Show
various reports,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,mod_commands
shutdown,Shutdown,,mod_commands
sndfile_debug,Set
sndfile debug,<on|off>,mod_sndfile
sofia,Sofia
Controls,<cmd> <args>,mod_sofia
sofia_contact,Sofia
Contacts,[profile/]<user>@<domain>,mod_sofia
sofia_count_reg,Count
Sofia registration,[profile/]<user>@<domain>,mod_sofia
sofia_dig,SIP
DIG,<url>,mod_sofia
sofia_gateway_data,Get
data from a sofia gateway,<gateway_name> [ivar|ovar|var]
<name>,mod_sofia
sofia_presence_data,Sofia
Presence Data,[list|status|rpid|user_agent]
[profile/]<user>@domain,mod_sofia
sofia_username_of,Sofia
Username Lookup,[profile/]<user>@<domain>,mod_sofia
spandsp_start_tone_detect,Start
background tone detection with cadence,<uuid> <name>,mod_spandsp
spandsp_stop_tone_detect,Stop
background tone detection with cadence,<uuid>,mod_spandsp
spawn,Execute
a spawn command without capturing it's output,<command>,mod_commands
spawn_stream,Execute
a spawn command and capture it's output,<command>,mod_commands
sql_escape,Escape
a string to prevent sql injection,<string>,mod_commands
start_tdd_detect,Start
background tdd detection,<uuid>,mod_spandsp
status,Show
current status,,mod_commands
stop_tdd_detect,Stop
background tdd detection,<uuid>,mod_spandsp
strepoch,Convert
a date string into epoch time,<string>,mod_dptools
strftime,strftime,<format_string>,mod_dptools
strftime_tz,Display
formatted time of timezone,<timezone_name> [<epoch>|][format
string],mod_commands
strmicroepoch,Convert
a date string into micoepoch time,<string>,mod_dptools
stun,Execute
STUN lookup,<stun_server>[:port] [<source_ip>[:<source_port]],mod_commands
switchname,Return
the switch name,,mod_commands
system,Execute
a system command,<command>,mod_commands
time_test,Show
time jitter,<mss> [count],mod_commands
timer_test,Exercise
FS timer,<10|20|40|60|120> [<1..200>] [<timer_name>],mod_commands
tolower,Lower
Case a string,<string>,mod_commands
tone_detect,Start
tone detection on a channel,<uuid> <key> <tone_spec>
[<flags> <timeout> <app> <args>
<hits>],mod_commands
toupper,Upper
Case a string,<string>,mod_commands
unload,Unload
module,[-f] <mod_name>,mod_commands
unsched_api,Unschedule
an api command,<task_id>,mod_commands
uptime,Show
uptime,[us|ms|s|m|h|d|microseconds|milliseconds|seconds|minutes|hours|days],mod_commands
url_decode,Url
decode a string,<string>,mod_commands
url_encode,Url
encode a string,<string>,mod_commands
user_data,Find
user data,<user>@<domain> [var|param|attr]
<name>,mod_commands
user_exists,Find
a user,<key> <user> <domain>,mod_commands
uuid_answer,answer,<uuid>,mod_commands
uuid_audio,uuid_audio,<uuid>
[start [read|write] [mute|level <level>]|stop],mod_commands
uuid_break,Break
out of media sent to channel,<uuid> [all],mod_commands
uuid_bridge,Bridge
call legs,,mod_commands
uuid_broadcast,Execute
dialplan application,<uuid> <path> [aleg|bleg|holdb|both],mod_commands
uuid_buglist,List
media bugs on a session,<uuid>,mod_commands
uuid_capture_text,start/stop
capture_text,<uuid> <on|off>,mod_commands
uuid_chat,Send
a chat message,<uuid> <text>,mod_commands
uuid_codec_debug,Send
codec a debug message,<uuid> audio|video <level>,mod_commands
uuid_codec_param,Send
codec a param,<uuid> audio|video read|write <param>
<val>,mod_commands
uuid_debug_media,Debug
media,<uuid> <read|write|both|vread|vwrite|vboth|all>
<on|off>,mod_commands
uuid_deflect,Send
a deflect,<uuid> <uri>,mod_commands
uuid_displace,Displace
audio,<uuid> [start|stop] <path> [<limit>] [mux],mod_commands
uuid_display,Update
phone display,<uuid> <display>,mod_commands
uuid_drop_dtmf,Drop
all DTMF or replace it with a mask,<uuid> [on | off ] [ mask_digits <digits>
| mask_file <file>],mod_commands
uuid_dual_transfer,Transfer
a session and its partner,<uuid>
<A-dest-exten>[/<A-dialplan>][/<A-context>]
<B-dest-exten>[/<B-dialplan>][/<B-context>],mod_commands
uuid_dump,Dump
session vars,<uuid> [format],mod_commands
uuid_early_ok,stop
ignoring early media,<uuid>,mod_commands
uuid_exists,Check
if a uuid exists,<uuid>,mod_commands
uuid_fileman,Manage
session audio,<uuid> <cmd>:<val>,mod_commands
uuid_flush_dtmf,Flush
dtmf on a given uuid,<uuid>,mod_commands
uuid_getvar,Get
a variable from a channel,<uuid> <var>,mod_commands
uuid_hold,Place
call on hold,[off|toggle] <uuid> [<display>],mod_commands
uuid_jitterbuffer,uuid_jitterbuffer,<uuid>
[0|<min_msec>[:<max_msec>]],mod_commands
uuid_kill,Kill
channel,<uuid> [cause],mod_commands
uuid_limit,Increase
limit resource,<uuid> <backend> <realm> <resource>
[<max>[/interval]] [number [dialplan [context]]],mod_commands
uuid_limit_release,Release
limit resource,<uuid> <backend> [realm] [resource],mod_commands
uuid_loglevel,Set
loglevel on session,<uuid> <level>,mod_commands
uuid_media,Reinvite
FS in or out of media path,[off] <uuid>,mod_commands
uuid_media_3p,Reinvite
FS in or out of media path using 3pcc,[off] <uuid>,mod_commands
uuid_media_params,Update
remote vid params,<uuid> <json>,mod_commands
uuid_media_reneg,Media
negotiation,<uuid>[ <codec_string>],mod_commands
uuid_msrp_send,send
msrp text,<msg>,mod_commands
uuid_outgoing_answer,Answer
outgoing channel,<uuid>,mod_commands
uuid_park,Park
channel,<uuid>,mod_commands
uuid_pause,Pause
media on a channel,<uuid> <on|off>,mod_commands
uuid_phone_event,Send
an event to the phone,<uuid>,mod_commands
uuid_pre_answer,pre_answer,<uuid>,mod_commands
uuid_preprocess,Pre-process
Channel,<>,mod_commands
uuid_record,Record
session audio,<uuid> [start|stop|mask|unmask] <path>
[<limit>] [<recording_vars>],mod_commands
uuid_recovery_refresh,Send
a recovery_refresh,<uuid> <uri>,mod_commands
uuid_recv_dtmf,Receive
dtmf digits,<uuid> <dtmf_data>,mod_commands
uuid_redirect,Send
a redirect,<uuid> <uri>,mod_commands
uuid_ring_ready,Sending
ringing to a channel,<uuid> [queued],mod_commands
uuid_send_dtmf,Send
dtmf digits,<uuid> <dtmf_data>,mod_commands
uuid_send_info,Send
info to the endpoint,<uuid> [<mime_type> <mime_subtype>]
<message>,mod_commands
uuid_send_message,Send
MESSAGE to the endpoint,<uuid> <message>,mod_commands
uuid_send_tdd,send
tdd data to a uuid,<uuid> <text>,mod_spandsp
uuid_send_text,Send
text in real-time,<uuid> <text>,mod_commands
uuid_session_heartbeat,uuid_session_heartbeat,<uuid>
[sched] [0|<seconds>],mod_commands
uuid_set_media_stats,Set
media stats,<uuid>,mod_commands
uuid_setvar,Set
a variable,<uuid> <var> [value],mod_commands
uuid_setvar_multi,Set
multiple variables,<uuid>
<var>=<value>;<var>=<value>...,mod_commands
uuid_simplify,Try
to cut out of a call path / attended xfer,<uuid>,mod_commands
uuid_transfer,Transfer
a session,<uuid> [-bleg|-both] <dest-exten> [<dialplan>]
[<context>],mod_commands
uuid_video_bandwidth,Send
video bandwidth,<uuid> <bitrate>,mod_commands
uuid_video_bitrate,Send
video bitrate req.,<uuid> <bitrate>,mod_commands
uuid_video_refresh,Send
video refresh.,<uuid> [auto|manual],mod_commands
uuid_write_png,grab
an image from a call,,mod_png
uuid_xfer_zombie,Allow
A leg to hangup and continue originating,<uuid>,mod_commands
uuid_zombie_exec,Set
zombie_exec flag on the specified uuid,<uuid>,mod_commands
valet_info,Valet
Parking Info,[<lot name>],mod_valet_parking
version,Version,[short],mod_commands
verto,Verto
API,syntax,mod_verto
verto_contact,Generate
a verto endpoint dialstring,user@domain,mod_verto
vm_boxcount,vm_boxcount,[profile/]<user>@<domain>[|[new|saved|new-urgent|saved-urgent|all]],mod_voicemail
vm_delete,vm_delete,<id>@<domain>[/profile]
[<uuid>],mod_voicemail
vm_fsdb_auth_login,vm_fsdb_auth_login,<profile>
<domain> <user> <password>,mod_voicemail
vm_fsdb_msg_count,vm_fsdb_msg_count,<format>
<profile> <domain> <user> <folder>,mod_voicemail
vm_fsdb_msg_delete,vm_fsdb_msg_delete,<profile>
<domain> <user> <uuid>,mod_voicemail
vm_fsdb_msg_email,vm_fsdb_msg_email,<profile>
<domain> <user> <uuid> <email>,mod_voicemail
vm_fsdb_msg_forward,vm_fsdb_msg_forward,<profile>
<domain> <user> <uuid> <dst_domain> <dst_user>
[prepend_file_location],mod_voicemail
vm_fsdb_msg_get,vm_fsdb_msg_get,<format>
<profile> <domain> <user> <uuid>,mod_voicemail
vm_fsdb_msg_list,vm_fsdb_msg_list,<format>
<profile> <domain> <user> <folder> <filter>
[msg-order = ASC | DESC],mod_voicemail
vm_fsdb_msg_purge,vm_fsdb_msg_purge,<profile>
<domain> <user>,mod_voicemail
vm_fsdb_msg_save,vm_fsdb_msg_save,<profile>
<domain> <user> <uuid>,mod_voicemail
vm_fsdb_msg_undelete,vm_fsdb_msg_undelete,<profile>
<domain> <user> <uuid>,mod_voicemail
vm_fsdb_pref_greeting_get,vm_fsdb_pref_greeting_get,<format>
<profile> <domain> <user> [slot],mod_voicemail
vm_fsdb_pref_greeting_set,vm_fsdb_pref_greeting_set,<profile>
<domain> <user> <slot> [file-path],mod_voicemail
vm_fsdb_pref_password_set,vm_fsdb_pref_password_set,<profile>
<domain> <user> <password>,mod_voicemail
vm_fsdb_pref_recname_set,vm_fsdb_pref_recname_set,<profile>
<domain> <user> <file-path>,mod_voicemail
vm_inject,vm_inject,[group=<group>[@domain]|domain=<domain>|<box>[@<domain>]]
<sound_file> [<cid_num>] [<cid_name>],mod_voicemail
vm_list,vm_list,<id>@<domain>[/profile]
[xml],mod_voicemail
vm_prefs,vm_prefs,[profile/]<user>@<domain>[|[name_path|greeting_path|password]],mod_voicemail
vm_read,vm_read,<id>@<domain>[/profile]
<read|unread> [<uuid>],mod_voicemail
voicemail,voicemail,rss
[<host> <port> <uri> <user> <domain>] | [load|unload|reload]
<profile> [reloadxml],mod_voicemail
voicemail_inject,voicemail_inject,[group=<group>[@domain]|domain=<domain>|<box>[@<domain>]]
<sound_file> [<cid_num>] [<cid_name>],mod_voicemail
vpx,VPX
API,<reload|debug <on|off>>,CORE_VPX_MODULE
xml_flush_cache,Clear
xml cache,<id> <key> <val>,mod_commands
xml_locate,Find
some xml,[root | <section> <tag> <tag_attr_name>
<tag_attr_val>],mod_commands
xml_wrap,Wrap
another api command in xml,<command> <args>,mod_commands
218
total.
"bg_system", "Execute a
system command in the background", bg_system_function, SYSTEM_SYNTAX
"system", "Execute a system
command", system_function, SYSTEM_SYNTAX
"bg_spawn", "Execute a spawn
command in the background", bg_spawn_function, SPAWN_SYNTAX
"spawn", "Execute a spawn
command without capturing it's output", spawn_function, SPAWN_SYNTAX
"spawn_stream", "Execute a
spawn command and capture it's output", spawn_stream_function,
SPAWN_SYNTAX
"acl", "Compare an ip to an
acl list", acl_function, "<ip> <list_name>"
"alias", "Alias",
alias_function, ALIAS_SYNTAX "coalesce", "Return first
nonempty parameter", coalesce_function, COALESCE_SYNTAX
"banner", "Return the system
banner", banner_function, ""
"bgapi", "Execute an api
command in a thread", bgapi_function, "<command>[
<arg>]"
"break", "uuid_break",
break_function, BREAK_SYNTAX
"complete", "Complete",
complete_function, COMPLETE_SYNTAX
"cond", "Evaluate a conditional",
cond_function, "<expr> ? <true val> : <false val>"
"console_complete", "",
console_complete_function, "<line>"
"console_complete_xml",
"", console_complete_xml_function, "<line>"
"create_uuid", "Create a
uuid", uuid_function, UUID_SYNTAX
"db_cache", "Manage db
cache", db_cache_function, "status"
"domain_data", "Find domain
data", domain_data_function, "<domain> [var|param|attr]
<name>"
"domain_exists", "Check if a
domain exists", domain_exists_function, "<domain>"
"echo", "Echo",
echo_function, "<data>"
"event_channel_broadcast",
"Broadcast", event_channel_broadcast_api_function,
"<channel> <json>"
"escape", "Escape a
string", escape_function, "<data>"
"eval", "eval (noop)",
eval_function, "[uuid:<uuid> ]<expression>"
"expand", "Execute an api
with variable expansion", expand_function, "[uuid:<uuid>
]<cmd> <args>"
"find_user_xml", "Find a
user", find_user_function, "<key> <user> <domain>"
"fsctl", "FS control
messages", ctl_function, CTL_SYNTAX
"...", "Shutdown",
shutdown_function, ""
"shutdown", "Shutdown",
shutdown_function, ""
"version", "Version",
version_function, "[short]"
"global_getvar", "Get global
var", global_getvar_function, GLOBAL_GETVAR_SYNTAX
"global_setvar", "Set global
var", global_setvar_function, GLOBAL_SETVAR_SYNTAX
"group_call", "Generate a
dial string to call a group", group_call_function,
"<group>[@<domain>]"
"help", "Show help for all
the api commands", help_function, ""
"host_lookup", "Lookup
host", host_lookup_function, "<hostname>"
"hostname", "Return the
system hostname", hostname_api_function, ""
"interface_ip", "Return the
primary IP of an interface", interface_ip_function, INTERFACE_IP_SYNTAX
"switchname", "Return the
switch name", switchname_api_function, ""
"gethost",
"gethostbyname", gethost_api_function, ""
"getenv", "getenv",
getenv_function, GETENV_SYNTAX
"hupall", "hupall",
hupall_api_function, "<cause> [<var> <value>]
[<var2> <value2>]"
"in_group", "Determine if a
user is in a group", in_group_function,
"<user>[@<domain>] <group_name>"
"is_lan_addr", "See if an ip
is a lan addr", lan_addr_function, "<ip>"
"limit_usage", "Get the usage
count of a limited resource", limit_usage_function, "<backend>
<realm> <id>"
"limit_hash_usage",
"Deprecated: gets the usage count of a limited resource",
limit_hash_usage_function, "<realm> <id>"
"limit_status", "Get the
status of a limit backend", limit_status_function,
"<backend>"
"limit_reset", "Reset the
counters of a limit backend", limit_reset_function,
"<backend>"
"limit_interval_reset",
"Reset the interval counter for a limited resource",
limit_interval_reset_function, LIMIT_INTERVAL_RESET_SYNTAX
"list_users", "List Users
configured in Directory", list_users_function, LIST_USERS_SYNTAX
"load", "Load Module",
load_function, LOAD_SYNTAX
"log", "Log",
log_function, LOG_SYNTAX
"md5", "Return md5
hash", md5_function, "<data>"
"module_exists", "Check if
module exists", module_exists_function, "<module>"
"msleep", "Sleep N
milliseconds", msleep_function, "<milliseconds>"
"nat_map", "Manage NAT",
nat_map_function, "[status|republish|reinit] | [add|del] <port>
[tcp|udp] [static]"
"originate", "Originate a
call", originate_function, ORIGINATE_SYNTAX
"pause", "Pause media on a
channel", pause_function, PAUSE_SYNTAX
"pool_stats", "Core pool
memory usage", pool_stats_function, "Core pool memory usage."
"quote_shell_arg",
"Quote/escape a string for use on shell command line",
quote_shell_arg_function, "<data>"
"regex", "Evaluate a
regex", regex_function, "<data>|<pattern>[|<subst
string>][n|b]"
"reloadacl", "Reload
XML", reload_acl_function, ""
"reload", "Reload
module", reload_function, UNLOAD_SYNTAX
"reloadxml", "Reload
XML", reload_xml_function, ""
"replace", "Replace a
string", replace_function,
"<data>|<string1>|<string2>"
"say_string", "",
say_string_function, SAY_STRING_SYNTAX
"sched_api", "Schedule an api
command", sched_api_function, SCHED_SYNTAX
"sched_broadcast", "Schedule
a broadcast event to a running call", sched_broadcast_function,
SCHED_BROADCAST_SYNTAX
"sched_del", "Delete a
scheduled task", sched_del_function,
"<task_id>|<group_id>"
"sched_hangup", "Schedule a
running call to hangup", sched_hangup_function, SCHED_HANGUP_SYNTAX
"sched_transfer", "Schedule a
transfer for a running call", sched_transfer_function,
SCHED_TRANSFER_SYNTAX
"show", "Show various
reports", show_function, SHOW_SYNTAX
"sql_escape", "Escape a
string to prevent sql injection", sql_escape, SQL_ESCAPE_SYNTAX
"status", "Show current
status", status_function, ""
"strftime_tz", "Display
formatted time of timezone", strftime_tz_api_function,
"<timezone_name> [<epoch>|][format string]"
"stun", "Execute STUN
lookup", stun_function, "<stun_server>[:port]
[<source_ip>[:<source_port]]"
"time_test", "Show time
jitter", time_test_function, "<mss> [count]"
"timer_test", "Exercise FS
timer", timer_test_function, TIMER_TEST_SYNTAX
"tone_detect", "Start tone
detection on a channel", tone_detect_session_function, TONE_DETECT_SYNTAX
"unload", "Unload
module", unload_function, UNLOAD_SYNTAX
"unsched_api", "Unschedule an
api command", unsched_api_function, UNSCHED_SYNTAX
"uptime", "Show uptime",
uptime_function, UPTIME_SYNTAX
"reg_url", "",
reg_url_function, "<user>@<realm>"
"url_decode", "Url decode a
string", url_decode_function, "<string>"
"url_encode", "Url encode a
string", url_encode_function, "<string>"
"toupper", "Upper Case a
string", toupper_function, "<string>"
"tolower", "Lower Case a
string", tolower_function, "<string>"
"user_data", "Find user
data", user_data_function, "<user>@<domain>
[var|param|attr] <name>"
"uuid_early_ok", "stop
ignoring early media", uuid_early_ok_function, "<uuid>"
"user_exists", "Find a user", user_exists_function,
"<key> <user> <domain>"
"uuid_answer", "answer",
uuid_answer_function, "<uuid>"
"uuid_audio",
"uuid_audio", session_audio_function, AUDIO_SYNTAX
"uuid_break", "Break out of
media sent to channel", break_function, BREAK_SYNTAX
"uuid_bridge", "Bridge call
legs", uuid_bridge_function, ""
"uuid_broadcast", "Execute
dialplan application", uuid_broadcast_function, BROADCAST_SYNTAX
"uuid_buglist", "List media
bugs on a session", uuid_buglist_function, BUGLIST_SYNTAX
"uuid_chat", "Send a chat
message", uuid_chat, UUID_CHAT_SYNTAX
"uuid_send_text", "Send text
in real-time", uuid_send_text, UUID_SEND_TEXT_SYNTAX
"uuid_capture_text",
"start/stop capture_text", uuid_capture_text,
UUID_CAPTURE_TEXT_SYNTAX
"uuid_codec_debug", "Send
codec a debug message", uuid_codec_debug_function, CODEC_DEBUG_SYNTAX
"uuid_codec_param", "Send
codec a param", uuid_codec_param_function, CODEC_PARAM_SYNTAX
"uuid_debug_media", "Debug
media", uuid_debug_media_function, DEBUG_MEDIA_SYNTAX
"uuid_deflect", "Send a
deflect", uuid_deflect, UUID_DEFLECT_SYNTAX
"uuid_displace", "Displace
audio", session_displace_function, "<uuid> [start|stop]
<path> [<limit>] [mux]"
"uuid_display", "Update phone
display", uuid_display_function, DISPLAY_SYNTAX
"uuid_media_params", "Update
remote vid params", uuid_media_params_function, MEDIA_PARAMS_SYNTAX
"uuid_drop_dtmf", "Drop all
DTMF or replace it with a mask", uuid_drop_dtmf, UUID_DROP_DTMF_SYNTAX
"uuid_dump", "Dump session
vars", uuid_dump_function, DUMP_SYNTAX
"uuid_exists", "Check if a
uuid exists", uuid_exists_function, EXISTS_SYNTAX
"uuid_fileman", "Manage
session audio", uuid_fileman_function, FILEMAN_SYNTAX
"uuid_flush_dtmf", "Flush
dtmf on a given uuid", uuid_flush_dtmf_function, "<uuid>"
"uuid_getvar", "Get a
variable from a channel", uuid_getvar_function, GETVAR_SYNTAX
"uuid_hold", "Place call on
hold", uuid_hold_function, HOLD_SYNTAX
"uuid_kill", "Kill
channel", kill_function, KILL_SYNTAX
"uuid_send_message", "Send
MESSAGE to the endpoint", uuid_send_message_function, SEND_MESSAGE_SYNTAX
"uuid_send_info", "Send info
to the endpoint", uuid_send_info_function, INFO_SYNTAX
"uuid_set_media_stats", "Set
media stats", uuid_set_media_stats, UUID_MEDIA_STATS_SYNTAX
"uuid_video_bitrate", "Send
video bitrate req.", uuid_video_bitrate_function, VIDEO_BITRATE_SYNTAX
"uuid_video_bandwidth", "Send
video bandwidth", uuid_video_bandwidth_function, VIDEO_BANDWIDTH_SYNTAX
"uuid_video_refresh", "Send
video refresh.", uuid_video_refresh_function, VIDEO_REFRESH_SYNTAX
"uuid_outgoing_answer",
"Answer outgoing channel", outgoing_answer_function, OUTGOING_ANSWER_SYNTAX
"uuid_limit", "Increase limit
resource", uuid_limit_function, LIMIT_SYNTAX
"uuid_limit_release",
"Release limit resource", uuid_limit_release_function,
LIMIT_RELEASE_SYNTAX
"uuid_loglevel", "Set
loglevel on session", uuid_loglevel, UUID_LOGLEVEL_SYNTAX
"uuid_media", "Reinvite FS in
or out of media path", uuid_media_function, MEDIA_SYNTAX
"uuid_media_3p", "Reinvite FS
in or out of media path using 3pcc", uuid_media_3p_function, MEDIA_SYNTAX
"uuid_media_reneg", "Media
negotiation", uuid_media_neg_function, MEDIA_RENEG_SYNTAX
"uuid_park", "Park
channel", park_function, PARK_SYNTAX
"uuid_pause", "Pause media on
a channel", pause_function, PAUSE_SYNTAX
"uuid_phone_event", "Send an
event to the phone", uuid_phone_event_function, PHONE_EVENT_SYNTAX
"uuid_ring_ready", "Sending
ringing to a channel", uuid_ring_ready_function, RING_READY_SYNTAX
"uuid_pre_answer",
"pre_answer", uuid_pre_answer_function, "<uuid>"
"uuid_preprocess",
"Pre-process Channel", preprocess_function, PREPROCESS_SYNTAX
"uuid_record", "Record
session audio", session_record_function, SESS_REC_SYNTAX
"uuid_recovery_refresh",
"Send a recovery_refresh", uuid_recovery_refresh,
UUID_RECOVERY_REFRESH_SYNTAX
"uuid_recv_dtmf", "Receive
dtmf digits", uuid_recv_dtmf_function, UUID_RECV_DTMF_SYNTAX
"uuid_redirect", "Send a
redirect", uuid_redirect, UUID_REDIRECT_SYNTAX
"uuid_send_dtmf", "Send dtmf
digits", uuid_send_dtmf_function, UUID_SEND_DTMF_SYNTAX
"uuid_session_heartbeat",
"uuid_session_heartbeat", uuid_session_heartbeat_function,
HEARTBEAT_SYNTAX
"uuid_setvar_multi", "Set
multiple variables", uuid_setvar_multi_function, SETVAR_MULTI_SYNTAX
"uuid_setvar", "Set a
variable", uuid_setvar_function, SETVAR_SYNTAX
"uuid_transfer", "Transfer a
session", transfer_function, TRANSFER_SYNTAX
"uuid_dual_transfer",
"Transfer a session and its partner", dual_transfer_function,
DUAL_TRANSFER_SYNTAX
"uuid_simplify", "Try to cut
out of a call path / attended xfer", uuid_simplify_function,
SIMPLIFY_SYNTAX
"uuid_jitterbuffer",
"uuid_jitterbuffer", uuid_jitterbuffer_function, JITTERBUFFER_SYNTAX
"uuid_zombie_exec", "Set
zombie_exec flag on the specified uuid", uuid_zombie_exec_function,
"<uuid>"
"uuid_xfer_zombie", "Allow A
leg to hangup and continue originating", uuid_xfer_zombie,
XFER_ZOMBIE_SYNTAX
"xml_flush_cache", "Clear xml
cache", xml_flush_function, "<id> <key> <val>"
"xml_locate", "Find some
xml", xml_locate_function, "[root | <section> <tag>
<tag_attr_name> <tag_attr_val>]"
"xml_wrap", "Wrap another api
command in xml", xml_wrap_api_function, "<command>
<args>"
"file_exists", "Check if a
file exists on server", file_exists_function, "<file>"
"getcputime", "Gets CPU time
in milliseconds (user,kernel)", getcputime_function, GETCPUTIME_SYNTAX
"json", "JSON API",
json_function, "JSON"
"memory", "Memory usage
statistics", memory_function, "memory"
"add alias add"
"add alias stickyadd"
"add alias del"
"add coalesce"
"add complete add"
"add complete del"
"add db_cache status"
"add fsctl debug_level"
"add fsctl debug_pool"
"add fsctl debug_sql"
"add fsctl last_sps"
"add fsctl default_dtmf_duration"
"add fsctl hupall"
"add fsctl loglevel"
"add fsctl loglevel console"
"add fsctl loglevel alert"
"add fsctl loglevel crit"
"add fsctl loglevel err"
"add fsctl loglevel warning"
"add fsctl loglevel notice"
"add fsctl loglevel info"
"add fsctl loglevel debug"
"add fsctl max_dtmf_duration"
"add fsctl max_sessions"
"add fsctl min_dtmf_duration"
"add fsctl pause"
"add fsctl pause inbound"
"add fsctl pause outbound"
"add fsctl reclaim_mem"
"add fsctl resume"
"add fsctl resume inbound"
"add fsctl resume outbound"
"add fsctl calibrate_clock"
"add fsctl crash"
"add fsctl verbose_events"
"add fsctl save_history"
"add fsctl pause_check"
"add fsctl pause_check inbound"
"add fsctl pause_check outbound"
"add fsctl ready_check"
"add fsctl recover"
"add fsctl shutdown_check"
"add fsctl shutdown"
"add fsctl shutdown asap"
"add fsctl shutdown now"
"add fsctl shutdown asap restart"
"add fsctl shutdown cancel"
"add fsctl shutdown elegant"
"add fsctl shutdown elegant restart"
"add fsctl shutdown reincarnate now"
"add fsctl shutdown restart"
"add fsctl shutdown restart asap"
"add fsctl shutdown restart elegant"
"add fsctl sps"
"add fsctl sync_clock"
"add fsctl flush_db_handles"
"add fsctl min_idle_cpu"
"add fsctl send_sighup"
"add fsctl mdns_resolve disable"
"add fsctl mdns_resolve enable"
"add interface_ip auto
::console::list_interfaces"
"add interface_ip ipv4
::console::list_interfaces"
"add interface_ip ipv6
::console::list_interfaces"
"add load
::console::list_available_modules"
"add nat_map reinit"
"add nat_map republish"
"add nat_map status"
"add reload
::console::list_loaded_modules"
"add reloadacl reloadxml"
"add show aliases"
"add show api"
"add show application"
"add show calls"
"add show channels"
"add show channels count"
"add show chat"
"add show codec"
"add show complete"
"add show dialplan"
"add show detailed_calls"
"add show bridged_calls"
"add show detailed_bridged_calls"
"add show endpoint"
"add show file"
"add show interfaces"
"add show interface_types"
"add show tasks"
"add show management"
"add show modules"
"add show nat_map"
"add show registrations"
"add show say"
"add show status"
"add show timer"
"add shutdown"
"add sql_escape"
"add unload
::console::list_loaded_modules"
"add uptime ms"
"add uptime s"
"add uptime m"
"add uptime h"
"add uptime d"
"add uptime microseconds"
"add uptime milliseconds"
"add uptime seconds"
"add uptime minutes"
"add uptime hours"
"add uptime days"
"add uuid_audio ::console::list_uuid
start read mute"
"add uuid_audio ::console::list_uuid
start read level"
"add uuid_audio ::console::list_uuid
start write mute"
"add uuid_audio ::console::list_uuid
start write level"
"add uuid_audio ::console::list_uuid
stop"
"add uuid_break ::console::list_uuid
all"
"add uuid_break ::console::list_uuid
both"
"add uuid_pause ::console::list_uuid
on"
"add uuid_pause ::console::list_uuid
off"
"add uuid_bridge ::console::list_uuid
::console::list_uuid"
"add uuid_broadcast
::console::list_uuid"
"add uuid_buglist
::console::list_uuid"
"add uuid_chat ::console::list_uuid"
"add uuid_send_text
::console::list_uuid"
"add uuid_capture_text
::console::list_uuid"
"add uuid_codec_debug
::console::list_uuid audio"
"add uuid_codec_debug
::console::list_uuid video"
"add uuid_codec_param
::console::list_uuid audio read"
"add uuid_codec_param
::console::list_uuid audio write"
"add uuid_codec_param ::console::list_uuid
video read"
"add uuid_codec_param
::console::list_uuid video write"
"add uuid_debug_media
::console::list_uuid"
"add uuid_deflect
::console::list_uuid"
"add uuid_displace
::console::list_uuid"
"add uuid_display ::console::list_uuid"
"add uuid_media_params
::console::list_uuid"
"add uuid_drop_dtmf
::console::list_uuid"
"add uuid_dump ::console::list_uuid"
"add uuid_answer
::console::list_uuid"
"add uuid_ring_ready ::console::list_uuid
queued"
"add uuid_pre_answer
::console::list_uuid"
"add uuid_early_ok
::console::list_uuid"
"add uuid_exists
::console::list_uuid"
"add uuid_fileman
::console::list_uuid"
"add uuid_flush_dtmf
::console::list_uuid"
"add uuid_getvar
::console::list_uuid"
"add uuid_hold ::console::list_uuid"
"add uuid_hold off
::console::list_uuid"
"add uuid_hold toggle
::console::list_uuid"
"add uuid_send_info
::console::list_uuid"
"add uuid_jitterbuffer
::console::list_uuid"
"add uuid_kill ::console::list_uuid"
"add uuid_outgoing_answer
::console::list_uuid"
"add uuid_limit
::console::list_uuid"
"add uuid_limit_release
::console::list_uuid"
"add uuid_loglevel ::console::list_uuid
console"
"add uuid_loglevel ::console::list_uuid
alert"
"add uuid_loglevel ::console::list_uuid
crit"
"add uuid_loglevel ::console::list_uuid
err"
"add uuid_loglevel ::console::list_uuid
warning"
"add uuid_loglevel ::console::list_uuid
notice"
"add uuid_loglevel ::console::list_uuid
info"
"add uuid_loglevel ::console::list_uuid
debug"
"add uuid_media
::console::list_uuid"
"add uuid_media off
::console::list_uuid"
"add uuid_media_3p
::console::list_uuid"
"add uuid_media_3p off
::console::list_uuid"
"add uuid_park ::console::list_uuid"
"add uuid_media_reneg
::console::list_uuid"
"add uuid_phone_event
::console::list_uuid talk"
"add uuid_phone_event
::console::list_uuid hold"
"add uuid_preprocess
::console::list_uuid"
"add uuid_record ::console::list_uuid
::[start:stop"
"add uuid_recovery_refresh
::console::list_uuid"
"add uuid_recv_dtmf
::console::list_uuid"
"add uuid_redirect
::console::list_uuid"
"add uuid_send_dtmf
::console::list_uuid"
"add uuid_session_heartbeat
::console::list_uuid"
"add uuid_setvar_multi
::console::list_uuid"
"add uuid_setvar
::console::list_uuid"
"add uuid_simplify
::console::list_uuid"
"add uuid_transfer
::console::list_uuid"
"add uuid_dual_transfer
::console::list_uuid"
"add uuid_video_refresh
::console::list_uuid"
"add uuid_video_bitrate
::console::list_uuid"
"add uuid_video_bandwidth
::console::list_uuid"
"add uuid_xfer_zombie
::console::list_uuid"
"add version"
"add uuid_warning
::console::list_uuid"
"add ..."
"add file_exists"
"add getcputime"
List of commands line link:-
https://myhandbook-technical.blogspot.com/2011/12/freeswitch-mod-commands.html
https://github.com/sparre/libesl/tree/master/src
https://freeswitch.org/confluence/display/FREESWITCH/mod_commands
https://www.ahfesco.com.cn/affairs/Article.asp?id=1984
http://wiki.pchero21.com/wiki/Freeswitch_fs_cli_commands
Comments
Post a Comment