Important

This documentation is deprecated, and only kept here to support users of browser extension APIs. If you are using Trigger.io for iOS or Android, see https://trigger.io/docs/.

sms: SMS messaging

The forge.sms namespace allows you to prompt the user to send SMS messages from your app.

Config

The sms module must be enabled in config.json

{
    "modules": {
        "sms": true
    }
}

API

send

Platforms: Mobile

Send an SMS message, optionally with one or more recipients and a message pre-filled in.

Example:

forge.sms.send({
  body: "Hello, World!",
  to: ["123457869", "328592835"]
}, function () {
  alert("Message sent");
});

sms.send(params, success, error)

Arguments:

• params (function()) -- Data to pre-fill SMS message with, contains body which is the content of the message, and to as either a string or array of phone numbers to send to.
• success (function()) -- callback to be invoked when no errors occur
• error (function(content)) -- called with details of any error which may occur