Instâncias

Listar instâncias do workspace

Lista os números do workspace com status, telefone, webhook e filtros configurados.

API key Escopo read

Exemplo de requisição

curl -X GET "https://seu-dominio/instances" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/instances', {
  method: 'GET',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

GET /instances

API key

Entenda

Conceituação

Lista os números do workspace com status, telefone, webhook e filtros configurados. Com a chave mestra, pode listar todas as instâncias.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Contrato

Atributos

1 campo

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Contrato

Resposta

200

{
  "data": [
    {
      "id": "inst_...",
      "name": "Atendimento",
      "status": "connected",
      "phone": "5511999999999",
      "webhookUrl": "https://seu-sistema.com/hooks/whatsapp",
      "webhookEvents": null,
      "webhookNotifyFromMe": true
    }
  ]
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.

401 Credencial ausente, inválida ou sessão expirada.

403 Escopo insuficiente, IP não autorizado ou workspace suspenso.

409 Instância não conectada ou conflito de estado.