Premium API Docs - Evolution Connect

🔑 Sessão & Conexão

POST /session/init

▼

Inicializa uma nova sessão de WhatsApp no servidor.

Parâmetros

Parâmetro	Tipo	Descrição
`Name` *	string	Nome identificador da sessão
`Token`	string	Token de segurança opcional ou obrigatório conforme config
`Os`	string	Sistema operacional (ex: Chrome, Windows)

Exemplo de Requisição

{
  "Name": "MinhaInstancia",
  "Token": "token_seguro",
  "Os": "Chrome"
}

Exemplo de Resposta

{
  "code": 200,
  "data": {
    "details": "user created successfully",
    "name": "MinhaInstancia",
    "token": "token_seguro"
  },
  "success": true
}

POST /session/connect

▼

Inicia a conexão com os servidores do WhatsApp para gerar o QR Code.

Exemplo de Requisição

{}

Exemplo de Resposta

{ "code": 200, "success": true, "message": "Connection started" }

GET /session/qr

▼

Recupera o QR Code atual em formato base64.

Exemplo de Resposta

{ "code": 200, "data": "data:image/png;base64,iVBOR...", "success": true }

GET /session/status

▼

Verifica o status atual da conexão e login.

Exemplo de Resposta

{ "code": 200, "data": { "connected": true, "loggedIn": true }, "success": true }

POST /session/logout

▼

Desconecta e encerra a sessão ativa.

Exemplo de Requisição

{}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /session/delete

▼

Remove permanentemente a instância e todos os seus dados.

Exemplo de Requisição

{}

Exemplo de Resposta

{ "code": 200, "success": true, "message": "Instance deleted" }

GET /session/all

▼

Lista todas as sessões registradas no banco de dados.

Exemplo de Resposta

{ "code": 200, "data": ["instancia1", "instancia2"], "success": true }

POST /session/terminate

▼

Encerra forçadamente o processo da instância no servidor.

Exemplo de Requisição

{}

Exemplo de Resposta

{ "code": 200, "success": true }

GET /session/settings

▼

Recupera as configurações internas da instância.

Exemplo de Resposta

{ "code": 200, "data": { "rejectCall": false, "groupsIgnore": false }, "success": true }

📤 Envio de Mensagens

POST /send/text

▼

Envia uma mensagem de texto simples.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string	Número com DDI (ex: 5511999999999)
`Body` *	string	Conteúdo da mensagem

Exemplo de Requisição

{
  "Phone": "5511999999999",
  "Body": "Olá! Esta é uma mensagem Premium."
}

Exemplo de Resposta

{ "code": 200, "success": true, "messageId": "..." }

POST /send/image

▼

Envia uma imagem via URL ou base64.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Image` *	string	URL ou Base64 da imagem
`Caption`	string	Legenda da imagem

Exemplo de Requisição

{
  "Phone": "5511999999999",
  "Image": "https://site.com/foto.jpg",
  "Caption": "Olha esta foto!"
}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /send/audio

▼

Envia um áudio (PTT ou arquivo).

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Audio` *	string	URL ou Base64

Exemplo de Requisição

{
  "Phone": "5511999999999",
  "Audio": "https://site.com/audio.mp3"
}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /send/poll

▼

Envia uma enquete interativa.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`PollName` *	string	Título da enquete
`Options` *	array	Lista de opções (strings)

Exemplo de Requisição

{
  "Phone": "5511999999999",
  "PollName": "Qual seu sabor favorito?",
  "Options": ["Pizza", "Hambúrguer", "Sushi"]
}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /send/document

▼

Envia um documento (PDF, DOCX, etc).

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Document` *	string	URL ou Base64
`FileName`	string

Exemplo de Requisição

{ "Phone": "...", "Document": "https://site.com/doc.pdf", "FileName": "Contrato.pdf" }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /send/location

▼

Envia uma localização geográfica.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Latitude` *	number
`Longitude` *	number
`Title`	string
`Address`	string

Exemplo de Requisição

{ "Phone": "...", "Latitude": -23.55, "Longitude": -46.63, "Title": "Escritório" }

Exemplo de Resposta

{ "code": 200, "success": true }

⚙️ Ações em Mensagens

POST /message/markread

▼

Marca mensagens como lidas no chat.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string

Exemplo de Requisição

{ "Phone": "5511999999999" }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /message/edit

▼

Edita uma mensagem enviada (se suportado pelo tempo).

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`MessageID` *	string
`NewBody` *	string

Exemplo de Requisição

{
  "Phone": "5511999999999",
  "MessageID": "3EB...",
  "NewBody": "Mensagem corrigida"
}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /message/react

▼

Envia uma reação (emoji) para uma mensagem.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`MessageID` *	string
`Emoji` *	string

Exemplo de Requisição

{
  "Phone": "5511999999999",
  "MessageID": "3EB...",
  "Emoji": "👍"
}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /message/delete

▼

Apaga uma mensagem para todos ou para você.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`MessageID` *	string
`Everyone`	boolean

Exemplo de Requisição

{ "Phone": "...", "MessageID": "...", "Everyone": true }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /chat/archive

▼

Arquiva ou desarquiva uma conversa.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Archive` *	boolean

Exemplo de Requisição

{ "Phone": "...", "Archive": true }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /chat/mute

▼

Silencia uma conversa por um período.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Mute` *	number	Duração em segundos (-1 para sempre)

Exemplo de Requisição

