当前位置:首页 >> 信息与通信 >>


Getting Started Guide 入门指南
From FreeSWITCH Wiki 从 FreeSWITCH 维基
Jump to: , 跳转到: 导航 , 搜索

The purpose of the following page is to instruct new users on how to configure FreeSWITCH? in a basic way.以下网页的目的,是指导新用户如何配置 FreeSWITCH?的一个 基本方式。 It is also intended to provide people with a basic understanding of the configuration files and how they are processed.这也是为了提供一个配置文件的基本了 解的人以及他们如何处理。 If FreeSWITCH? is not already installed on your system you should read the .如果 FreeSWITCH?不是已经安装在您的系统, 你应该阅读安装指南 。This guide is not intended to allow for more than a default configuration.本指南不打算 让超过默认配置。

FreeSWITCH? has a modular design. FreeSWITCH?采用模块化设计。 This design allows it to be extended without breaking functionality or requiring massive recoding efforts. 这种设计允许它在不破坏的功能或要求重新编写大量的努力延长。 Each module provides specific functionality, often commands that are related are grouped into one module. 每个模块都提供特定的功能,往往是相关的命令是在一个模块进行分组。 You will need to enable the modules that you desire, based on their function.您将需要启用,你的愿 望, 根据他们的功能模块。 By default FreeSWITCH? comes with a good set of modules loaded, to enable most basic functionality.默认情况下 FreeSWITCH?附带了一个良好的加载模块 设置,使最基本的功能。 Read up on the for more information.阅读上的更多信息, 配置的默认 。

The following sections will show you each step that you will have to take to get a functional system.下面的章节将告诉你每一步,你将不得不采取获得功能系统。

If you are going to route traffic across your network, you need to ensure that you do not have a firewall blocking traffic on the specified network paths.如果你想在 您的网络传输流量,你需要确保你没有防火墙阻止指定的网络路径流量。 Commonly firewalls are installed at egress points, where your local network connects to the internet.常见的防火墙是安装在出口点,在您的本地网络连接到互联网。 This is not

always the case in some corporate environments.这并不总是在一些企业环境的情况。 If you are not responsible for your network, you may wish to contact the group or individuals that are for assistance.如果您没有为您的网络负责,您可能希望联络小组 或个人的援助。 Information they may need to enable traffic would include the port numbers.他们可 能需要的信息,使交通将包括端口号。 Various protocols use different ports for different things.各种协议的不同的使用不同的端口。 Some you need bi-directional connectivity, some you only need outbound.一些你需要的双向连接,有些你只需要出站。 Depending on your call scenario you may only need to allow connections that are initiated by your system. If you have any problems with protocols not working, it is recommended that you disable your firewall to the FreeSWITCH? system and place a test call and see if the problem persists. Commonly people who have problems have a misconfigured firewall that is creating the problem.根据您的要求的情况你可能只 需要允许该由你的系统发起的连接。 如果您有任何问题的协议不工作, 如果您有任何问题的协议不工作, 建议您禁用防火墙的 FreeSWITCH?系统和地点通话测试 看看该问题仍然存在。 常见的有问题的人谁具有防火墙 FreeSWITCH?系统和地点通话测试 , 看看该问题仍然存在。 的配置错误是造成上述问题。

Network FireWall Ports 防 Protocol 网 Application Protocol 应用协议 火墙中的端口 络协议

Description 描述

1719 1720 3478 3479 5002 5003


H.323 Gatekeeper RAS port H.323 Call Signalling STUN service STUN service MLP protocol server Neighborhood service
Used for SIP signalling (Standard SIP Port, for default Internal Profile)用于 SIP 信令 (标准 SIP 端口, 默认内部资料) Used for SIP signalling (For default "NAT" Profile)用于为 SIP 信 令(对于默认“的 NAT”专页) Used for SIP signalling (For default "External" Profile)用于为 SIP 信令(对于默认“外部”专页) Used for audio/video data in SIP and other protocols 用于 SIP 音频/视频 Used for NAT traversal 用于 NAT 穿 越 Used for NAT traversal 用于 NAT 穿 越









SIP UAS RTP/ RTCP multimedia streaming




FreeSWITCH? configuration data is stored in XML format. FreeSWITCH?配置数据存储在 XML 格式文件。 These files are located in the conf directory under the FreeSWITCH? install directory.这些文件位于下 FreeSWITCH?conf directory 的目录。 By default on a Unix-like system this will be /usr/local/freeswitch/conf. 默认情况下,在 Unix 系 统上, 这将是/usr/local/freeswitch/conf。 There are preprocessor markup tags that tell the configuration parser to perform tasks, such as including other files, which are carried out before the XML is parsed.有预处理标记标签,告诉配置分析器来执行任务, 如包括其他文件,这是前进行的 XML 时,被解析。

Folder 文件夹

Description 描述

These configuration files are loaded automatically into FreeSWITCH.这些配置 autoload_configs 文件自动加载到 FreeSWITCH。 They contain configuration information for almost all core modules.它们包含了几乎所有的核心模块的配置信息。 dialplan This is the place where you setup your dialplan.这是你的地方设置你的拨号规 则。 There are some examples of how to configure your dialplan included.有 如何配置您的拨号规则包括一些例子。 The directory contains all users that may register and use freeswitch as their PBX.该目录包含所有的用户都可以登记,并以此为他们的 PBX freeswitch。


