Camada de Compatibilidade Evolution GO — Referência da API

A Camada de API Evolution GO do Pilot Status oferece um substituto direto para o seu servidor Evolution GO. Você mantém cada corpo de requisição, cabeçalho e caminho exatamente como estão hoje — a única mudança que você faz é trocar a sua base URL. O Pilot Status traduz suas requisições compatíveis com o Evolution GO para sua API nativa e retorna as respostas no formato que seu código já manipula.

Base URL

Aponte seu cliente HTTP ou variável de ambiente para a seguinte base URL para começar a usar a camada Evolution GO:

https://pilotstatus.com.br/api/layer/evolution-go/

Todos os caminhos que você usa atualmente com seu servidor Evolution GO são anexados diretamente a esta URL. Nenhuma outra alteração é necessária.

Autenticação

Passe sua chave de API do Pilot Status usando o mesmo cabeçalho que seu código Evolution GO existente já envia. Se o seu código usa o cabeçalho apikey, continue usando-o:

apikey: YOUR_API_KEY

Se o seu código usa um cabeçalho com token Bearer, esse formato também é aceito:

Authorization: Bearer YOUR_API_KEY

Use o formato que corresponder à sua implementação existente — você não precisa alterar seu código de autenticação.

Operações suportadas

Cada requisição é uma chamada para <MÉTODO> https://pilotstatus.com.br/api/layer/evolution-go<CAMINHO>. A instância é resolvida a partir da sua chave de API, então os caminhos do Evolution GO que normalmente carregam um segmento de instância não precisam dele aqui. As operações de envio são automaticamente balanceadas entre as instâncias conectadas do seu número.

Qualquer caminho não listado abaixo retorna 404. Caminhos globais ou exclusivos de administrador retornam 403 — eles nunca são expostos pela camada (veja Caminhos bloqueados).

Instância (sessão)

Método	Caminho
POST	`/instance/connect`
GET	`/instance/status`
GET	`/instance/qr`
POST	`/instance/pair`
POST	`/instance/disconnect`
POST	`/instance/reconnect`
DELETE	`/instance/logout`
GET	`/instance/{id}/advanced-settings`
PUT	`/instance/{id}/advanced-settings`

Envio (balanceado)

Esses endpoints enviam mensagens pela camada do Evolution GO; o número é selecionado pela chave de API, portanto o caminho não tem segmento de instância e o number no corpo é o destinatário.

POST /send/text — Enviar mensagem de texto

