Zeitplan

Schema herunterladen

Geplante Streaming-Ereignisse für Kaleo Connect-Geräte.

Geplante Ereignisse auflisten

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Listet geplante Ereignisse auf, die neuesten zuerst.

Geplante Ereignisse auflisten › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

Geplante Ereignisse auflisten › Abfrageparameter

page

integer · min: 1

Seitennummer, beginnend bei 1. Werte über der letzten Seite geben die letzte Seite zurück.

Standard: 1

pageSize

integer · min: 1

Ereignisse pro Seite. Werte über 100 verwenden 100.

Standard: 14

Geplante Ereignisse auflisten › Antworten

Erfolg

ScheduledEventPage

ScheduledEvent[] · erforderlich

total

integer · min: 0 · erforderlich

Gesamtzahl passender geplanter Ereignisse über alle Seiten.

page

integer · min: 1 · erforderlich

Zurückgegebene Seite; kann niedriger als angefordert sein.

pageSize

integer · min: 1 · max: 100 · erforderlich

Geplantes Ereignis abrufen

GET

https://babel.withkaleo.com

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

Bearer (API key)

Ruft ein geplantes Ereignis ab.

Geplantes Ereignis abrufen › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

eventId

string · erforderlich

ID des geplanten Ereignisses aus GET /schedule.

Geplantes Ereignis abrufen › Antworten

Erfolg

ScheduledEventDetails

ScheduledEvent · erforderlich

Geplantes Ereignis erstellen

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Erstellt ein geplantes Ereignis. Nicht angegebene Streaming-Einstellungen verwenden die gespeicherten Gemeindestandards.

Geplantes Ereignis erstellen › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

Geplantes Ereignis erstellen › Anfrageinhalt

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · erforderlich

deviceId

string · erforderlich

ID des Kaleo Connect-Geräts aus GET /devices.

startsAt

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

Startdatum und Startzeit in Ortszeit, ohne Zeitzonenversatz. Wird in timezone interpretiert.

timezone

string · erforderlich

IANA-Zeitzone, etwa America/Toronto. Wiederholungen folgen der Ortszeit; bei Zeitumstellungen entfallende Uhrzeiten werden übersprungen und doppelte Uhrzeiten nur einmal ausgeführt.

repeat

string · enum

Wiederholungsintervall. Beim Erstellen eines Ereignisses ist der Standard "once".

Aufzählungswerte:

once

daily

weekly

Standard: once

weekdays

string[] · maxItems: 7 · unique

Wochentage für wöchentliche Wiederholungen. Erforderlich, wenn repeat gleich "weekly" ist; andernfalls leer.

Aufzählungswerte:

Standard: []

speakerLanguage

string

Code von GET /languages/speaker. Verwenden Sie "mul" für den Mehrsprachmodus.

targetLanguages

string[]

Codes von GET /languages/target. Verwenden Sie ["ALL"] für alle unterstützten Ziele, innerhalb Ihres Planlimits.

duration

integer · min: 60 · max: 21600

Zeit bis zum automatischen Stopp in Sekunden.

ProPresenterSelection

Wählen Sie die ProPresenter-Quelle für diese Sitzung. Konfigurieren Sie deren Verbindung in Connect.

Geplantes Ereignis erstellen › Antworten

Erfolg

ScheduledEventDetails

ScheduledEvent · erforderlich

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

Beispiel-Anfrageinhalt

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

Beispiel-Antworten

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

Geplantes Ereignis aktualisieren

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Ändert ein geplantes Ereignis. Nicht angegebene Felder behalten ihre aktuellen Werte. Änderungen gelten für zukünftige Starts.

Geplantes Ereignis aktualisieren › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

eventId

string · erforderlich

ID des geplanten Ereignisses aus GET /schedule.

Geplantes Ereignis aktualisieren › Anfrageinhalt

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID des Kaleo Connect-Geräts aus GET /devices.

startsAt

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

Startdatum und Startzeit in Ortszeit, ohne Zeitzonenversatz. Wird in timezone interpretiert.

timezone

string

IANA-Zeitzone, etwa America/Toronto. Wiederholungen folgen der Ortszeit; bei Zeitumstellungen entfallende Uhrzeiten werden übersprungen und doppelte Uhrzeiten nur einmal ausgeführt.

repeat

string · enum

Wiederholungsintervall. Beim Erstellen eines Ereignisses ist der Standard "once".

Aufzählungswerte:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Wochentage für wöchentliche Wiederholungen. Erforderlich, wenn repeat gleich "weekly" ist; andernfalls leer.

Aufzählungswerte:

speakerLanguage

string

Code von GET /languages/speaker. Verwenden Sie "mul" für den Mehrsprachmodus.

targetLanguages

string[]

Codes von GET /languages/target. Verwenden Sie ["ALL"] für alle unterstützten Ziele, innerhalb Ihres Planlimits.

duration

integer · min: 60 · max: 21600

Zeit bis zum automatischen Stopp in Sekunden.

ProPresenterSelection

Wählen Sie die ProPresenter-Quelle für diese Sitzung. Konfigurieren Sie deren Verbindung in Connect.

Geplantes Ereignis aktualisieren › Antworten

Erfolg

ScheduledEventDetails

ScheduledEvent · erforderlich

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

Beispiel-Anfrageinhalt

{
  "duration": 5400
}

json

application/json

Beispiel-Antworten

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

Geplantes Ereignis entfernen

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Entfernt ein geplantes Ereignis und bricht dessen zukünftige Starts ab. Ein bereits laufender Stream wird fortgesetzt.

Geplantes Ereignis entfernen › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

eventId

string · erforderlich

ID des geplanten Ereignisses aus GET /schedule.

Geplantes Ereignis entfernen › Antworten

Erfolg

eventId

string · erforderlich

removed

boolean · enum · erforderlich

Aufzählungswerte:

Sitzungen

Geplante Ereignisse auflisten

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Listet geplante Ereignisse auf, die neuesten zuerst.

Geplante Ereignisse auflisten › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

Geplante Ereignisse auflisten › Abfrageparameter

page

integer · min: 1

Seitennummer, beginnend bei 1. Werte über der letzten Seite geben die letzte Seite zurück.

Standard: 1

pageSize

integer · min: 1

Ereignisse pro Seite. Werte über 100 verwenden 100.

Standard: 14

Geplante Ereignisse auflisten › Antworten

Erfolg

ScheduledEventPage

ScheduledEvent[] · erforderlich

total

integer · min: 0 · erforderlich

Gesamtzahl passender geplanter Ereignisse über alle Seiten.

page

integer · min: 1 · erforderlich

Zurückgegebene Seite; kann niedriger als angefordert sein.

pageSize

integer · min: 1 · max: 100 · erforderlich

Geplantes Ereignis abrufen

GET

https://babel.withkaleo.com

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

Bearer (API key)

Ruft ein geplantes Ereignis ab.

Geplantes Ereignis abrufen › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

eventId

string · erforderlich

ID des geplanten Ereignisses aus GET /schedule.

Geplantes Ereignis abrufen › Antworten

Erfolg

ScheduledEventDetails

ScheduledEvent · erforderlich

Geplantes Ereignis erstellen

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Erstellt ein geplantes Ereignis. Nicht angegebene Streaming-Einstellungen verwenden die gespeicherten Gemeindestandards.

Geplantes Ereignis erstellen › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

Geplantes Ereignis erstellen › Anfrageinhalt

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · erforderlich

deviceId

string · erforderlich

ID des Kaleo Connect-Geräts aus GET /devices.

startsAt

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

Startdatum und Startzeit in Ortszeit, ohne Zeitzonenversatz. Wird in timezone interpretiert.

