Skip to main content
GET
Detalhes de uma Instância

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Resposta

200 - application/json

Success

Estrutura de uma instância registrada na API.

created_at
string<date-time>
obrigatório

Data e hora de criação da instância no formato ISO 8601.

Exemplo:

"2024-10-03T21:56:22.620Z"

id
string
obrigatório

Identificador único da instância.

Exemplo:

"xy9rexnkwobmgg3tehgvs"

metadata
object
obrigatório

Metadados adicionais armazenados como chave e valor.

Exemplo:
name
string
obrigatório

Nome da instância.

Exemplo:

"MyNewInstance2"

owner
object
obrigatório

Informações sobre o proprietário da instância.

settings
object
obrigatório

Objeto opcional de configurações da sua instância.

status
enum<string>
obrigatório

Status atual da instância

Opções disponíveis:
connected,
disconnected,
offline
Exemplo:

"disconnected"

webhooks
object[]
obrigatório

Lista de webhooks configurados para esta instância.

connection_type
enum<string>

Tipo de conexão da instância:

  • unofficial: conexão via QR code (padrão)
  • waba: conexão via API oficial do WhatsApp (Cloud API da Meta)
Opções disponíveis:
unofficial,
waba
Exemplo:

"unofficial"

qrcode
string | null

QR Code da instância, caso disponível.

Exemplo:

null

lookup_key
string

Identificador de pesquisa criado anteriormente.

Exemplo:

"ins_8j7wlxmpjlixx9mux5"