/instance/allListar 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
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
companyId | string | opcional | — |
Headers adicionais
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
X-Request-Id | string | opcional | ASCII 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
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
[].id | string | obrigatório | Formato: uuid |
[].name | string | obrigatório | — |
[].systemName | string | opcional | — |
[].companyId | string | opcional | — |
[].status | string | obrigatório | Valores: "disconnected", "connecting", "connected" |
[].owner | string | obrigatório | — |
[].profileName | string | obrigatório | — |
[].qrcode | string | obrigatório | PNG em data URI quando há QR vigente; vazio no restante e nas listagens. |
[].paircode | string | opcional | — |
[].lastDisconnect | string | opcional | RFC 3339. Formato: date-time |
[].lastDisconnectReason | string | opcional | — |
[].disconnectCode | string | opcional | — |
[].worker | string | opcional | — |
[].limitEnforcement | string | opcional | — |
[].limitUntil | string | opcional | RFC 3339. Formato: date-time |
[].created | string | opcional | RFC 3339. Formato: date-time |
[].updated | string | opcional | RFC 3339. Formato: date-time |
[].kind | string | obrigatório | Valores: "whatsapp", "calls" |
unauthorized: header ausente, inválido ou duplicado. Bearer/query/instancekey não substituem admintoken/token.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |
storage_unavailable (Retry-After=5). Algumas rotas também retornam 502 por falha da conexão/mídia; consultar error.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |
Falha; usar HTTP status e error. 404 rota inexistente; 405 método inválido com Allow. Ver catálogo no guia de integração.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |