Communication¶
Ce qui sort du système : l'information diffusée aux voyageurs, les échanges avec les conducteurs, et les flux normalisés consommés par les tiers.
alerts¶
Alerte — un message d'information voyageurs signalant une perturbation : travaux, déviation, arrêt non desservi, événement exceptionnel. L'alerte reprend la structure des messages de perturbation du GTFS-RT : un titre, une description, une cause, un effet, les périodes concernées et les entités visées — une ligne, un arrêt.
Identifiant <alert_id>. Une alerte peut être diffusée aux voyageurs par notification poussée, et rester en brouillon tant qu'elle n'est pas publiée.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/alerts |
Liste les alertes du groupe |
GET /api/v4/groups/<group_id>/alerts/<alert_id> |
Décrit une alerte |
GET /api/v4/groups/<group_id>/export/alerts |
Exporte les alertes au format CSV |
messages¶
Message — un échange entre l'exploitant et les conducteurs, ou l'inverse. À distinguer de l'alerte, qui s'adresse aux voyageurs : le message reste interne au service.
Identifiant <message_id>. Un message a des destinataires, dont l'état de réception se suit individuellement.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/messages |
Liste les messages du groupe |
POST /api/v4/groups/<group_id>/messages |
Envoie un message |
PATCH /api/v4/groups/<group_id>/messages/<message_id>/recipients/<recipient_address> |
Met à jour l'état d'un destinataire |
notifications¶
Notification — l'envoi poussé vers un destinataire hors de l'application : SMS ou notification mobile. Sert notamment à relayer une alerte aux voyageurs abonnés, ou à joindre un conducteur.
Pas d'identifiant propre exposé.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/notifications/sms_count |
Donne la consommation de SMS du groupe |
urgency¶
Urgence — une alerte déclenchée par le conducteur depuis son appareil, signalant une situation nécessitant une intervention immédiate. Elle remonte la position du véhicule et le contexte au moment du déclenchement.
Identifiant <urgency_id>. Une urgence porte l'appareil émetteur, sa position et son horodatage, et référence la course, le conducteur et le véhicule concernés lorsqu'ils sont connus. Son cycle de vie comporte une prise en compte puis une résolution, chacune tracée avec son auteur ; une résolution peut qualifier l'alerte de fausse.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/urgency |
Liste les urgences du groupe |
| Endpoint | Rôle |
|---|---|
POST /api/v4/groups/<group_id>/urgency/acknowledge/<urgency_id> |
Prend en compte une urgence |
POST /api/v4/groups/<group_id>/urgency/resolve/<urgency_id> |
Résout une urgence |
voip¶
Téléphonie — la liaison vocale entre la régulation et les conducteurs, et les demandes de rappel qui en découlent. Complète la messagerie lorsqu'un échange écrit ne suffit pas.
Identifiant <callback_id> pour une demande de rappel.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/voip/devices |
Liste les appareils joignables |
GET /api/v4/groups/<group_id>/voip/callbacks |
Liste les demandes de rappel |
gtfs-rt¶
GTFS-RT — le flux temps réel normalisé décrivant l'état courant du réseau : positions des véhicules, avance-retard sur les courses, et perturbations. C'est le format attendu par les calculateurs d'itinéraire et les systèmes d'information voyageurs.
Pas d'identifiant : le flux se demande par type.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/gtfs-rt |
Donne le flux temps réel du groupe |
GET /api/v4/groups/<group_id>/gtfs-rt/<feed_type> |
Donne un type de flux précis |
Le flux est le produit des entités décrites ailleurs dans ce glossaire : le théorique vient du GTFS, les positions des appareils, les perturbations des alertes et des modifications de course.
siri¶
SIRI — la norme européenne d'échange de données temps réel entre systèmes de transport. Elle couvre le même besoin que le GTFS-RT, avec un formalisme différent, et est souvent exigée par les autorités organisatrices en Europe.
Pas d'identifiant : les services disponibles se découvrent par les capacités du flux.
| Endpoint | Rôle |
|---|---|
GET /api/v4/groups/<group_id>/siri |
Donne le flux SIRI du groupe |
GET /api/v4/groups/<group_id>/siri/capabilities |
Décrit les services SIRI disponibles |