FreeSwitch LUA API —— Sessions

session:answer();

if (session:bridged() == true) do

-- Do something

end

session:consoleLog("info", "lua rocks\n");

session:consoleLog("notice", "lua rocks\n");

session:consoleLog("err", "lua rocks\n");

session:consoleLog("debug", "lua rocks\n");

session:consoleLog("warning","lua rocks\n");

local mySound = "/usr/local/freeswitch/sounds/music/16000/partita-no-3-in-e-major-bwv-1006-1-preludio.wav"

session:execute("playback", mySound)

local mySound = "/usr/local/freeswitch/sounds/music/16000/partita-no-3-in-e-major-bwv-1006-1-preludio.wav"

session:executeString("playback "..mySound)

Callbacks(DTMF和friends)不能执行被执行于该事件

state=session:getState();

状态名

含义

CS_NEW

信道为新建立的

CS_INIT

信道已经初始化

CS_ROUTING

信道正在查找路由（extension）中

CS_SOFT_EXECUTE

信道已准备好被第三方执行

CS_EXECUTE

信道正在执行它的拨号计划(dialplan)

CS_EXCHANGE_MEDIA

正在与其他信道交换媒体信息

CS_PARK

信道正在等待接受媒体等待命令

CS_CONSUME_MEDIA

信道正在处理所有媒体，并舍弃之

CS_HIBERNATE

信道正处于休眠状态

CS_RESET

重置状态

CS_HANGUP

挂起状态，并且处于中断的就绪状态

CS_REPORTING

信道已准备好收集呼叫详情

CS_DESTROY

信道准备销毁，并且脱离状态机

local moh = session:getVariable("hold_music")

--[[ events obtained from "switch_channel.c"

regards Monroy from Mexico

]]

session:getVariable("context");

session:getVariable("destination_number");

session:getVariable("caller_id_name");

session:getVariable("caller_id_number");

session:getVariable("network_addr");

session:getVariable("ani");

session:getVariable("aniii");

session:getVariable("rdnis");

session:getVariable("source");

session:getVariable("chan_name");

session:getVariable("uuid");

session:hangup(); -- default normal_clearing

-- Initiate an outbound call

obSession = freeswitch.Session("sofia/192.168.0.4/1002")

-- Check to see if the call was answered

if obSession:ready() then

-- Do something good here

else -- This means the call was not answered ... Check for the reason

local obCause = obSession:hangupCause()

freeswitch.consoleLog("info", "obSession:hangupCause() = " .. obCause )

if ( obCause == "USER_BUSY" ) then -- SIP 486

-- For BUSY you may reschedule the call for later

elseif ( obCause == "NO_ANSWER" ) then

-- Call them back in an hour

elseif ( obCause == "ORIGINATOR_CANCEL" ) then -- SIP 487

-- May need to check for network congestion or problems

else

-- Log these issues

end

end

session1 = null;

max_retries1 = 3;

retries = 0;

ostr = "";

repeat

retries = retries + 1;

if (retries % 2) then ostr = originate_str1;

else ostr = originate_str12; end

freeswitch.consoleLog("notice", "*********** Dialing Leg1: " .. ostr .. " - Try: "..retries.." ***********\n");

session1 = freeswitch.Session(ostr);

local hcause = session1:hangupCause();

freeswitch.consoleLog("notice", "*********** Leg1: " .. hcause .. " - Try: "..retries.." ***********\n");

until not ((hcause == 'NO_ROUTE_DESTINATION' or hcause == 'RECOVERY_ON_TIMER_EXPIRE' or hcause == 'INCOMPATIBLE_DESTINATION' or hcause == 'CALL_REJECTED' or hcause == 'NORMAL_TEMPORARY_FAILURE') and (retries < max_retriesl1))

session:insertFile(<orig_file>, <file_to_insert>, <insertion_sample_point>)

-- On a ulaw channel, insert bar.wav one second into foo.wav:

session:insertFile("foo.wav", "bar.wav", 8000)

-- Prepend bar.wav to foo.wav:

session:insertFile("foo.wav", "bar.wav", 0)

-- Append bar.wav to foo.wav:

session:insertFile("bar.wav", "foo.wav", 0)

digits = session:playAndGetDigits (

          min_digits, max_digits, max_attempts, timeout, terminators,

          prompt_audio_files, input_error_audio_files,

          digit_regex, variable_name, digit_timeout,

          transfer_on_failure)

min_digits

允许最小的输入数字

max_digits

允许最大的输入数字

max_attempts

当无输入时重播等待音乐等待数字的最大次数

prompt_audio_file

当输入超时的提示音乐

input_error_audio_file

输入错误的提示音乐

digit_regex

数字匹配的正则表达式

variable_name

（可选）该信道变量用于存储接收的输入数字

digit_timeout