Jingle is the mod that FS uses to handle XMPP. 丁当是 FS 使用处理 XMPP 的 mod。 jingle_profiles Profiles tells FS how to use the protocol. 档案文件告诉 FS 如何使用协议。 Each profile has it's own ip port.每个配置文件有它自己的 IP 端口。 lang mrcp_profiles sip_profiles Tells FS how to say currency etc in different languages 告诉 FS 如何用不同的 语言 MRCP is used to allow FreeSWITCH to use speech recognition and TTS MRCP 是用 来允许 FreeSWITCH 使用语音识别和语音合成 Tells FS how to talk sip. 告诉 FS 如何对话 SIP。 Each profile has it's own port. 每个配置文件有它自己的端口。

This guide aims to explain the default configuration layout and how you configure it to your liking.本指南旨在解释默认配置的布局,以及如何配置它,你自己的喜好。 Read up on the for more information.阅读配置的默认上的更多信息, 。

This layout is in no way required, you can minimize the configuration to just one

file if needed.这种布局在任何需要的方式,您可以配置,以最大限度地减少只是一个文件, 如果需要的。 The main config file is called freeswitch.xml, you don't need to change it in any way, it just loads all other config files.主要的配置文件被称为 freeswitch.xml,你不必以任何方式改变它,它只是加载所有其他的配置文件。

vars.xml is used to define a couple of variables that are used system wide. vars.xml 用于定义两个是使用的系统广泛的变量。 NOTICE you can not comment these X-PRE-PROCESS lines out.公告您不能注释这些 X-PRE-PROCESS 行。 They will still be active in an XML comment. 他们仍将 XML 注释中的活动。。 See for example.看例子 Config_vars.xml

In the default configuration the vars.xml file is used to define some preprocessor variables.在默认配置中 vars.xml 文件是用来定义一些预处理变量。 In a first time setup you will most likely want to set:是在第一次安装最有可能想要设置: <X-PRE-PROCESS cmd="set" data="outbound_caller_name=FreeSWITCH"/> <X-PRE-PROCESS cmd="set" data="outbound_caller_id=8777423583"/> <X-PRE-PROCESS cmd="set" data="call_debug=false"/> directives for use in other portions of the configuration. 用于配置的其他部分中的 指令。 The default port of Freeswitch is also defined in Freeswitch 默认端口也被定义在里 面

<param name="sip-port" value="5060" />

