Versions Compared

Old Version 15

changes.mady.by.user uContact dev

Saved on

compared with

New Version Current

changes.mady.by.user uContact dev

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

https://integra-scm.atlassian.net/l/c/qfuptKeA

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.

Tip

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

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse

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.

Mensajes por segundo Si es 0 no limita la cantidad de mensajes que se podrán enviar por segundo

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

Note

Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)

Tipo Buttons:

Note

Todo lo qué se muestra en negrita es obligatorio.

Ejemplo:

Button:

image;https://integraccs.ucontactcloud.com/attachments/20211015/214bc4ec-5be3-4c03-a1e9-df2b6efa969c.jpeg;texto de la imagen;la caption

1-Opción 1

2-Opción 2

3-Opción 3

Interactive list

Note

Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)

Ejemplo sin titulo para opciones:

List:

button: Boton de lista

body: Algo de texto

header: el header

title: Titulo de lista

1-Opción 1 - descripcion 1

2-Opción 2 - descripcion 2

3-Opción 3 - descripcion 3

4-Opción 4 - descripcion 4

footer:el footer

Ejemplo con titulo para opciones:

List:

button: Boton de lista

body: Algo de texto

header: el header

title: Titulo de lista

itemTitle: primera parte

1-Opción 1 - descripcion 1

2-Opción 2 - descripcion 2

itemTitle: segunda parte

3-Opción 3 - descripcion 3

4-Opción 4 - descripcion 4

footer:el footer

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/sm/api/v1/template/list/<app_name>
HEADERS apikey: <api_key>

El app name 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.

Image Removedimage-20240415-203132.pngImage Added

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:

Note

Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)

hsm;id_template;tipo;variable;variable;variable

hsm;2b394c67-3ef5-4e50-b0bd-446bd5a71c4b;text;variable;variable;variable

hsm;id_template;tipo;mediaUrl;variable;variable;variable

hsm;c6aecef6-bcb0-4fb1-8100-28c094e3bc6b;image;https://images.pexels.com/photos/248797/pexels-photo-248797.jpeg;variable;variable;variable

Contact

Note

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:

contact;John:John Smith;59898514179;CELL;abc2594@gmail.com;Cufre 1940;HOME

Location

Note

Deprecado. Los nuevos formatos están en Formato de proveedores WhatsApp - uContact v6 Español - Confluence (atlassian.net)

location;longitude,latitude;Nombre;direccion

Ejemplo:

location;-34.92403016332158, -56.158280428772684;Shopping Punta Carretas;Montevideo, Uruguay

NGINX
Anchor
NGINX
NGINX

Para recibir los mensajes en uContact es necesario agregar el siguiente fragmento de código a la configuración de NGINX.

Code Block
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;
}