首页 > 编程语言 >FreeSWITCH学习笔记:应用程序(APP)

FreeSWITCH学习笔记:应用程序(APP)

时间:2022-12-15 23:34:09浏览次数:100  
标签:FILEPATH APP 应用程序 VAR playback MUSIC 按键 FreeSWITCH 播放

本文更新于2022-12-15,使用FreeSWITCH 1.10.7。

官方文档见:https://freeswitch.org/confluence/display/FREESWITCH/mod_dptools

说明:下文中,部分大写为自定义变量,根据实际情况填写。使用[]引起表示内容可选,|表示使用左侧或右侧内容,...表示重复之前内容。

APP又称拨号计划工具(Dialplan Tools)。可使用以下APP(括号中为参数列表,参数如有空格需用''引起):

  • answer([is_conference]):给主叫回送应答消息(200)。FreeSWITCH做被叫时,如果想给主叫放音,必需应答后才可以。is_conference表示支持RFC4579视频会议控制标准。

  • att_xfer(CALLURL):协商转。

  • bind_meta_app(NUM a|b s APP::ARG[ ...]):绑定DTMF,按键后执行APP。NUM为按键(需先按*键激活功能),可指定a腿或b腿,s表示在收到按键的相同的腿上执行。

  • bridge(CALLURL):桥接至另一条腿(b-leg)。其是阻塞的,直到b-leg释放后才继续往下走。

  • callcenter(QUEUE):将呼叫转到呼叫中心。

  • conference(CONFERENCE[@PROFILE][+PIN][+flags{FLAG1|FLAG2}]):将来话转入会议。@之前为会议的名字,之后为会议的参数。竖线为字面值,不表示“或”的意思。

  • curl(URL):与HTTP服务器交互。

  • delay_echo(MS):延迟若干毫秒回声。

  • detect_speech(ASRENGINE GRAMMERFILENAME GRAMMERFILENAME|pause|resume|params MODELFILENAME DICTIONARYFILENAME):语音识别开启/暂停/重启/设置参数。文件名可没有扩展名。

  • directory(default DOMAINNAME default):按姓名呼叫用户。当系统提示输入名字时,通过输入用户名字的前几位进行拨叫。

  • echo:回音。

  • endless_playback(FILEPATH):无限循环播放声音文件。

  • erlang(ERLANGCALL NODE):连接外部Erlang节点。

  • execute_extension(EXTENSION DIALPLAN CONTEXT):临时执行其他Dialplan下的context的extension,不会重新进入ROUTING阶段。

  • export([nolocal:]VAR=VALUE):设置变量,并会使用VAR设置特殊的变量export_vars。如使用nolocal,则只设置到b-leg上;否则,设置到两条腿上。

  • fifo(LIST in|LIST out [wait|nowait]):从一个先进先出队列中进行呼叫停泊/取回。使用out时可指定wait(offhook坐席)或nowait(onhook坐席),默认为wait。

  • hangup:挂断通话。

  • hash(insert/HASH/KEY/VALUE|delete/HASH/KEY|select/HASH/KEY):操作内存中哈希表数据结构的键值对。

  • hold:将通话挂起,并播放MOH保持音乐。

  • info:在日志中打印所有通道变量。

  • intercept([-bleg] CHANNELUUID):代接。

  • ivr(IVR):进入IVR菜单。

  • javascript(JSFILEPATH):执行JavaScript脚本。

  • log(LEVEL MESSAGE):打印日志。(originate命令执行此APP时,不知道怎么设置LEVEL,括号里面都当成MESSAGE。)

  • loop_playback(+N FILEPATH):循环播放声音文件若干次。

  • lua(LUAFILEPATH [ARG [ ...]]):执行Lua脚本。如为相对路径,则在安装目录的scripts目录下。

  • park:将通话挂起,对端听不到任何声音。

  • phrase(PHRASE[,INPUT]):播放Phrase宏。

  • play_and_detect_speect(MUSIC detect:ASRENGINE GRAMMARFILENAME):播放一段声音并进行语音识别。文件名可没有扩展名。

  • play_and_get_digits MINDIGITS MAXDIGITS MAXATTEMPTS TIMEOUTMS TERMINATORS MUSIC INVALIDMUSIC VAR REGEX [INTERDIGITTIMEOUTMS ['FAILEXTENSION [FAILDIALPLAN [FAILCONTEXT]]']]:播放声音并等待接收DTMF按键,与read类似,但更强大。MINDIGITS为最少收号位数,MAXDIGITS为最大收号位数,MAXATTEMPTS为重试次数,TIMEOUTMS为收齐全部位数的超时毫秒数,TERMINATORS为收号小于MINDIGITS位时的提前结束按键(可多个,通常是#),MUSIC为播放的提示音(用法见playback的MUSIC),INVALIDMUSIC为输入错误时播放的提示音(用法见playback的MUSIC),VAR为收到用户按键后存放的变量名,REGEX为收号后进行匹配的正则表达式,INTERDIGITTIMEOUTMS为位间间隔毫秒数,FAILEXTENSION为若最后输入错误时转到的extension,FAILDIALPLAN为输入错误时转到的Dialplan,FAILCONTEXT为输入错误时转到的Dialplan Context。

  • play_fsv(FILEPATH):播放录像。

  • playback(MUSIC):播放声音。MUSIC可为:

    • FILEPATH,文件名。不带扩展名会查找与本Channel编码一致的原生文件。
    • file_string://MUSIC[!...]:串联多个声音。
    • http://PATH:HTTP接口。可将远程文件缓存到本地。
    • local_stream://LOCALSTREAM,本地文件流,每个流在系统中只有一个实例。LOCALSTREAM为conf/autoload_configs/local_stream.cof.xml中定义的名字。
    • phrase:PHRASE[:INPUT]:Phrase宏。
    • say:[TTSENGINE:TTSVOICE:]TEXT:使用TTS根据文本内容放音。TTSENGINE和对应TTSVOICE用法见speak
    • shout://SERVER/PATH:SHOUTcast协议,播放服务器上的文件(可为MP3文件)。
    • silence_stream://MS[,CN],静音流,MS等于0为无限长,CN为舒适噪音,范围为1至10000,通常使用600至1400,值越小噪声越大,-1则产生绝对静音。
    • tone_stream://%(ONMS,OFFMS,HZ1[,HZ2])[;%(ONMS,OFFMS,HZ1[,HZ2])];loops=N]:铃流,使用TGML语音生成信号音。ONMS为通毫秒数,OFFMS为断毫秒数,HZ1、HZ2为交替的频率,N为循环次数,-1为无限循环。
    • unimrcp:SERVER:MRCP协议。
    • vlc://FILEPATH|HTTPURL:使用libvlc播放。
  • pre_answer:给对方回复消息(183),后续的playback之类的action将作为早期媒体给对方发送过去。

  • python(PYFILEPATH):执行Python脚本。文件路径为相对于Python的查找目录(如/usr/lib/python2.7/dist-packages/)。

  • read MINDIGITS MAXDIGITS MUSIC VAR INTERDIGITTIMEOUTMS TERMINATORS:播放声音并等待接收DTMF按键。MINDIGITS为最少收号位数,MAXDIGITS为最大收号位数,MUSIC为播放的提示音(用法见playback的MUSIC),VAR为收到用户按键后存放的变量名,INTERDIGITTIMEOUTMS为等待每一位的输入超时毫秒数,TERMINATORS为收号小于MINDIGITS位时的提前结束按键(可多个,通常是#)。

  • record(FILEPATH):对当前Channel进行录音。阻塞,只用于单腿的呼叫。如不指定扩展名,则以原生格式录音。

  • record_fsv(FILEPATH):录像,并将视频回显。只用于单腿的呼叫。

  • record_session(FILEPATH):对当前Channel进行录音。非阻塞,可用于单腿的呼叫也可用于桥接的呼叫。如不指定扩展名,则以原生格式录音。

  • ring_ready:给对方回复消息(180),通知对方可以振铃。

  • rxfax(FILENAME):收传真。文件格式为TIFF。

  • say(LANGUAGE SAYTYPE SAYMETHOD TEXT):使用Say接口将预先录好的声音对特定的内容放音,支持多语言。LANGUAGE为语言,SAYTYPE为播放的数据类型,SAYMETHOD为播放的读法,TEXT为播放的内容。

    SAYTYPE可为:

    • ACCOUNT_NUMBER:账号。
    • CURRENCY:货币。
    • CURRENT_DATE:当前日期。
    • CURRENT_DATE_TIME:当前日期时间。
    • CURRENT_TIME:当前时间。
    • EMAIL_ADDRESS:Email地址。
    • IP_ADDRESS:IP地址。
    • ITEMS:项目。
    • MESSAGES:消息。
    • NAME_PHONETIC:姓名拼写。
    • NAME_SPELLED:姓名。
    • NUMBER:数字。
    • PERSONS:人名。
    • POSTAL_ADDRESS:邮寄地址。
    • SHORT_DATE_TIME:短日期时间。
    • TELEPHONE_EXTENSION:分机号。
    • TELEPHONE_NUMBER:手机号码。
    • TIME_MEASUREMENT:时间。
    • URL:网址。

    SAYMETHOD可为(并不是所有语言都实现了全部读法):

    • COUNTED:以序数词方式读出。
    • ITERATED:逐个数字读出。
    • PRONOUNCED:以基数词方式读出。
  • sched_hangup(+SECOND):若干秒后挂断通话。

  • set(VAR=VALUE):设置通道变量到当前Channel(a-leg)上。如VALUE为_undef_则取消VAR的赋值。

  • sleep(MS):暂停若干毫秒。

  • socket(IP:PORT [async] [full]):使用Event Socket的外连模式连接外部服务器。async表示异步执行,默认是同步执行。full表示外部应用可以使用全部的API,默认只有少量API是有效的。

  • speak([TTSENGINE|TTSVOICE|]TEXT):使用TTS播放声音。此参数使用竖线隔开各字段。可用的TTSENGINE和对应TTSVOICE有:

    • flite:awb、kal、rms、slt。
    • tts_commandline
  • start_dtmf:打开带内DTMF检测。

  • transfer([-bleg] USERNAME DIALPLAN CONTEXT):盲转。将当前通话重新转接到ROUTING阶段,重新去Dialplan中进行路由,呼叫USERNAME。

  • txfax(FILENAME):发传真。文件格式为TIFF。

  • unset(VAR):取消变量的赋值。

  • verbose_events:令事件包含所有variable_开头的字段。

  • voicemail(CONTEXT DOMAINNAME EXTENSION):语音信箱。

标签:FILEPATH,APP,应用程序,VAR,playback,MUSIC,按键,FreeSWITCH,播放
From: https://www.cnblogs.com/garvenc/p/freeswitch_learning_app.html

相关文章

  • CSAPP Cache Lab
    任务A任务主要内容分析编写一个cache仿真程序,使用valgrind的内存跟踪记录作为输入,模拟高速缓存的命中/未命中行为,然后输出总的命中次数,未命中次数和缓存块的替换次数......
  • uniapp本地文件读写操作
    说明主要是封装官方文档里面的官方文档地址:https://www.html5plus.org/doc/zh_cn/io.html创建或打开文件//fileName目录路径dirEntry之前打开过的目录(没有则不填写......
  • uniapp 开发输入键盘几种 confirm-type 状态
    在uniapp中,可以使用confirm-type属性来控制input组件的确定键的样式。如果要将确定键显示为搜索按钮,可以将confirm-type设置为search,代码示例如下:<inputtype="tex......
  • 检查用户是否对环境和app有访问权限
    powerplatform的管理中心→环境→用户,有一个link可以打开AppAccessChecker,或者用下边的linkhttps://XXX.crm5.dynamics.com/WebResources/msdyn_AppAccessChecker.html画面......
  • [附源码]Python计算机毕业设计Django基于vuejs的爱宠用品销售app
    OverridetheentrypointofanimageIntroducedinGitLabandGitLabRunner9.4.Readmoreaboutthe extendedconfigurationoptions.Beforeexplainingtheav......
  • 实用APP分享:这3款“三无”浏览器,你竟然还不知道?
    相信很多人都听过夸克、UC浏览器,但是它们的内存越来越大了,UC浏览器的广告也越来越多。基于以上的痛点,今天给大家分享3款实用的手机浏览器,都是“三无”浏览器,无新闻、无广告......
  • ceph 因权重问题导致pgs active+clean+remapped 状态
    1.现象:  2.原因:是因为前期权重调整不合理导致,调整回来就正常了3.操作步骤:cephosdcrushreweightosd.20.98317  # osd位置、权重值  权重值计算=osd磁......
  • android studio 提示Failed to delete some children. This might happen because a p
    androidstudiobuild/clean/rebuild项目时提示Failedtodeletesomechildren.Thismighthappenbecauseaprocesshasfilesopenorhasitsworkingdirectorys......
  • OAuthApp v1.12.15 更新 | 前端发布工具
    OAuthApp是一个前端发布工具,用于快速开发前端网页项目,并发布到服务器。具有引入脚本库就能使用服务端API在线发布H5,数据独立存储的特性更新内容:1,新增角色/权限管理......
  • freeswitch的distributor模块
      概述freeswitch是一款简单好用的VOIP开源软交换平台。当呼叫是同一个入中继,但是有多条出中继时,需要对出中继做负载均衡,mod_distributor模块可以完成对应的配置和......