Index
A
- <action> tag / Running Lua scripts from the Dialplan
- Aastra 9112i / Aastra phones
- Aastra phones
- about / Aastra phones
- Aastra 9112i / Aastra phones
- absolute condition / How Dialplan processing works
- accountcode variable / User features
- ACD / Groups of users
- ACL / Configuring event socket settings, ACL
- actions / FreeSWITCH XML Dialplan elements
- actions, inline execution
- check_acl / Inline execution
- eval / Inline execution
- event / Inline execution
- export / Inline execution
- log / Inline execution
- presence / Inline execution
- set / Inline execution
- set_global / Inline execution
- set_profile_var / Inline execution
- set_user / Inline execution
- sleep / Inline execution
- unset / Inline execution
- verbose_events / Inline execution
- cidlookup / Inline execution
- curl / Inline execution
- easyroute / Inline execution
- enum / Inline execution
- lcr / Inline execution
- nibblebill / Inline execution
- odbc_query / Inline execution
- action tag / Voicemail
- active conference
- controlling / Controlling active conferences
- addBody($value) function / addBody($value)
- addHeader($header_name, $value) function / addHeader($header_name, $value)
- advanced routing, IVR
- about / Advanced routing
- advertise section
- about / Advertise
- alone-sound option / Conference profiles
- alternatives, XML
- about / Alternatives to XML
- YAML / YAML
- Asterisk dialplan / Asterisk Dialplan
- aniii variable / Special condition variables
- ani variable / Special condition variables
- announce-count parameter / Conference profiles
- answer application
- about / Creating a new extension, answer
- anti-actions
- about / Actions and anti-actions
- api($command[, $arguments]) command / api($command[, $arguments])
- api command
- Apple XCode
- URL / Mac OS X
- Application module / The FreeSWITCH design: modular, scalable, and stable
- Application Programming Interface (API) module / The FreeSWITCH design: modular, scalable, and stable
- applications, Dialplan
- about / Important Dialplan applications
- bridge / bridge
- playback / playback
- say / say
- play_and_get_digits / play_and_get_digits
- ivr / ivr
- sleep / sleep
- answer / answer
- hangup / hangup
- set / set
- applications, FreeSWITCH
- voicemail / Voicemail
- multi-party conferencing / Multi-party conferencing
- apply-inbound-acl parameter / Configuring event socket settings
- APR / Step 2: Run configure script
- Asterisk dialplan
- about / Asterisk Dialplan
- async keyword / Events from the Dialplan
- auth <password> command / auth <password>
- authorization
- about / Authorization
- auto-record parameter / Conference profiles
- AUTOCONF / Linux/Unix
- autoload_configs subdirectory / Step 4: Edit modules.conf.xml
- AUTOMAKE / Linux/Unix
- Automated Speech Recognition (ASR) module / The FreeSWITCH design: modular, scalable, and stable
B
- /bye command / Controlling FreeSWITCH with the CLI
- B2BUA
- bad-pin-sound option / Conference profiles
- bgapi($command[, $arguments]) command / bgapi($command[, $arguments])
- bgapi command
- bindings / Bindings
- bind_meta_app command / XML Dialplan commands
- bind_meta_app command, parameters
- KEY / XML Dialplan commands
- LISTEN_TO / XML Dialplan commands
- RESPOND_ON / XML Dialplan commands
- APPLICATION / XML Dialplan commands
- PARAMETERS / XML Dialplan commands
- break attribute / Conditions
- break flag / Conditions
- break parameter / Conditions
- break parameter, values
- on-false / Conditions
- on-true / Conditions
- always / Conditions
- never / Conditions
- bridge / Important concepts to understand
- bridge application / Important modules: Endpoint and Dialplan
- about / bridge
- bridge command / XML Dialplan commands
C
- <condition> tag / Conditions, How Dialplan processing works, Creating a new extension
- call
- bridging, ways / XML Dialplan commands
- call billing methods, mod_nibblebill module
- FreeSWITCH heartbeat / Nibble method (default)
- nibble billing method, alternative / Alternative to nibble billings
- caller-controls parameter / Conference profiles
- caller-id-name parameter / Conference profiles
- caller-id-number parameter / Conference profiles
- Caller controls
- about / Caller controls
- caller profile / Important concepts to understand
- caller profile fields
- about / Caller profile fields
- example / Caller profile fields
- caller_id_name variable / Special condition variables
- caller_id_number variable / Special condition variables
- callgroup variable / User features
- call leg
- one call leg / Important concepts to understand
- two call leg / Important concepts to understand
- about / Call legs and channel variables
- two call legs / Call legs and channel variables
- calls
- making, gateway used / Making calls
- receiving, gateway used / Receiving calls
- making, without gateways / Making calls without a gateway
- calls, routing
- channel variables / Important concepts to understand
- about / Call legs and channel variables, Channel variables
- accessing / Accessing channel variables
- list, URL / Channel variables
- utilizing / Channel variables and call setup
- setting, curly brackets used / Channel variables and call setup
- setting, square brackets used / Channel variables and call setup
- chan_name variable / Special condition variables
- Chat module / The FreeSWITCH design: modular, scalable, and stable
- chat rooms, FreeSWITCH
- #freeswitch / Talking in real-time via IRC
- #freeswitch-dev / Talking in real-time via IRC
- #freeswitch-social / Talking in real-time via IRC
- #openzap / Talking in real-time via IRC
- Chatzilla / Talking in real-time via IRC
- check command / Check
- check_acl action / Inline execution
- cidlookup action / Inline execution
- CLI / Starting FreeSWITCH
- FreeSWITCH, controlling / Controlling FreeSWITCH with the CLI
- close_db_conn function / Connecting to a database with LuaSQL
- ClueCon / Demonstration IVR
- Codec module / The FreeSWITCH design: modular, scalable, and stable
- Colloquy / Talking in real-time via IRC
- comfort-noise parameter / Conference profiles
- commands, ESLconnection object
- new($host, $port, $password) / new($host, $port, $password)
- new($fd) / new($fd)
- socketDescriptor() / socketDescriptor()
- connected() / connected()
- getInfo() / getInfo()
- send($command) / send($command)
- sendRecv($command) / sendRecv($command)
- api($command[, $arguments]) / api($command[, $arguments])
- bgapi($command[, $arguments]) / bgapi($command[, $arguments])
- sendEvent($send_me) / sendEvent($send_me)
- recvEvent() / recvEvent()
- recvEventTimed($milliseconds) / recvEventTimed($milliseconds)
- filter($header, $value) / filter($header, $value)
- events($event_type,$value) / events($event_type,$value)
- execute($app[, $arg][, $uuid]) / execute($app[, $arg][, $uuid])
- executeAsync($app[, $arg][, $uuid]) / executeAsync($app[, $arg][, $uuid])
- setAsyncExecute($value) / setAsyncExecute($value)
- setEventLock($value) / setEventLock($value)
- disconnect() / disconnect()
- commands, FreeSWITCH
- help / Controlling FreeSWITCH with the CLI
- version / Controlling FreeSWITCH with the CLI
- status / Controlling FreeSWITCH with the CLI
- show channels / Controlling FreeSWITCH with the CLI
- show calls / Controlling FreeSWITCH with the CLI
- commands, mod_nibblebill module
- commands, XML Dialplan module
- about / XML Dialplan commands
- mod_dptools / XML Dialplan commands
- bind_meta_app / XML Dialplan commands
- eavesdrop / XML Dialplan commands
- execute_extension / XML Dialplan commands
- send_display / XML Dialplan commands
- mod_sofia / XML Dialplan commands
- cond function / Real-time condition evaluation
- conditions
- about / Conditions, Conditions and looping, General Dialplan concepts, Conditions, Conditions
- example / Conditions, Conditions
- condition variables, XML Dialplan module
- about / Special condition variables
- context / Special condition variables
- rdnis / Special condition variables
- destination_number / Special condition variables
- dialplan / Special condition variables
- caller_id_name / Special condition variables
- caller_id_number / Special condition variables
- ani / Special condition variables
- aniii / Special condition variables
- uuid / Special condition variables
- source / Special condition variables
- chan_name / Special condition variables
- network_addr / Special condition variables
- year / Special condition variables
- yday / Special condition variables
- mon / Special condition variables
- mday / Special condition variables
- week / Special condition variables
- mweek / Special condition variables
- wday / Special condition variables
- hour / Special condition variables
- minute / Special condition variables
- minute-of-day / Special condition variables
- conference
- callers, connecting / Connecting callers to the conference
- conference-flags parameter / Conference profiles
- Conference profiles
- about / Conference profiles
- Conference profiles, parameters
- rate / Conference profiles
- caller-controls / Conference profiles
- auto-record / Conference profiles
- interval / Conference profiles
- energy-level / Conference profiles
- member-flags / Conference profiles
- conference-flags / Conference profiles
- tts-engine / Conference profiles
- tts-voice / Conference profiles
- pin / Conference profiles
- max-members / Conference profiles
- caller-id-name / Conference profiles
- caller-id-number / Conference profiles
- comfort-noise / Conference profiles
- announce-count / Conference profiles
- suppress-events / Conference profiles
- sound-prefix / Conference profiles
- Custom Sounds / Conference profiles
- configuration, mod_conference module
- about / Configuration
- conference profiles / Conference profiles
- caller controls / Caller controls
- advertise section / Advertise
- XMPP events, sending / Sending and receiving XMPP events
- XMPP events, receiving / Sending and receiving XMPP events
- configuration, mod_nibblebill module
- about / Installation and configuration
- database tables / Database tables
- configuration, mod_xml_curl module
- about / Configuration
- bindings / Bindings
- HTTP requests / HTTP requests
- HTTP response / HTTP response
- optimization / Optimization
- requests, order / Order of requests
- request, examples / Request/response examples
- response, examples / Request/response examples
- configuration, SIP phone
- about / Configuring a SIP phone to work with FreeSWITCH
- settings / SIP settings
- configuration error, X-Lite soft phone
- 403-Forbidden error<?AID 0013?> XE / X-Lite softphone
- configuration tools, FreeSWITCH
- about / Configuration tools and related projects
- Web GUIs / Web GUIs
- libraries / Supporting libraries
- configure script
- about / Step 2: Run configure script
- running / Step 2: Run configure script
- confirm-key attribute / confirm-key
- connected() command / connected()
- contexts / Important concepts to understand
- context variable / Special condition variables
- continue attribute / Extensions
- continue flag / Extensions
- curl
- web call, making / Making a web call with curl
- curl action / Inline execution
- Custom Sounds parameter / Conference profiles
- Custom Sounds parameter, options
- muted-sound / Conference profiles
- unmuted-sound / Conference profiles
- alone-sound / Conference profiles
- enter-sound / Conference profiles
- exit-sound / Conference profiles
- kicked-sound / Conference profiles
- locked-sound / Conference profiles
- is-locked-sound / Conference profiles
- is-unlocked-sound / Conference profiles
- pin-sound / Conference profiles
- bad-pin-sound / Conference profiles
- perpetual-sound / Conference profiles
- moh-sound / Conference profiles
- max-members-sound / Conference profiles
D
- /debug command / Controlling FreeSWITCH with the CLI
- <domain> elements / Understanding the FreeSWITCH user directory
- daemon / Running FreeSWITCH in the background
- data attribute / Actions and anti-actions
- database
- connecting, LuaSQL used / Connecting to a database with LuaSQL
- database queries
- about / Database queries
- database table
- creating, for PostgreSQL / Creating the database table for PostgreSQL
- creating, for MySQL / Creating the database table for MySQL
- deaf option / Conference profiles
- default.xml file / FreeSWITCH XML Dialplan elements
- default/ directory / FreeSWITCH XML Dialplan elements
- default configuration
- about / The default configuration
- purpose / The default configuration
- default context / Default
- Default Dialplan Quick Reference / Calling a conference
- delHeader($header_name) function / delHeader($header_name)
- design goals, mod_nibblebill module
- concurrent design / Design goals
- scalibility / Design goals
- flexibility / Design goals
- customizable / Design goals
- destination_number variable / Special condition variables
- Dialplan
- testing / Testing the default Dialplan
- Dialplan, testing
- about / Testing the default Dialplan
- test calls, for single phone / Test calls for a single phone
- test calls, for multiple phone / Test calls for two or more phones
- Dialplan application
- Lua scripts, running / Running Lua scripts from the Dialplan
- Lua scripting, tips / Scripting tips
- Dialplan bindings, mod_xml_curl module
- about / Dialplan bindings
- request / Request
- reply / Reply
- dialplan engine, FreeSWITCH
- about / Dialplan overview
- Dialplan module
- about / The FreeSWITCH design: modular, scalable, and stable, Important modules: Endpoint and Dialplan
- XML Dialplan module / Important modules: Endpoint and Dialplan
- XML, turning into extension / Important modules: Endpoint and Dialplan
- Dialplan parsing
- working / How Dialplan processing works
- Dialplan processing
- working / How Dialplan processing works
- dialplan processing, FreeSWITCH
- about / Dialplan overview
- dialplan variable / Special condition variables
- Dialstrings
- about / Dialstring formats
- usage / Dialstring formats
- formats / Dialstring formats
- Dialstrings, types
- loopback/<destination number> / Dialstring formats
- openzap/<span>/<channel>/<phone number> / Dialstring formats
- error/<error code> / Dialstring formats
- group/<group name>[@domain] / Dialstring formats
- DID / Public
- routing, to extensions / Route DIDs to extensions
- digit-len attribute / digit-len
- Directory module / The FreeSWITCH design: modular, scalable, and stable
- disconnect() command / disconnect()
- dist-dtmf option / Conference profiles
- divert_events command
- about / divert_events
- syntax / divert_events
- example / divert_events
E
- /exit command / Controlling FreeSWITCH with the CLI
- <entry> XML element / IVR menu destinations
- <extension> tag / Extensions
- easyroute action / Inline execution
- eavesdrop command / XML Dialplan commands
- echo extension / How Dialplan processing works
- effective_caller_id_name variable / User features
- effective_caller_id_number variable / User features
- elements, XML Dialplan
- call leg / Call legs and channel variables
- channel variables / Call legs and channel variables
- regular expressions / Regular expressions
- contexts / Contexts, Public, Contexts
- extensions / Extensions, Extensions
- conditions / Conditions, General Dialplan concepts, Conditions, Conditions
- anti-actions / Actions and anti-actions
- actions / Actions and anti-actions, General Dialplan concepts, Actions, Actions and anti-actions
- elements, XML Dialplan module
- anti-actions / Actions and anti-actions
- Emacs text editor / Text editors and XML
- enable_heartbeat_events variable / Bill based on B leg only
- endconf option / Conference profiles
- Endpoint module
- about / The FreeSWITCH design: modular, scalable, and stable, Important modules: Endpoint and Dialplan
- mod_sofia / Important modules: Endpoint and Dialplan
- SIP, turning into FreeSWITCH session / Important modules: Endpoint and Dialplan
- energy-level parameter / Conference profiles
- enter-sound option / Conference profiles
- enum action / Inline execution
- ESLconnection object / ESLconnection object, send($command), recvEventTimed($milliseconds), setAsyncExecute($value)
- ESLevent object / ESLevent object, addBody($value)
- ESLObject
- about / ESLObject
- eslSetLogLevel($loglevel) / eslSetLogLevel($loglevel)
- eslSetLogLevel($loglevel) / eslSetLogLevel($loglevel)
- eval action / Inline execution
- event action / Inline execution
- event command
- event handler modules, FreeSWITCH
- about / Event-based modules
- mod_event_socket / Event-based modules, mod_event_socket
- mod_event_multicast / Event-based modules, mod_event_multicast
- mod_erlang_event / Event-based modules, mod_erlang_event
- event message / Reading events
- events($event_type,$value) command / events($event_type,$value)
- EventSocket
- about / EventSocket (Python/Twisted)
- URL / EventSocket (Python/Twisted)
- Event Socket Library (ESL) / Event Socket Library
- example / Event Socket Library example: running a command, Turn lights on, Rebooting a phone, Custom notify messages
- command, running / Event Socket Library example: running a command
- events, sending to FreeSWITCH / Examples of sending events to FreeSWITCH
- Event Socket Library, FreeSWITCH
- about / Event Socket Library
- libraries / Supported libraries
- ESLObject / ESLObject
- ESLevent object / ESLevent object
- ESLconnection object / ESLconnection object
- event system, FreeSWITCH
- about / General overview
- functionality / General overview
- event system applications, FreeSWITCH
- about / Event-based applications
- FreeSWITCH Console application / FreeSWITCH Console application
- PHP Socket connections / PHP Socket connections
- Perl Socket connections / Perl Socket connections
- event system commands, FreeSWITCH
- about / FreeSWITCH event system commands
- auth <password> / auth <password>
- api / api
- bgapi / bgapi
- event / event
- divert_events / divert_events
- filter / filter
- filter delete / filter delete
- sendevent / sendevent
- sendmsg <uuid> / sendmsg <uuid>
- execute / execute
- hangup / hangup
- nomedia / nomedia
- log <level> / log <level>
- nolog / nolog
- noevents / noevents
- execute($app[, $arg][, $uuid]) command / execute($app[, $arg][, $uuid])
- executeAsync($app[, $arg][, $uuid]) command / executeAsync($app[, $arg][, $uuid])
- execute command / execute
- EXECUTE state / Hunting versus executing
- execute_extension command
- about / XML Dialplan commands
- using / XML Dialplan commands
- executing
- versus hunting / Hunting versus executing
- exit-sound attribute / exit-sound
- exit-sound option / Conference profiles
- export action / Inline execution
- export command
- about / Set versus export
- versus set command / Set versus export
- extension / Important concepts to understand
- extensions
- about / FreeSWITCH XML Dialplan elements, Extensions, Extensions
- new extension, creating / Creating a new extension, Building voice applications
- new extension, characteristics / Creating a new extension
- new extension, testing / Creating a new extension
- example / Extensions
- external profile / SIP profiles and user agents
F
- 403-Forbidden error / X-Lite softphone
- features.xml file / FreeSWITCH XML Dialplan elements
- features context / Features
- fetch method / Connecting to a database with LuaSQL
- File module / The FreeSWITCH design: modular, scalable, and stable
- filter($header, $value) command / filter($header, $value)
- filter command
- filter delete command
- about / filter delete
- syntax / filter delete
- example / filter delete
- firstHeader() function / firstHeader()
- flush command / Flush
- FreePBX
- about / FreePBX v3
- concepts / FreePBX v3
- URL / FreePBX v3
- FreeSWITCH
- about / A revolution has begun and secrets have been revealed, Important concepts to understand
- design / The FreeSWITCH design: modular, scalable, and stable
- module types / The FreeSWITCH design: modular, scalable, and stable
- advantages / The FreeSWITCH design: modular, scalable, and stable
- FSAPI module / The FreeSWITCH API (FSAPI)
- XML registry / The XML registry
- language module / Language modules
- default configuration / The default configuration
- environment, setting up / Setting up the FreeSWITCH environment
- source code / Downloading the source
- URL / Downloading the source
- latest source code / Building from the latest code
- compiling, for Linux / Compiling FreeSWITCH for Linux/Unix/Mac OS X
- compiling, for Mac OS X / Compiling FreeSWITCH for Linux/Unix/Mac OS X
- compiling, for Unix / Compiling FreeSWITCH for Linux/Unix/Mac OS X
- compiling / Compiling FreeSWITCH
- compiling, for Windows / Compiling FreeSWITCH for Windows
- building, MSVCEE used / Building the solution with MSVC/MSVCEE
- building, MSVC used / Building the solution with MSVC/MSVCEE
- launching / Starting FreeSWITCH
- running / Running FreeSWITCH in the background
- call leg / Important concepts to understand
- IVR / Important concepts to understand
- controlling, CLI used / Controlling FreeSWITCH with the CLI
- user directory / Understanding the FreeSWITCH user directory
- gateways / Connecting to the world with gateways
- SIP profiles / SIP profiles and user agents
- IVR engine / IVR engine overview
- voice applications, building / Building voice applications
- dialplan engine / Dialplan overview
- dialplan processing / Dialplan overview
- ROUTE phase / Putting it all together
- hunting, versus executing / Hunting versus executing
- executing, versus hunting / Hunting versus executing
- variables, utilizing / Utilizing variables
- event system / General overview
- event system architecture / Event system architecture
- event handler modules / Event-based modules
- event system commands / FreeSWITCH event system commands
- event system applications / Event-based applications
- Event Socket Library (ESL) / Event Socket Library
- phones, rebooting / Rebooting a phone
- phone reconfiguration, requesting / Requesting phone reconfiguration
- multi-user conferencing / Multi-user conferencing
- configuration tools / Configuration tools and related projects
- mailing lists / The FreeSWITCH mailing lists
- chat rooms / Talking in real-time via IRC
- main project page, URL / The FreeSWITCH main website and wiki, FreeSWITCHpublic wiki page, URLThe main FreeSWITCH page—www.freeswitch.org
- public wiki page, URL / FreeSWITCHpublic wiki page, URLThe main FreeSWITCH page—www.freeswitch.org, The FreeSWITCH Wiki page—wiki.freeswitch.org
- Cluecon / The annual ClueCon open source developer conference
- FreeSWITCH, compiling
- about / Compiling FreeSWITCH
- modules.conf file, editing / Step 1: Edit modules.conf
- configure script, running / Step 2: Run configure script
- make utility, running / Step 3: Run make and make install
- make install utility, running / Step 3: Run make and make install
- modules.conf.xml file, editing / Step 4: Edit modules.conf.xml
- sound files, installing / Step 5: Install sound and music files
- music files, installing / Step 5: Install sound and music files
- FreeSWITCH-biz list / The FreeSWITCH mailing lists
- freeswitch-users list / The FreeSWITCH mailing lists
- FreeSWITCH-users list / The FreeSWITCH mailing lists
- freeswitch.xml file / Important concepts to understand
- FreeSWITCH Console application
- about / FreeSWITCH Console application
- FreeSWITCH environment
- setting up / Setting up the FreeSWITCH environment
- operating system / Operating system
- operating system, prerequisites / Operating system prerequisites
- Mac OS X, requisites / Mac OS X
- Windows, requisites / Windows
- text editors / Text editors and XML
- FreeSWITCHeR
- about / FreeSWITCHeR (Ruby)
- URL / FreeSWITCHeR (Ruby)
- FreeSWITCH event system
- about / Voicemail
- FreeSWITCH event system architecture
- about / Event system architecture
- FreeSWITCH heartbeat
- about / Nibble method (default)
- FreeSWITCH source code
- about / Downloading the source
- FreeSWITCH user directory
- about / Understanding the FreeSWITCH user directory
- example / Understanding the FreeSWITCH user directory
- user@domain / Understanding the FreeSWITCH user directory
- accessing / Understanding the FreeSWITCH user directory
- working with / Working with the FreeSWITCH user directory
- user, features / User features
- user, adding / Adding a user
- voicemail, testing / Testing voicemail
- groups / Groups of users
- FreeSWITCH wiki
- FreeTDM / TDM with OpenZAP and FreeTDM
- FSAPI module
- about / The FreeSWITCH API (FSAPI)
- benefits / The FreeSWITCH API (FSAPI)
- CLI interface, providing / The FreeSWITCH API (FSAPI)
- fsctl shutdown command / Starting FreeSWITCH
- FSSocket (Perl)
- about / FSSocket (Perl)
- URL / FSSocket (Perl)
- fs_cli utility / Running FreeSWITCH in the background, Controlling FreeSWITCH with the CLI, The "Information" application, Call legs and channel variables
- launching / Controlling FreeSWITCH with the CLI
- full keyword / Events from the Dialplan
- functions, ESLevent object / ESLevent object
- serialize([$format]) / serialize([$format])
- setPriority([$number]) / setPriority([$number])
- getHeader($header_name) / getHeader($header_name)
- getBody() / getBody()
- getType() / getType()
- addBody($value) / addBody($value)
- addHeader($header_name, $value) / addHeader($header_name, $value)
- delHeader($header_name) / delHeader($header_name)
- firstHeader() / firstHeader()
- nextHeader() / nextHeader()
- functions, XML Dialplan module
- about / Dialplan functions
- conditional evaluation / Real-time condition evaluation
- string conditioning / String conditioning
- database queries / Database queries
- SIP contact parameter / SIP contact parameters
- FusionPBX
G
- <groups> elements / Understanding the FreeSWITCH user directory
- gateway
- about / Connecting to the world with gateways
- new gateway, setting up / Setting up a new gateway
- calls, making / Making calls
- calls, receiving / Receiving calls
- GCC / Linux/Unix
- getBody() function / getBody()
- getHeader($header_name) function / getHeader($header_name)
- getInfo() command / getInfo()
- getType() function / getType()
- Git client / Linux/Unix, Building from the latest code
- global variables / Global variables
- GNUMAKE / Linux/Unix
- GNU Screen utility
- URL / Adding a user
- greet-long attribute / greet-long
- greet-short attribute / greet-short
- groups
- about / Groups of users
- new group, adding / Groups of users
- group_call command / Groups of users
- GSM
- and Skype / Skype and GSM endpoints
- mod_gsmopen module / GSM with mod_gsmopen
- GSMOpen
- about / GSM with mod_gsmopen
- URL / GSM with mod_gsmopen
- GUI / Text editors and XML
H
- /help command / Controlling FreeSWITCH with the CLI
- 2600hz project
- hangup application
- about / hangup
- hangup command / hangup
- hangup_call function / Connecting to a database with LuaSQL
- hard phones
- about / Configuring a SIP phone to work with FreeSWITCH, Hard phones
- tips / Hard phones
- Aastra phones / Aastra phones
- Polycom phones / Polycom phones
- Snom phones / Snom phones
- help command / Controlling FreeSWITCH with the CLI
- hour variable / Special condition variables
- hunting
- versus executing / Hunting versus executing
- hupall command / XML Dialplan commands
I
- <include> tag / User features, Creating a new extension, Phrase Macro examples: voicemail
- id attribute / User features
- identities / Snom phones
- info application / The "Information" application, Pitfalls to avoid
- information extension / Call legs and channel variables
- init script / Running FreeSWITCH in the background
- inline execution, XML Dialplan module
- about / Inline execution
- inline flag / Inline execution
- need for / Inline execution
- example / Inline execution
- inline flag / Inline execution
- installation, mod_nibblebill module
- about / Installation and configuration
- installation, mod_xml_curl module
- about / Installation
- inter-digit-timeout attribute / inter-digit-timeout
- internal context / Contexts
- internal profile / SIP profiles and user agents
- interval parameter / Conference profiles
- invalid-sound attribute / invalid-sound
- IRC
- about / Talking in real-time via IRC
- using / Talking in real-time via IRC
- clients / Talking in real-time via IRC
- tips / Talking in real-time via IRC
- IRC clients
- IRSSI / Talking in real-time via IRC
- Colloquy / Talking in real-time via IRC
- mIRC / Talking in real-time via IRC
- IRSSI / Talking in real-time via IRC
- is-locked-sound option / Conference profiles
- is-unlocked-sound option / Conference profiles
- IVR
- about / Important concepts to understand
- demonstration / Demonstration IVR
- XML configuration file / IVR XML configuration file
- menu definitions / IVR menu definitions
- menu destinations / IVR menu destinations
- calls, routing / Routing calls to your IVR
- nesting / Nesting IVRs
- phrases, used / Using phrases with IVRs
- Phrase Macros, calling / Calling Phrase Macros
- advanced routing / Advanced routing
- interacting, with caller / Simple IVR—interacting with the caller
- database, connecting with LuaSQL / Connecting to a database with LuaSQL
- web call, making with curl / Making a web call with curl
- ivr application
- about / ivr
- IVR engine
- about / IVR engine overview
- IVR XML configuration file
- about / IVR XML configuration file
- example / IVR XML configuration file
K
- Kepler project
- kicked-sound option / Conference profiles
L
- /log 6 command / Call legs and channel variables
- /log command / Controlling FreeSWITCH with the CLI
- language module
- about / Language modules
- lcr action / Inline execution
- LIBNCURSES / Linux/Unix
- libraries, FreeSWITCH
- about / Supporting libraries
- Liverpie / Liverpie (Ruby)
- FreeSWITCHeR / FreeSWITCHeR (Ruby)
- Librevox / Librevox (Ruby)
- EventSocket / EventSocket (Python/Twisted)
- FSSocket (Perl) / FSSocket (Perl)
- Librevox
- about / Librevox (Ruby)
- URL / Librevox (Ruby)
- LIBTOOL / Linux/Unix
- Linux / Linux/Unix
- FreeSWITCH, compiling / Compiling FreeSWITCH for Linux/Unix/Mac OS X
- Linux/Unix executable files
- versus Windows executable files / Controlling FreeSWITCH with the CLI
- listen-ip parameter / Configuring event socket settings
- listen-port parameter / Configuring event socket settings
- Liverpie
- about / Liverpie (Ruby)
- URL / Liverpie (Ruby)
- loadable dialplan modules
- about / Dialplan overview
- advantages / Dialplan overview
- Local_Extension Dialplan entry
- modifying / Adding a user
- locked-sound option / Conference profiles
- log <level> command / log <level>
- log action / Inline execution
- loglevel information / ESLObject
- looping
- about / Conditions and looping
- Lua
- enabling, steps / Getting started with Lua
- scripts, running from Dialplan / Running Lua scripts from the Dialplan
- syntax / Basic Lua syntax
- script / Basic Lua syntax
- scripting, tips / Scripting tips
- Lua patterns
- versus regular expressions / Lua patterns versus regular expressions
- syntax, URL / Lua patterns versus regular expressions
- Lua script / Basic Lua syntax
- running, from Dialplan / Running Lua scripts from the Dialplan
- tips / Scripting tips
- LuaSQL
- database, connecting / Connecting to a database with LuaSQL
- luasql.postgres module / Connecting to a database with LuaSQL
M
- <macro> tag / Phrase Macro examples: voicemail
- <match> tag / Phrase Macro examples: voicemail
- Mac OS X
- requisites / Mac OS X
- FreeSWITCH, compiling / Compiling FreeSWITCH for Linux/Unix/Mac OS X
- macros
- voicemail_goodbye macro / Phrase Macro examples: voicemail
- voicemail_enter_pass macro / Phrase Macro examples: voicemail
- voicemail_message_count macro / Phrase Macro examples: voicemail
- mailing lists, FreeSWITCH
- about / The FreeSWITCH mailing lists
- URL / The FreeSWITCH mailing lists
- freeswitch-users / The FreeSWITCH mailing lists
- freeswitch-users list / The FreeSWITCH mailing lists
- FreeSWITCH-users list / The FreeSWITCH mailing lists
- FreeSWITCH-biz list / The FreeSWITCH mailing lists
- tips / The FreeSWITCH mailing lists
- Makefile / Step 3: Run make and make install
- make install utility
- running / Step 3: Run make and make install
- make utility
- about / Step 3: Run make and make install
- running / Step 3: Run make and make install
- match tag / Voicemail
- max-failures attribute / max-failures
- max-members-sound option / Conference profiles
- max-members parameter / Conference profiles
- max-timeouts attribute / max-timeouts
- mday variable / Special condition variables
- member-flags parameter / Conference profiles
- member-flags parameter, options
- deaf / Conference profiles
- waste / Conference profiles
- dist-dtmf / Conference profiles
- endconf / Conference profiles
- menu-back action / menu-back
- menu-exec-api action / menu-exec-api
- menu-exec-app action / IVR menu destinations, menu-exec-app
- menu-play-sound action / menu-play-sound
- menu-top action / menu-top
- menu definitions, IVR
- about / IVR menu definitions
- greet-long / greet-long
- greet-short / greet-short
- invalid-sound / invalid-sound
- exit-sound / exit-sound
- timeout / timeout
- inter-digit-timeout / inter-digit-timeout
- max-failures / max-failures
- max-timeouts / max-timeouts
- digit-len / digit-len
- tts-voice / tts-voice
- tts-engine / tts-engine
- confirm-key / confirm-key
- menu destinations, IVR
- about / IVR menu destinations
- menu-exec-app / menu-exec-app
- menu-exec-api / menu-exec-api
- menu-play-sound / menu-play-sound
- menu-back / menu-back
- menu-top / menu-top
- minute-of-day variable / Special condition variables
- minute variable / Special condition variables
- mIRC / Talking in real-time via IRC
- modules.conf.xml file
- about / Step 4: Edit modules.conf.xml
- editing / Step 4: Edit modules.conf.xml
- modules.conf file
- about / Step 1: Edit modules.conf, Step 4: Edit modules.conf.xml
- editing / Step 1: Edit modules.conf
- versus modules.conf.xml file / Step 4: Edit modules.conf.xml
- module types, FreeSWITCH
- about / The FreeSWITCH design: modular, scalable, and stable
- Endpoint / The FreeSWITCH design: modular, scalable, and stable, Important modules: Endpoint and Dialplan
- Dialplan / The FreeSWITCH design: modular, scalable, and stable, Important modules: Endpoint and Dialplan
- Codec / The FreeSWITCH design: modular, scalable, and stable
- Application / The FreeSWITCH design: modular, scalable, and stable
- Application Programming Interface (API) / The FreeSWITCH design: modular, scalable, and stable
- File / The FreeSWITCH design: modular, scalable, and stable
- Text-To-Speech (TTS) / The FreeSWITCH design: modular, scalable, and stable
- Automated Speech Recognition (ASR) / The FreeSWITCH design: modular, scalable, and stable
- Directory / The FreeSWITCH design: modular, scalable, and stable
- Chat / The FreeSWITCH design: modular, scalable, and stable
- Say / The FreeSWITCH design: modular, scalable, and stable, Voicemail
- mod_commands command / XML Dialplan commands
- mod_conference module
- about / Multi-party conferencing, Multi-user conferencing
- features / Multi-party conferencing
- configuring / Configuration
- mod_curl / Making a web call with curl
- mod_dptools command / XML Dialplan commands
- mod_erlang_event module
- about / mod_erlang_event
- mod_event_multicast module
- about / mod_event_multicast
- port/address / Port/address
- bindings / Bindings
- TTL / TTL
- mod_event_socket module / The FreeSWITCH API (FSAPI)
- about / mod_event_socket
- functionality / mod_event_socket
- event socket settings, configuring / Configuring event socket settings
- events, reading / Reading events
- event information / Minimum event information
- events, sending / Sending events
- socket, Dialplan application / Events from the Dialplan
- mod_flite module / Step 1: Edit modules.conf, Getting started with Lua
- mod_gsmopen module / Skype and GSM endpoints, GSM with mod_gsmopen
- mod_gsmopen module, GSM
- about / GSM with mod_gsmopen
- mod_lua / Getting started with Lua
- mod_nibblebill module
- about / Nibblebill
- use cases / Use cases
- design goals / Design goals
- configuring / Installation and configuration
- installing / Installation and configuration
- database table, creating for PostgreSQL / Creating the database table for PostgreSQL
- database table, creating for MySQL / Creating the database table for MySQL
- call billing methods / Billing a call
- examples / Examples, Single rate for all users , Different rates per service delivery , Hang up the call when the balance is depleted
- funds, deducting / Adding and deducting funds
- funds, adding / Adding and deducting funds
- session heartbeat, enabling / Enabling session heartbeat
- mod_nibblebill module, examples
- different rates per user / Different rates per user
- single rates, for all users / Single rate for all users
- different rates, per area code / Different rates per area code
- different rates, per service delivery / Different rates per service delivery
- call hangup / Hang up the call when the balance is depleted
- mod_skyopen module, Skype
- about / Skype with mod_skypopen
- mod_skypopen module / Skype and GSM endpoints, Skype with mod_skypopen
- mod_sofia command / XML Dialplan commands
- mod_sofia module / mod_sofia
- mod_voicemail module / Voicemail, Voicemail request
- mod_xml_curl / Understanding the FreeSWITCH user directory
- mod_xml_curl module
- about / XML/Curl
- installing / Installation
- configuring / Configuration
- Dialplan bindings / Dialplan bindings
- not found message / General "Not found" reply
- debugging / Debugging
- failing back / Failing back
- mod_xml_curl module, configuring
- about / Configuration
- bindings / Bindings
- HTTP requests / HTTP requests
- HTTP response / HTTP response
- optimization / Optimization
- requests, order / Order of requests
- response, examples / Request/response examples
- request, examples / Request/response examples
- mod_xml_rpc module
- about / The FreeSWITCH API (FSAPI)
- mod_yaml module
- about / YAML
- moh-sound option / Conference profiles
- mon variable / Special condition variables
- MSVC / Windows
- FreeSwitch, building / Building the solution with MSVC/MSVCEE
- MSVCEE / Windows
- FreeSwitch, building / Building the solution with MSVC/MSVCEE
- multi-party conferencing application
- about / Multi-party conferencing
- multi-tenancy / Contexts
- multi-user conferencing, FreeSWITCH
- about / Multi-user conferencing
- mod_conference module / Multi-user conferencing
- callers, connecting to conference / Connecting callers to the conference
- active conferences, controlling / Controlling active conferences
- muted-sound option / Conference profiles
- mweek variable / Special condition variables
- MySQL
- database table, creating / Creating the database table for MySQL
N
- <nomatch> tag / Phrase Macro examples: voicemail
- name attribute / Extensions, Creating a new extension
- network_addr variable / Special condition variables
- never flag / Conditions
- new($fd) command / new($fd)
- new($host, $port, $password) command / new($host, $port, $password)
- nextHeader() function / nextHeader()
- nibblebill action / Inline execution
- nibble_account variable / Nibble method (default)
- nibble_rate variable / Nibble method (default)
- noevents command / noevents
- nolog command / nolog
- nomedia command / nomedia
- Notepad++ text editor / Text editors and XML
- not found message, mod_xml_curl module / General "Not found" reply
- numrows() method / Connecting to a database with LuaSQL
O
- odbc_query action / Inline execution
- onInput function / Conditions and looping
- OpenZAP
- operating system, FreeSWITCH environment
- about / Operating system
- prerequisites / Operating system prerequisites
- Linux / Linux/Unix
- Unix / Linux/Unix
- originate command / Dialstring formats, Channel variables and call setup
- outbound_caller_id_name variable / User features
- outbound_caller_id_number variable / User features
P
- <param> tag / Conference profiles
- <profile> tag / Conference profiles
- params element / User features
- password parameter / Configuring event socket settings
- pattern matching / Regular expressions
- pause command / Pause
- PCRE / Step 2: Run configure script, Regular expressions, Lua patterns versus regular expressions
- Perl Socket connections
- about / Perl Socket connections
- perpetual-sound option / Conference profiles
- phases, XML Dialplan
- executing / How Dialplan processing works
- parsing / How Dialplan processing works
- PHP Socket connections
- about / PHP Socket connections
- Phrase Macros
- calling / Calling Phrase Macros
- examples / Phrase Macro examples: voicemail
- syntax / Phrase Macro examples: voicemail
- creating / Conditions and looping
- Phrase Macros layer
- about / Voicemail
- phrases
- IVR, using / Using phrases with IVRs
- pin-sound option / Conference profiles
- pin parameter / Conference profiles
- playAndGetDigits method / Simple IVR—interacting with the caller
- playback application
- about / Creating a new extension, playback
- play_and_get_digits application
- about / play_and_get_digits
- please_hold extension / Features
- PocketSphinx / Building the solution with MSVC/MSVCEE
- Polycom phones
- about / Polycom phones
- PortAudio
- about / Snom phones
- PostgreSQL
- database table, creating / Creating the database table for PostgreSQL
- POTS / A revolution has begun and secrets have been revealed
- presence action / Inline execution
- pronounced method / Creating a new extension
- public.xml file / FreeSWITCH XML Dialplan elements
- public/ directory / FreeSWITCH XML Dialplan elements
- public context / Public, Contexts
Q
- /quit command / Controlling FreeSWITCH with the CLI
R
- rate parameter / Conference profiles
- rdnis variable / Special condition variables
- recvEvent() command / recvEvent()
- recvEventTimed($milliseconds) command / recvEventTimed($milliseconds)
- regex command / Regular expressions
- regular expressions / Important concepts to understand
- about / Regular expressions
- versus Lua patterns / Lua patterns versus regular expressions
- reloadxml command / The XML registry, Adding a user, Groups of users
- request, mod_xml_curl module
- mod_sofia / mod_sofia
- ACL / ACL
- authorization / Authorization
- mod_voicemail module / Voicemail request
- reset command / Reset
- response, mod_xml_curl module
- mod_sofia / mod_sofia
- authorization / Authorization
- mod_voicemail module / Voicemail request
- resume command / Resume
- RHEL / Operating system
- ROUTE phase / Putting it all together
- ROUTE state / Hunting versus executing
S
- say application
- about / Creating a new extension, say
- Say module
- scripts subdirectory / Running Lua scripts from the Dialplan
- send($command) command / send($command)
- sendEvent($send_me) command / sendEvent($send_me)
- sendevent command / Sending events
- sendmsg <uuid> command / sendmsg <uuid>
- sendRecv($command) command / sendRecv($command)
- send_display command / XML Dialplan commands
- serialize([$format]) function / serialize([$format])
- session
- about / Important modules: Endpoint and Dialplan
- ready() method / Conditions and looping
- session object / Basic Lua syntax
- set action / Inline execution
- set application
- about / set
- setAsyncExecute($value) command / setAsyncExecute($value)
- set command / Inline execution
- about / Set versus export
- versus export command / Set versus export
- setEventLock($value) command / setEventLock($value)
- setInputCallback method / Conditions and looping
- setPriority([$number]) function / setPriority([$number])
- set_global action / Inline execution
- set_profile_var action / Inline execution
- show calls command / Controlling FreeSWITCH with the CLI
- show channels command / Controlling FreeSWITCH with the CLI
- SIP
- about / Important modules: Endpoint and Dialplan
- contact parameters / SIP contact parameters
- SIP module
- about / Important concepts to understand
- SIP phone
- configuring / Configuring a SIP phone to work with FreeSWITCH
- settings / SIP settings
- X-Lite soft phone / X-Lite softphone
- hard phones / Hard phones
- SIP profiles
- about / SIP profiles and user agents
- Skype
- and GSM / Skype and GSM endpoints
- mod_skyopen module / Skype with mod_skypopen
- Skypopen
- about / Skype with mod_skypopen
- URL / Skype with mod_skypopen
- slash commands, fs_cli utility
- /help / Controlling FreeSWITCH with the CLI
- about / Controlling FreeSWITCH with the CLI
- /exit / Controlling FreeSWITCH with the CLI
- /quit / Controlling FreeSWITCH with the CLI
- /bye / Controlling FreeSWITCH with the CLI
- /log / Controlling FreeSWITCH with the CLI
- /debug / Controlling FreeSWITCH with the CLI
- sleep action / Inline execution
- sleep application
- about / sleep
- Snom 300 / Snom phones
- Snom phones
- about / Snom phones
- Snom 300 / Snom phones
- socketDescriptor() command / socketDescriptor()
- Sofia / XML Dialplan commands
- Sofia-SIP
- sofia/ parameter / XML Dialplan commands
- sofia_contact command / SIP contact parameters
- soft phone
- sound-prefix parameter / Conference profiles
- source variable / Special condition variables
- status command / Starting FreeSWITCH, Controlling FreeSWITCH with the CLI
- status FSAPI function / The FreeSWITCH API (FSAPI)
- streamFile method / Building voice applications
- string conditioning
- about / String conditioning
- example / String conditioning
- suppress-events parameter / Conference profiles
- SVN client / Linux/Unix, Building from the latest code
- SWIG
- URL / Supported libraries
T
- 408-Timeout error / X-Lite softphone
- TDM / TDM with OpenZAP and FreeTDM
- telephony revolution
- test calls
- single phone / Test calls for a single phone
- multiple phones / Test calls for two or more phones
- test calls, for multiple phone
- call, parking / Parking a call
- conference, calling / Calling a conference
- test calls, for single phone
- IVR demonstration / Demonstration IVR
- info application / The "Information" application
- Tetris
- tone generator, example / Important concepts to understand
- Text-To-Speech (TTS) module / The FreeSWITCH design: modular, scalable, and stable
- text editors, FreeSWITCH environment
- Emacs / Text editors and XML
- vi / Text editors and XML
- Notepad++ / Text editors and XML
- TGML
- three-way call / Important concepts to understand
- timeout attribute / timeout
- toll_allow variable / User features
- TortoiseGit
- TortoiseSVN
- transfer application / IVR menu destinations, XML Dialplan commands
- TTL / TTL
- tts-engine attribute / tts-engine
- tts-engine parameter / Conference profiles
- tts-voice attribute / tts-voice
- tts-voice parameter / Conference profiles
- TTS engine
U
- <user> elements / Understanding the FreeSWITCH user directory
- UNIX
- FreeSWITCH, compiling / Compiling FreeSWITCH for Linux/Unix/Mac OS X
- Unix / Linux/Unix
- unmuted-sound option / Conference profiles
- unset action / Inline execution
- use cases, mod_nibblebill module
- billing (pre-pay) / Billing (pre-pay)
- billing (post-pay) / Billing (post-pay)
- pay-per-call service billing / Pay-per-call service billing
- fraud, preventing / Maximum credit and/or fraud prevention
- maximum credit / Maximum credit and/or fraud prevention
- user
- adding, to FreeSWITCH user directory / Adding a user
- XML file, creating for / Adding a user
- user@domain / Understanding the FreeSWITCH user directory
- user element / User features
- user_context variable / User features
- uuid variable / Special condition variables
V
- variables
- passing, call headers used / Passing variables via call headers
- variables, FreeSWITCH
- utilizing / Utilizing variables
- testing, regular expressions used / Testing variables with regular expressions
- caller profile fields / Caller profile fields
- channel variables / Channel variables
- global variables / Global variables
- variables, FreeSWITCH user directory
- toll_allow / User features
- accountcode / User features
- user_context / User features
- effective_caller_id_name / User features
- effective_caller_id_number / User features
- outbound_caller_id_name / User features
- outbound_caller_id_number / User features
- callgroup / User features
- variables element / User features
- verbose_events action / Inline execution
- version command / Starting FreeSWITCH, Controlling FreeSWITCH with the CLI
- vi text editor / Text editors and XML
- voice applications, FreeSWITCH
- building / Building voice applications
- IVR, interacting with caller / Simple IVR—interacting with the caller
- looping / Conditions and looping
- conditions / Conditions and looping
- voicemail
- testing / Testing voicemail
- voicemail application / IVR engine overview
- voicemail_enter_pass macro / Phrase Macro examples: voicemail
- voicemail_goodbye macro / Phrase Macro examples: voicemail
- voicemail_message_count macro / Phrase Macro examples: voicemail
W
- waste option / Conference profiles
- wday variable / Special condition variables
- web call
- making, curl used / Making a web call with curl
- Web GUIs
- about / Web GUIs
- Web GUIs, FreeSWITCH
- WikiPBX / WikiPBX
- FreePBX / FreePBX v3
- FusionPBX / FusionPBX
- 2600hz project / 2600hz
- week variable / Special condition variables
- WGET / Linux/Unix
- while loop / Conditions and looping
- WikiPBX
- Windows
- requisites / Windows
- FreeSwitch, compiling / Compiling FreeSWITCH for Windows
- Windows executable files
- versus Linux/Unix executable files / Controlling FreeSWITCH with the CLI
- WinRAR
- URL / Windows
- WinZip
- URL / Windows
X
- X-Lite
- X-Lite soft phone
- about / X-Lite softphone
- configuration error / X-Lite softphone
- X-PRE-PROCESS tag / Global variables
- XML
- alternatives / Alternatives to XML
- XML Dialplan, scenarios
- about / XML Dialplan cookbook
- IP address verification, number dialling / Match by IP address and call a number
- called number, matching with IP address / Match IP address and Caller ID
- called number, matching / Match number and strip digits, Match number, strip digits, and add prefix
- digits, capturing / Match number and strip digits, Match number, strip digits, and add prefix
- prefix, adding / Match number, strip digits, and add prefix
- registered devices, bridging to / Call registered device
- user authentication, verifying / Check for authenticated user
- DIDs, routing to extensions / Route DIDs to extensions
- local extension, trying / Try a local extension, failback to voicemail
- XML Dialplan module
- about / Important modules: Endpoint and Dialplan, General Dialplan concepts, XML Dialplan module review
- contexts / Important concepts to understand
- using / Important concepts to understand
- condition variables / Special condition variables
- inline execution / Inline execution
- pitfalls / Pitfalls to avoid
- commands / XML Dialplan commands
- functions / Dialplan functions
- XML registry
- about / The XML registry
- configuration section / The XML registry
- dialplan section / The XML registry
- directory section / The XML registry
- phrases section / The XML registry
- XMPP events
- sending / Sending and receiving XMPP events
- receiving / Sending and receiving XMPP events
Y
- YAML
- about / YAML
- yday variable / Special condition variables
- year variable / Special condition variables
Z
- 7-Zip
- URL / Windows