Streaming

Schema downloaden

Opmerking: de Start streaming endpoint kan alleen worden gebruikt om streaming te starten vanaf een Kaleo Connect-apparaat. Deze endpoint kan niet worden gebruikt om streaming te starten vanuit een webbrowser. Alle andere streaming endpoints bedienen zowel browser- als Kaleo Connect-apparaten.

Streamingstatus ophalen

GET

https://babel.withkaleo.com

/v1/church/{churchId}/streaming

Bearer (API key)

Lees de huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

Streamingstatus ophalen › Padparameters

churchId

string · verplicht

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

Streamingstatus ophalen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

Start streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/start

Bearer (API key)

Start streaming op een Kaleo Connect-apparaat met opgeslagen instellingen. De optionele body kan een deviceId selecteren en instellingen voor deze sessie overschrijven. Zonder deviceId kiest Kaleo de standaard audio-bron die is geconfigureerd op de Kaleo Connect pagina (onder Integraties) in je dashboard als er meerdere audio-capabele apparaten beschikbaar zijn, of het enige beschikbare audio-bronapparaat als er slechts één is.

Start streaming › Padparameters

churchId

string · verplicht

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

Start streaming › Request Body optioneel

StartStreaming

deviceId

string

Optionele audio-bron apparaat-ID van GET /devices. Overschrijft de standaard van de kerk voor deze sessie. Indien weggelaten, gebruik de opgeslagen standaard audio-bron of het enige audio-bron-capabele gekoppelde apparaat; meerdere apparaten zonder standaard vereisen selectie. Het geselecteerde apparaat moet nog steeds klaar zijn.

object

Instellingen alleen voor deze sessie. Weggelaten velden gebruiken opgeslagen standaardwaarden.

Start streaming › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

POST/v1/church/{churchId}/streaming/start

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/start \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Voorbeeld Request Body

{}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Stop streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/stop

Bearer (API key)

Stop de huidige streaming sessie. Er is geen request body nodig.

Stop streaming › Padparameters

churchId

string · verplicht

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

Stop streaming › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

Vertaalstem wijzigen

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/voice

Bearer (API key)

Wijzig de vertaalstem tijdens inactiviteit of streaming.

Vertaalstem wijzigen › Padparameters

churchId

string · verplicht

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

Vertaalstem wijzigen › Request Body

ChangeVoice

voice

string · enum · verplicht

Vertaalstem. Kan worden gewijzigd tijdens inactiviteit of streaming.

Enum waarden:

male

female

Vertaalstem wijzigen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

PATCH/v1/church/{churchId}/streaming/voice

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

Voorbeeld Request Body

{
  "voice": "female"
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "female",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Zichtbaarheid wijzigen

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/visibility

Bearer (API key)

Toon of verberg ondertitels tijdens inactiviteit of streaming. Het verbergen van ondertitels stopt de sessie niet.

Zichtbaarheid wijzigen › Padparameters

churchId

string · verplicht

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

Zichtbaarheid wijzigen › Request Body

ChangeVisibility

visible

boolean · verplicht

true toont ondertitels; false verbergt ze terwijl streaming doorgaat.

Zichtbaarheid wijzigen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

PATCH/v1/church/{churchId}/streaming/visibility

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/visibility \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "visible": false
}'

Voorbeeld Request Body

{
  "visible": false
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": false,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Ondertitels wissen

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/captions/clear

Bearer (API key)

Wis de huidige ondertitelstroom. Er is geen request body nodig.

Ondertitels wissen › Padparameters

churchId

string · verplicht

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

Ondertitels wissen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

POST/v1/church/{churchId}/streaming/captions/clear

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/captions/clear \
  --request POST \
  --header 'Authorization: Bearer <token>'

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Automatische stopdeadline wijzigen

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline

Bearer (API key)

Stel de automatische stoptijd in voor een actieve sessie. Geeft de bijgewerkte streamingstatus terug.

Automatische stopdeadline wijzigen › Padparameters

churchId

string · verplicht

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

Automatische stopdeadline wijzigen › Request Body

ChangeDeadline

deadlineAt

string · date-time · verplicht

Toekomstige automatische stoptijd met Z of een tijdzone-offset. Niet later dan zes uur na startedAt.

Automatische stopdeadline wijzigen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

PATCH/v1/church/{churchId}/streaming/deadline

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deadlineAt": "2026-10-08T16:00:00Z"
}'

Voorbeeld Request Body

{
  "deadlineAt": "2026-10-08T16:00:00Z"
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Automatische stoptijd aanpassen

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline/adjust

Bearer (API key)

Voeg automatische stoptijd toe of trek deze af. Tijdens inactiviteit wijzig je de duur voor de volgende handmatige start. Tijdens streaming wijzig je de huidige deadline. Elk verzoek past een afzonderlijke aanpassing toe.

Automatische stoptijd aanpassen › Padparameters

churchId

string · verplicht

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

Automatische stoptijd aanpassen › Request Body

AdjustDeadline

deltaSeconds

integer · min: -21600 · max: 21600 · verplicht

Seconden om toe te voegen aan de inactieve duur of huidige deadline; negatieve waarden trekken af. Kan niet 0 zijn. Inactieve duur: 60–21600 seconden. Live deadline: toekomst, binnen zes uur na startedAt.

Automatische stoptijd aanpassen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

POST/v1/church/{churchId}/streaming/deadline/adjust

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline/adjust \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deltaSeconds": 120
}'

Voorbeeld Request Body

