Module event

Interact with the FreeSWITCH event system.

This module provides actions for interacting with the FreeSWITCH event system.

Info:

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

Actions

fire_event Fires a custom event.


Actions

fire_event
Fires a custom event.

Event-Name will be 'CUSTOM', and Event-Subclass will be '[subclass]::[event_type]'.

The body will automatically have two newline characters appended to it.

  • action string fire_event
  • body string (Optional) The event body.
  • event_type string The second portion of the Event-Subclass header (after the double colons).
  • header_prefix string (Optional) Prefix all header keys with this string. Defaults to 'Jester-'.
  • headers tab (Optional) A table of event headers, key = header name, value = header description. Note that some headers will need to use the full table key syntax.
  • subclass string (Optional) The first portion of the Event-Subclass header (before the double colons). Default is 'jester'.

Usage:

    {
      action = "fire_event",
      body = "some message body, if you need it...",
      event_type = "messages_checked",
      header_prefix = "Checked-Messages-",
      headers = {
        Mailbox = mailbox,
        Domain = profile.domain,
        ["New-Message-Count"] = message_count,
      },
      subclass = "messages-checked",
    },
generated by LDoc 1.4.6 Last updated 2018-11-07 21:33:15