SMS Gateway
| Please see CS4OutlookAdminConfig.xml for the variables of the SMS Gateway. |
In order to enable users to send the transfer password via SMS message to the recipients, it is necessary to provide a configuration that contains all necessary information. This includes the URL of the SMS gateway, the required parameters for communication with the gateway, and the expected response from the gateway. The configuration can be set up in such a way that it is either fixed or changeable by the user.
We support SMS Gateways that provide a HTTP/S API, accept requests of type GET or POST, and send a response of type application/json or text/plain.
Config Creator settings
Activate SMS gateway
This checkbox activates the possibility to send the transfer password via SMS message. The user is presented to send the transfer password via SMS message when choosing either the password option Generate password or Enter password.
Request type
Provides the request type to be performed when sending the SMS message. You have the option to choose between GET (no request body), POST_FORM (request body of type application/x-www-form-urlencoded) and POST_RAW (request body of type application/json).
Request body template (only for POST_RAW)
If the SMS gateway requires the parameters to be submitted in a JSON request body, you can define the JSON body template here. The following placeholders are available:
-
from: The sender’s full name in the format "First Name Last Name".
-
to: The recipient’s phone number as provided by the user.
-
message: The SMS message to be sent to the recipient.
All placeholders must be wrapped between two curly braces (e.g. CSOCurrent en). Example:
{
"senderName": "CSOCurrent en",
"recipient": "CSOCurrent en",
"content": "CSOCurrent en",
"custom": "parameter"
}
Use credentials
If the SMS gateway requires basic authentication as defined in RFC 7617, you can provide the credentials here.
HTTP parameters
Allows you to pass the SMS information as HTTP parameters, e.g. when using the request type GET or POST_FORM. In case of POST_FORM, the constructed query string is placed in the POST request body. For parameters such as an API key, activate the option Encrypt value so that is is not saved in plain text within the configuration file.
| Note that the encryption is not meant to be secure, and only serves the need of preventing access to the parameter by users. |
Response type
Specifies the form in which the SMS gateway’s HTTP response is expected. The options text/plain and application/json are available.
Expected response on success
Provides the expected response in order to indicate a successful SMS send operation. If the actual response does not match the expected response, an error message is displayed to the user. The input is evaluated as a regular expression. Therefore, it performs a regular full text search for regular input such as 100. You can make use of more complex expression, e.g. 100|101, if either number denotes a successful operation.
Response message location
(only for HTTP responses of the form application/json)
Provides the JSON property that holds the status code of the SMS send operation. Please provide the property path in JsonPath in order to reach nested structures. Please note that you must omit the usual "$." prefix because the response is implicitly treated as the "root member object".
Error message location
(only for HTTP responses of the form application/json)
Provides the JSON property that holds the error message in case of an erroneous response. Please provide the property path in JsonPath in order to reach nested structures. The specified error message is presented to the user if the actual response does not match the expected response. Please note that you must omit the usual "$." prefix because the response is implicitly treated as the "root member object".
