WhatsApp Gupshup
- Luna Gil (Unlicensed)
- uContact dev
- Carina Soca
Setting up Gupshup in uContact is a simple process, but first, you must verify that you have everything required to create a provider and campaign.
Required:
Account configured with access in Gupshup.
Create an App.
Login to uContact with a user with permission to create SMS campaigns and dialers.
Have a Public IP to redirect uContact traffic.
Enable NGINX.
1. Set up account
The uContact webhooks are also configured so that Gupshup sends the messages and statuses to the portal.
2. Create a provider on uContact
Log into uContact with a user with permissions to create SMS providers.
Then we go to Administrator → Providers → SMS
We select Gupshup from the list of providers and complete the fields:
Name
To identify the provideruser
Name of the App.password
Gupshup API Key.sms from
WhatsApp number without dots, or spaces, or signs.Messages per second:Â Limit of messages that will be sent by this provider per second.
Application ID
Gupshup App ID.
Messages per second If it is 0, it does not limit the number of messages that can be sent per second.
3. Create campaign
Select a Gupshup provider.
Put the name of the app in the port field.
Interactive button list
Tipo Buttons:
body: texto
header;texto(si es tipo TEXT)
type VIDEO/IMAGE/
DOCUMENT/TEXT
mediaUrl; https://<instancename>.ucontactcloud.com/attachments/
filename (si es tipo DOCUMENT)
buttons: 1 a 3
ID - title - description
footer: texto
Â
Â
Ejemplo:
|
|---|
Interactive list
Example without title for options:
Example with title for options:
|
|---|
Templates
Message templates can serve as a valuable tool to initiate conversations with users. Text-based templates can be accessed within the provider's configuration window and employed within the inbox alongside canned responses. In this process, it is essential to replace the placeholders with the specific values required as variables.
Synchronize: Clicking this button will fetch all the approved text-type templates associated with the account. Once the synchronization process is successful, campaign members can utilize these templates as canned responses.
Delete: This button is used to permanently remove all templates from the provider's in uContact.
Templates examples:
|
|---|
|
|---|
|
|---|
|
|---|
Â
Contact
contact;firstName;formattedName;phone;type;email;type;direction;type
Ejemplo:
|
|---|
Location
location;longitude,latitude;Nombre;direccion
Ejemplo:
|
|---|
Call to Action
CTA URL buttons allow a brand to map any URL to a button so that the raw URL is not directly included in the interactive message body. After receiving the message, consumers can click on the CTA button and the given link will be opened in their default browser.
The message type can be video, image or text.
Propiedad | Tipo | Requerido | Descripción |
|---|---|---|---|
body | text | Yes | Message text |
type | text | Yes | Message type |
button_text | text | Yes | Text present on the button |
url | text | Yes | URL where the button redirects |
footer | text | No | Message footer |
mediaUrl | text | No* | Image or video URL |
*Required if type is image or video
{
"CTA":{
"body":"prueba",
"type":"video",
"button_text":"Visit page",
"footer":"footer",
"url":"www.net2phone.com",
"mediaUrl":"<https://elearning.ucontactcloud.com/attachments/20240909/86aa0229-2b7b-484a-8393-fc8a7c2bf020.uContact.mp4>"
}
}NGINX
To receive the messages un uContact is necessary to add the following code snippet to your NGINX configuration.
location /Integra/resources/Gupshup{
proxy_pass http://localhost:8085;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}Â