Module dialplan_tools

Access to dialplan applications.

This module provides access to various dialplan applications. An understanding of how these applications are used in FreeSWITCH dialplans is essential in order to properly use the actions in this module.

Info:

  • Copyright: 2011-2015 Chad Phillips
  • Author: Chad Phillips

Actions

bridge Bridges the current Jester channel with another endpoint.
execute Execute dialplan applications.
transfer Transfer to another extension in the dialplan.


Actions

bridge
Bridges the current Jester channel with another endpoint.

Note that many characteristics of the bridge can be controlled by setting various channel variables prior to the bridge. Check the FreeSWITCH wiki for more information on the available channel variables, and core_actions.set_variable for setting channel variables from Jester.

  • action string bridge
  • channel string The channel to use for the bridge. Can be a string (used for all extensions), or optionally a table of multiple channels (used with the matching extension in the extension table). Be sure to include everything up to the actual extension, including trailing slash and any dial prefix.
  • extension string The extension to bridge to. Can be a string (used for all channels), or optionally a table of multiple extensions (used with the matching channel in the channel table).
  • hangup_after_bridge bool (Optional) If set to true, the call will be hungup after the bridge completes. Note that all sequences registered for the exit and hangup loops will still be run.
  • multichannel_type string (Optional) If multiple channels or extensions are specified, this setting determines how they will be connected. 'first_wins' rings all channels until the first responds with media, then bridges that channel. 'sequential' rings each channel in succession, bridging the first one that responds with media. Default is 'first_wins'.
  • variables tab A table of channel variables to set for the bridge, key = variable name, value = variable value. Can be a single table (used for all channels), or optionally a table of variable tables (used with the matching channel in the channel list).

Usage:

    {
      action = "bridge",
      channel = "sofia/internal/",
      extension = {
        "1005",
        "1006",
      },
      hangup_after_bridge = true,
      multichannel_type = "first_wins",
      variables = {
        foo = "bar",
      },
    }
execute
Execute dialplan applications.

This action provides access to execute any dialplan application via Jester. Note that key presses will not be recognized during the execute action, use the various play and record actions to allow capturing of key presses.

  • action string execute
  • application string The application to execute.
  • data string (Optional) Data to pass to the application.

Usage:

    {
      action = "execute",
      application = "execute_extension",
      data = "set_up_call",
    }
transfer
Transfer to another extension in the dialplan.

This action is used to transfer to another extension in the dialplan. Prior to the transfer, the active sequence stack is cleared.

  • action string transfer
  • context string (Optional) The context to transfer to. Default is the current context.
  • dialplan string (Optional) The dialplan to transfer to. Default is 'XML'.
  • extension string The extension to transfer to.

Usage:

    {
      action = "transfer",
      context = "example",
      dialplan = "XML",
      extension = "101",
    }
generated by LDoc 1.4.6 Last updated 2018-11-07 21:33:15