Obter Instância
Retorna os detalhes de uma instância específica do WhatsApp.
{
"success": true,
"data": {
"id": "{ID_DA_SUA_INSTANCIA}",
"name": "Suporte Técnico",
"status": "CONNECTED",
"token": "{TOKEN_DA_SUA_INSTANCIA}",
"messages_sent": 350,
"messages_failed": 2,
"created_at": "2026-06-07T10:16:03Z"
},
"error": null
}Útil para monitorar o status da conexão periodicamente em segundo plano. Evite fazer polling em intervalos menores que 30 segundos.
Headers
Token no formato Bearer <token_empresa>.
Path Parameters
ID único da instância (UUIDv7) enviado no caminho da URL.
Response Schema
application/jsonIndica se a requisição obteve sucesso.
Mensagem de erro caso success seja falso.
Detalhes da instância obtida. Pode ser null caso não haja dados.
Atributos do Objeto
ID único da instância (UUIDv7).
Nome identificador da instância.
Status atual da conexão (Valores possíveis: CONNECTED, DISCONNECTED, WAITING_QR, ERROR, TIMEOUT, CONNECTING, CONNECT_FAILURE, BANNED, CONFLICT, LOGGED_OUT, STREAM_ERROR, CORRUPTED).
Token secreto exclusivo da instância (utilizado no header X-Instance-Token).
Total de mensagens enviadas.
Total de mensagens falhadas.
Data de criação da instância.