timezone

string · erforderlich

IANA-Zeitzone, etwa America/Toronto. Wiederholungen folgen der Ortszeit; bei Zeitumstellungen entfallende Uhrzeiten werden übersprungen und doppelte Uhrzeiten nur einmal ausgeführt.

repeat

string · enum

Wiederholungsintervall. Beim Erstellen eines Ereignisses ist der Standard "once".

Aufzählungswerte:

once

daily

weekly

Standard: once

weekdays

string[] · maxItems: 7 · unique

Wochentage für wöchentliche Wiederholungen. Erforderlich, wenn repeat gleich "weekly" ist; andernfalls leer.

Aufzählungswerte:

Standard: []

speakerLanguage

string

Code von GET /languages/speaker. Verwenden Sie "mul" für den Mehrsprachmodus.

targetLanguages

string[]

Codes von GET /languages/target. Verwenden Sie ["ALL"] für alle unterstützten Ziele, innerhalb Ihres Planlimits.

duration

integer · min: 60 · max: 21600

Zeit bis zum automatischen Stopp in Sekunden.

ProPresenterSelection

Wählen Sie die ProPresenter-Quelle für diese Sitzung. Konfigurieren Sie deren Verbindung in Connect.

Geplantes Ereignis erstellen › Antworten

Erfolg

ScheduledEventDetails

ScheduledEvent · erforderlich

Geplantes Ereignis aktualisieren

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Ändert ein geplantes Ereignis. Nicht angegebene Felder behalten ihre aktuellen Werte. Änderungen gelten für zukünftige Starts.

Geplantes Ereignis aktualisieren › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

eventId

string · erforderlich

ID des geplanten Ereignisses aus GET /schedule.

Geplantes Ereignis aktualisieren › Anfrageinhalt

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID des Kaleo Connect-Geräts aus GET /devices.

startsAt

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

Startdatum und Startzeit in Ortszeit, ohne Zeitzonenversatz. Wird in timezone interpretiert.

timezone

string

IANA-Zeitzone, etwa America/Toronto. Wiederholungen folgen der Ortszeit; bei Zeitumstellungen entfallende Uhrzeiten werden übersprungen und doppelte Uhrzeiten nur einmal ausgeführt.

repeat

string · enum

Wiederholungsintervall. Beim Erstellen eines Ereignisses ist der Standard "once".

Aufzählungswerte:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Wochentage für wöchentliche Wiederholungen. Erforderlich, wenn repeat gleich "weekly" ist; andernfalls leer.

Aufzählungswerte:

speakerLanguage

string

Code von GET /languages/speaker. Verwenden Sie "mul" für den Mehrsprachmodus.

targetLanguages

string[]

Codes von GET /languages/target. Verwenden Sie ["ALL"] für alle unterstützten Ziele, innerhalb Ihres Planlimits.

duration

integer · min: 60 · max: 21600

Zeit bis zum automatischen Stopp in Sekunden.

ProPresenterSelection

Wählen Sie die ProPresenter-Quelle für diese Sitzung. Konfigurieren Sie deren Verbindung in Connect.

Geplantes Ereignis aktualisieren › Antworten

Erfolg

ScheduledEventDetails

ScheduledEvent · erforderlich

Geplantes Ereignis entfernen

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Entfernt ein geplantes Ereignis und bricht dessen zukünftige Starts ab. Ein bereits laufender Stream wird fortgesetzt.

Geplantes Ereignis entfernen › Pfadparameter

churchId

string · erforderlich

Ihre Kirchen-ID. Kopieren Sie sie von der API-Seite (unter Integrationen) in Ihrem Dashboard.

eventId

string · erforderlich

ID des geplanten Ereignisses aus GET /schedule.

Geplantes Ereignis entfernen › Antworten

Erfolg

eventId

string · erforderlich

removed

boolean · enum · erforderlich

Aufzählungswerte: