Schema

Ladda ner schema

Schemalagda strömningshändelser för Kaleo Connect-enheter.

Lista schemalagda händelser

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Listar schemalagda händelser, nyast först.

Lista schemalagda händelser › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

Lista schemalagda händelser › Frågeparametrar

page

integer · min: 1

Sidnummer, börjar på 1. Värden över sista sidan returnerar sista sidan.

Standard: 1

pageSize

integer · min: 1

Händelser per sida. Värden över 100 använder 100.

Standard: 14

Lista schemalagda händelser › Svar

Lyckades

ScheduledEventPage

ScheduledEvent[] · obligatorisk

total

integer · min: 0 · obligatorisk

Totalt antal matchande schemalagda händelser på alla sidor.

page

integer · min: 1 · obligatorisk

Returnerad sida; kan vara lägre än begärd.

pageSize

integer · min: 1 · max: 100 · obligatorisk

Hämta schemalagd händelse

GET

https://babel.withkaleo.com

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

Bearer (API key)

Läser en schemalagd händelse.

Hämta schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

eventId

string · obligatorisk

ID för schemalagd händelse från GET /schedule.

Hämta schemalagd händelse › Svar

Lyckades

ScheduledEventDetails

ScheduledEvent · obligatorisk

Skapa schemalagd händelse

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Skapar en schemalagd händelse. Utelämnade strömningsinställningar använder församlingens sparade standardvärden.

Skapa schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

Skapa schemalagd händelse › Förfrågningskropp

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · obligatorisk

deviceId

string · obligatorisk

ID för Kaleo Connect-enheten från GET /devices.

startsAt

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

Startdatum och starttid i lokal tid, utan tidszonsförskjutning. Tolkas i timezone.

timezone

string · obligatorisk

IANA-tidszon, till exempel America/Toronto. Upprepningar följer lokal tid; tider som saknas vid sommartidsbyten hoppas över och upprepade tider körs en gång.

repeat

string · enum

Upprepningsfrekvens. Standardvärdet när en händelse skapas är "once".

Enum-värden:

once

daily

weekly

Standard: once

weekdays

string[] · maxItems: 7 · unique

Dagar för veckovisa upprepningar. Krävs när repeat är "weekly"; annars tomt.

Enum-värden:

Standard: []

speakerLanguage

string

Kod från GET /languages/speaker. Använd "mul" för flerspråkigt läge.

targetLanguages

string[]

Koder från GET /languages/target. Använd ["ALL"] för alla stödda mål inom din planbegränsning.

duration

integer · min: 60 · max: 21600

Tid tills automatisk stopp, i sekunder.

ProPresenterSelection

Välj ProPresenter-källa för denna session. Konfigurera dess anslutning i Connect.

Skapa schemalagd händelse › Svar

Lyckades

ScheduledEventDetails

ScheduledEvent · obligatorisk

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

Exempel på förfrågningskropp

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

Exempel på svar

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

Uppdatera schemalagd händelse

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Ändrar en schemalagd händelse. Utelämnade fält behåller sina nuvarande värden. Ändringar gäller framtida starter.

Uppdatera schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

eventId

string · obligatorisk

ID för schemalagd händelse från GET /schedule.

Uppdatera schemalagd händelse › Förfrågningskropp

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID för Kaleo Connect-enheten från GET /devices.

startsAt

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

Startdatum och starttid i lokal tid, utan tidszonsförskjutning. Tolkas i timezone.

timezone

string

IANA-tidszon, till exempel America/Toronto. Upprepningar följer lokal tid; tider som saknas vid sommartidsbyten hoppas över och upprepade tider körs en gång.

repeat

string · enum

Upprepningsfrekvens. Standardvärdet när en händelse skapas är "once".

Enum-värden:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dagar för veckovisa upprepningar. Krävs när repeat är "weekly"; annars tomt.

Enum-värden:

speakerLanguage

string

Kod från GET /languages/speaker. Använd "mul" för flerspråkigt läge.

targetLanguages

string[]

Koder från GET /languages/target. Använd ["ALL"] för alla stödda mål inom din planbegränsning.

duration

integer · min: 60 · max: 21600

Tid tills automatisk stopp, i sekunder.

ProPresenterSelection

Välj ProPresenter-källa för denna session. Konfigurera dess anslutning i Connect.

Uppdatera schemalagd händelse › Svar

Lyckades

ScheduledEventDetails

ScheduledEvent · obligatorisk

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

Exempel på förfrågningskropp

{
  "duration": 5400
}

json

application/json

Exempel på svar

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

Ta bort schemalagd händelse

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Tar bort en schemalagd händelse och avbryter dess framtida starter. En ström som redan pågår fortsätter.

Ta bort schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

eventId

string · obligatorisk

ID för schemalagd händelse från GET /schedule.

Ta bort schemalagd händelse › Svar

Lyckades

eventId

string · obligatorisk

removed

boolean · enum · obligatorisk

Enum-värden:

Sessioner

Lista schemalagda händelser

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Listar schemalagda händelser, nyast först.

Lista schemalagda händelser › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

Lista schemalagda händelser › Frågeparametrar

page

integer · min: 1

Sidnummer, börjar på 1. Värden över sista sidan returnerar sista sidan.

Standard: 1

pageSize

integer · min: 1

Händelser per sida. Värden över 100 använder 100.

Standard: 14

Lista schemalagda händelser › Svar

Lyckades

ScheduledEventPage

ScheduledEvent[] · obligatorisk

total

integer · min: 0 · obligatorisk

Totalt antal matchande schemalagda händelser på alla sidor.

page

integer · min: 1 · obligatorisk

Returnerad sida; kan vara lägre än begärd.

pageSize

integer · min: 1 · max: 100 · obligatorisk

Hämta schemalagd händelse

GET

https://babel.withkaleo.com

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

Bearer (API key)

Läser en schemalagd händelse.

Hämta schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

eventId

string · obligatorisk

ID för schemalagd händelse från GET /schedule.

Hämta schemalagd händelse › Svar

Lyckades

ScheduledEventDetails

ScheduledEvent · obligatorisk

Skapa schemalagd händelse

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Skapar en schemalagd händelse. Utelämnade strömningsinställningar använder församlingens sparade standardvärden.

Skapa schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

Skapa schemalagd händelse › Förfrågningskropp

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · obligatorisk

deviceId

string · obligatorisk

ID för Kaleo Connect-enheten från GET /devices.

startsAt

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

Startdatum och starttid i lokal tid, utan tidszonsförskjutning. Tolkas i timezone.

timezone

string · obligatorisk

IANA-tidszon, till exempel America/Toronto. Upprepningar följer lokal tid; tider som saknas vid sommartidsbyten hoppas över och upprepade tider körs en gång.

repeat

string · enum

Upprepningsfrekvens. Standardvärdet när en händelse skapas är "once".

Enum-värden:

once

daily

weekly

Standard: once

weekdays

string[] · maxItems: 7 · unique

Dagar för veckovisa upprepningar. Krävs när repeat är "weekly"; annars tomt.

Enum-värden:

Standard: []

speakerLanguage

string

Kod från GET /languages/speaker. Använd "mul" för flerspråkigt läge.

targetLanguages

string[]

Koder från GET /languages/target. Använd ["ALL"] för alla stödda mål inom din planbegränsning.

duration

integer · min: 60 · max: 21600

Tid tills automatisk stopp, i sekunder.

ProPresenterSelection

Välj ProPresenter-källa för denna session. Konfigurera dess anslutning i Connect.

Skapa schemalagd händelse › Svar

Lyckades

ScheduledEventDetails

ScheduledEvent · obligatorisk

Uppdatera schemalagd händelse

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Ändrar en schemalagd händelse. Utelämnade fält behåller sina nuvarande värden. Ändringar gäller framtida starter.

Uppdatera schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

eventId

string · obligatorisk

ID för schemalagd händelse från GET /schedule.

Uppdatera schemalagd händelse › Förfrågningskropp

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID för Kaleo Connect-enheten från GET /devices.

startsAt

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

Startdatum och starttid i lokal tid, utan tidszonsförskjutning. Tolkas i timezone.

timezone

string

IANA-tidszon, till exempel America/Toronto. Upprepningar följer lokal tid; tider som saknas vid sommartidsbyten hoppas över och upprepade tider körs en gång.

repeat

string · enum

Upprepningsfrekvens. Standardvärdet när en händelse skapas är "once".

Enum-värden:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dagar för veckovisa upprepningar. Krävs när repeat är "weekly"; annars tomt.

Enum-värden:

speakerLanguage

string

Kod från GET /languages/speaker. Använd "mul" för flerspråkigt läge.

targetLanguages

string[]

Koder från GET /languages/target. Använd ["ALL"] för alla stödda mål inom din planbegränsning.

duration

integer · min: 60 · max: 21600

Tid tills automatisk stopp, i sekunder.

ProPresenterSelection

Välj ProPresenter-källa för denna session. Konfigurera dess anslutning i Connect.

Uppdatera schemalagd händelse › Svar

Lyckades

ScheduledEventDetails

ScheduledEvent · obligatorisk

Ta bort schemalagd händelse

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Tar bort en schemalagd händelse och avbryter dess framtida starter. En ström som redan pågår fortsätter.

Ta bort schemalagd händelse › Sökvägsparametrar

churchId

string · obligatorisk

Ditt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.

eventId

string · obligatorisk

ID för schemalagd händelse från GET /schedule.

Ta bort schemalagd händelse › Svar

Lyckades

eventId

string · obligatorisk

removed

boolean · enum · obligatorisk

Enum-värden: