$SMSNotifyProvider

The $SMSNotifyProvider parameter must be set to the name of an installed "SMS::Send" module as a string, without the "SMS::Send" qualifier. For example, to use SMS::Send::RedOxygen you'd use:

  Set($SMSNotifyProvider, 'RedOxygen');

$SMSNotifyArguments

The $SMSNotifyArguments parameter must be set to a hash reference with the parameters the SMS:Send driver expects. The exact parameters will vary from driver to driver. The sample given in "CONFIGURATION" shows settings for "SMS::Send::RedSMS".

$SMSNotifyGetPhoneForUserFn

This config-overridable method is useful for filtering users to limit the recipients of a message. For example, you might want to return a user's phone number only when their local time is between 08:00 and 17:00.

If set, this variable must be either a function reference or a string that names a module with a function named GetPhoneForUser. In either case the variable is set in RT_SiteConfig.pm.

If defined this function must take an RT::User as the 1st argument and returns a phone number as a string. The default implementation looks up the RT::User's PagerPhone attribute, which is shown as Pager in the RT UI, but you can replace this with an LDAP query or whatever you want.

Two additional arguments are passed: the Ticket being operated on or undef if no ticket, and a user-defined hint extracted from the action argument if found as documented in SMS::Action::SMSNotify.

Return undef or the empty string if no phone number exists for a user. More than one phone number may be returned by returning an array (not an arrayref); all of them will be notified.

To set it as an anonymous function reference:

  Set($SMSNotifyGetPhoneForUserFn, sub {
    my ($user, $ticket, $hint) = @_;
    return $user->PagerPhone;
  });

Alternately and preferably if the above code were put in a function named GetPhoneForUser in a module named 'My::Module' with a matching 'package' declaration the configuration would be:

  Set($SMSNotifyGetPhoneForUserFn, 'My::Module');

Note that this method has full access to the RT system so write it carefully and don't trust user-supplied code.

$SMSNotifyErrorAlertFn

This config-overridable method lets you change this extension's error reporting for when SMSes fail to send. You might want this if you're using a pre-paid service and want to alert when you're out of credit, for example.

It works like $SMSNotifyGetPhoneForUserFn in that it can be set to a function reference or to the string name of a module with a function named 'ErrorAlert'.

The function (whether in a module or a func ref) must accept four arguments:

* The SMS::Send result code (non-zero) * The SMS::Send error message * The destination phone number * The destination RT::User or undef if none

The default implementation sends an email to the rt owner address.

Use with rt-crontool

This is an example of RT::Extension::SMSNotify use with rt-crontool in /etc/crontab format. The example presumes the existence of a template named 'SLA Alert SMS' and assumes that your local RT user is named 'requesttracker4'. There must be a user in the RT database with 'gecos' set to the local RT user Cron uses. The action argument specifies that notifications should be sent to all ticket AdminCc users/groups and queue AdminCc watchers. Action arguments are documented in RT::Action::SMSNotify.

The search filter is a TicketSQL expression. You can use the RT query builder to generate TicketSQL, but it's very limited so you will usually want to write your own. You can test it by pasting it into the Advanced search in RT. This search sends SMSes for any ticket with a due date set that's due 24-25 mins, 11-12 mins, or 3-5 mins from now. Since it runs every minute ("*/1"; could just be written as "*") this will generate one message for each of the first time ranges and two for the 2nd.

The crontab entry:

  */1 * *   *   *   requesttracker4   rt-crontool --transaction last --search RT::Search::FromSQL --search-arg "(Status='new' OR Status='open') AND (Due > 'Jan 1, 1970') AND ((Due < '25 minutes' AND Due >= '24 minutes') OR (Due < '12 minutes' AND Due >= '11 minutes') OR (Due < '5 minutes' AND Due >= '3 minutes'))" --action RT::Action::SMSNotify --action-arg "TicketAdminCc,QueueAdminCc" --template 'SLA Alert SMS'

If you want to test sending messages from cron use a simple search for ticket ID, eg:

    rt-crontool --search RT::Search::FromSQL --search-arg 'Id = 1033' --action RT::Action::SMSNotify --action-arg "TicketAdminCc,QueueAdminCc" --template 'SLA Alert SMS'

or to send direct to a specified phone number:

    rt-crontool --search RT::Search::FromSQL --search-arg 'Id = 1033' --action RT::Action::SMSNotify --action-arg "p:+1234123132" --template 'SLA Alert SMS'