Saltar a contenido

Comunicación

Lo que sale del sistema: la información difundida a los viajeros, los intercambios con los conductores y los flujos normalizados que consumen terceros.

alerts

Alerta — un mensaje de información al viajero que señala una incidencia: obras, desvío, parada sin servicio, acontecimiento excepcional. La alerta sigue la estructura de los mensajes de incidencia del GTFS-RT: un título, una descripción, una causa, un efecto, los periodos afectados y las entidades a las que se dirige (una línea, una parada).

Identificador <alert_id>. Una alerta puede difundirse a los viajeros mediante notificación push y permanecer en borrador mientras no se publique.

Una alerta registrada con un periodo ilegible (una fecha o una hora que no se puede convertir) se excluye por completo del flujo GTFS-RT, en lugar de difundirse sin su periodo, lo que la dejaría activa de forma permanente. Sigue pudiendo leerse y modificarse a través de la API, y la exportación CSV la conserva con las fechas vacías.

Endpoint Función
GET /api/v4/groups/<group_id>/alerts Lista las alertas del grupo
GET /api/v4/groups/<group_id>/alerts/<alert_id> Describe una alerta
GET /api/v4/groups/<group_id>/export/alerts Exporta las alertas en formato CSV

messages

Mensaje — un intercambio entre el operador y los conductores, o a la inversa. No debe confundirse con la alerta, que se dirige a los viajeros: el mensaje es interno al servicio.

Identificador <message_id>. Un mensaje tiene destinatarios, cuyo estado de recepción se sigue de forma individual.

Endpoint Función
GET /api/v4/groups/<group_id>/messages Lista los mensajes del grupo
POST /api/v4/groups/<group_id>/messages Envía un mensaje
PATCH /api/v4/groups/<group_id>/messages/<message_id>/recipients/<recipient_address> Actualiza el estado de un destinatario

notifications

Notificación — el envío push a un destinatario fuera de la aplicación: SMS o notificación móvil. Sirve sobre todo para transmitir una alerta a los viajeros suscritos o para contactar con un conductor.

Sin identificador propio expuesto.

Endpoint Función
GET /api/v4/groups/<group_id>/notifications/sms-count Devuelve el consumo de SMS del grupo

urgency

Urgencia — una alerta activada por el conductor, desde su dispositivo o desde el pedal de emergencia conectado a un equipo embarcado del vehículo, que señala una situación que requiere una intervención inmediata. Transmite la posición del vehículo y el contexto en el momento de la activación.

Identificador <urgency_id>. Una urgencia contiene el dispositivo emisor, su posición y su marca de tiempo, y hace referencia a la expedición, al conductor y al vehículo afectados cuando se conocen. Su origen (source) distingue una alerta emitida desde la aplicación del conductor (driver_app) de una alerta emitida por un equipo embarcado (onboard_equipment). Su ciclo de vida incluye una toma en consideración y después una resolución, cada una registrada con su autor; una resolución puede calificar la alerta como falsa.

Endpoint Función
GET /api/v4/groups/<group_id>/urgency Lista las urgencias del grupo

voip

Telefonía — el enlace de voz entre la regulación y los conductores, y las solicitudes de devolución de llamada que se derivan de él. Complementa la mensajería cuando un intercambio escrito no es suficiente.

Identificador <callback_id> para una solicitud de devolución de llamada.

Endpoint Función
GET /api/v4/groups/<group_id>/voip/devices Lista los dispositivos localizables
GET /api/v4/groups/<group_id>/voip/callbacks Lista las solicitudes de devolución de llamada

gtfs-rt

GTFS-RT — el flujo en tiempo real normalizado que describe el estado actual de la red: posiciones de los vehículos, adelanto o retraso de las expediciones e incidencias. Es el formato que esperan los planificadores de viajes y los sistemas de información al viajero.

Sin identificador: el flujo se solicita por tipo.

Endpoint Función
GET /api/v4/groups/<group_id>/gtfs-rt Devuelve el flujo en tiempo real del grupo
GET /api/v4/groups/<group_id>/gtfs-rt/<feed_type> Devuelve un tipo de flujo concreto

El flujo es el resultado de entidades descritas en otras partes de este glosario: la oferta teórica procede del GTFS, las posiciones de los dispositivos y las incidencias de las alertas y de las modificaciones de expedición.

siri

SIRI — la norma europea de intercambio de datos en tiempo real entre sistemas de transporte. Cubre la misma necesidad que el GTFS-RT, con un formalismo distinto, y suelen exigirla las autoridades de transporte en Europa.

Sin identificador: los servicios disponibles se descubren a través de las capacidades del flujo.

Endpoint Función
GET /api/v4/groups/<group_id>/siri Devuelve el flujo SIRI del grupo
GET /api/v4/groups/<group_id>/siri/capabilities Describe los servicios SIRI disponibles