Configuration values for the parameters contain variable elements, which are replaced with corresponding values during SMS transmission. For example, ${cfg.user} is replaced with the “Account User Name” configuration value.
The following elements are required in the parameters string.
Element | Field Corresponding to Element |
$msg.address | User Attribute to Provide SMS Destination |
$msg.message | On-Demand Tokencode Message |
$cfg.user | Account User Name |
$cfg.password | Account Password |
The +, &, and = characters are reserved for use with value pairs in the parameters string, for example, text=${msg.message}&clientid=${cfg.user}.
If the +, &, or = characters are used in any name value data that is retrieved by the parameters string, you must enter the following elements in the parameter string:
Character | Element |
+ | ${plus} |
& | ${ampersand} |
= | ${equal} |
For example, if you want to include the + character with a foreign phone number, use the ${plus} element as follows: destaddr=${plus}${msg.address}
Configuration Example
In this example, an SMS provider requires message data in the following format:
This example requires the following configuration:
Configuration Parameter | Value |
Base URL | |
HTTP Method | GET |
Parameters | user=$cfg.user&password=$cfg.password&extraparam=123456&to=$msg.address&text=$msg.message |
Account User Name | john |
Account Password | doe123 |
Success Response Code | RESULT:OK |
Response Format | RESULT:OK |