Skip to main content

FreeSWITCH : FreeSWITCH Explained

Start Here

Welcome to FreeSWITCH™, the future of telephony.

Introduction to newcomers to FreeSWITCH™.

Search is your friend

The sprint that copied remaining pages from the old mediawiki to Confluence has given us all the documentation fit to print, however they are not organized well. This means that the Table of Contents will look very different as pages are re-ordered to their final location. It is best to use the search function or click on a label (tag) to find related pages for now.

What Is FreeSWITCH?

FreeSWITCH™ is an open source carrier-grade telephony platform implemented as a back-to-back user agent. Because of this design it can perform a great number of different tasks from a PBX to transit switch, TTS (text-to-speech) conversion, audio and video conferencing host, and even a VoIP telephone and more.


Newcomers should start with the Introduction page in the table of contents and follow the child pages for further information. The documentation is not perfect so we rely on your help to improve it with suggestions from a fresh viewpoint.

Confluence Wiki

This online documentation wiki will parallel the ongoing development by the FreeSWITCH™ core development team in concert with contributions from the open source user community. This online reference will always track the latest version of code available from the git repository (with your help).

The wiki 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) with scripts written in Lua, Perl, and other languages. Pages tagged with the label "examples" provide reference information to configure and experiment with FreeSWITCH.Be sure to click on the labels to find pages that related to that topic.

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

Docs Team

Many of these pages are contributed by the FreeSWITCH™ community over the years, some might be out of date and would benefit from your improvement. Ask for editor access to Confluence to join the party! Details can be found on the Contributing Documentation page.


The most rapid way to start configuring FreeSWITCH™ is with the FreeSWITCH 1.8 book. Advanced topics are covered in the FreeSWITCH 1.6 Cookbook. Those and others are available at the Packt Publishing web site.

Dec, 28th: The search feature is being enabled and will be available shortly.


Connect with other members of the FreeSWITCH™ community via the mailing list, IRC channel, and Slack channel. See the Community page for that information.

Recent Labels

call-control, channel_variable, dialplan, interop, certificate, encryption, security, sofia, high-availability, sms, operating-systems, installation, dtmf

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 Confluence

Errors, Omissions, Updates

Because FreeSWITCH is an open source community project, if you find incorrect or outdated information you are obligated to report it to the document maintainers so that we all benefit from your keen observation. You can also help us by Contributing Documentation.

Search FreeSWITCH Wiki



KXUT670_fs.png (image/png)
book_reader_xp.png (image/png)
ABC_blocks_xp.gif (image/gif)