Planning

Schema downloaden

Geplande streaminggebeurtenissen voor Kaleo Connect-apparaten.

Geplande gebeurtenissen weergeven

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Geeft geplande gebeurtenissen weer, de nieuwste eerst.

Geplande gebeurtenissen weergeven › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

Geplande gebeurtenissen weergeven › Queryparameters

page

integer · min: 1

Paginanummer, beginnend bij 1. Waarden boven de laatste pagina retourneren de laatste pagina.

Standaard: 1

pageSize

integer · min: 1

Gebeurtenissen per pagina. Waarden boven 100 gebruiken 100.

Standaard: 14

Geplande gebeurtenissen weergeven › Antwoorden

Succes

ScheduledEventPage

ScheduledEvent[] · verplicht

total

integer · min: 0 · verplicht

Totaal aantal overeenkomende geplande gebeurtenissen, over alle pagina’s.

page

integer · min: 1 · verplicht

Teruggegeven pagina; kan lager zijn dan aangevraagd.

pageSize

integer · min: 1 · max: 100 · verplicht

Geplande gebeurtenis ophalen

GET

https://babel.withkaleo.com

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

Bearer (API key)

Leest één geplande gebeurtenis.

Geplande gebeurtenis ophalen › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

eventId

string · verplicht

ID van de geplande gebeurtenis uit GET /schedule.

Geplande gebeurtenis ophalen › Antwoorden

Succes

ScheduledEventDetails

ScheduledEvent · verplicht

Geplande gebeurtenis maken

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Maakt een geplande gebeurtenis. Weggelaten streaminginstellingen gebruiken de opgeslagen standaardwaarden van de kerk.

Geplande gebeurtenis maken › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

Geplande gebeurtenis maken › Request Body

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · verplicht

deviceId

string · verplicht

ID van het Kaleo Connect-apparaat uit GET /devices.

startsAt

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

Startdatum en -tijd in lokale tijd, zonder tijdzoneverschil. Geïnterpreteerd in timezone.

timezone

string · verplicht

IANA-tijdzone, zoals America/Toronto. Herhalingen volgen de lokale tijd; ontbrekende tijden bij zomertijdwisselingen worden overgeslagen en herhaalde tijden worden eenmaal uitgevoerd.

repeat

string · enum

Herhalingsfrequentie. De standaardwaarde bij het maken van een gebeurtenis is "once".

Enum waarden:

once

daily

weekly

Standaard: once

weekdays

string[] · maxItems: 7 · unique

Dagen voor wekelijkse herhalingen. Vereist wanneer repeat gelijk is aan "weekly"; anders leeg.

Enum waarden:

Standaard: []

speakerLanguage

string

Code van GET /languages/speaker. Gebruik "mul" voor Meertalige modus.

targetLanguages

string[]

Codes van GET /languages/target. Gebruik ["ALL"] voor alle ondersteunde doelen, binnen je planlimiet.

duration

integer · min: 60 · max: 21600

Tijd tot automatische stop, in seconden.

ProPresenterSelection

Kies de ProPresenter-bron voor deze sessie. Configureer de verbinding in Connect.

Geplande gebeurtenis maken › Antwoorden

Succes

ScheduledEventDetails

ScheduledEvent · verplicht

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"
  }
}'

Voorbeeld Request Body

