# WhatsApp

O **WhatsApp** permite que você envie mensagens por WhatsApp.

## **Parâmetros**

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por [expressões Double Braces](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/double-braces/overview) estão marcados com `(DB)`.

{% hint style="info" %}
Este conector oferece suporte ao parâmetro **Alias**, que permite salvar sua saída e referenciá-la posteriormente no fluxo usando expressões com Double Braces. [Saiba mais](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/double-braces/how-to-reference-data-using-double-braces/previous-steps-access).
{% endhint %}

### **Aba General**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Account</strong></td><td><a href="https://app.gitbook.com/s/cO0A6g1dOsu8BiHYqO67/platform-administration/settings/accounts">Conta utilizada pelo conector</a>. Tipo suportado: <strong>OAuth Bearer</strong>.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Phone Number ID</strong> <code>(DB)</code></td><td>O ID associado ao número de telefone da sua conta WhatsApp Business, disponível no painel do WhatsApp Business.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>Se ativado, interrompe a execução do pipeline ao ocorrer um erro. Se desativado, a execução continua, mas a propriedade <code>"success"</code> será definida como <code>false</code>.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Optional**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>API Version</strong> <code>(DB)</code></td><td>Especifica a versão da API Facebook Graph a ser utilizada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Base URI</strong> <code>(DB)</code></td><td>Opcional. Define uma URI base personalizada. Útil, por exemplo, para testes com uma API WhatsApp simulada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Webhook Path</strong> <code>(DB)</code></td><td>Caminho no qual o conector receberá requisições webhook.</td><td>/messages</td><td>String</td></tr><tr><td><strong>To</strong> <code>(DB)</code></td><td>Número de telefone do destinatário, incluindo o código do país, código de área (DDD) e número (por exemplo, 5511999998888).</td><td>N/A</td><td>String</td></tr><tr><td><strong>Message</strong> <code>(DB)</code></td><td>Conteúdo em texto da mensagem a ser enviada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Preview URL</strong></td><td>Se a mensagem incluir uma URL, ao ativar esta opção será exibida uma pré-visualização do link na mensagem.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Documentation**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes.</td><td>N/A</td><td>String</td></tr></tbody></table>

## **Fluxo de mensagens**

### **Entrada**

O conector aceita qualquer mensagem de entrada, podendo utilizá-la por meio de expressões com Double Braces.

### **Saída**

O conector retorna um objeto JSON com a seguinte estrutura:

```json
{
  "success": true,
  "body": {
    "messages": {
      "empty": false
    },
    "contacts": {
      "empty": false
    },
    "messagingProduct": "whatsapp"
  }
}
```

**Descrição dos campos:**

* **`success`**: Indica se a execução foi bem-sucedida. Um valor `true` significa que a requisição foi processada sem erros.
* **`body.messages.empty`**: Indicador booleano que informa se a lista de mensagens está vazia. Um valor `false` indica que pelo menos uma mensagem foi processada com sucesso.
* **`body.contacts.empty`**: Semelhante ao campo `messages`, este indicador mostra se algum contato foi retornado. Um valor `false` confirma que pelo menos um contato foi processado.
* **`body.messagingProduct`**: Especifica a plataforma de mensagens utilizada. Neste caso, o valor `"whatsapp"` confirma que a requisição foi processada pela API do WhatsApp Business.
