Alias Z-API para conversas

Alias Z-API para listar conversas da instância.

API key Escopo read

Exemplo de requisição

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

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

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

GET /instances/{id}/token/{token}/get-chats

API key

Entenda

Conceituação

Alias Z-API para listar conversas da instância.

O token na URL é a API key do workspace ou a chave mestra. Por aparecer em logs de acesso, use HTTPS e migre para as rotas nativas quando possível.

Contrato

Atributos

4 campos

Header

x-api-key string obrigatório

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

Client-Token string opcional

Opcional. Quando enviado, precisa pertencer ao mesmo workspace.

Path

id string obrigatório

ID da instância.

token string obrigatório

API key do workspace ou chave mestra.

Contrato

Resposta

200

{
  "data": {
    "id": "..."
  }
}

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.

404 Recurso não encontrado ou pertence a outro workspace.