atendroZAP Documentação
DocsInstâncias
Markdown
GET/instance/all

Listar instâncias do servidor

Array direto. Nunca inclui token; qrcode é vazio. companyId é filtro administrativo, não isolamento de autenticação.

Autenticação

Header obrigatório: admintoken. Use o token administrativo do servidor.

Base URL: a API do servidor selecionado, como https://1.atendro.cloud. O domínio wpp.atendro.cloud hospeda a documentação e o console.

Parâmetros de consulta

CampoTipoPresençaDescrição
companyIdstringopcional—

Headers adicionais

CampoTipoPresençaDescrição
X-Request-IdstringopcionalASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: 128

Corpo da requisição

Não há corpo de requisição definido para esta operação.

Respostas

Listar instâncias do servidor

CampoTipoPresençaDescrição
[].idstringobrigatórioFormato: uuid
[].namestringobrigatório—
[].systemNamestringopcional—
[].companyIdstringopcional—
[].statusstringobrigatórioValores: "disconnected", "connecting", "connected"
[].ownerstringobrigatório—
[].profileNamestringobrigatório—
[].qrcodestringobrigatórioPNG em data URI quando há QR vigente; vazio no restante e nas listagens.
[].paircodestringopcional—
[].lastDisconnectstringopcionalRFC 3339. Formato: date-time
[].lastDisconnectReasonstringopcional—
[].disconnectCodestringopcional—
[].workerstringopcional—
[].limitEnforcementstringopcional—
[].limitUntilstringopcionalRFC 3339. Formato: date-time
[].createdstringopcionalRFC 3339. Formato: date-time
[].updatedstringopcionalRFC 3339. Formato: date-time
[].kindstringobrigatórioValores: "whatsapp", "calls"
[].callsMaxConcurrentintegeropcionalLimite próprio de ligações simultâneas da instância calls: voz e vídeo, recebidas e realizadas, incluindo ringing/connecting/active e reservas de discagem. Acima de 1 ainda depende de homologação em chamadas reais. Mínimo: 1. Máximo: 8
[].callsConfigVersionintegeropcionalVersão crescente da configuração de chamadas; presente inclusive 0 em objetos instance de kind=calls. Comparar esta versão entre respostas HTTP e snapshots de webhook para evitar regressões. O campo não pertence às instâncias whatsapp. Mínimo: 0. Formato: int64
[].incomingCallModestringopcionalComportamento para novas chamadas recebidas: allow permite atendimento humano; reject recusa no servidor; reject_reply recusa e solicita ao consumidor resposta por uma conexão de mensagens vinculada. Não atende automaticamente. O envio do texto é independente da recusa. Modelo: IncomingCallMode. Valores: "allow", "reject", "reject_reply"