{
  "deltaSeconds": 120
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Apparaten Sessies

Kaleo API

Streaming

Schema downloaden

Streamingstatus ophalen

GET

https://babel.withkaleo.com

/v1/church/{churchId}/streaming

Bearer (API key)

Lees de huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

Streamingstatus ophalen › Padparameters

churchId

string · verplicht

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

Streamingstatus ophalen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

Start streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/start

Bearer (API key)

Start streaming › Padparameters

churchId

string · verplicht

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

Start streaming › Request Body optioneel

StartStreaming

deviceId

string

object

Instellingen alleen voor deze sessie. Weggelaten velden gebruiken opgeslagen standaardwaarden.

Start streaming › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

POST/v1/church/{churchId}/streaming/start

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/start \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Voorbeeld Request Body

{}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Stop streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/stop

Bearer (API key)

Stop de huidige streaming sessie. Er is geen request body nodig.

Stop streaming › Padparameters

churchId

string · verplicht

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

Stop streaming › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

Vertaalstem wijzigen

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/voice

Bearer (API key)

Wijzig de vertaalstem tijdens inactiviteit of streaming.

Vertaalstem wijzigen › Padparameters

churchId

string · verplicht

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

Vertaalstem wijzigen › Request Body

ChangeVoice

voice

string · enum · verplicht

Vertaalstem. Kan worden gewijzigd tijdens inactiviteit of streaming.

Enum waarden:

male

female

Vertaalstem wijzigen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

PATCH/v1/church/{churchId}/streaming/voice

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

Voorbeeld Request Body

{
  "voice": "female"
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "female",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Zichtbaarheid wijzigen

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/visibility

Bearer (API key)

Toon of verberg ondertitels tijdens inactiviteit of streaming. Het verbergen van ondertitels stopt de sessie niet.

Zichtbaarheid wijzigen › Padparameters

churchId

string · verplicht

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

Zichtbaarheid wijzigen › Request Body

ChangeVisibility

visible

boolean · verplicht

true toont ondertitels; false verbergt ze terwijl streaming doorgaat.

Zichtbaarheid wijzigen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

PATCH/v1/church/{churchId}/streaming/visibility

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/visibility \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "visible": false
}'

Voorbeeld Request Body

{
  "visible": false
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": false,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Ondertitels wissen

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/captions/clear

Bearer (API key)

Wis de huidige ondertitelstroom. Er is geen request body nodig.

Ondertitels wissen › Padparameters

churchId

string · verplicht

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

Ondertitels wissen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

POST/v1/church/{churchId}/streaming/captions/clear

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/captions/clear \
  --request POST \
  --header 'Authorization: Bearer <token>'

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Automatische stopdeadline wijzigen

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline

Bearer (API key)

Stel de automatische stoptijd in voor een actieve sessie. Geeft de bijgewerkte streamingstatus terug.

Automatische stopdeadline wijzigen › Padparameters

churchId

string · verplicht

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

Automatische stopdeadline wijzigen › Request Body

ChangeDeadline

deadlineAt

string · date-time · verplicht

Toekomstige automatische stoptijd met Z of een tijdzone-offset. Niet later dan zes uur na startedAt.

Automatische stopdeadline wijzigen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

PATCH/v1/church/{churchId}/streaming/deadline

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deadlineAt": "2026-10-08T16:00:00Z"
}'

Voorbeeld Request Body

{
  "deadlineAt": "2026-10-08T16:00:00Z"
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Automatische stoptijd aanpassen

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline/adjust

Bearer (API key)

Automatische stoptijd aanpassen › Padparameters

churchId

string · verplicht

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

Automatische stoptijd aanpassen › Request Body

AdjustDeadline

deltaSeconds

integer · min: -21600 · max: 21600 · verplicht

Automatische stoptijd aanpassen › Antwoorden

Succes

Huidige sessie en gedeelde kerkinstellingen. Alle velden zijn aanwezig, ook tijdens inactiviteit.

StreamingStatus

streaming

boolean · verplicht

true tijdens een actieve sessie, inclusief opstarten, opnieuw verbinden en afsluiten. Bevestigt niet dat audio binnenkomt.

sessionId

string | null · verplicht

Huidige sessie-ID; null tijdens inactiviteit.

startedAt

string | null · date-time · verplicht

Starttijd huidige sessie; null tijdens inactiviteit.

deadlineAt

string | null · date-time · verplicht

Automatische stoptijd; null tijdens inactiviteit of als geen deadline is geregistreerd.

speakerLanguage

string | null · verplicht

Huidige sprekerstaalcode; null tijdens inactiviteit.

targetLanguages

string[] · verplicht

Huidige vertaaltalcodes; leeg tijdens inactiviteit.

voice

string · enum · verplicht

Vertaalstem, ook tijdens inactiviteit.

Enum waarden:

male

female

visible

boolean · verplicht

true toont ondertitels; false verbergt ze. Geldt ook tijdens inactiviteit.

publisher

object | null · verplicht

Kaleo Connect-apparaat of browser die audio verzendt; null tijdens inactiviteit.

phase

string · enum · verplicht

Sessie-fase; inactiviteit betekent dat er geen actieve sessie is.

Enum waarden:

idle

starting

streaming

reconnecting

ending

object · verplicht

Kerkstandaarden voor de volgende handmatige start. Actieve sessie-overschrijvingen wijzigen deze waarden niet.

POST/v1/church/{churchId}/streaming/deadline/adjust

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline/adjust \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deltaSeconds": 120
}'

Voorbeeld Request Body

{
  "deltaSeconds": 120
}

json

application/json

Voorbeeld Antwoorden

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Apparaten Sessies