Instância de WhatsApp: Como Criar e Gerenciar

Após realizar o cadastro, você recebe um período de teste gratuito de 7 dias, com direito a uma instância de WhatsApp. Esse período permite testar a integração, o envio de mensagens e os recursos de automação disponíveis na plataforma.

O que é uma instância?

Uma instância representa a conexão entre a plataforma e uma conta do WhatsApp.

Por meio da instância, é possível conectar um número de WhatsApp à plataforma e utilizar recursos como:

• Envio e recebimento de mensagens;
• Automação de mensagens;
• Integração com sistemas externos;
• Recebimento de eventos por meio de Webhooks;
• Monitoramento do status das mensagens;
• Integração com grupos e outros eventos do WhatsApp.

OBS.: Para criar uma instância externamente, ou seja, sem utilizar diretamente o painel da plataforma, é necessário utilizar o Token da API disponível no seu perfil.

Como obter o Token da API

Para acessar o Token da API:

1. Acesse o Menu da plataforma.
2. Clique em Meu Perfil.
3. Localize o Token da API.
4. Utilize esse token para autenticar suas requisições.

Importante: mantenha seu Token da API em segurança. Ele funciona como uma credencial de acesso e não deve ser compartilhado publicamente ou exposto em aplicações do lado do cliente.

Endpoint para criação da instância

Para criar uma nova instância utilizando a API, utilize o seguinte endpoint:

POST {{baseUrl}}/:username/:version/instance/add

Estrutura da URL

A URL é composta pelos seguintes parâmetros:

Exemplo de URL:

https://api.uzapi.com.br/teste/v1/instance/add

Configurando a autenticação

A API utiliza o método de autenticação Bearer Token.

Para realizar a requisição pelo Postman, recomendamos criar uma variável de ambiente para armazenar o token.

Variável de ambiente

Nome:

token

Valor:

f23d0183141366265xxxxxx

Depois, acesse a aba Authorization da requisição e configure:

Type: Bearer Token
Token: {{token}}

Dessa forma, o Postman enviará automaticamente o token no cabeçalho da requisição:

Authorization: Bearer SEU_TOKEN

Corpo da requisição

Na aba Body do Postman, selecione:

Body → raw → JSON

Em seguida, informe o seguinte conteúdo:

{
  "name": "Nome da Instância",
  "appVersion": "latest",
  "authenticationMethod": "QRCode",
  "phoneNumber": "Seu número",
  "autoRejectCall": false,
  "answerMissedCall": "Olá, não posso atender ligações.",
  "webhook": "https://webhook.site/receives",
  "webhookEvents": {
    "authentication": true,
    "connection": true,
    "group_messages": true,
    "message_status": true,
    "group_events": true,
    "history": false
  },
  "resources": {
    "resources": {
      "requests": {
        "cpu": "50m",
        "memory": "70Mi"
      },
      "limits": {
        "cpu": "100m",
        "memory": "128Mi"
      }
    }
  }
}

Principais parâmetros

Como criar uma instância pelo Dashboard

Também é possível criar uma instância diretamente pelo painel da plataforma, sem utilizar a API.

Passo a passo

1. Acesse o Dashboard.
2. Clique em Nova Instância.
3. Preencha as informações solicitadas:
   • Nome da instância;
   • Webhook, caso queira receber eventos automaticamente;
   • Método de autenticação.
4. Selecione o método de autenticação desejado:
   • QR Code;
   • Pairing Code, utilizando o número do WhatsApp.
5. Acesse Opções → Autenticação.
6. Caso tenha escolhido QR Code, abra o WhatsApp no celular.
7. Acesse Configurações → Dispositivos conectados.
8. Selecione Conectar dispositivo.
9. Escaneie o QR Code apresentado pela plataforma.
10. Aguarde a conclusão da autenticação e a conexão da instância.

Após a conexão, a instância estará disponível no painel e poderá ser utilizada para realizar a integração com o WhatsApp.

Dica: caso esteja utilizando Webhooks, verifique se a URL configurada está acessível publicamente e preparada para receber as notificações enviadas pela API.