Hooks

This usage mode allows for the module actions to be performed when new channels are being created. A hook is defined as a combination of:

• filters - one can limit the eligible channels by FreeSWITCH context as well as direction (inbound or outbound);
• scope - whether the phone number the actions should be executed against is the caller, the destination or both;
• actions - one or more actions to execute against the scope;
• parameters - the parameters the action should use when executed. When omitted, they will be inferred from the default configuration;

One can define as many hooks as necessary; their definitions are located in module’s configuration file, in the <hooks> section, the syntax being outlined in the configuration documentation.

In this usage mode, the actions’ output will be returned in the form of channel variables; their naming is dictated by the responsible action as well as the scope. The table below outlines the channel variable names based on the executed action and the scope: