ZapFácil zapfacil.dev Doc
Entrar Painel
Doc AI Friendly (agente de IA)

Obter Instância

Retorna os detalhes de uma instância específica do WhatsApp.

GET /instances/{instance_id}
Exemplo de Retorno (JSON) 
{
  "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

Authorization string header required 06/04/2026

Token no formato Bearer <token_empresa>.

Query Parameters

instance_id string (uuid) path required 06/04/2026

ID único da instância (UUIDv7) enviado no caminho da URL.

Response Schema

application/json
success boolean required 06/04/2026

Indica se a requisição obteve sucesso.

error string | null required 06/04/2026

Mensagem de erro caso success seja falso.

data object | null required 06/04/2026

Detalhes da instância obtida. Pode ser null caso não haja dados.

Atributos do Objeto
id string (uuid) 06/04/2026

ID único da instância (UUIDv7).

name string 06/04/2026

Nome identificador da instância.

status enum 06/04/2026

Status atual da conexão (Valores possíveis: CONNECTED, DISCONNECTED, WAITING_QR, ERROR, TIMEOUT, CONNECTING, CONNECT_FAILURE, BANNED, CONFLICT, LOGGED_OUT, STREAM_ERROR, CORRUPTED).

messages_sent integer 06/04/2026

Total de mensagens enviadas.

messages_failed integer 06/04/2026

Total de mensagens falhadas.

created_at string 06/04/2026

Data de criação da instância.

{
  "success": true,
  "data": {
    "id": "019e059f...",
    "name": "Suporte Técnico",
    "status": "CONNECTED",
    "token": "7o6DCwb8eS3WkdomVCOa...",
    "messages_sent": 1205,
    "messages_failed": 12,
    "created_at": "2026-06-05T15:20:00Z"
  },
  "error": null
}