Skip to main content
Skip table of contents

Salesforce: Setting Up SMS for Salesforce

With Retarus SMS for Salesforce you can send text messages easily and intuitively. Through the seamless integration, text messages can be triggered directly and automatized in a personalized way by using Flow Builder, which accelerates customer processes and improves customer satisfaction.
The solution also supports quick direct responses and can be equipped with different functionalities depending on the user requirements for embedding custom components into the user dashboard by the administrator.

Developer: Retarus

Category: CRM, ERP Integration

Prerequisites

How to get started

1. Request Retarus SMS through AppExchange

  • Got to AppExchange and look for Retarus Enterprise SMS for Salesforce

  • Request Retarus Enterprise SMS for Salesforce

  • Retarus will contact you for providing test, agreements and credentials

image-20240813-125327.png

2. Create Named Credentials
  • From Setup, in the Quick Find box, enter Named Credentials, and then select Named Credentials.

  • Click New Named Credential

  • Enter a label for your Named Credential. The label can contain no spaces or special characters

  • (Optional) Enter a name for your Named Credential or use the system generated name.

  • Leave Certificate empty

  • Select Named Principal for Identity Type

  • Select Password Authentication for Authentication Protocol

  • Fill out username and password with the credentials for the Retarus API

  • Click Save

    image-20240618-143052.png

3. Configure LWC (Lightning Web Component) for Record Page

On the Record page (e.g., Account, Contact, ...)

  • Click the "gear" icon and select Edit Page

  • In the edit page find "Retarus - Send SMS" component from the left side list under custom component

  • "Drag and drop" the component onto any part of the page

  • In the "configuration panel" on the right side, select the name of the field where the phone number is stored

  • You can choose as Admin if the user should have permission to set values

  • Select the API (If you did not create Named Credentials, please read the previous step "Create Named Credentials")

  • You can also set the values in the "component configuration panel"

  • API Label: Provide a Name for the dashboard

  • Phone number field: choose e.g, "Mobilephone"

  • Allow user to set the log recipient: Number can be provided by the user

  • Allow user to set the log message: Message can be provided by the user

  • Allow the user to select the API: User can choose between several dashboards

  • Allow user to set the BillCode: User can provide a Billing Code in the dashboard, which is visible at reporting and invoice level

  • Allow the user to set Status Requested

  • Allow user to set the ValidityMin

  • Allow user to set the MaxParts

  • Allow the user to set the Quality of Service

  • Allow the user to set the JobPeriod

  • Name or Number of the sender: Set the name or number that should appear as the sender on the recipient's page

  • BillCode: Set a billing code that should be mapped to the user or user group

For more information please check the SMS-for-Application documentation.

4. Configure LWC (Lightning Web Component) for Screen Flow
  • In the "Screen Flow", add a new screen

  • Provide the name and label for your screen

  • Make sure to uncheck "Show Footer" under the "Configure Footer" in the right-side panel

  • Find "Retarus - Send SMS (Flow)" component from the left side list under "custom component"

  • Drag and drop the component onto any part of the screen

  • provide API Name (this is different than the API for Retarus)

  • You can also set the values in the component “configuration panel"

  • Click Done

5. Apex Action Configuration Editor in Screen Flow
  • Add an action in the flow

  • In the search bar type "SMS" and select "Send SMS"

    image-20240618-143448.png

  • Select an API (This is the API for Retarus - Named Credentials) 

  • You can configure the destination and message with either "reference values" or "actual values"

  • If you choose to send bulk SMS (only one message to multiple numbers), you need to insert a "collection variable reference" in the destination

  • In "advanced configuration section" you can set the other parameters (see the picture)

  • click Done

image-20240618-143547.png

6. How to send an SMS using Apex Code

The method sendSMS in the Class named Retarus should be used. You can check the example.

  • The following classes are set as global to give the developer the ability to send SMS directly in apex in the org where the package is installed.

  • SMSConfiguration

    • Retarus

    • JobStatus

      image-20240618-143656.png

      Example Code

7. Reporting via myEAS Portal
  • Admins can get a comprehensive overview in the myEAS Portal

  • SMS report details like status, status code can be reported by the related SMS Job ID

  • The status codes are described in the Retarus SMS for Application status code online documentation

image-20240813-152829.png

SMS Outbound Reporting in myEAS

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.