SMSMode Connection Package
This package integrates a Self Help project providing a set of procedures or end points, for interfacing with the SMSMode API. The API is used to send SMS directly from theses procedures.
- The endpoints can only be used by parent procedures located in any other Self Help project within the domain.
- The package is shipped in a compressed folder that you must import to a Self Help domain.
Notes
- To use the SMSMode service, you must have an SMSMode account and an API key.
See the list of end points.
- The connection package can be used with any Self Help project.
- The package is not usable alone. Procedures in the package are called by parent procedures using an alias.
See the list of package procedures.
- Each end point has input / output parameters. Mandatory procedures are displayed in bold.
- A return code is returned by each package procedure.
- The name of the connection package archive indicates the service and date.
example SMSMODE | Integration | 202004
Contents of the connection package
(1): Global object used for configuring the connection package procedures.
(2): REST connector used by package procedures for exchanging information with the SMSMode service.
(3): Sample procedures and configuration test.
(4): Set of package end points grouped in two folders:
- Balance: Information on the number of remaining SMS.
- SMS: Procedures for sending SMS.
List of connection package endpoints
Balance
Get Remaining Balance (alias: SMSmodeGetBalance) | ||
---|---|---|
Input parameters: None |
Output parameter
|
SMS
Send SMS to Group (alias: SMSmodeSendtoGroup) | ||
---|---|---|
Input parameters (mandatory parameters in bold)
|
Output parameter
|
|
Send SMS to Number (alias: SMSmodeSendtoNumber) | ||
Input parameters (mandatory parameters in bold)
|
Output parameter
|
Return codes
Code | Description |
---|---|
0 | Successful. The message was accepted by the system. |
31 | Internal error |
32 | Authentication error |
33 | Insufficient account balance |
35 | Missing mandatory parameter |
50 | Temporarily unavailable |
Procedures
How to install the SMSMode connection package
Prerequisites.
- You must have an SMSMode account.
- You must have an SMSMode API key.
See the procedure.
Step 1: Import the connection package to Self Help.
1. Download the file below to your workstation.
2. Open the Desktop Studio in edit mode and import the file to the domain of your target Self Help project.
A new Self Help SMSMode project is created. All procedures in the package are automatically imported and added to the tree structure.
Step 2: Configure the Self Help SMSMode project.
1. Generate an SMSMode API key and copy it. See the procedure.
2. Open the Self Help SMSMode project.
3. Right-click the oSetup.auth.accessToken project variable and select Update.
4. Paste the value of the API key in the Macro body field.
Step 3: Test the Self Help SMSMode project.
1. Copy the [01] Examples folder to your target Self Help project.
2. Run the Send SMS procedure to check that it works correctly.
How to obtain an SMSMode API key
1. Log in to your SMSMode account.
2. Select Settings > Access key API.
3. Click Generate access key.
A new SMSMode access key will be generated.
Use case: How to send an SMS to a recipient
See the detailed procedure.
List of files to download
See the procedure for the installation.
.