SMS integration: Difference between revisions

Latest revision as of 13:25, 14 November 2023

Integration with third-party systems
Resco CRM Connector (web APIs): REST API service OData service Questionnaire OData service Resco Cloud Client (NuGet) Connect Resco Cloud and Dynamics Business Central Power Automate Resco Cloud connector Resco Reports connector Integrations Glossary entry on integration Woodford configuration Documents (Box, Dropbox, OneDrive, SharePoint) Communication with external applications (via URL schemes) Email integration Exchange (email, calendar, contacts) ~~Google~~ (discontinued) DocuSign integration Marketing services (MailChimp, MailerLite, GetResponse) SMS integration GitHub integration (for Woodford customizations)

Resco Cloud can use Amazon Web Services (AWS) or an external SMS gateway to send short messages.

AWS

Before you can use AWS, you have to set it up:

Log in to Resco Cloud and start the Admin Console.
Select Settings > Organization from the menu and click Configure Organization SMS Integration.
As Outgoing SMS Mode, select "AWS".
Enter the details of your AWS, such as region, sender, access key, and security key.
Save all changes.
Optionally, click Send Test SMS to verify that your connection is set up correctly.

Once AWS is configured, the server can send out SMS.

You can use the function SendSms in server processes.
You can use SMS authentication when logging in to Resco Cloud. See Authentication for more information.

External SMS gateway

If you want to use a different SMS provider than AWS, that gateway has to support web requests.

Sending messages

Resco Cloud has server-side support for invoking basic web requests as a reaction to specific entity/field changes. It can be used for activating external services for sending text messages. It is possible to implement this by using the API of an external SMS gateway and then calling Server.InvokeWebRequest on Resco Cloud. This can be configured as a process in the Admin Console.

Receiving messages

Resco Cloud does not directly support receiving SMS. An SMS gateway receives the message, and it has to tell Resco Cloud what to do. If you want to receive an SMS to trigger some action on Resco Cloud (for example, create a record), you can explore the following approaches:

Use Resco Cloud's REST API function "Execute Workflow"
Use Power Automate connectors

The important part is that the SMS gateway has to support one of these integrations.

{{#CI form: title = Was this information helpful? How can we improve? | type = inputs | [textarea] }}

@@ Line 1: / Line 1: @@
 {{Integration TOC}}
-[[Resco Cloud]] can use an external SMS gateway to send and receive short messages.
+[[Resco Cloud]] can use Amazon Web Services (AWS) or an external SMS gateway to send short messages.
-== Sending messages ==
+== AWS ==
+Before you can use AWS, you have to set it up:
+# Log in to Resco Cloud and start the [[Admin Console]].
+# Select '''Settings > Organization''' from the menu and click '''Configure Organization SMS Integration'''.
+# As '''Outgoing SMS Mode''', select "AWS".
+# Enter the details of your AWS, such as region, sender, access key, and security key.
+# Save all changes.
+# Optionally, click '''Send Test SMS''' to verify that your connection is set up correctly.
+Once AWS is configured, the server can send out SMS.
+* You can use the function SendSms in [[server processes]].
+* You can use SMS authentication when logging in to Resco Cloud. See [[Admin_Console#Authentication|Authentication]] for more information.
+[[File:Send SMS function.png|alt=Server process on Resco Cloud that sends SMS via Amazon Web Services (AWS)]]
+== External SMS gateway ==
+If you want to use a different SMS provider than AWS, that gateway has to support web requests.
+=== Sending messages ===
 Resco Cloud has server-side support for invoking basic web requests as a reaction to specific entity/field changes. It can be used for activating external services for sending text messages. It is possible to implement this by using the API of an external SMS gateway and then calling Server.InvokeWebRequest on Resco Cloud. This can be configured as a '''[[Admin_Console#Processes|process]]''' in the [[Admin Console]].
-[[File:Sms in resco cloud.png|600px]]
+[[File:Sms in resco cloud.png|600px|alt=Using Server.InvokeWebRequest to send SMS via external gateway]]
-== Receiving messages ==
+=== Receiving messages ===
-Resco Cloud does not directly support receiving SMS. An SMS gateway receives the message and it has to tell Resco Cloud what to do. If you want to receive an SMS to trigger some action on Resco Cloud (for example, create a record), you can explore the following approaches:
+Resco Cloud does not directly support receiving SMS. An SMS gateway receives the message, and it has to tell Resco Cloud what to do. If you want to receive an SMS to trigger some action on Resco Cloud (for example, create a record), you can explore the following approaches:
 * Use Resco Cloud's REST API function "Execute Workflow"
 * Use [[Power Automate]] connectors
@@ Line 17: / Line 37: @@
+{{Feedback}}
 [[Category:Resco Cloud]]