# WhatsApp API Hyperflow

{% hint style="warning" %}
Sua conta precisa de uma liberação prévia para usar este recurso. Caso queria saber mais informações, entre em contato com o seu CS.
{% endhint %}

## Para quem é essa API?

Esta API é recomendada para pessoas que possuem conhecimento técnico para realizar a integração entre sistemas.

Ela só deve ser utilizada, caso você não queira utilizar os módulos de Integrações e Conversas da Hyperflow, ou seja, você deseja apenas acesso a API oficial do WhatsApp, e irá realizar todo controle e integração do seu lado com o seu time ténico.

### Acessando a API

Para acessar as configurações da WhatsApp API Hyperflow, basta acessar <https://integracoes.hyperflow.global/index.html>, e em seguida, ir na aba "Contas de WhatsApp"

<figure><img src="/files/rFMDuvPolp8wvIDWS1uz" alt="Menu contas de WhatsApp"><figcaption><p>Imagem 01 - Acessando o menu Contas de WhatsApp</p></figcaption></figure>

Em seguida, clique no botão para adicionar contas de WhatsApp e você poderá escolher um número de teste fornecido pela Hyperflow para testar a API e começar a criar as suas integrações

<figure><img src="/files/OGnZWdm45z00a4ElMw5b" alt="Criar número de teste para WhatsApp API Hyperflow"><figcaption><p>Imagem 02 - Criando um número de teste para a WhatsApp API Hyperflow</p></figcaption></figure>

Agora que você possui um número de teste, você poderá ver e editar os dados do número, ou consultar a documentação completa do Postman com todos os métodos e payloads disponíveis da WhatsApp API Hyperflow.

<figure><img src="/files/xgLtzI2B1NPB4w0nOrzR" alt="Número de teste conectado na WhatsApp API Hyperflow"><figcaption><p>Imagem 03 - Número de teste conectado na WhatsApp API Hyperflow e link para documentação</p></figcaption></figure>

Se preferir, você também já pode acessar a documentação completa com todos os payloads e webhooks, clicando neste link: <https://www.postman.com/hyperflow-global/whatsapp-business-api-hyperflow>

### Usando o número de teste

O número de teste fornecido pela Hyperflow é um número compartilhado. Por conta disso, para iniciar os seus testes, você precisará primeiro enviar uma palavra chave para o número. Uma vez feito isso, a sua sessão é vinculada ao número de teste, e você poderá usar ele para manipular a API.

Basta clicar no link fornecido para já abrir o número de teste com a mensagem pré-populada e iniciar os seus testes.

Você também pode usar esta tela para configurar a sua URL de webhook de novas mensagens e status de mensagem.

<figure><img src="/files/2tWv36i1hgis98Jibyq3" alt="Tela de configuração do número de teste"><figcaption><p>Imagem 04 - Tela para configurar os dados e obter o token do seu número de teste</p></figcaption></figure>

Envie a mensagem para o número de teste. Será uma mensagem do tipo *"proxy ID\_DO\_SEU\_AMBIENTE"*

<figure><img src="/files/WvUjeADgKNyWd0EbzrWp" alt="Mensagem para ativar o broker Hyperflow"><figcaption><p>Imagem 05 - Envio de mensagem para habilitar o uso da WhatsApp API Hyperflow no número de teste</p></figcaption></figure>

Uma vez enviada esta mensagem, você poderá chamar os métodos da API normalmente.

Exemplo de chamada para envio de texto:

{% tabs %}
{% tab title="cURL" %}

```powershell
curl --location 'https://messaging.hyperflowapis.global/whatsapp/send-message' \
--header 'apikey: hf-SUA_CHAVE_OBTIDA_NA_IMAGEM_04' \
--header 'Content-Type: application/json' \
--data '{
  "to": "5534992611858",
  "type": "text",
  "payload": {
    "text": "Olá, teste WhatsApp API Hyperflow!"
  }
}'
```

{% endtab %}
{% endtabs %}

Pronto! Sua mensagem será enviada com sucesso para o número inserido na propriedade "to" do payload.

### Recebendo webhooks

Se você configurou uma URL para recebimentos dos webhooks de mensagens e status, ela passará a ser notificada sempre que tiver uma nova mensagem ou atualização de status de mensagem (lido, entregue, etc..).

<figure><img src="/files/ZflZwWOd4qhXq8VqGFjH" alt="Exemplo de payload recebido via webhook"><figcaption><p>Imagem 06 - Exemplo de webhook recebido do número de teste da WhatsApp API Hyperflow</p></figcaption></figure>

Você pode consultar todos os modelos de webhooks e regras pelo link da nossa documentação do Postman.

{% hint style="success" %}
**Sucesso! 🎉**

Agora você sabe como utilizar e manipular a WhatsApp API da Hyperflow! Caso tenha qualquer dúvida, pode chamar o nosso time de suporte que estará pronto para lhe ajudar!
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.hyperflow.global/docs/whatsapp-api-hyperflow/whatsapp-api-hyperflow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.