> ## Documentation Index
> Fetch the complete documentation index at: https://help.wizebot.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução à API WhatsApp

> Guia de introdução para utilizar a API WhatsApp da WizeBot

# Introdução à API WhatsApp

A API WhatsApp da WizeBot permite que você integre os recursos da plataforma diretamente em seus sistemas e aplicativos. Com a API, você pode automatizar o envio de mensagens, gerenciar contatos, criar etiquetas, acionar fluxos de bot e muito mais.

## Disponibilidade

<Note type="warning">
  A API da WizeBot está disponível **exclusivamente** para clientes do plano **Elite**.

  Se você ainda não possui este plano, entre em contato com nossa equipe comercial para fazer um upgrade.
</Note>

## Obtendo sua Chave API

Para utilizar a API da WizeBot, você precisará de uma chave API (apiToken). Siga os passos abaixo para gerar sua chave:

1. Acesse o Console de Desenvolvedor da WizeBot em [https://app.wizebot.com.br/api/developer/console](https://app.wizebot.com.br/api/developer/console)
2. Clique no botão "Gerar chave API"

<Frame>
  <img src="https://mintcdn.com/wizebot-d8529edc/IGqKZMMz1MEwnVwL/images/geral/key.png?fit=max&auto=format&n=IGqKZMMz1MEwnVwL&q=85&s=1dd6afe89b77f85a5fa51a2aaba1faba" alt="Gerando chave API" width="710" height="359" data-path="images/geral/key.png" />
</Frame>

<Warning>
  **Importante**: Sua chave API é confidencial e não deve ser compartilhada. Ela concede acesso total à sua conta da WizeBot.

  Guarde sua chave em um local seguro e nunca a exponha em código-fonte público ou repositórios.
</Warning>

## Identificando seu Phone Number ID

Todas as APIs do WhatsApp exigem o parâmetro `phone_number_id`, que é o identificador único do seu número de telefone na plataforma da WizeBot.

Para encontrar seu Phone Number ID:

1. Acesse [https://app.wizebot.com.br/whatsapp/bot/connect](https://app.wizebot.com.br/whatsapp/bot/connect)
2. Localize o número na seção de identificação da conta

<Frame>
  <img src="https://mintcdn.com/wizebot-d8529edc/IGqKZMMz1MEwnVwL/images/geral/identifica%C3%A7%C3%A3o.png?fit=max&auto=format&n=IGqKZMMz1MEwnVwL&q=85&s=c10167d60109b89941f5f01f46031132" alt="Identificação do Phone Number ID" width="794" height="487" data-path="images/geral/identificação.png" />
</Frame>

## Estrutura das Requisições

Todas as APIs da WizeBot seguem uma estrutura consistente:

* **Método HTTP**: POST GET
* **URL Base**: `https://app.wizebot.com.br/api/v1/whatsapp/`
* **Autenticação**: Via parâmetro `apiToken` no corpo da requisição
* **Formato de Resposta**: JSON

### Parâmetros Obrigatórios em Todas as Requisições

| Parâmetro         | Descrição                    | Tipo   |
| ----------------- | ---------------------------- | ------ |
| apiToken          | Sua chave de API             | String |
| phone\_number\_id | ID do seu número de WhatsApp | String |

### Exemplo de Requisição Básica

```bash theme={null}
curl -X POST \
  'https://app.wizebot.com.br/api/v1/whatsapp/send' \
  -d 'apiToken=SUA_API_KEY_AQUI' \
  -d 'phone_number_id=SEU_PHONE_NUMBER_ID' \
  -d 'phone_number=5511999999999' \
  -d 'message=Olá, esta é uma mensagem de teste!'
```

## Formato das Respostas

As respostas da API seguem um formato padrão:

```json theme={null}
{
  "status": "1",  // 1 para sucesso, 0 para erro
  "message": "..." // Mensagem de sucesso ou erro
}
```

Em caso de erros, a API retornará um status "0" com uma mensagem descritiva do problema.

## Categorias de APIs Disponíveis

A WizeBot oferece diversas categorias de APIs para o WhatsApp:

1. **Mensagens** - Envio de mensagens de texto, modelos e obtenção de conversas
2. **Fluxo de Conversa** - Acionamento de fluxos de bot
3. **Contatos** - Gerenciamento de assinantes e atribuições
4. **Etiquetas** - Criação e listagem de etiquetas

## Limites de Uso

O uso da API está sujeito aos mesmos limites da sua conta do WhatsApp Business. Recomendamos seguir as diretrizes do WhatsApp para evitar bloqueios ou suspensões.

## Playground Interativo

Cada endpoint da API possui um playground interativo que permite testar as requisições diretamente na documentação. Utilize-o para verificar o funcionamento da API antes de implementar em seu sistema.

## Suporte

Em caso de dúvidas ou problemas com a API, entre em contato com nosso suporte técnico através do chat na plataforma ou pelo e-mail [suporte@wizebot.com.br](mailto:suporte@wizebot.com.br).

<Note>
  Lembre-se de sempre manter suas integrações atualizadas conforme as novas versões da API são lançadas.
</Note>