Skip to content

Voki APIPlataforma de Videochamadas

Documentação completa da API REST e WebSocket para integração com a plataforma Voki v4.0

Visão Geral

A API Voki permite integrar e automatizar todas as funcionalidades da plataforma de videochamadas. Construída sobre Elixir/Phoenix, a API oferece:

  • Autenticação JWT com suporte a MFA (TOTP)
  • Multi-tenancy com isolamento completo por tenant
  • CRUD completo para todas as entidades do sistema
  • Analytics em tempo real com views materializadas
  • WebSocket para comunicação bidirecional
  • Webhooks Asaas para billing automatizado

Base URL

https://voki.avanter.com.br/api/

Formato de Resposta

Todas as respostas seguem o padrão:

Sucesso (objeto)

json
{
  "data": {
    "id": "uuid",
    "field": "value"
  }
}

Sucesso (lista paginada)

json
{
  "data": [...],
  "meta": {
    "current_page": 1,
    "page_size": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Erro de validação

json
{
  "errors": {
    "email": ["não pode ficar em branco"],
    "name": ["deve ter pelo menos 2 caracteres"]
  }
}

Erro genérico

json
{
  "errors": {
    "detail": "Não autorizado"
  }
}

Rate Limiting

EndpointLimite
/api/auth/*5 requisições/minuto
Endpoints públicos30 requisições/minuto
Endpoints autenticadosSem limite explícito

Documentação da API Voki v4.0