SMS

Function

This module enables you to send outbound SMS messages.

This module requires a Plum DEV account with SMS-enabled, non-PCI phone numbers.

Don't have Plum DEV yet? Contact us to get set up!

Input Fields

As shown in the following image, this module first displays fields for Plum DEV account authentication:

1. Username

2. Password

Username & Password

Enter your Plum DEV account credentials in these fields, then select Authenticate. If authentication is successful, the module will display your username with a checkmark. As shown in the following image, additional fields will also be displayed:

1. SMS Phone Number: Select one of your SMS-enabled phone numbers.

2. Recipient Phone Number: Strings and/or variables are accepted.

3. SMS Message: Strings and/or variables are accepted.

SMS Phone Number

Select the SMS-enabled number you will use to send your message(s). Phone numbers linked to your Plum DEV account will be listed for use.

IMPORTANT! Your SMS-enabled number must be non-PCI. SMS is unencrypted, which makes SMS messaging incompatible with PCI numbers and infrastructure.

Recipient Phone Number

Accepted values: Strings, variables.

Enter one phone number that will receive your message.

Format. The phone number may be entered with or without formatting. See the following list for some examples:

• Formatted: [phone]

• Unformatted: 2223456789

Adding variables. Any declared variables can be added to this field by selecting the plus sign (​), selecting a variable from the Variable Name dropdown box, and selecting Add. Note that this field will only accept one value for the recipient's phone number.

SMS Message

Accepted values: Strings, variables.

Enter the message to be sent. You can enter one or multiple values.

Adding variables. Any declared variables can be added to this field by selecting the plus sign (​), selecting a variable from the Variable Name dropdown box, and selecting Add.

Module Settings

Hold Music

Enable this setting to play audio while an end-user is on hold. To upload a file for hold music, go to Application Settings > Connection Settings > Webservices > Webservice fetch audio Note: For the SMS module, this setting's effects will likely be noticeable only when servers are busy.

Timeout Length

Allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies to modules that fetch outside scripts, like the SOAP, REST, or Subdialog modules. Default value is 30 seconds. Minimum is 1 second. Maximum is 120 seconds.

Private

Controls the logging function of a module. Enabling this setting instructs the module to not record, report, or retain information input to that module for reporting or any other purposes. When enabled, any information entered into a module during a call will be lost immediately when the call terminates. A critical setting for businesses that need to maintain PCI-DSS or HIPAA compliance. The module icon becomes grayed-out when this setting is enabled. More details here.

Show Custom Errors (SMS)

When enabled, this setting adds an Error transmitter to the module. As shown in the following image, this can be used to set an alternate call flow if an error is returned. Note: For sample errors returned on failure, see the SMS API page for DEV.