Freeswitch API

Name	Description	Module	Syntax
...	Shutdown	mod_commands	...
acl	Compare an ip to an acl list	mod_commands	<ip> <list_name>
alias	Alias	mod_commands	[add\|stickyadd] <alias> <command> \| del [<alias>\|*]
banner	Return the system banner	mod_commands
bg_system	Execute a system command in the background	mod_commands	<command>
bgapi	Execute an api command in a thread	mod_commands	<command>[ <arg>]
break	uuid_break	mod_commands	<uuid> [all]
Freeswitch ESL: callcenter	callcenter	mod_callcenter	parameters
cdr_csv	cdr_csv controls	mod_cdr_csv	parameters
mod_dptools:Chat	chat	mod_dptools	<proto>\|<from>\|<to>\|<message>\|[<content-type>]
coalesce	Return first nonempty parameter	mod_commands	[^^<delim>]<value1>,<value2>,...
complete	Complete	mod_commands	add <word>\|del [<word>\|*]
cond	Evaluate a conditional	mod_commands	<expr> ? <true val> : <false val>
conference	Conference module commands	mod_conference
console	Console	mod_console	loglevel [level]\|colorize [on\|toggle\|off]
console_complete		mod_commands	<line>
console_complete_xml		mod_commands	<line>
create_uuid	Create a uuid	mod_commands	<uuid> <other_uuid>
db	db get/set	mod_db	[insert\|delete\|select\|exists\|count\|list]/<realm>/<key>/<value>
db_cache	Manage db cache	mod_commands	status
domain_exists	Check if a domain exists	mod_commands	<domain>
echo	Echo	mod_commands	<data>
enum	ENUM	mod_enum
enum_auto	ENUM	mod_enum
escape	Escape a string	mod_commands	<data>
eval	eval (noop)	mod_commands	[uuid:<uuid> ]<expression>
event_sink	event_sink	mod_event_socket	<web data>
expand	Execute an api with variable expansion	mod_commands	[uuid:<uuid> ]<cmd> <args>
expr	Eval an expression	mod_expr	<expr>
fifo	Return data about a fifo	mod_fifo	list\|list_verbose\|count\|debug\|status\|has_outbound\|importance [<fifo name>]\|reparse [del_all]
fifo_add_outbound	Add outbound members to a fifo	mod_fifo	<node> <url> [<priority>]
fifo_check_bridge	check if uuid is in a bridge	mod_fifo	<uuid>\|<outbound_id>
fifo_member	Add members to a fifo	mod_fifo	[add <fifo_name> <originate_string> [<simo_count>] [<timeout>] [<lag>] [<expires>] [<taking_calls>] \| del <fifo_name> <originate_string>]
file_exists	Check if a file exists on server	mod_commands	<file>
find_user_xml	Find a user	mod_commands	<key> <user> <domain>
fsctl	FS control messages	mod_commands	[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]]
getcputime	Gets CPU time in milliseconds (user,kernel)	mod_commands	[reset]
getenv	getenv	mod_commands	<name>
gethost	gethostbyname	mod_commands
global_getvar	Get global var	mod_commands	<var>
global_setvar	Set global var	mod_commands	<var>=<value> [=<value2>]
group	group [insert	delete	call]	mod_db	[insert\|delete\|call]:<group name>:<url>
group_call	Generate a dial string to call a group	mod_commands	<group>[@<domain>]
hash	hash get/set	mod_hash	[insert\|delete\|select]/<realm>/<key>/<value>
hash_dump	dump hash/limit_hash data (used for synchronization)	mod_hash	all\|limit\|db [<realm>]
hash_remote	hash remote	mod_hash	list\|kill [name]\|rescan
help	Show help for all the api commands	mod_commands
host_lookup	Lookup host	mod_commands	<hostname>
hostname	Return the system hostname	mod_commands
httapi	HT-TAPI Hypertext Telephony API	mod_httapi	[debug_on\|debug_off]
hup_local_stream	Skip to next file in local_stream	mod_local_stream	<local_stream_name>
hupall	hupall	mod_commands	<cause> [<var> <value>]
in_group	Determine if a user is in a group	mod_commands	<user>[@<domain>] <group_name>
interface_ip	Return the primary IP of an interface	mod_commands	[auto\|ipv4\|ipv6] <ifname>
is_lan_addr	See if an ip is a lan addr	mod_commands	<ip>
Freeswitch: fsapi - Json	JSON API	mod_commands	JSON
limit_hash_usage	Deprecated: gets the usage count of a limited resource	mod_commands	<realm> <id>
limit_interval_reset	Reset the interval counter for a limited resource	mod_commands	<backend> <realm> <resource>
limit_reset	Reset the counters of a limit backend	mod_commands	<backend>
limit_status	Get the status of a limit backend	mod_commands	<backend>
limit_usage	Get the usage count of a limited resource	mod_commands	<backend> <realm> <id>
list_users	List Users configured in Directory	mod_commands	[group <group>] [domain <domain>] [user <user>] [context <context>]
load	Load Module	mod_commands	<mod_name>
log	Log	mod_commands	<level> <message>
lua	run a script as an api function	mod_lua	<script>
luarun	run a script	mod_lua	<script>
md5	Return md5 hash	mod_commands	<data>
module_exists	Check if module exists	mod_commands	<module>
msleep	Sleep N milliseconds	mod_commands	<milliseconds>
nat_map	Manage NAT	mod_commands	[status\|republish\|reinit] \| [add\|del] <port> [tcp\|udp] [static]
opus_debug	Set OPUS Debug	mod_opus	<on\|off>
originate	Originate a call	mod_commands	<call url> <exten>\|&<application_name>(<app_args>) [<dialplan>] [<context>] [<cid_name>] [<cid_num>] [<timeout_sec>]
page	Send a file as a page	mod_dptools	(var1=val1,var2=val2)<var1=val1,var2=val2><chan1>[:_:<chanN>]
pause	Pause media on a channel	mod_commands	<uuid> <on\|off>
presence	presence	mod_dptools	[in\|out] <user> <rpid> <message>
quote_shell_arg	Quote/escape a string for use on shell command line	mod_commands	<data>
reg_url		mod_commands	<user>@<realm>
Freeswitch ESL: regex	Evaluate a regex	mod_commands	<data>\|<pattern>[\|<subst string>][n\|b]
reload	Reload module	mod_commands	[-f] <mod_name>
reload_local_stream	Reloads a local_stream	mod_local_stream	<local_stream_name>
reloadacl	Reload XML	mod_commands
reloadxml	Reload XML	mod_commands
replace	Replace a string	mod_commands	<data>\|<string1>\|<string2>
say_string		mod_commands	<module_name>[.<ext>] <lang>[.<ext>] <say_type> <say_method> [<say_gender>] <text>
sched_api	Schedule an api command	mod_commands	[+@]<time> <group_name> <command_string>[&]
sched_broadcast	Schedule a broadcast event to a running call	mod_commands	[[+]<time>\|@time] <uuid> <path> [aleg\|bleg\|both]
sched_del	Delete a scheduled task	mod_commands	<task_id>\|<group_id>
sched_hangup	Schedule a running call to hangup	mod_commands	[+]<time> <uuid> [<cause>]
sched_transfer	Schedule a transfer for a running call	mod_commands	[+]<time> <uuid> <extension> [<dialplan>] [<context>]
show	Show various reports	mod_commands	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_local_stream	Shows a local stream	mod_local_stream	[local_stream_name [xml]]
shutdown	Shutdown	mod_commands
sofia	Sofia Controls	mod_sofia	<cmd> <args>
Freeswitch: Fsapi - Sofia_contact	Sofia Contacts	mod_sofia	[profile/]<user>@<domain>
sofia_count_reg	Count Sofia registration	mod_sofia	[profile/]<user>@<domain>
sofia_dig	SIP DIG	mod_sofia	<url>
sofia_gateway_data	Get data from a sofia gateway	mod_sofia	<gateway_name> [ivar\|ovar\|var] <name>
sofia_presence_data	Sofia Presence Data	mod_sofia	[list\|status\|rpid\|user_agent] [profile/]<user>@domain
sofia_username_of	Sofia Username Lookup	mod_sofia	[profile/]<user>@<domain>
spandsp_start_tone_detect	Start background tone detection with cadence	mod_spandsp	<uuid> <name>
spandsp_stop_tone_detect	Stop background tone detection with cadence	mod_spandsp	<uuid>
sql_escape	Escape a string to prevent sql injection	mod_commands	<string>
start_local_stream	Starts a new local_stream	mod_local_stream	<local_stream_name>
start_tdd_detect	Start background tdd detection	mod_spandsp	<uuid>
status	Show current status	mod_commands
stop_local_stream	Stops and unloads a local_stream	mod_local_stream	<local_stream_name>
stop_tdd_detect	Stop background tdd detection	mod_spandsp	<uuid>
strepoch	Convert a date string into epoch time	mod_dptools	<string>
strftime	strftime	mod_dptools	<format_string>
strftime_tz	Display formatted time of timezone	mod_commands	<timezone_name> [<epoch>\|][format string]
strmicroepoch	Convert a date string into micoepoch time	mod_dptools	<string>
stun	Execute STUN lookup	mod_commands	<stun_server>[:port] [<source_ip>[:<source_port]]
switchname	Return the switch name	mod_commands
system	Execute a system command	mod_commands	<command>
telecast	telecast	mod_shout
time_test	Show time jitter	mod_commands	<mss> [count]
timer_test	Exercise FS timer	mod_commands	<10\|20\|40\|60\|120> [<1..200>] [<timer_name>]
tone_detect	Start tone detection on a channel	mod_commands	<uuid> <key> <tone_spec> [<flags> <timeout> <app> <args> <hits>]
unload	Unload module	mod_commands	[-f] <mod_name>
unsched_api	Unschedule an api command	mod_commands	<task_id>
uptime	Show uptime	mod_commands	[us\|ms\|s\|m\|h\|d\|microseconds\|milliseconds\|seconds\|minutes\|hours\|days]
url_decode	Url decode a string	mod_commands	<string>
url_encode	Url encode a string	mod_commands	<string>
user_data	Find user data	mod_commands	<user>@<domain> [var\|param\|attr] <name>
user_exists	Find a user	mod_commands	<key> <user> <domain>
uuid_answer	answer	mod_commands	<uuid>
uuid_audio	uuid_audio	mod_commands	<uuid> [start [read\|write] [mute\|level <level>]\|stop]
uuid_break	Break out of media sent to channel	mod_commands	<uuid> [all]
uuid_bridge	Bridge call legs	mod_commands
uuid_broadcast	Execute dialplan application	mod_commands	<uuid> <path> [aleg\|bleg\|holdb\|both]
uuid_buglist	List media bugs on a session	mod_commands	<uuid>
uuid_chat	Send a chat message	mod_commands	<uuid> <text>
uuid_codec_debug	Send codec a debug message	mod_commands	<uuid> audio\|video <level>
uuid_codec_param	Send codec a param	mod_commands	<uuid> audio\|video read\|write <param> <val>
uuid_debug_media	Debug media	mod_commands	<uuid> <read\|write\|both\|vread\|vwrite\|vboth\|all> <on\|off>
uuid_deflect	Send a deflect	mod_commands	<uuid> <uri>
uuid_displace	Displace audio	mod_commands	<uuid> [start\|stop] <path> [<limit>] [mux]
uuid_display	Update phone display	mod_commands	<uuid> <display>
uuid_drop_dtmf	Drop all DTMF or replace it with a mask	mod_commands	<uuid> [on \| off ] [ mask_digits <digits> \| mask_file <file>]
uuid_dual_transfer	Transfer a session and its partner	mod_commands	<uuid> <A-dest-exten>[/<A-dialplan>][/<A-context>] <B-dest-exten>[/<B-dialplan>][/<B-context>]
uuid_dump	Dump session vars	mod_commands	<uuid> [format]
uuid_early_ok	stop ignoring early media	mod_commands	<uuid>
uuid_exists	Check if a uuid exists	mod_commands	<uuid>
uuid_fileman	Manage session audio	mod_commands	<uuid> <cmd>:<val>
uuid_flush_dtmf	Flush dtmf on a given uuid	mod_commands	<uuid>
uuid_getvar	Get a variable from a channel	mod_commands	<uuid> <var>
uuid_hold	Place call on hold	mod_commands	[off\|toggle] <uuid> [<display>]
uuid_jitterbuffer	uuid_jitterbuffer	mod_commands	<uuid> [0\|<min_msec>[:<max_msec>]]
uuid_kill	Kill channel	mod_commands	<uuid> [cause]
uuid_limit	Increase limit resource	mod_commands	<uuid> <backend> <realm> <resource> [<max>[/interval]] [number [dialplan [context]]]
uuid_limit_release	Release limit resource	mod_commands	<uuid> <backend> [realm] [resource]
uuid_limit_release	Release limit resource	mod_commands	<uuid> <backend> [realm] [resource]
uuid_loglevel	Set loglevel on session	mod_commands	<uuid> <level>
uuid_media	Reinvite FS in or out of media path	mod_commands	[off] <uuid>
uuid_media_3p	Reinvite FS in or out of media path using 3pcc	mod_commands	[off] <uuid>
uuid_media_reneg	Media negotiation	mod_commands	<uuid>[ <codec_string>]
uuid_outgoing_answer	Answer outgoing channel	mod_commands	<uuid>
uuid_park	Park channel	mod_commands	<uuid>
uuid_pause	Pause media on a channel	mod_commands	<uuid> <on\|off>
uuid_phone_event	Send an event to the phone	mod_commands	<uuid>
uuid_pre_answer	pre_answer	mod_commands	<uuid>
uuid_preprocess	Pre-process Channel	mod_commands	<>
uuid_record	Record session audio	mod_commands	<uuid> [start\|stop\|mask\|unmask] <path> [<limit>]
uuid_recovery_refresh	Send a recovery_refresh	mod_commands	<uuid> <uri>
uuid_recv_dtmf	Receive dtmf digits	mod_commands	<uuid> <dtmf_data>
uuid_redirect	Send a redirect	mod_commands	<uuid> <uri>
uuid_ring_ready	Sending ringing to a channel	mod_commands	<uuid> [queued]
uuid_send_dtmf	Send dtmf digits	mod_commands	<uuid> <dtmf_data>
uuid_send_info	Send info to the endpoint	mod_commands	<uuid> [<mime_type> <mime_subtype>] <message>
uuid_send_message	Send MESSAGE to the endpoint	mod_commands	<uuid> <message>
uuid_send_tdd	send tdd data to a uuid	mod_spandsp	<uuid> <text>
uuid_session_heartbeat	uuid_session_heartbeat	mod_commands	<uuid> [sched] [0\|<seconds>]
uuid_set_media_stats	Set media stats	mod_commands	<uuid>
uuid_setvar	Set a variable	mod_commands	<uuid> <var> [value]
uuid_setvar_multi	Set multiple variables	mod_commands	<uuid> <var>=<value>	<var>=<value>...
uuid_simplify	Try to cut out of a call path / attended xfer	mod_commands	<uuid>
uuid_transfer	Transfer a session	mod_commands	<uuid> [-bleg\|-both] <dest-exten> [<dialplan>] [<context>]
uuid_video_bitrate	Send video bitrate req.	mod_commands	<uuid> <bitrate>
uuid_video_refresh	Send video refresh.	mod_commands	<uuid>
uuid_write_png	grab an image from a call	mod_png
uuid_zombie_exec	Set zombie_exec flag on the specified uuid	mod_commands	<uuid>
valet_info	Valet Parking Info	mod_valet_parking	[<lot name>]
version	Version	mod_commands	[short]
verto	Verto API	mod_verto	syntax
verto_contact	Generate a verto endpoint dialstring	mod_verto	user@domain
vm_boxcount	vm_boxcount	mod_voicemail	[profile/]<user>@<domain>[\|[new\|saved\|new-urgent\|saved-urgent\|all]]
vm_delete	vm_delete	mod_voicemail	<id>@<domain>[/profile] [<uuid>]
vm_fsdb_auth_login	vm_fsdb_auth_login	mod_voicemail	<profile> <domain> <user> <password>
vm_fsdb_msg_count	vm_fsdb_msg_count	mod_voicemail	<format> <profile> <domain> <user> <folder>
vm_fsdb_msg_delete	vm_fsdb_msg_delete	mod_voicemail	<profile> <domain> <user> <uuid>
vm_fsdb_msg_email	vm_fsdb_msg_email	mod_voicemail	<profile> <domain> <user> <uuid> <email>
vm_fsdb_msg_forward	vm_fsdb_msg_forward	mod_voicemail	<profile> <domain> <user> <uuid> <dst_domain> <dst_user> [prepend_file_location]
vm_fsdb_msg_get	vm_fsdb_msg_get	mod_voicemail	<format> <profile> <domain> <user> <uuid>
vm_fsdb_msg_list	vm_fsdb_msg_list	mod_voicemail	<format> <profile> <domain> <user> <folder> <filter> [msg-order = ASC \| DESC]
vm_fsdb_msg_purge	vm_fsdb_msg_purge	mod_voicemail	<profile> <domain> <user>
vm_fsdb_msg_save	vm_fsdb_msg_save	mod_voicemail	<profile> <domain> <user> <uuid>
vm_fsdb_msg_undelete	vm_fsdb_msg_undelete	mod_voicemail	<profile> <domain> <user> <uuid>
vm_fsdb_pref_greeting_get	vm_fsdb_pref_greeting_get	mod_voicemail	<format> <profile> <domain> <user> [slot]
vm_fsdb_pref_greeting_set	vm_fsdb_pref_greeting_set	mod_voicemail	<profile> <domain> <user> <slot> [file-path]
vm_fsdb_pref_password_set	vm_fsdb_pref_password_set	mod_voicemail	<profile> <domain> <user> <password>
vm_fsdb_pref_recname_set	vm_fsdb_pref_recname_set	mod_voicemail	<profile> <domain> <user> <file-path>
vm_inject	vm_inject	mod_voicemail	[group=<group>[@domain]\|domain=<domain>\|<box>[@<domain>]] <sound_file> [<cid_num>] [<cid_name>]
vm_list	vm_list	mod_voicemail	<id>@<domain>[/profile] [xml]
vm_prefs	vm_prefs	mod_voicemail	[profile/]<user>@<domain>[\|[name_path\|greeting_path\|password]]
vm_read	vm_read	mod_voicemail	<id>@<domain>[/profile] <read\|unread> [<uuid>]
voicemail	voicemail	mod_voicemail	rss [<host> <port> <uri> <user> <domain>] \| [load\|unload\|reload] <profile> [reloadxml]
voicemail_inject	voicemail_inject	mod_voicemail	[group=<group>[@domain]\|domain=<domain>\|<box>[@<domain>]] <sound_file> [<cid_num>] [<cid_name>]
xml_flush_cache	Clear xml cache	mod_commands	<id> <key> <val>
Freeswitch: Fsapi - xml_locate	Find some xml	mod_commands	[root \| <section> <tag> <tag_attr_name> <tag_attr_val>]
xml_wrap	Wrap another api command in xml	mod_commands	<command> <args>

FreeSWITCH

freeswitch, api