(可选)输入数字间的时间间隔，单位毫秒

transfer_on_failure

（可选）失败时的操作，执行一个extension，语法为extension-name [dialplan-id [context]]

digits = session:playAndGetDigits(2, 5, 3, 3000, "#", "/prompt.wav", "/error.wav", "\\d+")

session:consoleLog("info", "Got DTMF digits: ".. digits .."\n")

digits = session:playAndGetDigits(1, 1, 3, 3000, "", "/menu.wav", "/error.wav", "[134]", "digits_received", 3, "operator XML default")

session:consoleLog("info", "Got DTMF digits: ".. digits .."\n")

digits = session:playAndGetDigits(2, 5, 3, 3000, "#", "/sr8k.wav", "", "\\d+|\\*");

session:preAnswer();

digits = session:read(5, 10, "/sr8k.wav", 3000, "#");

session:consoleLog("info", "Got dtmf: ".. digits .."\n");

session:read has 5 arguments: <min digits> <max digits> <file to play> <inter-digit timeout> <terminators>

session:setVariable("read_terminator_used", "")

digits = session:read(5, 10, "/sr8k.wav", 3000, "*#")

terminator = session:getVariable("read_terminator_used")

session:consoleLog("info", "Got dtmf: " .. digits .. " terminator: " .. terminator .. "\n")

while (session:ready() == true) do

-- do something here

end

ended_by_silence = session:recordFile(file_name, max_len_secs, silence_threshold, silence_secs)

function onInputCBF(s, _type, obj, arg)

local k, v = nil, nil

local _debug = true

if _debug then

for k, v in pairs(obj) do

printSessionFunctions(obj)

print(string.format('obj k-> %s v->%s\n', tostring(k), tostring(v)))

end

if _type == 'table' then

for k, v in pairs(_type) do

print(string.format('_type k-> %s v->%s\n', tostring(k), tostring(v)))

end

end

print(string.format('\n(%s == dtmf) and (obj.digit [%s])\n', _type, obj.digit))

end

if (_type == "dtmf") then

return 'break'

else

return ''

end

end

recording_dir = '/tmp/'

filename = 'myfile.wav'

recording_filename = string.format('%s%s', recording_dir, filename)

if session:ready() then

session:setInputCallback('onInputCBF', '');

-- syntax is session:recordFile(file_name, max_len_secs, silence_threshold, silence_secs)

max_len_secs = 30

silence_threshold = 30

silence_secs = 5

test = session:recordFile(recording_filename, max_len_secs, silence_threshold, silence_secs);

session:consoleLog("info", "session:recordFile() = " .. test )

end

session:sayPhrase(macro_name [,macro_data] [,language]);

function key_press(session, input_type, data, args)

if input_type == "dtmf" then

session:consoleLog("info", "Key pressed: " .. data["digit"])

return "break"

end

end

if session:ready() then

session:answer()

session:execute("sleep", "1000")

session:setInputCallback("key_press", "")

session:sayPhrase("voicemail_menu", "1:2:3:#", "en")

end

session:setAutoHangup(false)

function myHangupHook(s, status, arg)

freeswitch.consoleLog("NOTICE", "myHangupHook: " .. status .. "\n")

-- close db_conn and terminate

db_conn:close()

error()

end

blah="w00t";

session:setHangupHook("myHangupHook", "blah")

return "exit";

or

return "die";

or

s:destroy("error message");

function my_cb(s, type, obj, arg)

if (arg) then

io.write("type: " .. type .. "\n" .. "arg: " .. arg .. "\n");

else

io.write("type: " .. type .. "\n");

end

if (type == "dtmf") then

io.write("digit: [" .. obj['digit'] .. "]\nduration: [" .. obj['duration'] .. "]\n");

else

io.write(obj:serialize("xml"));

e = freeswitch.Event("message");

e:add_body("you said " .. obj:get_body());

session:sendEvent(e);

end

end

blah="w00t";

session:answer();

session:setInputCallback("my_cb", "blah");

session:streamFile("/tmp/swimp.raw");

返回值

效果（当传输音频流的时候）

speed

未知

volume

未知

pause

暂停，直到获得下一个输入为止。当获得下一个输入时，继续播放。

stop

未知

truncate

未知

restart

未知

seek

未知

true

等待至播放结束

false

立即暂停播放

None/NULL

不要返回这个值，它会导致错误发生，特别是在python中

session:setVariable("varname", "varval");

session:sleep(3000);

session:set_tts_params("flite", "kal");

session:speak("Please say the name of the person you're trying to contact");

session:say("12345", "en", "number", "pronounced");

session:streamFile("/tmp/blah.wav");

session:streamFile("/tmp/blah.wav", <sample_count>);

session:transfer("3000", "XML", "default");

session:execute("transfer", "3000 XML default")