Setting Up SMS for Salesforce

Retarus SMS for Salesforce enables effortless and intuitive text messaging. The seamless integration allows personalized text messages to be automated. Messages can be sent directly using Flow Builder, streamlining customer processes and enhancing satisfaction. The solution also supports instant direct replies and offers customizable features, allowing administrators to embed tailored components into the user dashboard to meet specific needs.

Developer: Retarus

Category: CRM, ERP Integration

Prerequisites

Valid Salesforce organization credentials
Valid SMS-for-Applications (REST API) account and credentials
The Retarus SMS for Salesforce Add-In

How to get started

1. Request Retarus SMS for Salesforce

Contact Retarus https://www.retarus.com/contact/.
Select Enterprise SMS from the Interest drop-down list and add the keywords Retarus SMS for Salesforce in the message field.
→ Retarus will contact you and provide you with the installation link.

This product is currently available as a beta version. It can be made available for testing but is not yet subject to versioning, continuous maintenance and contractual requirements (Retarus Terms and Conditions and SLA). However, we encourage customers and partners to share their usability needs with us, enabling us to deliver the best possible experience when using Retarus messaging products within Salesforce.

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 the Certificate field empty.
Select Named Principal for Identity Type.
Select Password Authentication for Authentication Protocol.
Enter the username and password with the credentials for the Retarus API.
Click Save.

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

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

Click the gear icon and select Edit Page.
On the edit page, find the Retarus - Send SMS component listed on the left side under Custom Components.
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 an entry, 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 the 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-Applications 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 Configure Footer in the right-side panel.
Find the 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 an 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.
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 the Advanced configuration section, you can set additional parameters (see the screenshot below).
Click Done.

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

7. Reporting via myEAS Portal

Admins can get a comprehensive overview in the myEAS Portal.
SMS report details like status and 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.