WhatsApp Gupshup
- Luna Gil (Unlicensed)
- uContact dev
- Aylen Martinez (Unlicensed)
Configurar Gupshup en uContact es un proceso sencillo, pero primero se debe verificar que se posea todo lo requerido para crear un proveedor y campaña.
Requerido:
Cuenta configurada con acceso en Gupshup.
Crear una App.
Ingresar a uContact con un usuario con permiso para crear campañas y marcadores SMS.
Poseer una IP Pública para redireccionamiento de tráfico de uContact.
Habilitar el NGINX.
Contenido
- 1.1 1. Configurar cuenta
- 1.2 2. Crear proveedor en uContact
- 1.3 3. Crear campaña
- 1.4 Interactive button list
- 1.5 Interactive list
- 1.6 Templates
- 1.7 Contact
- 1.8 Location
- 1.9 Call to Action
- 1.10 NGINX
- 2
1. Configurar cuenta
También se configuran los webhooks de uContact para que Gupshup mande los mensajes y estados al portal.
https://<instancename>.ucontactcloud.com/Integra/resources/Gupshup/event
2. Crear proveedor en uContact
Ingresa a uContact con un usuario con permisos para crear proveedores de SMS.
Luego nos dirigimos a Administrador → Proveedores → SMS
Seleccionamos Gupshup de la lista de proveedores y completamos los campos:
Nombre
Para identificar al proveedor.user
Nombre de la App.password
API Key de Gupshup.sms from
Número de WhatsApp sin puntos, ni espacios, ni signos.Mensajes por segundo
Limite de mensajes que serán enviados por segundo por el proveedor.
ID de la aplicación
ID de la App de Gupshup.
Mensajes por segundo Si es 0 no limita la cantidad de mensajes que se podrán enviar por segundo
ID de la aplicación Se puede encontrar en Panel de Control / {Tu app} → Configuración → ID de la aplicación
3. Crear campaña
Seleccionar un proveedor Gupshup.
Colocar nombre de la app en el campo puerto.
NGINX debe ser modificado para que responda los eventos cuando se agrega la URL en Gupshup.
Para ello se debe agregar el siguiente párrafo en el archivo "/etc/nginx/sites-enabled/default"
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;}
Interactive button list
Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)
Tipo Buttons:
body: texto
header;texto(si es tipo TEXT)
type VIDEO/IMAGE/DOCUMENT/TEXT
filename (si es tipo DOCUMENT)
buttons: 1 a 3
ID - title - description
footer: texto
Todo lo qué se muestra en negrita es obligatorio.
Ejemplo:
|
|---|
Interactive list
Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)
Ejemplo sin titulo para opciones:
Ejemplo con titulo para opciones:
|
|---|
Para poder enviar hsm's, debe ser por medio de un ID. Este ID se obtiene realizando una petición HTTP.
GET https://api.gupshup.io/wa/app/<App id>/template<>$
HEADERS apikey: <api_key>
El app id y api key son los mismos parámetros que se utilizan al configurar un proveedor de Gupshup en uContact.
Templates
Las plantillas de mensajes pueden ser una herramienta valiosa para iniciar conversaciones con los usuarios. Las plantillas de texto se pueden acceder en la ventana de configuración del proveedor y utilizar en el buzón junto con respuestas predefinidas. En este proceso, es esencial reemplazar los marcadores de posición con los valores específicos requeridos como variables.
Sincronizar: Al hacer clic en este botón, se obtendrán todas las plantillas aprobadas de tipo texto asociadas a la cuenta. Una vez que la sincronización se realice con éxito, los miembros de la campaña podrán utilizar estas plantillas como respuestas prearmadas.
Eliminar: Este botón se utiliza para eliminar permanentemente todas las plantillas de la base de datos del proveedor en uContact.
Ejemplos de templates:
Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)
|
|---|
|
|---|
|
|---|
|
|---|
Contact
Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)
contact;firstName;formattedName;phone;type;:email;type;direction;type
Ejemplo:
|
|---|
Location
Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)
location;longitude,latitude;Nombre;direccion
Ejemplo:
|
|---|
Call to Action
Los botones de URL de CTA permiten a una marca asignar cualquier URL a un botón para que la URL sin formato no se incluya directamente en el cuerpo del mensaje interactivo. Después de recibir el mensaje, los consumidores pueden hacer clic en el botón CTA y el enlace proporcionado se abrirá en su navegador predeterminado.
El tipo puede ser video, imagen o texto.
Propiedad | Tipo | Requerido | Descripción |
|---|---|---|---|
body | texto | Si | Texto del mensaje |
type | texto | Si | Tipo del mensaje |
button_text | texto | Si | Texto presente en el botón |
url | texto | Si | URL donde se redirige el boton |
footer | texto | No | Footer del mensaje |
mediaUrl | texto | No* | Url del video o imagen. |
*Requerido si el tipo es imagen o video
{
"CTA":{
"body":"prueba",
"type":"video",
"button_text":"Visit page",
"footer":"footer",
"url":"https://www.net2phone.com/",
"mediaUrl":"https://elearning.ucontactcloud.com/attachments/20240909/86aa0229-2b7b-484a-8393-fc8a7c2bf020.uContact.mp4"
}
}NGINX
Para recibir los mensajes en uContact es necesario agregar el siguiente fragmento de código a la configuración de NGINX.
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;
}