Planification

Télécharger le schéma

Événements de diffusion planifiés pour les appareils Kaleo Connect.

Lister les événements planifiés

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Liste les événements planifiés, du plus récent au plus ancien.

Lister les événements planifiés › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

Lister les événements planifiés › Paramètres de requête

page

integer · min: 1

Numéro de page, à partir de 1. Les valeurs supérieures à la dernière page renvoient la dernière page.

Par défaut : 1

pageSize

integer · min: 1

Événements par page. Les valeurs supérieures à 100 utilisent 100.

Par défaut : 14

Lister les événements planifiés › Réponses

Succès

ScheduledEventPage

ScheduledEvent[] · requis

total

integer · min: 0 · requis

Nombre total d’événements planifiés correspondants, toutes pages confondues.

page

integer · min: 1 · requis

Page retournée ; peut être inférieure à celle demandée.

pageSize

integer · min: 1 · max: 100 · requis

Obtenir un événement planifié

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule/{eventId}

Bearer (API key)

Consulte un événement planifié.

Obtenir un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

eventId

string · requis

ID de l’événement planifié provenant de GET /schedule.

Obtenir un événement planifié › Réponses

Succès

ScheduledEventDetails

ScheduledEvent · requis

Créer un événement planifié

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Crée un événement planifié. Les paramètres de diffusion omis utilisent les valeurs enregistrées de l’église.

Créer un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

Créer un événement planifié › Corps de la requête

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · requis

deviceId

string · requis

ID de l’appareil Kaleo Connect provenant de GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · requis

Date et heure de début en heure locale, sans décalage de fuseau horaire. Interprétées dans timezone.

timezone

string · requis

Fuseau horaire IANA, comme America/Toronto. Les répétitions suivent l’heure locale ; les heures inexistantes lors des changements d’heure sont ignorées et les heures répétées ne sont exécutées qu’une fois.

repeat

string · enum

Fréquence de répétition. La valeur par défaut est "once" à la création d’un événement.

Valeurs de l'énumération :

once

daily

weekly

Par défaut : once

weekdays

string[] · maxItems: 7 · unique

Jours des répétitions hebdomadaires. Obligatoire lorsque repeat vaut "weekly" ; vide sinon.

Valeurs de l'énumération :

Par défaut : []

speakerLanguage

string

Code depuis GET /languages/speaker. Utilisez "mul" pour le mode multilingue.

targetLanguages

string[]

Codes depuis GET /languages/target. Utilisez ["ALL"] pour toutes les cibles prises en charge, dans la limite de votre plan.

duration

integer · min: 60 · max: 21600

Durée jusqu'à l'arrêt automatique, en secondes.

ProPresenterSelection

Choisissez la source ProPresenter pour cette session. Configurez sa connexion dans Connect.

Créer un événement planifié › Réponses

Succès

ScheduledEventDetails

ScheduledEvent · requis

POST/v1/church/{churchId}/schedule

curl https://babel.withkaleo.com/v1/church/:churchId/schedule \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Sunday service",
  "deviceId": "00000000-0000-4000-8000-000000000003",
  "startsAt": "2026-11-01T09:00:00",
  "timezone": "America/Toronto",
  "repeat": "weekly",
  "weekdays": [
    "SU"
  ],
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "duration": 3600,
  "proPresenter": {
    "mode": "default"
  }
}'

Exemple de corps de requête

{
  "name": "Sunday service",
  "deviceId": "00000000-0000-4000-8000-000000000003",
  "startsAt": "2026-11-01T09:00:00",
  "timezone": "America/Toronto",
  "repeat": "weekly",
  "weekdays": [
    "SU"
  ],
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "duration": 3600,
  "proPresenter": {
    "mode": "default"
  }
}

json

application/json

Exemples de réponses

