com.cultofbits.integrationm.service.actionpack

Interface SmsActionPack

All Known Implementing Classes:

SmsActionPackTwilio

public interface SmsActionPack

Action pack for sending SMSs
The action pack should be configured in com.cultofbits.integrationm.service.properties file with the sms key.

Minimum props are:

  action.names=...,<sms-ap-name>

  action.<sms-ap-name>=sms

  # For Twilio Provider
  action.<sms-ap-name>.provider=twilio
  action.<sms-ap-name>.twilio.sid=<Twilio Service Id>
  action.<sms-ap-name>.twilio.token=<Twilio Token>
  action.<sms-ap-name>.twilio.default-from=<Twilio account phone number>
 

More props will be configured depending on the provider

Recomended sms-ap-name: sms

In case <sms-ap-name> is sms, in the IntegrationM scripts, you can refer to it only by `sms.send(...)` otherwise you have to refer to it using `actionpacks.<sms-ap-name>.send(...)`

Method Summary

Modifier and Type	Method and Description
void	send(String text, List<String> to, Map<String,Object> options) Sends a sms to the provided destination.

Method Detail

send

void send(String text,
          List<String> to,
          Map<String,Object> options)

Sends a sms to the provided destination.

Parameters:

text - the sms content

to - a list of one or more phone numbers to send the message to

options - an options map.
The available options are:

• from: a specific phone number to use as the sender. If no from is defined then the default number configured in action.sms.<provider>.default-from will be used.