{ "Phone": "...", "Mute": 28800 }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /chat/clear

▼

Limpa todas as mensagens de uma conversa.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string

Exemplo de Requisição

{ "Phone": "..." }

Exemplo de Resposta

{ "code": 200, "success": true }

👤 Usuários & Contatos

POST /user/check

▼

Verifica se um número possui conta no WhatsApp.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string

Exemplo de Requisição

{ "Phone": "5511999999999" }

Exemplo de Resposta

{ "code": 200, "data": { "exists": true, "jid": "..." }, "success": true }

POST /user/info

▼

Recupera informações de perfil (foto, status, nome).

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string

Exemplo de Requisição

{ "Phone": "5511999999999" }

Exemplo de Resposta

{ "code": 200, "data": { "name": "Joao", "status": "Busy" }, "success": true }

POST /user/privacy

▼

Ajusta configurações de privacidade (visto por último, foto, etc).

Parâmetros

Parâmetro	Tipo	Descrição
`Category` *	string	last_seen \| profile_pic \| status \| groups
`Value` *	string	all \| contacts \| none

Exemplo de Requisição

{ "Category": "last_seen", "Value": "none" }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /user/block

▼

Bloqueia ou desbloqueia um contato.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`Action` *	string	block \| unblock

Exemplo de Requisição

{ "Phone": "5511999999999", "Action": "block" }

Exemplo de Resposta

{ "code": 200, "success": true }

GET /label/list

▼

Lista todas as etiquetas (labels) disponíveis.

Exemplo de Resposta

{ "code": 200, "data": [{ "id": "1", "name": "Novo Cliente" }], "success": true }

POST /label/add

▼

Adiciona uma etiqueta a um contato ou grupo.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string
`LabelID` *	string

Exemplo de Requisição

{ "Phone": "...", "LabelID": "1" }

Exemplo de Resposta

{ "code": 200, "success": true }

POST /call/reject

▼

Rejeita uma chamada recebida.

Parâmetros

Parâmetro	Tipo	Descrição
`CallID` *	string

Exemplo de Requisição

{ "CallID": "..." }

Exemplo de Resposta

{ "code": 200, "success": true }

👥 Grupos

POST /group/create

▼

Cria um novo grupo de WhatsApp.

Parâmetros

Parâmetro	Tipo	Descrição
`GroupName` *	string
`Participants` *	array	Lista de números

Exemplo de Requisição

{
  "GroupName": "Grupo Premium",
  "Participants": ["5511999999999", "5511888888888"]
}

Exemplo de Resposta

{ "code": 200, "success": true, "GroupJID": "...@g.us" }

GET /group/list

▼

Lista todos os grupos que você participa.

Exemplo de Resposta

{ "code": 200, "data": [{ "id": "...@g.us", "subject": "..." }], "success": true }

POST /group/update

▼

Adiciona ou remove participantes do grupo.

Parâmetros

Parâmetro	Tipo	Descrição
`GroupJID` *	string
`ParticipantJID` *	array
`Action` *	string	add \| remove \| promote \| demote

Exemplo de Requisição

{
  "GroupJID": "123456@g.us",
  "ParticipantJID": ["5511999999999"],
  "Action": "add"
}

Exemplo de Resposta

{ "code": 200, "success": true }

POST /group/invite

▼

Gera ou revoga o link de convite do grupo.

Parâmetros

Parâmetro	Tipo	Descrição
`GroupJID` *	string

Exemplo de Requisição

{ "GroupJID": "..." }

Exemplo de Resposta

{ "code": 200, "inviteUrl": "https://chat.whatsapp.com/..." }

💼 Business & Newsletters

POST /business/catalog

▼

Recupera o catálogo de uma conta Business.

Parâmetros

Parâmetro	Tipo	Descrição
`Phone` *	string

Exemplo de Requisição

{ "Phone": "5511999999999" }

Exemplo de Resposta

{ "code": 200, "data": { "products": [...] }, "success": true }

POST /newsletter/create

▼

Cria uma nova Newsletter.

Parâmetros

Parâmetro	Tipo	Descrição
`Name` *	string
`Desc`	string

Exemplo de Requisição

{ "Name": "Novidades Premium", "Desc": "Canal de notícias" }

Exemplo de Resposta

{ "code": 200, "data": { "id": "...@newsletter" }, "success": true }

GET /newsletter/list

▼

Lista as Newsletters que você segue ou gerencia.

Exemplo de Resposta

{ "code": 200, "data": [...], "success": true }

🔗 Webhooks & Config

POST /webhook/set

▼

Configura a URL de Webhook para receber eventos.

Parâmetros

Parâmetro	Tipo	Descrição
`Url` *	string
`Events`	array	messages.upsert, connection.update, etc

Exemplo de Requisição

{ "Url": "https://meusite.com/webhook", "Events": ["all"] }

Exemplo de Resposta

{ "code": 200, "success": true }

GET /webhook

▼

Recupera a configuração atual do Webhook.

Exemplo de Resposta

{ "code": 200, "data": { "url": "..." }, "success": true }

GET /server/status

▼

Verifica o estado geral do servidor de API.

Exemplo de Resposta

{ "code": 200, "status": "online", "uptime": 3600 }

📚 Documentação

🔐 Autenticação

🔑 Sessão & Conexão

📤 Envio de Mensagens

⚙️ Ações em Mensagens

👤 Usuários & Contatos

👥 Grupos

💼 Business & Newsletters

🔗 Webhooks & Config