> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/whatsapp-api-hyperflow/whatsapp-api-hyperflow.md).

# WhatsApp API Hyperflow

Use esta documentação para realizar a conexão com a API do WhatsApp através da 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FJEJiD4noeQ999QoGhDr8%2Fimage.png?alt=media&amp;token=e054a933-9db9-4be0-a7a8-4bef33e9ba07" 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FZA6fko7FNCJ5GFJ2RnrC%2Fimage.png?alt=media&amp;token=d701b847-6ae3-4495-9ad5-cc4da041d7dc" 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2F2fMwRTcy9PwrmihM5juS%2Fimage.png?alt=media&amp;token=e232bc5b-1a58-4dfa-a003-517c06e4751c" 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FovJGc2988GCGxPMHg3Ij%2Fimage.png?alt=media&amp;token=7cac377b-7c58-418b-8e81-cddec7d76c13" 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2Fq4do0JpEcMyydZQOR579%2FproxyBroker.jpeg?alt=media&amp;token=137ef2db-b08f-4b27-b646-4282d273799e" 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2Fi3HGbxP4q2P2fTB06VdP%2Fimage.png?alt=media&amp;token=cba03e08-47bc-46a9-80bf-e55b040eb316" 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 %}