{
  "event": {
    "eventId": "00000000-0000-4000-8000-000000000002",
    "name": "Sunday service",
    "deviceId": "00000000-0000-4000-8000-000000000003",
    "startsAt": "2026-11-01T09:00:00",
    "timezone": "America/Toronto",
    "repeat": "weekly",
    "weekdays": [
      "SU"
    ],
    "speakerLanguage": "en",
    "targetLanguages": [
      "fr-FR"
    ],
    "duration": 3600,
    "proPresenter": {
      "mode": "default"
    }
  }
}

json

application/json

Modifier un événement planifié

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/schedule/{eventId}

Bearer (API key)

Modifie un événement planifié. Les champs omis conservent leur valeur actuelle. Les modifications s’appliquent aux prochains démarrages.

Modifier un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

eventId

string · requis

ID de l’événement planifié provenant de GET /schedule.

Modifier un événement planifié › Corps de la requête

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID de l’appareil Kaleo Connect provenant de GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\…

Date et heure de début en heure locale, sans décalage de fuseau horaire. Interprétées dans timezone.

timezone

string

repeat

string · enum

Fréquence de répétition. La valeur par défaut est "once" à la création d’un événement.

Valeurs de l'énumération :

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Jours des répétitions hebdomadaires. Obligatoire lorsque repeat vaut "weekly" ; vide sinon.

Valeurs de l'énumération :

speakerLanguage

string

Code depuis GET /languages/speaker. Utilisez "mul" pour le mode multilingue.

targetLanguages

string[]

Codes depuis GET /languages/target. Utilisez ["ALL"] pour toutes les cibles prises en charge, dans la limite de votre plan.

duration

integer · min: 60 · max: 21600

Durée jusqu'à l'arrêt automatique, en secondes.

ProPresenterSelection

Choisissez la source ProPresenter pour cette session. Configurez sa connexion dans Connect.

Modifier un événement planifié › Réponses

Succès

ScheduledEventDetails

ScheduledEvent · requis

PATCH/v1/church/{churchId}/schedule/{eventId}

curl https://babel.withkaleo.com/v1/church/:churchId/schedule/:eventId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "duration": 5400
}'

Exemple de corps de requête

{
  "duration": 5400
}

json

application/json

Exemples de réponses

{
  "event": {
    "eventId": "00000000-0000-4000-8000-000000000002",
    "name": "Sunday service",
    "deviceId": "00000000-0000-4000-8000-000000000003",
    "startsAt": "2026-11-01T09:00:00",
    "timezone": "America/Toronto",
    "repeat": "weekly",
    "weekdays": [
      "SU"
    ],
    "speakerLanguage": "en",
    "targetLanguages": [
      "fr-FR"
    ],
    "duration": 5400,
    "proPresenter": {
      "mode": "default"
    }
  }
}

json

application/json

Supprimer un événement planifié

DELETE

https://babel.withkaleo.com

/v1/church/{churchId}/schedule/{eventId}

Bearer (API key)

Supprime un événement planifié et annule ses prochains démarrages. Une diffusion déjà en cours continue.

Supprimer un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

eventId

string · requis

ID de l’événement planifié provenant de GET /schedule.

Supprimer un événement planifié › Réponses

Succès

eventId

string · requis

removed

boolean · enum · requis

Valeurs de l'énumération :

Sessions

Lister les événements planifiés

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Liste les événements planifiés, du plus récent au plus ancien.

Lister les événements planifiés › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

Lister les événements planifiés › Paramètres de requête

page

integer · min: 1

Numéro de page, à partir de 1. Les valeurs supérieures à la dernière page renvoient la dernière page.

Par défaut : 1

pageSize

integer · min: 1

Événements par page. Les valeurs supérieures à 100 utilisent 100.

Par défaut : 14

Lister les événements planifiés › Réponses

Succès

ScheduledEventPage

ScheduledEvent[] · requis

total

integer · min: 0 · requis

Nombre total d’événements planifiés correspondants, toutes pages confondues.

page

integer · min: 1 · requis

Page retournée ; peut être inférieure à celle demandée.

pageSize

integer · min: 1 · max: 100 · requis

Obtenir un événement planifié

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule/{eventId}

Bearer (API key)

Consulte un événement planifié.

Obtenir un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

eventId

string · requis

ID de l’événement planifié provenant de GET /schedule.

Obtenir un événement planifié › Réponses

Succès

ScheduledEventDetails

ScheduledEvent · requis

Créer un événement planifié

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Crée un événement planifié. Les paramètres de diffusion omis utilisent les valeurs enregistrées de l’église.

Créer un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

Créer un événement planifié › Corps de la requête

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · requis

deviceId

string · requis

ID de l’appareil Kaleo Connect provenant de GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · requis

Date et heure de début en heure locale, sans décalage de fuseau horaire. Interprétées dans timezone.

timezone

string · requis

repeat

string · enum

Fréquence de répétition. La valeur par défaut est "once" à la création d’un événement.

Valeurs de l'énumération :

once

daily

weekly

Par défaut : once

weekdays

string[] · maxItems: 7 · unique

Jours des répétitions hebdomadaires. Obligatoire lorsque repeat vaut "weekly" ; vide sinon.

Valeurs de l'énumération :

Par défaut : []

speakerLanguage

string

Code depuis GET /languages/speaker. Utilisez "mul" pour le mode multilingue.

targetLanguages

string[]

Codes depuis GET /languages/target. Utilisez ["ALL"] pour toutes les cibles prises en charge, dans la limite de votre plan.

duration

integer · min: 60 · max: 21600

Durée jusqu'à l'arrêt automatique, en secondes.

ProPresenterSelection

Choisissez la source ProPresenter pour cette session. Configurez sa connexion dans Connect.

Créer un événement planifié › Réponses

Succès

ScheduledEventDetails

ScheduledEvent · requis

Modifier un événement planifié

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/schedule/{eventId}

Bearer (API key)

Modifie un événement planifié. Les champs omis conservent leur valeur actuelle. Les modifications s’appliquent aux prochains démarrages.

Modifier un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

eventId

string · requis

ID de l’événement planifié provenant de GET /schedule.

Modifier un événement planifié › Corps de la requête

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID de l’appareil Kaleo Connect provenant de GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\…

Date et heure de début en heure locale, sans décalage de fuseau horaire. Interprétées dans timezone.

timezone

string

repeat

string · enum

Fréquence de répétition. La valeur par défaut est "once" à la création d’un événement.

Valeurs de l'énumération :

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Jours des répétitions hebdomadaires. Obligatoire lorsque repeat vaut "weekly" ; vide sinon.

Valeurs de l'énumération :

speakerLanguage

string

Code depuis GET /languages/speaker. Utilisez "mul" pour le mode multilingue.

targetLanguages

string[]

Codes depuis GET /languages/target. Utilisez ["ALL"] pour toutes les cibles prises en charge, dans la limite de votre plan.

duration

integer · min: 60 · max: 21600

Durée jusqu'à l'arrêt automatique, en secondes.

ProPresenterSelection

Choisissez la source ProPresenter pour cette session. Configurez sa connexion dans Connect.

Modifier un événement planifié › Réponses

Succès

ScheduledEventDetails

ScheduledEvent · requis

Supprimer un événement planifié

DELETE

https://babel.withkaleo.com

/v1/church/{churchId}/schedule/{eventId}

Bearer (API key)

Supprime un événement planifié et annule ses prochains démarrages. Une diffusion déjà en cours continue.

Supprimer un événement planifié › Paramètres de chemin

churchId

string · requis

L'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.

eventId

string · requis

ID de l’événement planifié provenant de GET /schedule.

Supprimer un événement planifié › Réponses

Succès

eventId

string · requis

removed

boolean · enum · requis

Valeurs de l'énumération :