Skip to content

Voki APIPlataforma de Videollamadas

Documentación completa de la API REST y WebSocket para integración con la plataforma Voki v4.0

Descripción General

La API Voki permite integrar y automatizar todas las funcionalidades de la plataforma de videollamadas. Construida sobre Elixir/Phoenix, la API ofrece:

  • Autenticación JWT con soporte para MFA (TOTP)
  • Multi-tenancy con aislamiento completo por tenant
  • CRUD completo para todas las entidades del sistema
  • Analytics en tiempo real con vistas materializadas
  • WebSocket para comunicación bidireccional
  • Webhooks Asaas para facturación automatizada

Base URL

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

Formato de Respuesta

Todas las respuestas siguen el patrón:

Éxito (objeto)

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

Éxito (lista paginada)

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

Error de validación

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

Error genérico

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

Rate Limiting

EndpointLímite
/api/auth/*5 solicitudes/minuto
Endpoints públicos30 solicitudes/minuto
Endpoints autenticadosSin límite explícito

Documentação da API Voki v4.0