Saltar al contenido principal
Esta página resume de forma visual el ciclo de vida de una consulta, el flujo típico de integración y la estructura de la API.

​
Estados de una consulta

Una consulta pasa por los siguientes estados. Los eventos de webhook (consultation.created, consultation.expired, consultation.completed, session_started, session_ended) reflejan las transiciones.
EstadoDescripción
PendienteConsulta creada; paciente y proveedor pueden unirse con las URLs y el PIN.
En cursoAl menos un participante ha entrado a la videollamada (session_started).
ExpiradaLlegó la hora de expiración sin que se utilizara la consulta.
FinalizadaLa sesión se cerró (manual o automáticamente); evento consultation.completed.
El campo status en la respuesta de la API y en los payloads de webhook puede tomar valores como Pending; los estados del diagrama son conceptuales y alineados con los eventos de webhook.

​
Flujo de integración típico

Flujo simplificado: su sistema crea la consulta, recibe las URLs y el PIN, y opcionalmente recibe eventos en tiempo real por webhook.
  • Creación: su sistema llama a POST /consultations y recibe participantAccess (URLs) y accessPin.
  • Uso: paciente y proveedor entran con esas URLs; si tiene webhooks, recibe session_started y session_ended.
  • Cierre: al finalizar la sesión se envía consultation.completed; puede consultar el detalle con GET /consultations/{consultationId}.

​
Estructura de la API

Visión general de los recursos y cómo se relacionan con su organización.
RecursoDescripción
ConsultationsCrear consultas (POST) y obtener detalle por consultationId (GET).
ProvidersListar proveedores con filtros opcionales (GET /providers).
Organization profileDatos de su organización y configuración (GET /organizations/profile).
WebhooksLa plataforma envía eventos a su URL; usted verifica la firma y procesa.

​
Consulta programada vs inmediata

Diferencia rápida según la presencia de scheduledAt en POST /consultations:
  • Programada: incluya scheduledAt en formato yyyy-MM-dd HH:mm (zona horaria de la organización). Mínimo 15 minutos de anticipación.
  • Inmediata: no envíe scheduledAt; la consulta queda disponible de inmediato.

​
Ver también