autoload_configs is a directory where a lot of the freeswitch configuration resides. autoload_configs autoload_configs 是很多 freeswitch 配置文件保存的目录。 This directory is located in $PREFIX/conf/autoload_configs. 这个目录位于 $PREFIX/conf/autoload_configs。 The default freeswitch.xml preprocesses xml files matched by the glob conf/autoload_configs/*.xml 默认 freeswitch.xml 预先处理(自 动加载)conf/autoload_configs/*.xml 里面匹配的 XML 文件 modules.conf.xml See for an example of modules.conf.xml.看一个 modules.conf.xml 的例子 modules.conf.xml。 modules.conf.xml tells freeswitch which modules to load. modules.conf.xml 告诉

freeswitch 加载哪些模块。 There are certain modules required for operation so you should not edit this file unless you know that you wish to add or remove a specific module 有操作所需要的某些模块,因此你不能编辑这个文件,除非你知道你想添加或删除特 定模块 sofia.conf.xml mod_sofia is used to create SIP endpoints in FreeSWITCH. 模块 sofia 是用于创建 SIP 终端到 FreeSWITCH。 If you are familiar with Asterisk, each SIP Profile in mod_sofia is similar to chan_sip in Asterisk, though much more powerful.如果您熟悉 Asterisk, 每个 mod_sofia 的 SIP 档案类似 Asterisk 的 chan_sip,但更强大。 The sofia.conf.xml file contains a "X-PRE-PROCESS" directive that includes other XML files (within, by default, conf/sip_profiles/) that define one or more "SIP Profiles". 该 sofia.conf.xml 文件包含的"X-PRE-PROCESS"指令,其中包括其他 XML 文件(在默认情况 下,conf/sip_profiles/),定义一个或多个“SIP 档案文件”。 A SIP Profile is a SIP UA (User Agent or an endpoint), which communicates with other SIP endpoints. 一个 SIP UA (用户代理或终结点) 与 SIP 的其他终结点进行通信的 SIP 的配置文件。 A "User Agent" ("UA") is an application used for running a certain network protocol. “用户代理”(“ UA”)是运行在一定的网络协议使用的应用程序。 A Sofia User Agent is the same thing but the protocol in that case is SIP.这个 Sofia 用户代理是同样的事 情,但如果是在那应样的话协议是 SIP。 In FreeSWITCH terms, User Agent = UA = Sofia Profile = SIP Profile.在 FreeSWITCH 方面,User Agent = UA = Sofia Profile = SIP Profile.。 See for an example sofia.conf.xml.看例子 sofia.conf.xml Sofia_Configuration_Files。 .另见 SIP 在维基百科网络元素 。

See also

SIP 档案文件 The SIP Profiles in FreeSWITCH can often lead to confusion. 在 FreeSWITCH SIP 的 配置文件通常会导致混乱。 Unlike other softswitches (like Asterisk), FreeSWITCH allows you to handle media (calls, video, etc.) differently based on where the equipment is attached to your network.不同 (如 Asterisk) 其他软, 不同的应用 FreeSWITCH 允许您在处理不同的设备相连网络的媒体 (电话,视频,等)。 This assists with security as well as providing added functionality.这有助于安全,并提供额外的功能。 SIP Profiles allow you to define paths to devices or carriers that may live inside or outside your network. SIP 的配置文件可用于定义路径的设备或运营商可住内部或外部 网络。 These paths can be of many different types, but must consist of a unique combination of port and IP pairs.这些路径可以有许多不同的类型,但必须由一个端口和 IP 对独特的组合。 You could have SIP profiles for your internal network, or multiple profiles for each subnet of your internal network, or even completely different protocols like IPv6 as profile definitions.你可能对您的内部网络,即每您的内部网络, 或者类似的文件定义甚至完全不同的 IPv6 协议的子网的 SIP 配置多个配置文件。This helps

FreeSWITCH identify how to route different types of calls when necessary, and also gives you the flexibility to tailor your dialplans based on what path a call originates to/from. 这可以帮助 FreeSWITCH 确定如何路线不同类型的要求,必要时,还能让你的灵活性, 以调整你的拨号方案基于路径的一个叫来源于/。 In the sample configuration there are three default categories for where a SIP Profile can reside.在示例配置有 3 个在一个 SIP 文件可以驻留默认类别。Each profile is detailed below.每个配置文件的详细情况如下。

The default profiles are "internal" and "external", each serves a special purpose so it would be wise to understand what they do.默认配置文件是("internal" and "external",) “内部”和“外部”,都提供了特殊用途,所以明智的做法是了解他们所做的 事情。

File Location: $PREFIX/conf/sip_profiles/internal.xml 文件位置:$PREFIX/conf/ sip_profiles / internal.xml This profile generally refers to devices that reside on your internal network.此 配置文件通常是指设备驻留在您的内部网络。 Those devices will inherit all configuration options in the internal profile you setup.这些设备将继承内部文件的 所有配置选项设置。 This is typically your internal phones with extensions.这通常 是与扩展您的内部电话。 By default, these devices must use SIP authentication.默认 情况下,这些设备必须使用 SIP 认证。 The Internal (formerly called "default") SIP profile is configured to listen on the primary IP address of the machine (unless you set $${domain} to something else in vars.xml) on port 5060 (the default SIP port).内部(以前称为"default"))的 SIP 配 置文件被配置为侦听的主 IP 地址的机器 (除非您设置域$${domain}的东西在 vars.xml 其他) 在端口 5060(默认 SIP 端口)。 The internal SIP profile does authenticate calls and is not suitable for configuring trunks to providers or outside phones, in most cases (ie, use the External profile for configuring trunks to providers or outside phones). 内部的 SIP (例如,使用外部配置文件的配置中继或外部电话)。 The Internal profile should be used if you intend on handling registration for sip clients (ie a SIP registrar).内部配置文件应使用如果您在处理 SIP 客户端注册的打算 (即 SIP 注册)。 You may wish to skip to the section to configure additional sip clients. 你可能希望跳到 Getting_Started_Guide#directory 配置部分另外的的 SIP 客户端。 Authenticated users of this profile are normally set (via the variable user_context) to use the dialplan defined in .这个文件验证的用户通常设置(通过变量 user_context) 使用 default context.定义的拨号规则。 See 见 Config_default.xml


File Location: $PREFIX/conf/sip_profiles/external.xml 文件位置:$PREFIX/conf/ sip_profiles / external.xml This profile generally refers to devices or gateways that reside outside of your network.此配置文件,一般是指设备或网关外的网络。 Generally this is where you define your external trunks/VoIP carriers/etc.通常这是您定义您的外部中继线/ VoIP 运营商/ 等。 Again, those devices will inherit all configuration options in the external profile you setup.同样,这些设备将继承在外部配置文件的所有配置选项设置。 The External (formerly "outbound") profile handles outbound registrations to a SIP provider.外部 (先前"outbound") 配置文件处理出站登记, 的供应商。 The SIP provider SIP sends calls to you, and you send calls to your provider, through the external profile. 供应商发送的 SIP 要求你, 你调用发送到您的提供商, 通过外部形象。 The external profile allows anonymous calling, which is required as your provider will never authenticate with you to send you a call.外部配置文件允许匿名电话,这是你的供应商需要将永远与 您进行身份验证向您发出的呼吁。 In order to secure your FreeSWITCH it is wise to link your outbound profile to a dialplan context other than 'default', which in the default configuration is the where authenticated users are placed.为了获取您的 FreeSWITCH 与拨号方案的安全,您的向外 去外形除‘缺省之外’是明智的,它在默认配置是在身份验证的用户的位置。 NOTE: The default port for external connections is 5080. 注意:为外部连接的默认端 注意: 口是 5080。 This also means if you are trying to connect a phone remotely to your FreeSWITCH box, you must set it to connect on port 5080, or change your ports around. 这也意味着,如果您尝试远程连接到您的手机 FreeSWITCH 框,您必须将其连接到端口 5080, 或者改变你的端口。 This confuses a lot of people.这混淆了很多人。 As an example, in X-Lite, if you are connecting to FS from the outside, set your server as "my.server.com:5080".作为一个例子,在 X 光宝,如果你是从外部连接,设置为 “my.server.com:5080”。 The dialplan for this profile (per-default) is defined in 此配置文件的拨号规则(每 默认)在 的定义 See 见 Config_external.xml

The nat.xml file (and profile) have been deprecated.该 nat.xml 文件(和配置文件) 已被弃用。 Use the External Profile and port 5080.使用外部配置文件和端口 5080。
其他配置文件概念 其他配置文件概念 配置文件

Ideas for other SIP profiles you might end up building:其他 SIP 配置文件的意见你 可能最终建筑:

? ? ?

Routing IPv6 IPv6 的路由 Having multiple profiles for different networks or subnets 经对不同的网络或子网多个配 置文件 Having multiple profiles for different remote hosts/endpoints (remote offices, etc.) 经对不同的远程主机多个配置文件/端点(远程办公室等)

The FreeSWITCH dialplan is a full-featured, XML-based call-routing mechanism.该 FreeSWITCH 拨号规则是一个全功能的,基于 XML 的呼叫路由机制。 (There also exists support for Asterisk-like dialplans as well as really fancy real-time and/or back-end database-driven dialplans.) The best place to get started in learning about the FreeSWITCH dialplan is the page here on the wiki. (此外,还存在 Asterisk 的支持, 如拨号方案以及真正花式实时和/或后端数据库驱动拨号方案。)的最佳位置大约在 FreeSWITCH 拨号规则学习的开始是拨号规则页的维基这里。 It discusses the basics of the FreeSWITCH dialplan.它讨论了 FreeSWITCH 拨号规则的基础知识。 If you need an XML primer check out the information on the page which will get you pointed in the right direction.如果您需要内,有关 Basic_XML 网页将让你在正确的方向信息的 XML 底漆检查。 There are two other important resources for you to learn more about the diaplan: the small-but-growing page as well as the that comes with a standard FreeSWITCH installation.有两个其他重要资源,您了解 diaplan:小,但增长 Dialplan_Recipes 页以 上,以及默认的拨号规则与标准 FreeSWITCH 安装中。 It is recommended that you compile FreeSWITCH with the default configuration and make sure it works before you start making customizations.我们建议您编译默认的配置 FreeSWTICH 和确保它工作,然后再开始做自定义。 Note that the default config files, including the default.xml dialplan, are still being updated.请注意,默认的配置文 件, 包括 default.xml 的拨号规则, 现正被更新。 It makes sense to put your custom diaplan entries into the extensions subdirectory under conf/dialplan.是有道理的 conf 置于 您的自定义 diaplan 项目扩展 扩展到子目录/拨号规则。 You may create one or more XML files 扩展 in this subdirectory, all of which will be included in the dialplan thanks to an "include" directive in the default.xml file.您可以创建一个或多个在这个子目录 XML 文件,所有这些都将在一个“包括”在 default.xml 的文件指令包含的拨号规则感谢。 By keeping your customized extensions separate from default.xml you will be able to update default.xml without having to re-enter your custom extensions.通过保持你的 个性化扩展的 default.xml 的你将能够更新 default.xml 的独立,而不必重新输入您的自定 义扩展。 用于测试一些常用的扩展
? ? ? ?

1000, 1001, ..., 1019 - Generic SIP extensions 1000,1001,...,1019 -通用 SIP 扩展 5000 - demo IVR (requires sounds and music files to be installed) 5000 -演示的 IVR(需 要声音和音乐文件被安装) 9995 - five second delay echo test 9995 -五秒延迟回波测试 9996 - standard echo test 9996 -回波测试标准


9999 - music on hold (requires music files to be installed) 9999 搁置-音乐(音乐文件需 要安装)

See for a sample configuration.见一个示例配置 Config_directory.xml。 The directory holds authentication credentials for other sip endpoints that will register to freeswitch (most commonly users).该目录保存的其他 SIP 终端,将登记 freeswitch(最常见的用户)身份验证凭据。 The directory configuration default is configured to process the glob $PREFIX/conf/directory/default/*.xml by the configuration included in freeswitch.xml $PREFIX/conf/directory/*.xml.该目录默认 配置配置为处理的 glob $PREFIX/conf/directory/default/*.xml 的包括 freeswitch.xml $PREFIX/conf/directory/*.xml.的。 This may seem confusing but the default will work in most cases.这似乎令人困惑, 但默认将在大多数情况下。 Feel free to look at the examples in: $PREFIX/conf/directory/随意看看在例子: $PREFIX/conf/directory/ 用户配置 see for a simple (1000.xml) configuration of a user (endpoint) which will register (1000.xml Config_1000.xml) 的用户 (终端)将登记 freeswitch , to freeswitch.看到一个简单 配置。 样本网关配置 See for sample gateway configurations for different providers.见为不同供应商的样 本网关配置 SIP 提供者的例子 。 outbound registrations to providers can also be made in the outbound profile. 出 站登记的供应商也可以在出站的形象 也可以在出站的形象。 解释页 站登记的供应商也可以在出站的形象。 see this page for a clarification 见 此解释页 通过网关进行拨号 Add the following to default.xml (in prefix /conf/dialplan) for 11 digit dialing (US) via your newly created gateway configuration above.以下添加到 default.xml 文件(在 prefix /conf/dialplan)为 11 位拨号(美国)。 Remember, the default configuration provided by FreeSWITCH does not include a diaplan rule for outbound calls via the gateway you've defined.请记住,默认配置 FreeSWITCH 提供不包括为通过您所定义的网关 呼出拨号规则。 You will need to add something similar to the following.您将需要添 加类似以下。
<!-- Dial any 10 digit number (2223334444) or 1+10 number (12223334444) here --> <!—拨任意 10 数字 (2223334444) 或 1+10 号码 (12223334444) 这里 --> <extension name="Long Distance - voicepulse"> expression="^(1{0,1}\ <condition field="destination_number" expression="^(1{0,1}\d{10})$"> <action application="set" data="effective_caller_id_number=12223334444"/> <!-- If your provider does not provide ringback (180 or 183) you may simulate

ringback by uncommenting the following line. --> 如果您的提供商不提供回铃音(180 或 183),你可以模拟下面的注释行回铃音。 <!-/---> <!-- action application="ringback" /--> <action application="bridge" data="sofia/gateway/voicepulse/$1"/> </condition> </extension>

接收来自网关发出入站调用 Add the following to public.xml (in prefix /conf/dialplan) to receive inbound calls via your newly created gateway configuration above.以下添加到 public.xml(在 prefix /conf/dialplan)接收通过新建立的网关配置上面接听电话。 Make sure to set destination_number to a DID defined for this gateway.请确保将设置为此网关定义一个 DID 目的地号码。 This will route all inbound calls to extension 1001.这将路线延长 1001 的所有来电。 Remember, you can have multiple endpoints register to one account ( See ).请记住, 你可以有多个端点注册一个帐户 (见 ) You will need to add something 。 similar to the following.您将需要添加类似以下。 Please note, this will only redirect to an extension, you will also need to have the extension bridge with an endpoint/user if that is your desire (See ).请注意,这只会重定向到一个扩展,您还需要有一个端点 延伸桥/用户如果这是您的愿望(见 Dialplan_XML#Example_9)。 <extension name="Voicepulse"> <!-- your provider or any name you'd like to call it --> 您的供应商或任何你想呼叫的名称 expression="15555551212"> <condition field="destination_number" expression="15555551212"> <!-- your DID for this gateway--> <action application="transfer" data="1001 XML default"/> </condition> </extension>

If you want users to register with something other than the number that will reach them, then is for you.如果您希望用户注册的东西超过了他们将达到他们的话, 等是为 您。 **Note: Not all providers work this way, if you have difficulty with routing incoming calls from your provider look in the Wiki section for . **注意:不是所有的供应商 注意: **注意 合作 , 这样,如果您有您的路由在为提供的例子 看维基部分供应商来电困难。

Starting FreeSWITCH? is done from the command-line.开始 FreeSWITCH?完成命令行。 The location of the executable varies depending on your system.可执行文件的位置取决于 您的系统。

开始在基于 Unix 的系统
Now that you have compiled and configured FreeSWITCH? its time to place a test call to ensure that everything is working so far.现在,您已经编译和配置 FreeSWITCH?的 时间来进行测试要求,以确保一切工作至今。 To start FreeSWITCH? change to the bin subdirectory under the FreeSWITCH? installation directory, and run FreeSWITCH?. 要启动 FreeSWITCH?改变 bin 子目录下 FreeSWITCH?安装目录,并运行 FreeSWITCH?。 In a unix-like system that might be:在一个类似的系统可能的 Unix:

cd /usr/local/freeswitch/bin ./freeswitch

REDHAT CENTOS Startup Scripts:红帽 CENTOS 启动脚本: build/freeswitch.init.redhat cp build/freeswitch.init.redhat /etc/init.d/freeswitch chmod 755 /etc/init.d/freeswitch

在启动 Windows 系统
The Visual Studio project runs via an executable located under the debug or release folder of your project's directory tree (depending on how your project was built). 在 Visual Studio 项目通过运行一个可执行下调试或发布您的项目的目录树文件夹中(在你 的项目是如何建定)。 On a debug build of the Windows system start FreeSWITCH? as follows:在一个调试版本的 Windows 系统启动 FreeSWITCH?如下: FOLDER>\ cd <PROJECT FOLDER>\debug FreeSwitch.exe

The FreeSWITCH? command line will be available after successful loading of the application.在 FreeSWITCH?命令行可申请后,成功地加载。


These are the optional arguments you can pass to freeswitch:这些是可选参数可以传 递给 freeswitch:

-conf [confdir] -db [dbdir] -help -hp -log [logdir] -nc -nf -nonat -stop -waste


config specify an alternate config dir 指定一个备用的配置目录 specify an alternate db dir 指定一个备用数据库目录 this message enable high priority settings 启用高优先级设置 specify an alternate log dir 指定一个备用的日志目录 do not output to a console and background 并不会输出到控制台和背景 no forking 没有分支 do not load NAT (network address translation, for firewalls) 不会加载 NAT (网络地址转换,防火墙的) -- stop freeswitch 停止 freeswitch -- don't consume tons of unix resources (file handles) 不要使用大量的 UNIX 资源(文件句柄)

关机 FreeSWITCH?
To exit the FreeSwitch CLI, simply type 'shutdown' or '...'.要退出 FreeSwitch CLI 的,只需键入''shutdown'或'...'. Note, this will shutdown FreeSwitch.请注意,这将 关闭 FreeSwitch。 If you do not wish to shutdown FreeSwitch, it is suggested to start the process inside of a "screen" session; In Windows, FreeSWITCH? may be started as a service.如果你不想关闭 FreeSwitch,建议启动内部的“screen”会话层;该进程在 Windows,FreeSWITCH?可以作为服务启动。 It is not recommended that you start FreeSWITCH? as a service until you are certain your configuration is valid.不建议 你开始作为一种服务 FreeSWITCH?,直到您确定您的配置是有效的。 Also if started from a remote login session (IE SSH) it is not advised to terminate the connection with FS left in the foreground.另外,如果从一开始远程登录会话(即 SSH)技术是不建议终 止与前台 FS 左的连接。

一些东西来尝试! 一些东西来尝试!
The optimal way of testing is to get a pair of SIP phones and try out features via the default dialplan.在测试的最佳方法是得到一个 SIP 电话一双尝试通过默认的拨号规则 的功能。 If you're already familiar with asterisk, you could also start out by 如 果您已经熟悉了 asterisk,你还可以开始由

Register two phones to FreeSWITCH with two different extension numbers.注册两个手机 FreeSWITCH 两种不同的分机号码。 o Let's assume for the example that you have your SIP phones registered as extensions 1000 and 1001.让我们为示例假定您有您的 SIP 的扩展 1000 和 1001 的注册电话。 o You can use extension numbers 1000 through 1019 with a password of 1234 (the default voice-mail password is the same number as the extension {Ex: Extension 1000 has its voice-mail password set to 1000}.您可以通过 1019 的和 1234 密码(默认的语音信 箱密码,分机号码 1000 是作为扩展名(例如:1000 相同数量的扩展有其语音邮件密码设 置为 1000) 。

A sample configuration with

is shown below: 带有 X 精简版 示例配置,显示如下:

Once you've done that, you can try out a bunch of features already setup in the test dialplan.一旦完成,你可以尝试一堆的功能已在测试拨号规则设置。

Basic Calling 基本通话
? ? ? ? ?

Call between 1000 and 1001 by dialing the respective extension. 1000 和 1001 之间的呼叫 通过拨打各自的延伸。 Call 4000 to login to your voicemail box.呼叫 4000 登录到您的语音信箱。 870 - Redial last called # from this extension. 870 -重拨#从这一延长所谓的最后。 *69 - Call back the last person to call this extension. * 69 -回拨最后一个人叫这个扩 展。 8+[ext] - Place an intercom call to extension [ext]. 8 + [转] -将一个对讲机呼叫来扩展 [转]。 If no answer, it does not go to voicemail but just keeps ringing.如果没有答案, 但这并不转入语音信箱,只是不断响起。 Some phones have additional functionality for intercom calls.有些手机具备其他功能的对讲电话。

Advanced Calling Features 先进的呼叫功能

? ?

88+[ext] - Eavesdrop on extension [ext] (ex: 881001). 88 + [转] -关于延长窃听[转](例 如:881001) That extension must be on an active call.这一扩展必须以积极的呼吁。 Once 。 connected, you can listen to the call without being heard, or you can...一旦连接,就 可以收听电话会议而不听,也可以... o Press 1 to barge in with the distant party. 按 1 到驳船在与远程一方。 。 o Press 2 to barge in with the local party. 按 2 到驳船本地一方 。 。 o Press 3 to barge in on both parties. 按 3 驳船在双方。 5900 - Park a call in a hold queue (First-in-first-out style). 5900 -在一个公园举行队 列(先入先出风格)调用。 5901 - Pickup a call parked in queue (that was put there via 5900). 5901 -拾取呼叫停 泊在队列中(这是通过把 5900 那里) 。

Group Assignments The below functions involve the idea of keeping a database/table of which extensions belong to one of 100 groups (numbered 00-99).下面小组 小组职能任务 小组 任务 包括保持一个数据库/表属于哪些扩展的 100 组一个想法(编号 00-99)。



80+[group] - Delete this extension from calling group #[group] (can be two digits 00-99). 80 + [集团] -删除此组的要求#[组扩展](可两个数字 00-99) A beep tone confirms the 。 function worked.阿确认提示音的功能工作。 81+[group] - Add this extension to calling group #[group] (can be two digits 00-99). 81 + [集团] -添加此扩展呼叫组#[组](可两个数字 00-99) A beep tone confirms the function 。 worked.阿确认提示音的功能工作。 82+[group] - Simultaneously ring all extensions in group #[group]. 82 + [集团] -环同 时在组中的所有扩展#[集团]。 The first person to answer will be connected to you automatically.第一人回答会自动连接到你。

Conferencing 会议
? ? ? ? ?

30+[conf] - Join conference #[conf] - 8kHz quality. 30 + [conf 档案] -加入会议#[conf 档案] - 8kHz 的质量。 31+[conf] - Join conference #[conf] - 16kHz quality. 31 + [conf 档案] -加入会议#[conf 档案] - 16kHz 的质量。 32+[conf] - Join conference #[conf] - 32kHz quality. 32 + [conf 档案] -加入会议#[conf 档案] -为 32kHz 的质量。 9888 - Join the FreeSWITCH conference via a SIP Internet connection (8kHz). 9888 -加 入通过一个 SIP 的 Internet 连接(为 8kHz)FreeSWITCH 会议。 91616 - Join the FreeSWITCH conference via a SIP Internet connection (16kHz). 91616 加入通过一个 SIP 的 Internet 连接(16kHz 的)FreeSWITCH 会议。

Note: Conference rooms are unique for the bit-level you choose (ie 3000 for conference room 00 will not join with participants in 3100 which is also conference room 00.

They are different conferences).注:会议室是为位唯一级别选择(即 3000 会议室 00, 不会在 3100 参与者加入这也是会议室 00。两者是不同的会议)。

Interactive Voice Response 交互式语音应答

5000 - IVR demo. 5000 -的 IVR 演示。

Other Tests 其他测试
? ? ? ? ? ?

9992 - Info test (prints information to the command line interface). 9992 -信息测试(打 印资料的命令行界面) 。 9995 - Echo test (5-second delay before returning echo). 9995 -在返回 echo 回测试(5 秒 的延迟) 。 9996 - Echo test (real-time). 9996 -回波测试(实时) 。 9997 - Play milliwatt tone. 9997 -播放毫瓦基调。 9998 - Tetris, via tone streaming. 9998 -俄罗斯方块,通过调流。 9999 - Test Music On Hold out (if you installed sound files). 9999 -测试音乐保持了(如 果您安装了声音文件) 。

预处理命令 The FreeSWITCH? configuration supports preprocessor commands reminiscent of (but not matching) apache server-side includes: #comment, #include and #set.在 FreeSWITCH? 配置支持预处理命令的(但不匹配)阿帕奇服务器端想起包括:#comment, #include and #set.。 In addition to the pre-processor PIs, which may appear anywhere, the freeswitch.xml file has a root element of "document", and all its children are "section" elements, with "name" attribute values being one of:除了预处理器督察,可能会出现在任何地点, freeswitch.xml 文件有一个“文件”的根元素,它的所有儿童“节”分子,“名称”属性, 价值观念是其中之一:
? ? ?

??? ??? ??? ??? ??? ???

Note that preprocessor variables set with a #set PI are unrelated to "channel variables", defined with the <variable> element.请注意预处理器的变量用一个 #set PI 设置无关"通道变量"的定义, <variable> 元素。 Those variables are only expanded within channels.这些变量只在扩大渠道。

Preprocessor commands are included in XML style comment brackets.预处理命令都包含 在 XML 样式注释括号。 Even though they appear commented to an XML parser, they are still processed.尽管他们似乎注释,XML 解析器,但仍处理。 The comment characters are required or they will not be processed.注释字符的需要,否则将不获处理。 An example would be:一个例子是: <!--#include "switch.conf.xml"--> <!--#包括“switch.conf.xml” - “ freeswitch.xml This is the main configuration file, and the only one that has a fixed name.这是 主要的配置文件,唯一一个具有固定的名称。 When you start FreeSWITCH? it will locate this file and process it.当您启动 FreeSWITCH?会找到该文件并进行处理。 The default freeswitch.xml file includes other files to allow for easier maintenance of configuration data.默认 freeswitch.xml 文件包含其他文件,以便更容易配置数据的维护。 The default configuration of most of these files is suitable for first time users, until you become more familiar with FreeSWITCH? it is advised that you leave them to their default settings.在这些文件的默认配置是最适合用户的第一次,直到你变得更 FreeSWITCH?熟悉表示,这是你离开他们自己的默认设置。 freeswitch.xml is divided into multiple sections, and each section is used by a different component in FreeSWITCH?. freeswitch.xml 分为多个节,每节是由一种 FreeSWITCH?不同的组件中使用。 The sections are as follows:这几节如下:

? ? ?

The "configuration" section has children for and which are used by the core, as well as a child for each module in use.在“配置”一节已 switch.conf 和 modules.conf 文件是由 核心使用的儿童,以及使用中的每个模块的孩子。 The section defines which action to invoke when a call arrvies to the switch.在拨号 规则部分定义的行动,调用时调用 arrvies 到交换机。 The defines the users that can connect to the switch (user agents).该目录定义的用户 可以连接到交换机(用户代理) 。 The phrases section defines where freeswitch can find the sound files, and if it can use any TTS engines.在短语部分定义了 freeswitch 可以找到声音文件,如果它可以使用任何语音合 成引擎。

The structure below "document" and "section" varies according to the parent. There is currently no dtd/relaxng/xmlschema available to validate the file, though since it does not use xml mechanisms for inclusion that would be an obstacle to true validation (and the limited xml parser used by FreeSwitch doesn't implement any of the XML standard mechanisms such as external entities or XInclude). XML namespaces are not currently used.下面的"document"和 "section" 的结构根据不同父。目前还没有 DTD / relaxng / XMLSchema 的使用验证文件,但因为它不使用列入 XML 的机制,将是对真 正的验证障碍(与有限的 XML 解析器的 FreeSwitch 使用不落实,如外部实体或 XInclude XML 的标准机制的话) XML 命名空间目前没有使用。 There is no application-level versioning 。 within the file.没有应用在文件级版本。 如何配置文件解析

FS begins with its single, master configuration file (conf/freeswitch.xml).FS 的 单开始,主配置文件(conf / freeswitch.xml)。 This master config file then loads (via eg "*.xml") additional config files.这个主配置文件,然后加载(通过“globs”如“*. xml”的)的额外配置文件。 FS 1.0.4 installs with dozens of config files.FS1.0.4 安装与配置文件几十人。 You may stray daringly far from the stock install and arrange the files (and the loading thereof) however you wish: it's up to you if you want a single, huge config file or a series of config files.您可能会偏离大胆远离股票,并 安排安装文件(和其装载),但是你想:这取决于你,如果你想要一个单一的,巨大的配置 文件或配置文件系列。 Each config file can include none or many other config files. 每个配置文件可以包括没有或许多其他配置文件。Whatever method you choose, at runtime FreeSwitch parses all the (one or many) files into a single, huge, resultant "running config" file (located at log/ ) which mustn't be edited while FS is running as portions are memory-mapped into FS.无论您选择哪种方法在运行时 FreeSwitch,所有的 解析(一到一个巨大的,产生的“运行配置”文件或多个)文件(在日志位于/ freeswitch.xml.fsxml),绝不能被编辑,而 FS 运行由于部分是内存映射到 FS。 IMPORTANT When the FS console reports a configuration error, the line number it gives is the line number in the "running config" file, not the line number in any included 重要 file. 重要当 FS 控制台报告配置错误,行号,是它给在 "running config"文件中的行数, 而不是在任何包含文件中的行号。
例如 freeswitch.xml

Below is a snippet file.下面是一个片段 freeswitch.xml 文件。 Of course, the bulk of the configuration is found in the included files.当然,大部分的配置中找到的包含文 件。 <?xml version="1.0"?> <document type="freeswitch/xml"> <X-PREcmd="include" <X-PRE-PROCESS cmd="include" data="vars.xml"/> <section name="configuration" description="Various Configuration"> <X-PRE<X-PRE-PROCESS cmd="include" data="autoload_configs/*.xml"/> </section> <section name="dialplan" description="Regex/XML Dialplan"> <X-PRE-PROCESS cmd="include" data="dialplan/*.xml"/> <X-PRE-PROCESS </section> <!-- mod_dingaling is reliant on the vcard data in the "directory" section. --> <!-- mod_sofia is reliant on the user data for authorization --> Directory"> <section name="directory" description="User Directory"> <X-PRE<X-PRE-PROCESS cmd="include" data="directory/*.xml"/> </section> <!-- phrases section (under development still) --> <section name="phrases" description="Speech Phrase Management">

<macros> <X-PREdata="lang/*/*.xml"/> <X-PRE-PROCESS cmd="include" data="lang/*/*.xml"/> </macros> </section> </document> 预处理变量 For now, do not worry about all of the configuration properties, this guide will show you the minimum required to get a running FreeSWITCH? system.现在,不用担心的配置 所有属性,本指南会告诉你需要得到一个运行 FreeSWITCH?系统的最低。 After you have verified your installation you may then configure the system in more detail.在验 证您的安装可能会再配置更详细的系统。 The first thing you should do is review conf/vars.xml and conf/freeswitch.xml.首 先你应该做的是检查 conf/ vars.xml 和 conf/ freeswitch.xml。 For now just make note of the preprocessor variables.现在只利用预处理变量说明。 <X-PRE<X-PRE-PROCESS cmd="set" data="bind_server_ip=auto"/> <X-PRE<X-PRE-PROCESS cmd="set" data="global_codec_prefs=G722,PCMU@20i,PCMA@20i"/>
? ?

"bind_server_ip" Can be an ip address, a dns name, or "auto". “bind_server_ip”可以 是一个 IP 地址,DNS 名称,或“auto”。 "global_codec_prefs" has a default of G.711 u-law. “global_codec_prefs”有个 G.711 ü 默认的律。 You can probably leave this alone, unless you need to change it to another , but most VoIP equipment will support this .你可能离开就凭这一点,除非您需要更改到另 一个编解码器 ,但大多数 VoIP 设备将支持这一编解码器 。

hint: If you need to troubleshoot your configuration, the log/freeswitch.xml.fsxml file contains the entire pre-processed freeswitch.xml file. 提示:如果您需要解决您的配 置, log/freeswitch.xml.fsxml 文件包含整个前处理 freeswitch.xml 文件。 (For testing and troubleshooting you could replace the freeswitch.xml file with this copy.) (用于 测试和故障排除可以替换这个副本 freeswitch.xml 文件。) hint2: If you have a [ ] (Single Link, Multiple IP address) then remember that you may have to set a pre-process variable in the file. hint2:如果你有一个[ 多宿主 网卡 ](单链路,多个 IP 地址),那么请记住,您必须设置在 vars.xml 文件中预先过程变 量。 <X-PRE<X-PRE-PROCESS cmd="set" data="local_ip_v4=<your ip address>"/> “X 光预处理加 利福尼亚=”设置“数据=”local_ip_v4 = <您的 IP 地址>“/”

多租户信息/ 多租户信息/多公司 HOWTO

The page gives details regarding running FS to support multiple separate companies. is a HOWTO that describes setting up two independent companies on FS, where the files go, what they must contain, etc.在多租户页为 FS 的有关细节,以支持运行多个独立的公 司。 多家公司是一个描述的 HOWTO,成立两个独立的公司在 FS,那里的文件去,他们必须包 含等

什么不能做 FreeSWITCH
If you want to know what FreeSWITCH cannot do, refer to this page: 什么 FreeSWITCH 不能做的,参考下列网页: 什么 FreeSwitch 不能做 。 .如果你想知道

Asterisk 的罗塞塔石碑
is a page of common Asterisk -> FreeSWITCH translations. 罗塞塔石是一种常见的 Asterisk 的一页- “FreeSWITCH 译本。

? ? ?

拨号规则 拨号规则的 XML 拨号规则食谱

Spanish translation. 东望洋德首页西班牙文翻译。
Retrieved from " "来自“http://wiki.freeswitch.org/wiki/Getting_Started_Guide” : | 分类 : 配置 | 文档
Views Views 点击 ? ? ? ?

页 讨论 查看源代码 历史

Personal tools 个人工具 ?


Start Here 从这里开始

? ? ?

下载 FreeSWITCH 安装指南 入门指南

Community 社区 ? ?

体育馆 齐来参与

Navigation 导航 ? ? ? ? ? ? ? ? ? ? ? ?

主页 文档 安装指南 入门指南 社区门户 当前事件 最近的更改 随机页面 帮助 sitesupport 教我如何? 下载 FreeSWITCH

Toolbox 工具箱 ? ? ? ? ? ?

链入 相关变化 特殊页面 打印版本 永久链接 打印成 PDF

? ? ? ? ?

This page was last modified on 10 October 2009, at 01:25.这页的最后修订于 2009 年 10 月 在 01:25。 This page has been accessed 109,545 times.本页面已经被浏览 109545 次。 隐私权政策 关于 FreeSWITCH 维基 免责声明