Introduction, Tutorials, Examples

Welcome to FreeSWITCH™, the future of telephony. You are now muted.

This online documentation will parallel the ongoing development by the FreeSWITCH™ core development team in concert with contributions from the open source user community. When a new version is released a snapshot of this online document will be copied to a static online version at the same time to provide a reference in the future to those still running older code. This online reference will always track the latest version of code available from the git repository.


The online educational guide introduces system administrators who are new to the FreeSWITCH™ Community Project to the architecture, standards, and best practices to get you up and running quickly and to avoid trouble in the future.

The upper group of links in the outline to the left help you learn about FreeSWITCH.


The online reference provides usage prototypes and examples for the channel variables, dialplan applications, and API commands that can be accessed via E.S.L. (the Event Socket Layer) or with scripts written in Lua, Perl, and others. The reference section will also present a list of changes published periodically to document bug fixes, patches, and feature additions. The lower group of links in the outline to the left provide reference information to configure and experiment with FreeSWITCH.

Reference documentation of core API functions can be found on FreeSWITCH Tech Reference.


The back-end Atlassian databases have been merged to allow single sign-on. From now on please log in with your JIRA credentials to access JIRA, Confluence, Stash, Fisheye, and all other development platforms.

Because FreeSWITCH is an open source community project, if you find incorrect or outdated information you are obligated to correct it or report it to the document maintainers so that we all benefit from your keen observation. Feel free to log in with your JIRA credentials to leave an informative comment at the bottom of the page that needs updating.

To create an account to use here on Confluence, sign up at

Search FreeSWITCH Wiki

Featured Pages

Recently Updated Pages