Saltar al contenido principal
Ir al Studio
Módulos

Messaging

Messaging

El módulo Messaging es responsable de realizar acciones de envío de mensajes como SMS y WhatsApp. Sus métodos pueden accederse conforme al ejemplo a continuación:

js
await Messaging.whatsAppSendMessage["v1_0_0"]({
      originWhatsAppInstance: "1008888888823000088a8d18",
      destinationNumbers: ["5511998888888"],
      message: "Hello world!"
    })

Métodos​

whatsAppSendMessage​

Método responsable de enviar un mensaje en WhatsApp a uno o más números de celular.

js
await Messaging.whatsAppSendMessage["v1_0_0"]({
      originWhatsAppInstance: "1008888888823000088a8d18",
      destinationNumbers: ["5511998888888"],
      message: "Hello world!"
    })

Parámetros obligatorios​

  • originWhatsAppInstance: String - es una clave que referencia la instancia del número de celular que está registrado en el dispositivo. Es posible encontrar esa clave en la pantalla "Bots de WhatsApp".
Atención

Para utilizar la opción customer, el número de celular del usuario debe registrarse de acuerdo con el tutorial registrar número de WhatsApp.

  • destinationNumbers: String[] - Es un array de strings, en el que cada posición debe ser un número de teléfono. El mensaje será enviado a todos los números que estén en ese array.
  • message: String - Mensaje que será enviado.

Parámetros opcionales​

No hay parámetros opcionales.

Retorno​

Esta acción no tiene retorno.

whatsAppSendMedia​

Método responsable de enviar un archivo multimedia (imagen, video, documento, etc.) por WhatsApp a uno o más números de celular.

js
await Messaging.whatsAppSendMedia["v1_0_0"]({
      originWhatsAppInstance: "1008888888823000088a8d18",
      destinationNumbers: ["5511998888888"],
      mediaPath: "C:\\Users\\Roberty\\Downloads\\imagem.png",
      message: "Segue o arquivo solicitado."
    })

Parámetros obligatorios​

  • originWhatsAppInstance: String - es una clave que referencia la instancia del número de celular que está registrado en el dispositivo. Es posible encontrar esa clave en la pantalla "Bots de WhatsApp".
  • destinationNumbers: String[] - Es un array de strings, en el que cada posición debe ser un número de teléfono. El archivo será enviado a todos los números que estén en ese array.
  • mediaPath: String - ruta completa del archivo multimedia que será enviado.

Parámetros opcionales​

  • message: String - texto opcional que será enviado junto con el archivo multimedia.

Retorno​

Esta acción no tiene retorno.

sendSMS (Profissional)​

Método responsable de enviar un mensaje SMS a un número de celular.

js
await Messaging.sendSMS.v1_0_0({
      destination: ['5511998888888'],
      message: 'Hello World!'
    })

Parámetros obligatorios​

  • destination: String - espera un string que debe ser un número de teléfono que recibirá el mensaje SMS.
  • message: String - Mensaje que será enviado, con un máximo de 140 caracteres.

Parámetros opcionales​

No hay parámetros opcionales.

Retorno​

Esta acción no tiene retorno.