Freeswitch API

NameDescriptionModuleSyntax
...Shutdownmod_commands...
aclCompare an ip to an acl listmod_commands<ip> <list_name>
aliasAliasmod_commands[add|stickyadd] <alias> <command> | del [<alias>|*]
bannerReturn the system bannermod_commands
bg_systemExecute a system command in the backgroundmod_commands<command>
bgapiExecute an api command in a threadmod_commands<command>[ <arg>]
breakuuid_breakmod_commands<uuid> [all]
cdr_csvcdr_csv controlsmod_cdr_csvparameters
chatchatmod_dptools<proto>|<from>|<to>|<message>|[<content-type>]
coalesceReturn first nonempty parametermod_commands[^^<delim>]<value1>,<value2>,...
completeCompletemod_commandsadd <word>|del [<word>|*]
condEvaluate a conditionalmod_commands<expr> ? <true val> : <false val>
conferenceConference module commandsmod_conference
consoleConsolemod_consoleloglevel [level]|colorize [on|toggle|off]
console_completemod_commands<line>
console_complete_xmlmod_commands<line>
create_uuidCreate a uuidmod_commands<uuid> <other_uuid>
dbdb get/setmod_db[insert|delete|select|exists|count|list]/<realm>/<key>/<value>
db_cacheManage db cachemod_commandsstatus
domain_existsCheck if a domain existsmod_commands<domain>
echoEchomod_commands<data>
enumENUMmod_enum
enum_autoENUMmod_enum
escapeEscape a stringmod_commands<data>
evaleval (noop)mod_commands[uuid:<uuid> ]<expression>
event_sinkevent_sinkmod_event_socket<web data>
expandExecute an api with variable expansionmod_commands[uuid:<uuid> ]<cmd> <args>
exprEval an expressionmod_expr<expr>
fifoReturn data about a fifomod_fifolist|list_verbose|count|debug|status|has_outbound|importance [<fifo name>]|reparse [del_all]
fifo_add_outboundAdd outbound members to a fifomod_fifo<node> <url> [<priority>]
fifo_check_bridgecheck if uuid is in a bridgemod_fifo<uuid>|<outbound_id>
fifo_memberAdd members to a fifomod_fifo[add <fifo_name> <originate_string> [<simo_count>] [<timeout>] [<lag>] [<expires>] [<taking_calls>] | del <fifo_name> <originate_string>]
file_existsCheck if a file exists on servermod_commands<file>
find_user_xmlFind a usermod_commands<key> <user> <domain>
fsctlFS control messagesmod_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]]
getcputimeGets CPU time in milliseconds (user,kernel)mod_commands[reset]
getenvgetenvmod_commands<name>
gethostgethostbynamemod_commands
global_getvarGet global varmod_commands<var>
global_setvarSet global varmod_commands<var>=<value> [=<value2>]
groupgroup [insertdeletecall]mod_db[insert|delete|call]:<group name>:<url>
group_callGenerate a dial string to call a groupmod_commands<group>[@<domain>]
hashhash get/setmod_hash[insert|delete|select]/<realm>/<key>/<value>
hash_dumpdump hash/limit_hash data (used for synchronization)mod_hashall|limit|db [<realm>]
hash_remotehash remotemod_hashlist|kill [name]|rescan
helpShow help for all the api commandsmod_commands
host_lookupLookup hostmod_commands<hostname>
hostnameReturn the system hostnamemod_commands
httapiHT-TAPI Hypertext Telephony APImod_httapi[debug_on|debug_off]
hup_local_streamSkip to next file in local_streammod_local_stream<local_stream_name>
hupallhupallmod_commands<cause> [<var> <value>]
in_groupDetermine if a user is in a groupmod_commands<user>[@<domain>] <group_name>
interface_ipReturn the primary IP of an interfacemod_commands[auto|ipv4|ipv6] <ifname>
is_lan_addrSee if an ip is a lan addrmod_commands<ip>
jsonJSON APImod_commandsJSON
limit_hash_usageDeprecated: gets the usage count of a limited resourcemod_commands<realm> <id>
limit_interval_resetReset the interval counter for a limited resourcemod_commands<backend> <realm> <resource>
limit_resetReset the counters of a limit backendmod_commands<backend>
limit_statusGet the status of a limit backendmod_commands<backend>
limit_usageGet the usage count of a limited resourcemod_commands<backend> <realm> <id>
list_usersList Users configured in Directorymod_commands[group <group>] [domain <domain>] [user <user>] [context <context>]
loadLoad Modulemod_commands<mod_name>
logLogmod_commands<level> <message>
luarun a script as an api functionmod_lua<script>
luarunrun a scriptmod_lua<script>
md5Return md5 hashmod_commands<data>
module_existsCheck if module existsmod_commands<module>
msleepSleep N millisecondsmod_commands<milliseconds>
nat_mapManage NATmod_commands[status|republish|reinit] | [add|del] <port> [tcp|udp] [static]
opus_debugSet OPUS Debugmod_opus<on|off>
originateOriginate a callmod_commands<call url> <exten>|&<application_name>(<app_args>) [<dialplan>] [<context>] [<cid_name>] [<cid_num>] [<timeout_sec>]
pageSend a file as a pagemod_dptools(var1=val1,var2=val2)<var1=val1,var2=val2><chan1>[:_:<chanN>]
pausePause media on a channelmod_commands<uuid> <on|off>
presencepresencemod_dptools[in|out] <user> <rpid> <message>
quote_shell_argQuote/escape a string for use on shell command linemod_commands<data>
reg_urlmod_commands<user>@<realm>
regexEvaluate a regexmod_commands<data>|<pattern>[|<subst string>][n|b]
reloadReload modulemod_commands[-f] <mod_name>
reload_local_streamReloads a local_streammod_local_stream<local_stream_name>
reloadaclReload XMLmod_commands
reloadxmlReload XMLmod_commands
replaceReplace a stringmod_commands<data>|<string1>|<string2>
say_stringmod_commands<module_name>[.<ext>] <lang>[.<ext>] <say_type> <say_method> [<say_gender>] <text>
sched_apiSchedule an api commandmod_commands[+@]<time> <group_name> <command_string>[&]
sched_broadcastSchedule a broadcast event to a running callmod_commands[[+]<time>|@time] <uuid> <path> [aleg|bleg|both]
sched_delDelete a scheduled taskmod_commands<task_id>|<group_id>
sched_hangupSchedule a running call to hangupmod_commands[+]<time> <uuid> [<cause>]
sched_transferSchedule a transfer for a running callmod_commands[+]<time> <uuid> <extension> [<dialplan>] [<context>]
showShow various reportsmod_commandscodec|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_streamShows a local streammod_local_stream[local_stream_name [xml]]
shutdownShutdownmod_commands
sofiaSofia Controlsmod_sofia<cmd> <args>
Freeswitch: Sofia_contact FunctionSofia Contactsmod_sofia[profile/]<user>@<domain>
sofia_count_regCount Sofia registrationmod_sofia[profile/]<user>@<domain>
sofia_digSIP DIGmod_sofia<url>
sofia_gateway_dataGet data from a sofia gatewaymod_sofia<gateway_name> [ivar|ovar|var] <name>
sofia_presence_dataSofia Presence Datamod_sofia[list|status|rpid|user_agent] [profile/]<user>@domain
sofia_username_ofSofia Username Lookupmod_sofia[profile/]<user>@<domain>
spandsp_start_tone_detectStart background tone detection with cadencemod_spandsp<uuid> <name>
spandsp_stop_tone_detectStop background tone detection with cadencemod_spandsp<uuid>
sql_escapeEscape a string to prevent sql injectionmod_commands<string>
start_local_streamStarts a new local_streammod_local_stream<local_stream_name>
start_tdd_detectStart background tdd detectionmod_spandsp<uuid>
statusShow current statusmod_commands
stop_local_streamStops and unloads a local_streammod_local_stream<local_stream_name>
stop_tdd_detectStop background tdd detectionmod_spandsp<uuid>
strepochConvert a date string into epoch timemod_dptools<string>
strftimestrftimemod_dptools<format_string>
strftime_tzDisplay formatted time of timezonemod_commands<timezone_name> [<epoch>|][format string]
strmicroepochConvert a date string into micoepoch timemod_dptools<string>
stunExecute STUN lookupmod_commands<stun_server>[:port] [<source_ip>[:<source_port]]
switchnameReturn the switch namemod_commands
systemExecute a system commandmod_commands<command>
telecasttelecastmod_shout
time_testShow time jittermod_commands<mss> [count]
timer_testExercise FS timermod_commands<10|20|40|60|120> [<1..200>] [<timer_name>]
tone_detectStart tone detection on a channelmod_commands<uuid> <key> <tone_spec> [<flags> <timeout> <app> <args> <hits>]
unloadUnload modulemod_commands[-f] <mod_name>
unsched_apiUnschedule an api commandmod_commands<task_id>
uptimeShow uptimemod_commands[us|ms|s|m|h|d|microseconds|milliseconds|seconds|minutes|hours|days]
url_decodeUrl decode a stringmod_commands<string>
url_encodeUrl encode a stringmod_commands<string>
user_dataFind user datamod_commands<user>@<domain> [var|param|attr] <name>
user_existsFind a usermod_commands<key> <user> <domain>
uuid_answeranswermod_commands<uuid>
uuid_audiouuid_audiomod_commands<uuid> [start [read|write] [mute|level <level>]|stop]
uuid_breakBreak out of media sent to channelmod_commands<uuid> [all]
uuid_bridgeBridge call legsmod_commands
uuid_broadcastExecute dialplan applicationmod_commands<uuid> <path> [aleg|bleg|holdb|both]
uuid_buglistList media bugs on a sessionmod_commands<uuid>
uuid_chatSend a chat messagemod_commands<uuid> <text>
uuid_codec_debugSend codec a debug messagemod_commands<uuid> audio|video <level>
uuid_codec_paramSend codec a parammod_commands<uuid> audio|video read|write <param> <val>
uuid_debug_mediaDebug mediamod_commands<uuid> <read|write|both|vread|vwrite|vboth|all> <on|off>
uuid_deflectSend a deflectmod_commands<uuid> <uri>
uuid_displaceDisplace audiomod_commands<uuid> [start|stop] <path> [<limit>] [mux]
uuid_displayUpdate phone displaymod_commands<uuid> <display>
uuid_drop_dtmfDrop all DTMF or replace it with a maskmod_commands<uuid> [on | off ] [ mask_digits <digits> | mask_file <file>]
uuid_dual_transferTransfer a session and its partnermod_commands<uuid> <A-dest-exten>[/<A-dialplan>][/<A-context>] <B-dest-exten>[/<B-dialplan>][/<B-context>]
uuid_dumpDump session varsmod_commands<uuid> [format]
uuid_early_okstop ignoring early mediamod_commands<uuid>
uuid_existsCheck if a uuid existsmod_commands<uuid>
uuid_filemanManage session audiomod_commands<uuid> <cmd>:<val>
uuid_flush_dtmfFlush dtmf on a given uuidmod_commands<uuid>
uuid_getvarGet a variable from a channelmod_commands<uuid> <var>
uuid_holdPlace call on holdmod_commands[off|toggle] <uuid> [<display>]
uuid_jitterbufferuuid_jitterbuffermod_commands<uuid> [0|<min_msec>[:<max_msec>]]
uuid_killKill channelmod_commands<uuid> [cause]
uuid_limitIncrease limit resourcemod_commands<uuid> <backend> <realm> <resource> [<max>[/interval]] [number [dialplan [context]]]
uuid_limit_releaseRelease limit resourcemod_commands<uuid> <backend> [realm] [resource]
uuid_limit_releaseRelease limit resourcemod_commands<uuid> <backend> [realm] [resource]
uuid_loglevelSet loglevel on sessionmod_commands<uuid> <level>
uuid_mediaReinvite FS in or out of media pathmod_commands[off] <uuid>
uuid_media_3pReinvite FS in or out of media path using 3pccmod_commands[off] <uuid>
uuid_media_renegMedia negotiationmod_commands<uuid>[ <codec_string>]
uuid_outgoing_answerAnswer outgoing channelmod_commands<uuid>
uuid_parkPark channelmod_commands<uuid>
uuid_pausePause media on a channelmod_commands<uuid> <on|off>
uuid_phone_eventSend an event to the phonemod_commands<uuid>
uuid_pre_answerpre_answermod_commands<uuid>
uuid_preprocessPre-process Channelmod_commands<>
uuid_recordRecord session audiomod_commands<uuid> [start|stop|mask|unmask] <path> [<limit>]
uuid_recovery_refreshSend a recovery_refreshmod_commands<uuid> <uri>
uuid_recv_dtmfReceive dtmf digitsmod_commands<uuid> <dtmf_data>
uuid_redirectSend a redirectmod_commands<uuid> <uri>
uuid_ring_readySending ringing to a channelmod_commands<uuid> [queued]
uuid_send_dtmfSend dtmf digitsmod_commands<uuid> <dtmf_data>
uuid_send_infoSend info to the endpointmod_commands<uuid> [<mime_type> <mime_subtype>] <message>
uuid_send_messageSend MESSAGE to the endpointmod_commands<uuid> <message>
uuid_send_tddsend tdd data to a uuidmod_spandsp<uuid> <text>
uuid_session_heartbeatuuid_session_heartbeatmod_commands<uuid> [sched] [0|<seconds>]
uuid_set_media_statsSet media statsmod_commands<uuid>
uuid_setvarSet a variablemod_commands<uuid> <var> [value]
uuid_setvar_multiSet multiple variablesmod_commands<uuid> <var>=<value><var>=<value>...
uuid_simplifyTry to cut out of a call path / attended xfermod_commands<uuid>
uuid_transferTransfer a sessionmod_commands<uuid> [-bleg|-both] <dest-exten> [<dialplan>] [<context>]
uuid_video_bitrateSend video bitrate req.mod_commands<uuid> <bitrate>
uuid_video_refreshSend video refresh.mod_commands<uuid>
uuid_write_pnggrab an image from a callmod_png
uuid_zombie_execSet zombie_exec flag on the specified uuidmod_commands<uuid>
valet_infoValet Parking Infomod_valet_parking[<lot name>]
versionVersionmod_commands[short]
vertoVerto APImod_vertosyntax
verto_contactGenerate a verto endpoint dialstringmod_vertouser@domain
vm_boxcountvm_boxcountmod_voicemail[profile/]<user>@<domain>[|[new|saved|new-urgent|saved-urgent|all]]
vm_deletevm_deletemod_voicemail<id>@<domain>[/profile] [<uuid>]
vm_fsdb_auth_loginvm_fsdb_auth_loginmod_voicemail<profile> <domain> <user> <password>
vm_fsdb_msg_countvm_fsdb_msg_countmod_voicemail<format> <profile> <domain> <user> <folder>
vm_fsdb_msg_deletevm_fsdb_msg_deletemod_voicemail<profile> <domain> <user> <uuid>
vm_fsdb_msg_emailvm_fsdb_msg_emailmod_voicemail<profile> <domain> <user> <uuid> <email>
vm_fsdb_msg_forwardvm_fsdb_msg_forwardmod_voicemail<profile> <domain> <user> <uuid> <dst_domain> <dst_user> [prepend_file_location]
vm_fsdb_msg_getvm_fsdb_msg_getmod_voicemail<format> <profile> <domain> <user> <uuid>
vm_fsdb_msg_listvm_fsdb_msg_listmod_voicemail<format> <profile> <domain> <user> <folder> <filter> [msg-order = ASC | DESC]
vm_fsdb_msg_purgevm_fsdb_msg_purgemod_voicemail<profile> <domain> <user>
vm_fsdb_msg_savevm_fsdb_msg_savemod_voicemail<profile> <domain> <user> <uuid>
vm_fsdb_msg_undeletevm_fsdb_msg_undeletemod_voicemail<profile> <domain> <user> <uuid>
vm_fsdb_pref_greeting_getvm_fsdb_pref_greeting_getmod_voicemail<format> <profile> <domain> <user> [slot]
vm_fsdb_pref_greeting_setvm_fsdb_pref_greeting_setmod_voicemail<profile> <domain> <user> <slot> [file-path]
vm_fsdb_pref_password_setvm_fsdb_pref_password_setmod_voicemail<profile> <domain> <user> <password>
vm_fsdb_pref_recname_setvm_fsdb_pref_recname_setmod_voicemail<profile> <domain> <user> <file-path>
vm_injectvm_injectmod_voicemail[group=<group>[@domain]|domain=<domain>|<box>[@<domain>]] <sound_file> [<cid_num>] [<cid_name>]
vm_listvm_listmod_voicemail<id>@<domain>[/profile] [xml]
vm_prefsvm_prefsmod_voicemail[profile/]<user>@<domain>[|[name_path|greeting_path|password]]
vm_readvm_readmod_voicemail<id>@<domain>[/profile] <read|unread> [<uuid>]
voicemailvoicemailmod_voicemailrss [<host> <port> <uri> <user> <domain>] | [load|unload|reload] <profile> [reloadxml]
voicemail_injectvoicemail_injectmod_voicemail[group=<group>[@domain]|domain=<domain>|<box>[@<domain>]] <sound_file> [<cid_num>] [<cid_name>]
xml_flush_cacheClear xml cachemod_commands<id> <key> <val>
xml_locateFind some xmlmod_commands[root | <section> <tag> <tag_attr_name> <tag_attr_val>]
xml_wrapWrap another api command in xmlmod_commands<command> <args>

FreeSWITCH

Только авторизованные участники могут оставлять комментарии.
  • freeswitch/api/start.txt
  • Последние изменения: 2018/10/10