Envia uma mensagem de texto simples; quando linkPreview é true, o servidor enriquece a primeira URL de text com um cartão de pré-visualização OpenGraph.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário (ex.: `5511999999999` ou `5511999999999@s.whatsapp.net`, grupo `...@g.us`).
`text`	string	Sim	Corpo da mensagem.
`linkPreview`	boolean	Não	Busca os metadados OpenGraph da primeira URL em `text` e anexa uma pré-visualização.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente para rastreamento/idempotência.
`delay`	integer	Não	Milissegundos a aguardar (como “digitando”) antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`); defina `false` para enviar o valor como está.
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "text": "Hello from Pilot Status! https://pilotstatus.com.br",
  "linkPreview": true,
  "delay": 1200,
  "quoted": {
    "messageId": "3EB0C767D097B7C7A0A1",
    "participant": "5511988888888@s.whatsapp.net"
  }
}

POST /send/link — Enviar pré-visualização de link

Envia uma mensagem de texto com um cartão de link rico; o servidor busca automaticamente title, description e imgUrl a partir da URL encontrada em text, então esses campos são opcionais e qualquer valor informado pode ser sobrescrito.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`text`	string	Sim	Corpo da mensagem contendo a URL a ser pré-visualizada.
`title`	string	Não	Título da pré-visualização (preenchido automaticamente pelo OpenGraph quando omitido).
`description`	string	Não	Descrição da pré-visualização (preenchida automaticamente quando omitida).
`url`	string	Não	URL de destino da pré-visualização.
`imgUrl`	string	Não	URL da imagem de miniatura (preenchida automaticamente quando omitida).
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "text": "Check this out: https://pilotstatus.com.br",
  "title": "Pilot Status",
  "description": "WhatsApp API platform",
  "url": "https://pilotstatus.com.br",
  "imgUrl": "https://pilotstatus.com.br/og.png"
}

POST /send/media — Enviar mensagem de mídia

Envia uma imagem, vídeo, áudio ou documento por URL (corpo JSON) — ou como um upload multipart/form-data com um campo file; type seleciona o tipo de mídia.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`url`	string	Sim	URL da mídia (modo JSON). Em `multipart/form-data`, envie o binário em um campo `file`.
`type`	string	Sim	Tipo de mídia: `image`, `video`, `audio`, `document` (também `ptv`).
`caption`	string	Não	Texto da legenda (imagem/vídeo/documento).
`filename`	string	Não	Nome do arquivo exibido para documentos.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "type": "image",
  "url": "https://example.com/photo.jpg",
  "caption": "Look at this"
}

POST /send/poll — Enviar enquete

Envia uma enquete com uma pergunta e uma lista de opções; requer no mínimo duas opções.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`question`	string	Sim	Pergunta da enquete.
`options`	string[]	Sim	Opções de resposta (mínimo 2).
`maxAnswer`	integer	Não	Número máximo de opções que um votante pode selecionar (`1` = escolha única).
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "question": "Best day for the meeting?",
  "options": ["Monday", "Tuesday", "Wednesday"],
  "maxAnswer": 1
}

POST /send/sticker — Enviar figurinha

Envia uma figurinha a partir de uma URL de imagem; o servidor a baixa e converte para WebP antes de enviar.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`sticker`	string	Sim	URL de imagem `http(s)` a ser convertida em figurinha.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "sticker": "https://example.com/sticker.png"
}

POST /send/location — Enviar localização

Envia um marcador de localização geográfica com um nome e uma etiqueta de endereço.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`name`	string	Sim	Nome/título da localização.
`address`	string	Sim	Etiqueta do endereço.
`latitude`	number	Sim	Latitude em graus decimais.
`longitude`	number	Sim	Longitude em graus decimais.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "name": "Pilot Status HQ",
  "address": "Av. Paulista, 1000, Sao Paulo",
  "latitude": -23.561414,
  "longitude": -46.655881
}

POST /send/contact — Enviar cartão de contato

Envia um cartão de contato vCard; fullName e phone são obrigatórios dentro de vcard.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`vcard`	object	Sim	Objeto do cartão de contato (veja os campos aninhados).
`vcard.fullName`	string	Sim	Nome completo do contato.
`vcard.phone`	string	Sim	Número de telefone do contato.
`vcard.organization`	string	Não	Organização do contato.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "vcard": {
    "fullName": "Joao Silva",
    "organization": "Acme Ltda",
    "phone": "5511988888888"
  }
}

POST /send/button — Enviar botões interativos

Envia uma mensagem interativa com botões clicáveis; o comportamento de cada botão é definido por item via type (reply, url, call, copy, etc.).

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`title`	string	Sim	Texto do cabeçalho/título.
`description`	string	Sim	Texto do corpo.
`footer`	string	Não	Texto do rodapé.
`imageUrl`	string	Não	URL da imagem do cabeçalho.
`buttons`	array	Sim	Objetos de botão: `{ type, displayText, id, url, phoneNumber, copyCode, currency, name, keyType, key }`.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "title": "Order #123",
  "description": "Your order is ready.",
  "footer": "Pilot Status",
  "buttons": [
    { "type": "reply", "displayText": "Confirm", "id": "confirm_1" },
    { "type": "url", "displayText": "Track", "url": "https://track.example.com/123" }
  ]
}

POST /send/list — Enviar menu de lista

Envia uma mensagem de menu em que o destinatário toca em buttonText para abrir seções de linhas selecionáveis.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`title`	string	Sim	Texto do cabeçalho/título.
`description`	string	Sim	Texto do corpo.
`buttonText`	string	Sim	Rótulo do botão que abre a lista.
`footerText`	string	Sim	Texto do rodapé.
`sections`	array	Sim	Objetos de seção: `{ title, rows: [{ title, description, rowId }] }`.
`id`	string	Não	Identificador de mensagem fornecido pelo cliente.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "title": "Menu",
  "description": "Choose an option",
  "buttonText": "Open menu",
  "footerText": "Pilot Status",
  "sections": [
    {
      "title": "Drinks",
      "rows": [
        { "title": "Coffee", "description": "Hot brewed", "rowId": "drink_coffee" },
        { "title": "Tea", "description": "Green tea", "rowId": "drink_tea" }
      ]
    }
  ]
}

POST /send/carousel — Enviar cartões de carrossel

Envia um carrossel de rolagem horizontal; cada cartão tem a própria imagem, texto e botões.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	MSISDN ou JID do destinatário.
`title`	string	Sim	Texto do cabeçalho/título.
`description`	string	Sim	Texto do corpo.
`footerText`	string	Sim	Texto do rodapé.
`cards`	array	Sim	Objetos de cartão: `{ text, thumbnailUrl, footerText, buttons: [Button] }`.
`delay`	integer	Não	Milissegundos a aguardar antes de enviar.
`mentionedJid`	string	Não	JID(s) a mencionar.
`mentionAll`	boolean	Não	Menciona todos os participantes (grupos).
`formatJid`	boolean	Não	Formata automaticamente `number` em um JID (padrão `true`).
`quoted`	object	Não	Referência de resposta: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "title": "Featured products",
  "description": "Swipe to browse",
  "footerText": "Pilot Status",
  "cards": [
    {
      "text": "Product A",
      "thumbnailUrl": "https://example.com/a.jpg",
      "footerText": "In stock",
      "buttons": [
        { "type": "url", "displayText": "Buy", "url": "https://shop.example.com/a" }
      ]
    }
  ]
}

Usuário / Contatos

A apikey seleciona o número, portanto nenhum segmento de instância aparece no caminho ou no corpo.

POST /user/info — Obter informações do usuário

Busca os detalhes da conta do WhatsApp (JID, nome, nome comercial) de um ou mais números de telefone.

Campo	Tipo	Obrigatório	Descrição
`number`	string[]	Sim	Números de telefone em formato internacional para consultar.
`formatJid`	boolean	Não	Quando verdadeiro, retorna cada resultado indexado pelo JID formatado.

{
  "number": ["5511999999999"],
  "formatJid": true
}

POST /user/check — Verificar no WhatsApp

Verifica se os números de telefone informados estão registrados no WhatsApp.

Campo	Tipo	Obrigatório	Descrição
`number`	string[]	Sim	Números de telefone em formato internacional para verificar.
`formatJid`	boolean	Não	Quando verdadeiro, retorna cada resultado indexado pelo JID formatado.

{
  "number": ["5511999999999", "5511888888888"],
  "formatJid": false
}

POST /user/avatar — Obter avatar do usuário

Retorna a URL da foto de perfil de um número de telefone.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Número de telefone em formato internacional.
`preview`	boolean	Não	Quando verdadeiro, retorna a imagem de pré-visualização em baixa resolução em vez da foto em tamanho completo.

{
  "number": "5511999999999",
  "preview": false
}

GET /user/contacts — Listar contatos

Retorna todos os contatos armazenados para o número conectado.Sem corpo de requisição.

GET /user/privacy — Obter configurações de privacidade

Retorna as configurações de privacidade atuais do número conectado.Sem corpo de requisição.

POST /user/privacy — Definir configurações de privacidade

Atualiza as configurações de privacidade do número conectado. Cada campo recebe um escopo de privacidade, como all, contacts, contact_blacklist, known, match_last_seen ou none.

Campo	Tipo	Obrigatório	Descrição
`groupAdd`	string	Sim	Quem pode adicionar você a grupos (`all`, `contacts`, `contact_blacklist`, `none`).
`lastSeen`	string	Sim	Quem pode ver seu visto por último (`all`, `contacts`, `contact_blacklist`, `none`).
`status`	string	Sim	Quem pode ver seu status (`all`, `contacts`, `contact_blacklist`, `none`).
`profile`	string	Sim	Quem pode ver sua foto de perfil (`all`, `contacts`, `contact_blacklist`, `none`).
`readReceipts`	string	Sim	Configuração de confirmações de leitura (`all`, `none`).
`callAdd`	string	Sim	Quem pode ligar para você (`all`, `known`).
`online`	string	Sim	Quem pode ver quando você está online (`all`, `match_last_seen`).

{
  "groupAdd": "contacts",
  "lastSeen": "contacts",
  "status": "contacts",
  "profile": "all",
  "readReceipts": "all",
  "callAdd": "known",
  "online": "match_last_seen"
}

POST /user/block — Bloquear um contato

Bloqueia o contato informado para o número conectado.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Número de telefone em formato internacional para bloquear.

{
  "number": "5511999999999"
}

POST /user/unblock — Desbloquear um contato

Remove o contato informado da lista de bloqueio.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Número de telefone em formato internacional para desbloquear.

{
  "number": "5511999999999"
}

GET /user/blocklist — Listar contatos bloqueados

Retorna a lista de bloqueio do número conectado.Sem corpo de requisição.

POST /user/profilePicture — Definir foto de perfil

Define a foto de perfil do número conectado.

Campo	Tipo	Obrigatório	Descrição
`image`	string	Sim	Imagem como URL ou dados codificados em base64.

{
  "image": "https://media.pilotstatus.com.br/avatar.jpg"
}

POST /user/profileName — Definir nome de perfil

Atualiza o nome de exibição do número conectado.

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Novo nome de exibição do perfil.

{
  "name": "Pilot Status Support"
}

POST /user/profileStatus — Definir status de perfil

Atualiza o texto de status (recado) do número conectado.

Campo	Tipo	Obrigatório	Descrição
`status`	string	Sim	Novo texto de status do perfil.

{
  "status": "Available"
}

Mensagem

Ações no nível da mensagem no número conectado — a apikey seleciona o número, então nunca inclua uma instância no caminho ou no corpo.

POST /message/react — Reagir a uma mensagem

Envia uma reação com emoji a uma mensagem existente; suporta fromMe e (para mensagens de grupo) o autor em participant.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Conversa do destinatário, como um telefone em dígitos E.164 ou um JID
`reaction`	string	Sim	Emoji com o qual reagir (envie uma string vazia para remover a reação)
`id`	string	Sim	ID da mensagem à qual reagir
`fromMe`	boolean	Não	Se a mensagem alvo foi enviada por você
`participant`	string	Não	JID do autor da mensagem (necessário para mensagens de grupo)

{
  "number": "5511999999999",
  "reaction": "👍",
  "id": "3EB0A1B2C3D4E5F6A7B8",
  "fromMe": false,
  "participant": "5511988888888@s.whatsapp.net"
}

POST /message/presence — Enviar presença na conversa

Transmite um indicador de presença de digitação ou gravação para uma conversa.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Conversa alvo, como um telefone em dígitos E.164 ou um JID
`state`	string	Sim	Estado de presença: `composing` (digitando) ou `paused`
`isAudio`	boolean	Não	Quando verdadeiro, exibe “gravando áudio” em vez de digitando

{
  "number": "5511999999999",
  "state": "composing",
  "isAudio": false
}

POST /message/markread — Marcar mensagens como lidas

Marca uma ou mais mensagens de uma conversa como lidas.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Conversa cujas mensagens estão sendo lidas, como um telefone em dígitos E.164 ou um JID
`id`	string[]	Sim	Array de IDs de mensagens a marcar como lidas

{
  "number": "5511999999999",
  "id": ["3EB0A1B2C3D4E5F6A7B8", "3EB0F9E8D7C6B5A43210"]
}

POST /message/downloadmedia — Baixar mídia

Baixa e descriptografa a mídia anexada a uma mensagem recebida, retornando-a como uma data URL em base64.

Campo	Tipo	Obrigatório	Descrição
`message`	object	Sim	Payload completo da mensagem contendo o nó de mídia a baixar — um de `imageMessage`, `audioMessage`, `videoMessage`, `documentMessage` ou `stickerMessage` — com seus campos `url`, `directPath`, `mediaKey`, `fileEncSHA256`, `fileSHA256`, `mimetype` e `fileLength`

{
  "message": {
    "imageMessage": {
      "url": "https://mmg.whatsapp.net/d/f/AbCdEf123456.enc",
      "directPath": "/v/t62.7118-24/12345_67890.enc",
      "mediaKey": "sPqT2bXyZ0aBcDeFgHiJkLmNoPqRsTuVwXyZ012345=",
      "mimetype": "image/jpeg",
      "fileEncSHA256": "9dJkLmNoPqRsTuVwXyZ0123456789AbCdEfGhIjKlMno=",
      "fileSHA256": "Q1w2E3r4T5y6U7i8O9p0AsDfGhJkLzXcVbNmQwErTyU=",
      "fileLength": 24576
    }
  }
}

POST /message/status — Obter status da mensagem

Consulta o status de entrega armazenado de uma mensagem pelo seu ID.

Campo	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da mensagem a consultar

{
  "id": "3EB0A1B2C3D4E5F6A7B8"
}

POST /message/delete — Apagar para todos

Revoga uma mensagem para todos na conversa.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	Conversa onde a mensagem está, como um JID ou telefone em dígitos E.164
`messageId`	string	Sim	ID da mensagem a revogar

{
  "chat": "5511999999999@s.whatsapp.net",
  "messageId": "3EB0A1B2C3D4E5F6A7B8"
}

POST /message/edit — Editar uma mensagem

Substitui o conteúdo de texto de uma mensagem enviada anteriormente.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	Conversa onde a mensagem está, como um JID ou telefone em dígitos E.164
`message`	string	Sim	Novo conteúdo de texto da mensagem
`messageId`	string	Sim	ID da mensagem a editar

{
  "chat": "5511999999999@s.whatsapp.net",
  "message": "Corrected text",
  "messageId": "3EB0A1B2C3D4E5F6A7B8"
}

Chat

Gerencie o estado das conversas (fixar, arquivar, silenciar) e solicite o histórico de mensagens do número selecionado pela sua chave de API.

POST /chat/pin — Fixar uma conversa

Fixa uma conversa no topo da lista.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	JID da conversa a fixar (individual `...@s.whatsapp.net` ou grupo `...@g.us`).

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/unpin — Desafixar uma conversa

Remove uma conversa da lista de fixadas.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	JID da conversa a desafixar.

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/archive — Arquivar uma conversa

Arquiva uma conversa, ocultando-a da lista principal.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	JID da conversa a arquivar.

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/unarchive — Desarquivar uma conversa

Restaura uma conversa arquivada de volta para a lista principal.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	JID da conversa a desarquivar.

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/mute — Silenciar uma conversa

Silencia as notificações de uma conversa.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	JID da conversa a silenciar.

{
  "chat": "120363000000000000@g.us"
}

POST /chat/unmute — Reativar notificações de uma conversa

Reativa as notificações de uma conversa silenciada.

Campo	Tipo	Obrigatório	Descrição
`chat`	string	Sim	JID da conversa a reativar as notificações.

{
  "chat": "120363000000000000@g.us"
}

POST /chat/history-sync — Solicitar sincronização de histórico

Solicita o histórico de mensagens mais antigas anteriores a uma mensagem de referência. O objeto messageInfo identifica a mensagem âncora (seu JID Chat, o ID da mensagem, as flags de direção e o Timestamp); os campos são desserializados a partir do tipo MessageInfo do whatsmeow, portanto as chaves são PascalCase e Chat é uma string JID.

Campo	Tipo	Obrigatório	Descrição
`messageInfo`	object	Sim	Mensagem de referência antes da qual sincronizar o histórico. Contém `Chat` (string JID), `ID` (id da mensagem), `IsFromMe` (boolean), `IsGroup` (boolean) e `Timestamp` (RFC 3339).
`count`	integer	Não	Número de mensagens a buscar antes da mensagem de referência.

{
  "messageInfo": {
    "Chat": "5511999999999@s.whatsapp.net",
    "ID": "3EB0C767D82B0A1B2C3D",
    "IsFromMe": false,
    "IsGroup": false,
    "Timestamp": "2026-07-09T12:00:00Z"
  },
  "count": 50
}

Grupo

Gerencie grupos do WhatsApp para o número conectado: liste, inspecione, crie, atualize e entre ou saia. A apikey seleciona o número, portanto nenhum segmento de instância é usado.

GET /group/list — Listar grupos dos quais participa

Retorna todos os grupos dos quais o número conectado participa.Sem corpo de requisição.

POST /group/info — Obter informações do grupo

Busca os metadados (nome, participantes, dono) de um único grupo.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).

{
  "groupJid": "120363012345678901@g.us"
}

POST /group/invitelink — Obter link de convite

Retorna o link de convite do grupo, opcionalmente revogando o anterior primeiro.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).
`reset`	boolean	Não	Quando `true`, revoga o link atual e gera um novo.

{
  "groupJid": "120363012345678901@g.us",
  "reset": false
}

POST /group/photo — Definir foto do grupo

Define a foto de perfil do grupo a partir de uma URL pública ou de um data URI base64.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).
`image`	string	Sim	Imagem como URL `http(s)` ou um data URI `data:image/jpeg;base64,` / `data:image/png;base64,`.

{
  "groupJid": "120363012345678901@g.us",
  "image": "https://example.com/group-photo.jpg"
}

POST /group/name — Definir nome do grupo

Atualiza o assunto (nome) do grupo.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).
`name`	string	Sim	Novo nome do grupo.

{
  "groupJid": "120363012345678901@g.us",
  "name": "Sales Team"
}

POST /group/description — Definir descrição do grupo

Atualiza a descrição (tópico) do grupo.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).
`description`	string	Sim	Nova descrição do grupo.

{
  "groupJid": "120363012345678901@g.us",
  "description": "Team coordination and announcements"
}

POST /group/create — Criar grupo

Cria um novo grupo com o nome informado e os participantes iniciais.

Campo	Tipo	Obrigatório	Descrição
`groupName`	string	Sim	Nome do novo grupo.
`participants`	string[]	Sim	Números de telefone ou JIDs a adicionar (pelo menos um).

{
  "groupName": "Sales Team",
  "participants": [
    "5511999999999",
    "5511888888888"
  ]
}

POST /group/participant — Atualizar participantes

Adiciona, remove, promove ou rebaixa participantes de um grupo.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).
`participants`	string[]	Sim	Números de telefone ou JIDs sobre os quais agir (pelo menos um).
`action`	string	Sim	Um entre `add`, `remove`, `promote`, `demote`.

{
  "groupJid": "120363012345678901@g.us",
  "participants": [
    "5511999999999"
  ],
  "action": "add"
}

GET /group/myall — Listar grupos próprios

Retorna apenas os grupos dos quais o número conectado é dono (é admin/dono).Sem corpo de requisição.

POST /group/join — Entrar via convite

Entra em um grupo usando um código de convite (o token de um link de convite).

Campo	Tipo	Obrigatório	Descrição
`code`	string	Sim	Código de convite (o segmento após `chat.whatsapp.com/`).

{
  "code": "AbCdEfGhIjKlMnOpQrStUv"
}

POST /group/leave — Sair do grupo

Sai do grupo especificado.

Campo	Tipo	Obrigatório	Descrição
`groupJid`	string	Sim	JID do grupo (`<id>@g.us`).

{
  "groupJid": "120363012345678901@g.us"
}

Chamada (voz)

Faça, atenda, rejeite, encerre e transmita áudio em chamadas de voz do WhatsApp. A apikey seleciona o número, então nenhuma instância vai no caminho ou no corpo.

POST /call/start — Iniciar chamada de saída

Faz uma chamada de voz de saída no WhatsApp para o número informado e retorna a sessão de chamada criada.

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Telefone do destinatário no formato DDI+DDD+número (ex.: `5511999999999`) ou um JID completo.

{
  "number": "5511999999999"
}

GET /call/list — Listar chamadas ativas

Retorna todas as sessões de chamada atualmente monitoradas para o número.Sem corpo de requisição.

POST /call/get — Obter chamada por id

Retorna o estado atual de uma única sessão de chamada monitorada.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Não	Identificador da chamada a ser obtida. Um corpo vazio é aceito (retorna a última chamada monitorada).

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/answer — Atender chamada recebida

Atende uma chamada recebida que está tocando; omita callId para atender a última chamada recebida.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Não	Identificador da chamada recebida a ser atendida. Quando omitido, a chamada recebida mais recente é atendida.

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/reject — Rejeitar chamada

Rejeita uma chamada; se a chamada não estiver mais sendo monitorada, recorre à rejeição via callCreator.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Sim	Identificador da chamada a ser rejeitada.
`callCreator`	string	Não	JID de quem chamou, usado como alternativa quando a chamada não está sendo monitorada (ex.: `5511999999999@s.whatsapp.net`).

{
  "callId": "3EB0C767D26A8B4E7F1A",
  "callCreator": "5511999999999@s.whatsapp.net"
}

POST /call/reject/by-id — Rejeitar chamada monitorada

Rejeita uma chamada atualmente monitorada pelo seu identificador.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Sim	Identificador da chamada monitorada a ser rejeitada.

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/reject/latest — Rejeitar última oferta

Rejeita a chamada recebida oferecida mais recentemente para o número.Sem corpo de requisição.

POST /call/hangup — Encerrar chamada

Encerra uma chamada ativa pelo seu identificador.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Sim	Identificador da chamada ativa a ser encerrada.

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/media/play — Reproduzir áudio na chamada

Transmite um arquivo de áudio para uma chamada ativa. Aceita este corpo JSON (filePath no servidor) ou um upload multipart/form-data com os campos callId, audio (ou file) e hangupAfterPlay.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Sim	Identificador da chamada ativa em que reproduzir.
`filePath`	string	Sim	Caminho no servidor para o arquivo de áudio (`.mp3`, `.wav` ou `.opus`).
`hangupAfterPlay`	boolean	Não	Quando `true`, encerra a chamada automaticamente assim que a reprodução termina. O padrão é `false`.

{
  "callId": "3EB0C767D26A8B4E7F1A",
  "filePath": "/audios/greeting.mp3",
  "hangupAfterPlay": true
}

POST /call/media/realtime/session — Criar sessão em tempo real

Cria um token de curta duração e uma URL de WebSocket para transmitir áudio PCM em tempo real de/para uma chamada ativa.

Campo	Tipo	Obrigatório	Descrição
`callId`	string	Sim	Identificador da chamada ativa à qual anexar a mídia.
`mode`	string	Não	`talk` (enviar e receber áudio, padrão) ou `listen` (apenas receber).

{
  "callId": "3EB0C767D26A8B4E7F1A",
  "mode": "talk"
}

Comunidade

Gerencie comunidades do WhatsApp e seus grupos vinculados. A chave de API seleciona o número, portanto nenhuma instância é incluída no caminho ou no corpo.

POST /community/create — Criar comunidade

Cria uma nova comunidade com o nome informado.

Campo	Tipo	Obrigatório	Descrição
`communityName`	string	Sim	Nome de exibição da comunidade a ser criada.

{
  "communityName": "Pilot Status Community"
}

POST /community/add — Adicionar grupos

Vincula um ou mais grupos existentes a uma comunidade.

Campo	Tipo	Obrigatório	Descrição
`communityJid`	string	Sim	JID da comunidade de destino.
`groupJid`	string[]	Sim	Array de JIDs de grupos a adicionar à comunidade.

{
  "communityJid": "120363000000000000@g.us",
  "groupJid": [
    "120363111111111111@g.us",
    "120363222222222222@g.us"
  ]
}

POST /community/remove — Remover grupos

Desvincula um ou mais grupos de uma comunidade.

Campo	Tipo	Obrigatório	Descrição
`communityJid`	string	Sim	JID da comunidade de destino.
`groupJid`	string[]	Sim	Array de JIDs de grupos a remover da comunidade.

{
  "communityJid": "120363000000000000@g.us",
  "groupJid": [
    "120363111111111111@g.us"
  ]
}

Etiqueta (label)

Gerencie etiquetas do WhatsApp: adicione-as ou remova-as de conversas e mensagens, edite uma etiqueta e liste todas as etiquetas. A apikey seleciona o número, portanto nenhuma instância é incluída no caminho ou no corpo.

POST /label/chat — Adicionar etiqueta à conversa

Anexa uma etiqueta existente a uma conversa.

Campo	Tipo	Obrigatório	Descrição
`jid`	string	Sim	JID da conversa a ser etiquetada.
`labelId`	string	Sim	ID da etiqueta a ser anexada.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1"
}

POST /label/message — Adicionar etiqueta à mensagem

Anexa uma etiqueta existente a uma mensagem específica em uma conversa.

Campo	Tipo	Obrigatório	Descrição
`jid`	string	Sim	JID da conversa que contém a mensagem.
`labelId`	string	Sim	ID da etiqueta a ser anexada.
`messageId`	string	Sim	ID da mensagem de destino.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1",
  "messageId": "3EB0C767D26A8A4E8F1B"
}

POST /label/edit — Editar etiqueta

Cria ou atualiza o nome, a cor ou o estado de exclusão de uma etiqueta.

Campo	Tipo	Obrigatório	Descrição
`labelId`	string	Sim	ID da etiqueta a ser editada.
`name`	string	Sim	Nome de exibição da etiqueta.
`color`	integer	Não	Índice de cor da etiqueta.
`deleted`	boolean	Não	Marca a etiqueta como excluída quando verdadeiro.

{
  "labelId": "1",
  "name": "Priority",
  "color": 3,
  "deleted": false
}

GET /label/list — Listar todas as etiquetas

Retorna todas as etiquetas definidas no número conectado.Sem corpo de requisição.

POST /unlabel/chat — Remover etiqueta da conversa

Remove uma etiqueta de uma conversa.

Campo	Tipo	Obrigatório	Descrição
`jid`	string	Sim	JID da conversa da qual remover a etiqueta.
`labelId`	string	Sim	ID da etiqueta a ser removida.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1"
}

POST /unlabel/message — Remover etiqueta da mensagem

Remove uma etiqueta de uma mensagem específica em uma conversa.

Campo	Tipo	Obrigatório	Descrição
`jid`	string	Sim	JID da conversa que contém a mensagem.
`labelId`	string	Sim	ID da etiqueta a ser removida.
`messageId`	string	Sim	ID da mensagem de destino.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1",
  "messageId": "3EB0C767D26A8A4E8F1B"
}

Gerencie newsletters (canais) do WhatsApp — crie, liste, inspecione, resolva convites, inscreva-se e busque mensagens. A apikey seleciona o número, então nenhum segmento de instância aparece no caminho.

Cria uma nova newsletter (canal) com um nome e uma descrição opcional.

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome de exibição da newsletter (canal).
`description`	string	Não	Descrição da newsletter exibida aos inscritos.

{
  "name": "Pilot Status Updates",
  "description": "Official channel for product news and status."
}

Resolve os metadados da newsletter a partir de uma chave de convite (a parte do código de um link de convite de canal).

Campo	Tipo	Obrigatório	Descrição
`key`	string	Sim	Chave de convite do link do canal (por exemplo, a parte após `whatsapp.com/channel/`).

{
  "key": "0029VaAbCdEfGhIjKlMnOpQr"
}

Inscreve o número conectado nas atualizações ao vivo da newsletter informada pelo JID.

Campo	Tipo	Obrigatório	Descrição
`jid`	string	Sim	JID da newsletter (termina em `@newsletter`).

{
  "jid": "120363012345678901@newsletter"
}

Busca mensagens de uma newsletter, com paginação opcional por contagem e por before-id.

Campo	Tipo	Obrigatório	Descrição
`jid`	string	Sim	JID da newsletter (termina em `@newsletter`).
`count`	integer	Não	Número máximo de mensagens a retornar.
`before_id`	integer	Não	Retorna mensagens mais antigas que este id de mensagem (cursor de paginação).

{
  "jid": "120363012345678901@newsletter",
  "count": 50,
  "before_id": 100
}

Bloqueados (admin/global)

Estes caminhos globais e exclusivos de administrador do Evolution GO não são expostos pela camada e retornam 403: GET /server/ok · /swagger/* · POST /instance/create · GET /instance/all · GET /instance/info/{id} · DELETE /instance/delete/{id} · POST /instance/proxy/{id} · DELETE /instance/proxy/{id} · POST /instance/forcereconnect/{id} · GET /instance/logs/{id}

Eventos

A camada encaminha eventos para o seu webhook configurado no formato nativo (PascalCase) do próprio Evolution GO, para que seus manipuladores de eventos existentes continuem funcionando sem alterações: Message · SendMessage · Receipt · Presence · ChatPresence · Archive · CallOffer · CallAccept · CallTerminate · Connected · PairSuccess · TemporaryBan · LoggedOut · ConnectFailure · Disconnected · LabelEdit · LabelAssociationChat · LabelAssociationMessage · Contact · PushName · GroupInfo · JoinedGroup · NewsletterJoin · NewsletterLeave · QRCode · QRSuccess Os aliases modernos em UPPER_SNAKE também são aceitos: MESSAGES_UPSERT · SEND_MESSAGE · CONNECTION_UPDATE · QRCODE_UPDATED · PRESENCE_UPDATE · CHATS_UPSERT · CHATS_UPDATE · CHATS_DELETE · GROUPS_UPSERT · GROUPS_UPDATE · GROUP_PARTICIPANTS_UPDATE · CALL · CONTACTS_UPSERT · CONTACTS_UPDATE · NEWSLETTER_UPDATE · LABEL_EDIT · LABEL_ASSOCIATION Além disso, o Pilot Status pode entregar seus próprios eventos normalizados junto com os nativos:

Ciclo de vida da chamada: call.ringing, call.connected, call.ended, call.missed
Ciclo de vida do número: number.created, number.connected, number.disconnected, number.removed

Exemplo: enviar texto via camada Evolution GO

A requisição abaixo é uma chamada real da camada Evolution GO — um POST /send/text padrão, com apenas a base URL alterada para rotear através do Pilot Status. Não há segmento de instância no caminho: o cabeçalho apikey seleciona a instância.

curl -X POST 'https://pilotstatus.com.br/api/layer/evolution-go/send/text' \
  -H 'apikey: YOUR_PILOT_STATUS_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "number": "5511999999999", "text": "Hello from Pilot Status! 👋" }'

Os campos do corpo são os mesmos que seu código Evolution GO já envia para POST /send/text — number e text, além de campos opcionais como delay, quoted e mentionedJid. O formato da resposta é idêntico ao que seu código existente consome.

Se alguma operação do Evolution GO não for suportada pela camada, use a API nativa do Pilot Status. Para dúvidas específicas de compatibilidade, fale com o suporte no WhatsApp: +55 11 96743-5133.

Visão Geral

Mensagens

Modelos

Números

Conversas & Dados

Webhooks

Chamadas de Voz