SMSMode Connection Package

Last modified on 2022/12/20 11:15
Contents

From: Self Help versions Oxygen and later

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. Open url.png 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. Open url.png 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

         SMSMode connexion package tree.png

(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

  • status: Return code of the query.
  • description: Error message if any.
  • balance: Number of remaining SMS.

SMS

Send SMS to Group    (alias: SMSmodeSendtoGroup)
Input parameters (mandatory parameters in bold)

  • message: Text of the message to be sent.
    • Maximum 160 characters per SMS.
  • groupName: Name of the group containing the recipients' phone numbers.
    • Note: You must first create the group in the SMSMode account.
  • classe_msg: Type of message.
    • 2 (default value): Professional SMS.
    • 4: SMS with authorized reply. Note: This option is available only in France.
  • refClient: Optional customer data returned with the automatic delivery report callback.
    • Maximum 40 characters.
    • You can use this data to tag the query using your own ID.
  • emetteur (Note: Only if the type of message is 4): Text used to customize the SMS sender.
    • Maximum 11 characters.
    • Accents, spaces and phone numbers are not authorized.
  • nbr_msg: Maximum number of SMS.
    • The message will be truncated if this limit is exceeded.
    • Default value: 5.
  • notification_url: Callback URL to be used to notify your system when the delivery report is updated.
  • notification_url_reponse: Callback URL to be used to notify your system when an incoming message is received.
  • stop: Used to manage STOP SMS text.
    • 0 (default value): The STOP SMS text will not be added to the SMS.
    • 1: The STOP SMS text will be added to the SMS only if the authorized length of the message is not exceeded.
    • 2: The STOP SMS text will be added to the SMS irrespective of the authorized length of the message.
Output parameter

  • status: Return code of the query.
  • description: Error message if any.
  • smsID: ID of the SMS sent, used for monitoring and acknowledging the SMS received.
Send SMS to Number    (alias: SMSmodeSendtoNumber)
Input parameters   (mandatory parameters in bold)

  • message: Text of the message to be sent.
    • Maximum 160 characters per SMS.
  • number: Phone number in international format.

    example   0033

  • classe_msg: Type of message.
    • 2 (default value): Professional SMS.
    • 4: SMS with authorized reply. Note: This option is available only in France.
  • refClient: Optional customer data returned with the automatic delivery report callback.
    • Maximum 40 characters.
    • You can use this data to tag the query using your own ID.
  • emetteur (Note: Only if the type of message is 4): Text used to customize the SMS sender.
    • Maximum 11 characters.
    • Accents, spaces and phone numbers are not authorized.
  • nbr_msg: Maximum number of SMS.
    • The message will be truncated if this limit is exceeded.
    • Default value: 5.
  • notification_url: Callback URL to be used to notify your system when the delivery report is updated.
  • notification_url_reponse: Callback URL to be used to notify your system when an incoming message is received.
  • stop: Used to manage STOP SMS text.
    • 0 (default value): The STOP SMS text will not be added to the SMS.
    • 1: The STOP SMS text will be added to the SMS only if the authorized length of the message is not exceeded.
    • 2: The STOP SMS text will be added to the SMS irrespective of the authorized length of the message.
Output parameter

  • status: Return code of the query.
  • description: Error message if any.
  • smsID: ID of the SMS sent, used for monitoring and acknowledging the SMS received.

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.

Step 1: Import the connection package to Self Help.

1. Download the file below to your workstation.

  SMSMode connection package

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. Open url.png See the procedure.

2. Open the Self Help SMSMode project.

3. Right-click the oSetup.auth.accessToken project variable and select Update.

          accessTocken project variable initialization - menu.png

4. Paste the value of the API key in the Macro body field.

          accessTocken project variable initialization - paste value.png
 

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.
         Access Key SMSMode.png

Use case: How to send an SMS to a recipient

     Open url.png See the detailed procedure.
         Use case - Send a SMS procedure.png

List of files to download

Tags:
Powered by XWiki © EasyVista 2022