Plán

Stáhnout schéma

Naplánované události streamování pro zařízení Kaleo Connect.

Seznam naplánovaných událostí

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Vrátí naplánované události od nejnovější.

Seznam naplánovaných událostí › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

Seznam naplánovaných událostí › Parametry dotazu

page

integer · min: 1

Číslo stránky, začíná na 1. Hodnoty nad poslední stránkou vrací poslední stránku.

Výchozí: 1

pageSize

integer · min: 1

Události na stránku. Hodnoty nad 100 použijí 100.

Výchozí: 14

Seznam naplánovaných událostí › Odpovědi

Úspěch

ScheduledEventPage

ScheduledEvent[] · povinné

total

integer · min: 0 · povinné

Celkový počet odpovídajících naplánovaných událostí na všech stránkách.

page

integer · min: 1 · povinné

Vrácená stránka; může být nižší než požadovaná.

pageSize

integer · min: 1 · max: 100 · povinné

Získat naplánovanou událost

GET

https://babel.withkaleo.com

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

Bearer (API key)

Načte jednu naplánovanou událost.

Získat naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

eventId

string · povinné

ID naplánované události z GET /schedule.

Získat naplánovanou událost › Odpovědi

Úspěch

ScheduledEventDetails

ScheduledEvent · povinné

Vytvořit naplánovanou událost

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Vytvoří naplánovanou událost. Vynechaná nastavení streamování použijí uložené výchozí hodnoty sboru.

Vytvořit naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

Vytvořit naplánovanou událost › Tělo požadavku

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · povinné

deviceId

string · povinné

ID zařízení Kaleo Connect z GET /devices.

startsAt

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

Datum a čas začátku v místním čase bez posunu časového pásma. Vyhodnocuje se v timezone.

timezone

string · povinné

Časové pásmo IANA, například America/Toronto. Opakování se řídí místním časem; neexistující časy při změně letního času se přeskočí a opakované časy se spustí jednou.

repeat

string · enum

Frekvence opakování. Při vytváření události je výchozí hodnota "once".

Hodnoty výčtu:

once

daily

weekly

Výchozí: once

weekdays

string[] · maxItems: 7 · unique

Dny pro týdenní opakování. Povinné, pokud je repeat rovno "weekly"; jinak prázdné.

Hodnoty výčtu:

Výchozí: []

speakerLanguage

string

Kód z GET /languages/speaker. Použijte "mul" pro režim vícejazyčný.

targetLanguages

string[]

Kódy z GET /languages/target. Použijte ["ALL"] pro všechny podporované cíle, v rámci limitu vašeho plánu.

duration

integer · min: 60 · max: 21600

Čas do automatického zastavení v sekundách.

ProPresenterSelection

Vyberte zdroj ProPresenter pro tuto relaci. Nakonfigurujte jeho připojení v Connect.

Vytvořit naplánovanou událost › Odpovědi

Úspěch

ScheduledEventDetails

ScheduledEvent · povinné

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

Příklad těla požadavku

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

Příklad odpovědí

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

Upravit naplánovanou událost

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Změní naplánovanou událost. Vynechaná pole si zachovají aktuální hodnoty. Změny platí pro budoucí spuštění.

Upravit naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

eventId

string · povinné

ID naplánované události z GET /schedule.

Upravit naplánovanou událost › Tělo požadavku

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID zařízení Kaleo Connect z GET /devices.

startsAt

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

Datum a čas začátku v místním čase bez posunu časového pásma. Vyhodnocuje se v timezone.

timezone

string

Časové pásmo IANA, například America/Toronto. Opakování se řídí místním časem; neexistující časy při změně letního času se přeskočí a opakované časy se spustí jednou.

repeat

string · enum

Frekvence opakování. Při vytváření události je výchozí hodnota "once".

Hodnoty výčtu:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dny pro týdenní opakování. Povinné, pokud je repeat rovno "weekly"; jinak prázdné.

Hodnoty výčtu:

speakerLanguage

string

Kód z GET /languages/speaker. Použijte "mul" pro režim vícejazyčný.

targetLanguages

string[]

Kódy z GET /languages/target. Použijte ["ALL"] pro všechny podporované cíle, v rámci limitu vašeho plánu.

duration

integer · min: 60 · max: 21600

Čas do automatického zastavení v sekundách.

ProPresenterSelection

Vyberte zdroj ProPresenter pro tuto relaci. Nakonfigurujte jeho připojení v Connect.

Upravit naplánovanou událost › Odpovědi

Úspěch

ScheduledEventDetails

ScheduledEvent · povinné

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

Příklad těla požadavku

{
  "duration": 5400
}

json

application/json

Příklad odpovědí

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

Odstranit naplánovanou událost

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Odstraní naplánovanou událost a zruší její budoucí spuštění. Již probíhající stream pokračuje.

Odstranit naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

eventId

string · povinné

ID naplánované události z GET /schedule.

Odstranit naplánovanou událost › Odpovědi

Úspěch

eventId

string · povinné

removed