{
  "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

Voorbeeld Antwoorden

{
  "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

Geplande gebeurtenis bijwerken

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Wijzigt een geplande gebeurtenis. Weggelaten velden behouden hun huidige waarden. Wijzigingen gelden voor toekomstige starts.

Geplande gebeurtenis bijwerken › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

eventId

string · verplicht

ID van de geplande gebeurtenis uit GET /schedule.

Geplande gebeurtenis bijwerken › Request Body

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID van het Kaleo Connect-apparaat uit GET /devices.

startsAt

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

Startdatum en -tijd in lokale tijd, zonder tijdzoneverschil. Geïnterpreteerd in timezone.

timezone

string

IANA-tijdzone, zoals America/Toronto. Herhalingen volgen de lokale tijd; ontbrekende tijden bij zomertijdwisselingen worden overgeslagen en herhaalde tijden worden eenmaal uitgevoerd.

repeat

string · enum

Herhalingsfrequentie. De standaardwaarde bij het maken van een gebeurtenis is "once".

Enum waarden:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dagen voor wekelijkse herhalingen. Vereist wanneer repeat gelijk is aan "weekly"; anders leeg.

Enum waarden:

speakerLanguage

string

Code van GET /languages/speaker. Gebruik "mul" voor Meertalige modus.

targetLanguages

string[]

Codes van GET /languages/target. Gebruik ["ALL"] voor alle ondersteunde doelen, binnen je planlimiet.

duration

integer · min: 60 · max: 21600

Tijd tot automatische stop, in seconden.

ProPresenterSelection

Kies de ProPresenter-bron voor deze sessie. Configureer de verbinding in Connect.

Geplande gebeurtenis bijwerken › Antwoorden

Succes

ScheduledEventDetails

ScheduledEvent · verplicht

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
}'

Voorbeeld Request Body

{
  "duration": 5400
}

json

application/json

Voorbeeld Antwoorden

{
  "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

Geplande gebeurtenis verwijderen

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Verwijdert een geplande gebeurtenis en annuleert toekomstige starts ervan. Een stream die al bezig is, gaat door.

Geplande gebeurtenis verwijderen › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

eventId

string · verplicht

ID van de geplande gebeurtenis uit GET /schedule.

Geplande gebeurtenis verwijderen › Antwoorden

Succes

eventId

string · verplicht

removed

boolean · enum · verplicht

Enum waarden:

Sessies

Geplande gebeurtenissen weergeven

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Geeft geplande gebeurtenissen weer, de nieuwste eerst.

Geplande gebeurtenissen weergeven › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

Geplande gebeurtenissen weergeven › Queryparameters

page

integer · min: 1

Paginanummer, beginnend bij 1. Waarden boven de laatste pagina retourneren de laatste pagina.

Standaard: 1

pageSize

integer · min: 1

Gebeurtenissen per pagina. Waarden boven 100 gebruiken 100.

Standaard: 14

Geplande gebeurtenissen weergeven › Antwoorden

Succes

ScheduledEventPage

ScheduledEvent[] · verplicht

total

integer · min: 0 · verplicht

Totaal aantal overeenkomende geplande gebeurtenissen, over alle pagina’s.

page

integer · min: 1 · verplicht

Teruggegeven pagina; kan lager zijn dan aangevraagd.

pageSize

integer · min: 1 · max: 100 · verplicht

Geplande gebeurtenis ophalen

GET

https://babel.withkaleo.com

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

Bearer (API key)

Leest één geplande gebeurtenis.

Geplande gebeurtenis ophalen › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

eventId

string · verplicht

ID van de geplande gebeurtenis uit GET /schedule.

Geplande gebeurtenis ophalen › Antwoorden

Succes

ScheduledEventDetails

ScheduledEvent · verplicht

Geplande gebeurtenis maken

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Maakt een geplande gebeurtenis. Weggelaten streaminginstellingen gebruiken de opgeslagen standaardwaarden van de kerk.

Geplande gebeurtenis maken › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

Geplande gebeurtenis maken › Request Body

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · verplicht

deviceId

string · verplicht

ID van het Kaleo Connect-apparaat uit GET /devices.

startsAt

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

Startdatum en -tijd in lokale tijd, zonder tijdzoneverschil. Geïnterpreteerd in timezone.

timezone

string · verplicht

IANA-tijdzone, zoals America/Toronto. Herhalingen volgen de lokale tijd; ontbrekende tijden bij zomertijdwisselingen worden overgeslagen en herhaalde tijden worden eenmaal uitgevoerd.

repeat

string · enum

Herhalingsfrequentie. De standaardwaarde bij het maken van een gebeurtenis is "once".

Enum waarden:

once

daily

weekly

Standaard: once

weekdays

string[] · maxItems: 7 · unique

Dagen voor wekelijkse herhalingen. Vereist wanneer repeat gelijk is aan "weekly"; anders leeg.

Enum waarden:

Standaard: []

speakerLanguage

string

Code van GET /languages/speaker. Gebruik "mul" voor Meertalige modus.

targetLanguages

string[]

Codes van GET /languages/target. Gebruik ["ALL"] voor alle ondersteunde doelen, binnen je planlimiet.

duration

integer · min: 60 · max: 21600

Tijd tot automatische stop, in seconden.

ProPresenterSelection

Kies de ProPresenter-bron voor deze sessie. Configureer de verbinding in Connect.

Geplande gebeurtenis maken › Antwoorden

Succes

ScheduledEventDetails

ScheduledEvent · verplicht

Geplande gebeurtenis bijwerken

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Wijzigt een geplande gebeurtenis. Weggelaten velden behouden hun huidige waarden. Wijzigingen gelden voor toekomstige starts.

Geplande gebeurtenis bijwerken › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

eventId

string · verplicht

ID van de geplande gebeurtenis uit GET /schedule.

Geplande gebeurtenis bijwerken › Request Body

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID van het Kaleo Connect-apparaat uit GET /devices.

startsAt

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

Startdatum en -tijd in lokale tijd, zonder tijdzoneverschil. Geïnterpreteerd in timezone.

timezone

string

IANA-tijdzone, zoals America/Toronto. Herhalingen volgen de lokale tijd; ontbrekende tijden bij zomertijdwisselingen worden overgeslagen en herhaalde tijden worden eenmaal uitgevoerd.

repeat

string · enum

Herhalingsfrequentie. De standaardwaarde bij het maken van een gebeurtenis is "once".

Enum waarden:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dagen voor wekelijkse herhalingen. Vereist wanneer repeat gelijk is aan "weekly"; anders leeg.

Enum waarden:

speakerLanguage

string

Code van GET /languages/speaker. Gebruik "mul" voor Meertalige modus.

targetLanguages

string[]

Codes van GET /languages/target. Gebruik ["ALL"] voor alle ondersteunde doelen, binnen je planlimiet.

duration

integer · min: 60 · max: 21600

Tijd tot automatische stop, in seconden.

ProPresenterSelection

Kies de ProPresenter-bron voor deze sessie. Configureer de verbinding in Connect.

Geplande gebeurtenis bijwerken › Antwoorden

Succes

ScheduledEventDetails

ScheduledEvent · verplicht

Geplande gebeurtenis verwijderen

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Verwijdert een geplande gebeurtenis en annuleert toekomstige starts ervan. Een stream die al bezig is, gaat door.

Geplande gebeurtenis verwijderen › Padparameters

churchId

string · verplicht

Je kerk-ID. Kopieer deze van de API pagina (onder Integraties) in je dashboard.

eventId

string · verplicht

ID van de geplande gebeurtenis uit GET /schedule.

Geplande gebeurtenis verwijderen › Antwoorden

Succes

eventId

string · verplicht

removed

boolean · enum · verplicht

Enum waarden: