Dialplan functions

Dialplan functions are small pieces of functionality that run real-time when processing Dialplan conditions. They can be used to gain a little more control and flexibility when writing your condition statements.

Dialplan functions can actually be used elsewhere—not just in the Dialplan. They are not related to XML—they can be used anywhere that a FreeSWITCH string processor is invoked. Examples of other places they may appear include external scripts that execute and set variables, bridge and transfer applications, and so on.

The general format for Dialplan functions is:

${api_func(api_args ${var_name})}

Where the api_func function is the name of the Dialplan function, api_args is the name of the arguments to pass to the function, and ${var_name} is an optional variable name to pass to the function. The format and expected parameters for api_args vary depending on the function being used. Each available Dialplan function is explained in more detail in the following sections...