Pular para o conteúdo principal
Acessar Studio
Módulos

Messaging

Messaging

O módulo Messaging é responsável por realizar ações de envio de mensagens como SMS e WhatsApp. Seus métodos podem ser acessados conforme o exemplo abaixo:

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

Métodos​

whatsAppSendMessage​

Método responsável por enviar uma mensagem no whatsapp para um ou mais números de celular.

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

Parâmetros obrigatórios​

  • originWhatsAppInstance: String - é uma chave que referência a instância do número de celular que está cadastrado no dispositivo. É possível encontrar essa chave na tela "Bots de whatsapp".
Atenção

Para utilizar a opção customer, o número de celular do usuário deve ser cadastrado de acordo com o tutorial registrar número de whatsapp.

  • destinationNumbers: String[] - É um array de strings, em que cada posição deve ser um número de telefone. A mensagem será enviada para todos os números que estiverem nesse array.
  • message: String - Mensagem a ser enviada.

Parâmetros opcionais​

Não há parâmetros opcionais.

Retorno​

Este ação não possui retorno.

whatsAppSendMedia​

Método responsável por enviar um arquivo de mídia (imagem, vídeo, documento, etc.) pelo WhatsApp para um ou mais 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 obrigatórios​

  • originWhatsAppInstance: String - é uma chave que referência a instância do número de celular que está cadastrado no dispositivo. É possível encontrar essa chave na tela "Bots de whatsapp".
  • destinationNumbers: String[] - É um array de strings, em que cada posição deve ser um número de telefone. A mídia será enviada para todos os números que estiverem nesse array.
  • mediaPath: String - caminho completo do arquivo de mídia que será enviado.

Parâmetros opcionais​

  • message: String - texto opcional a ser enviado junto com a mídia.

Retorno​

Esta ação não possui retorno.

sendSMS (Profissional)​

Método responsável por enviar uma mensagem de SMS para um número de celular.

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

Parâmetros obrigatórios​

  • destination: String - espera uma string que deve ser um número de telefone que receberá a mensagem de SMS.
  • message: String - Mensagem a ser enviada com no máximo 140 caracteres.

Parâmetros opcionais​

Não há parâmetros opcionais.

Retorno​

Esta ação não possui retorno.