boolean · enum · povinné

Hodnoty výčtu:

Relace

Seznam naplánovaných událostí

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Vrátí naplánované události od nejnovější.

Seznam naplánovaných událostí › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

Seznam naplánovaných událostí › Parametry dotazu

page

integer · min: 1

Číslo stránky, začíná na 1. Hodnoty nad poslední stránkou vrací poslední stránku.

Výchozí: 1

pageSize

integer · min: 1

Události na stránku. Hodnoty nad 100 použijí 100.

Výchozí: 14

Seznam naplánovaných událostí › Odpovědi

Úspěch

ScheduledEventPage

ScheduledEvent[] · povinné

total

integer · min: 0 · povinné

Celkový počet odpovídajících naplánovaných událostí na všech stránkách.

page

integer · min: 1 · povinné

Vrácená stránka; může být nižší než požadovaná.

pageSize

integer · min: 1 · max: 100 · povinné

Získat naplánovanou událost

GET

https://babel.withkaleo.com

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

Bearer (API key)

Načte jednu naplánovanou událost.

Získat naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

eventId

string · povinné

ID naplánované události z GET /schedule.

Získat naplánovanou událost › Odpovědi

Úspěch

ScheduledEventDetails

ScheduledEvent · povinné

Vytvořit naplánovanou událost

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Vytvoří naplánovanou událost. Vynechaná nastavení streamování použijí uložené výchozí hodnoty sboru.

Vytvořit naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

Vytvořit naplánovanou událost › Tělo požadavku

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · povinné

deviceId

string · povinné

ID zařízení Kaleo Connect z GET /devices.

startsAt

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

Datum a čas začátku v místním čase bez posunu časového pásma. Vyhodnocuje se v timezone.

timezone

string · povinné

Časové pásmo IANA, například America/Toronto. Opakování se řídí místním časem; neexistující časy při změně letního času se přeskočí a opakované časy se spustí jednou.

repeat

string · enum

Frekvence opakování. Při vytváření události je výchozí hodnota "once".

Hodnoty výčtu:

once

daily

weekly

Výchozí: once

weekdays

string[] · maxItems: 7 · unique

Dny pro týdenní opakování. Povinné, pokud je repeat rovno "weekly"; jinak prázdné.

Hodnoty výčtu:

Výchozí: []

speakerLanguage

string

Kód z GET /languages/speaker. Použijte "mul" pro režim vícejazyčný.

targetLanguages

string[]

Kódy z GET /languages/target. Použijte ["ALL"] pro všechny podporované cíle, v rámci limitu vašeho plánu.

duration

integer · min: 60 · max: 21600

Čas do automatického zastavení v sekundách.

ProPresenterSelection

Vyberte zdroj ProPresenter pro tuto relaci. Nakonfigurujte jeho připojení v Connect.

Vytvořit naplánovanou událost › Odpovědi

Úspěch

ScheduledEventDetails

ScheduledEvent · povinné

Upravit naplánovanou událost

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Změní naplánovanou událost. Vynechaná pole si zachovají aktuální hodnoty. Změny platí pro budoucí spuštění.

Upravit naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

eventId

string · povinné

ID naplánované události z GET /schedule.

Upravit naplánovanou událost › Tělo požadavku

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID zařízení Kaleo Connect z GET /devices.

startsAt

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

Datum a čas začátku v místním čase bez posunu časového pásma. Vyhodnocuje se v timezone.

timezone

string

Časové pásmo IANA, například America/Toronto. Opakování se řídí místním časem; neexistující časy při změně letního času se přeskočí a opakované časy se spustí jednou.

repeat

string · enum

Frekvence opakování. Při vytváření události je výchozí hodnota "once".

Hodnoty výčtu:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dny pro týdenní opakování. Povinné, pokud je repeat rovno "weekly"; jinak prázdné.

Hodnoty výčtu:

speakerLanguage

string

Kód z GET /languages/speaker. Použijte "mul" pro režim vícejazyčný.

targetLanguages

string[]

Kódy z GET /languages/target. Použijte ["ALL"] pro všechny podporované cíle, v rámci limitu vašeho plánu.

duration

integer · min: 60 · max: 21600

Čas do automatického zastavení v sekundách.

ProPresenterSelection

Vyberte zdroj ProPresenter pro tuto relaci. Nakonfigurujte jeho připojení v Connect.

Upravit naplánovanou událost › Odpovědi

Úspěch

ScheduledEventDetails

ScheduledEvent · povinné

Odstranit naplánovanou událost

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Odstraní naplánovanou událost a zruší její budoucí spuštění. Již probíhající stream pokračuje.

Odstranit naplánovanou událost › Parametry cesty

churchId

string · povinné

ID vaší církve. Zkopírujte jej ze stránky API (v sekci Integrace) ve vašem dashboardu.

eventId

string · povinné

ID naplánované události z GET /schedule.

Odstranit naplánovanou událost › Odpovědi

Úspěch

eventId

string · povinné

removed

boolean · enum · povinné

Hodnoty výčtu: