Agenda

Baixar esquema

Eventos de transmissão agendados para dispositivos Kaleo Connect.

Listar eventos agendados

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Lista os eventos agendados, do mais recente ao mais antigo.

Listar eventos agendados › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Listar eventos agendados › Parâmetros de consulta

page

integer · min: 1

Número da página, começando em 1. Valores acima da última página retornam a última página.

Padrão: 1

pageSize

integer · min: 1

Eventos por página. Valores acima de 100 usam 100.

Padrão: 14

Listar eventos agendados › Respostas

Sucesso

ScheduledEventPage

ScheduledEvent[] · obrigatório

total

integer · min: 0 · obrigatório

Total de eventos agendados correspondentes, em todas as páginas.

page

integer · min: 1 · obrigatório

Página retornada; pode ser menor que a solicitada.

pageSize

integer · min: 1 · max: 100 · obrigatório

Obter evento agendado

GET

https://babel.withkaleo.com

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

Bearer (API key)

Consulta um evento agendado.

Obter evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

eventId

string · obrigatório

ID do evento agendado de GET /schedule.

Obter evento agendado › Respostas

Sucesso

ScheduledEventDetails

ScheduledEvent · obrigatório

Criar evento agendado

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Cria um evento agendado. As configurações de transmissão omitidas usam os padrões salvos da igreja.

Criar evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Criar evento agendado › Corpo da requisição

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · obrigatório

deviceId

string · obrigatório

ID do dispositivo Kaleo Connect de GET /devices.

startsAt

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

Data e hora de início no horário local, sem deslocamento de fuso horário. Interpretadas em timezone.

timezone

string · obrigatório

Fuso horário IANA, como America/Toronto. As repetições seguem o horário local; horários inexistentes nas mudanças de horário de verão são ignorados e horários repetidos são executados uma vez.

repeat

string · enum

Frequência de repetição. O padrão ao criar um evento é "once".

Valores do enumeração:

once

daily

weekly

Padrão: once

weekdays

string[] · maxItems: 7 · unique

Dias das repetições semanais. Obrigatório quando repeat é "weekly"; vazio nos demais casos.

Valores do enumeração:

Padrão: []

speakerLanguage

string

Código de GET /languages/speaker. Use "mul" para modo multilíngue.

targetLanguages

string[]

Códigos de GET /languages/target. Use ["ALL"] para todos os alvos suportados, dentro do limite do seu plano.

duration

integer · min: 60 · max: 21600

Tempo até a parada automática, em segundos.

ProPresenterSelection

Escolha a fonte ProPresenter para esta sessão. Configure sua conexão no Connect.

Criar evento agendado › Respostas

Sucesso

ScheduledEventDetails

ScheduledEvent · obrigatório

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

Exemplo de corpo da requisição

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

Exemplos de respostas

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

Atualizar evento agendado

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Altera um evento agendado. Os campos omitidos mantêm os valores atuais. As alterações se aplicam aos próximos inícios.

Atualizar evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

eventId

string · obrigatório

ID do evento agendado de GET /schedule.

Atualizar evento agendado › Corpo da requisição

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID do dispositivo Kaleo Connect de GET /devices.

startsAt

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

Data e hora de início no horário local, sem deslocamento de fuso horário. Interpretadas em timezone.

timezone

string

repeat

string · enum

Frequência de repetição. O padrão ao criar um evento é "once".

Valores do enumeração:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dias das repetições semanais. Obrigatório quando repeat é "weekly"; vazio nos demais casos.

Valores do enumeração:

speakerLanguage

string

Código de GET /languages/speaker. Use "mul" para modo multilíngue.

targetLanguages

string[]

Códigos de GET /languages/target. Use ["ALL"] para todos os alvos suportados, dentro do limite do seu plano.

duration

integer · min: 60 · max: 21600

Tempo até a parada automática, em segundos.

ProPresenterSelection

Escolha a fonte ProPresenter para esta sessão. Configure sua conexão no Connect.

Atualizar evento agendado › Respostas

Sucesso

ScheduledEventDetails

ScheduledEvent · obrigatório

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

Exemplo de corpo da requisição

{
  "duration": 5400
}

json

application/json

Exemplos de respostas

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

Remover evento agendado

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Remove um evento agendado e cancela seus próximos inícios. Uma transmissão já em andamento continua.

Remover evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

eventId

string · obrigatório

ID do evento agendado de GET /schedule.

Remover evento agendado › Respostas

Sucesso

eventId

string · obrigatório

removed

boolean · enum · obrigatório

Valores do enumeração:

Sessões

Listar eventos agendados

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Lista os eventos agendados, do mais recente ao mais antigo.

Listar eventos agendados › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Listar eventos agendados › Parâmetros de consulta

page

integer · min: 1

Número da página, começando em 1. Valores acima da última página retornam a última página.

Padrão: 1

pageSize

integer · min: 1

Eventos por página. Valores acima de 100 usam 100.

Padrão: 14

Listar eventos agendados › Respostas

Sucesso

ScheduledEventPage

ScheduledEvent[] · obrigatório

total

integer · min: 0 · obrigatório

Total de eventos agendados correspondentes, em todas as páginas.

page

integer · min: 1 · obrigatório

Página retornada; pode ser menor que a solicitada.

pageSize

integer · min: 1 · max: 100 · obrigatório

Obter evento agendado

GET

https://babel.withkaleo.com

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

Bearer (API key)

Consulta um evento agendado.

Obter evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

eventId

string · obrigatório

ID do evento agendado de GET /schedule.

Obter evento agendado › Respostas

Sucesso

ScheduledEventDetails

ScheduledEvent · obrigatório

Criar evento agendado

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Cria um evento agendado. As configurações de transmissão omitidas usam os padrões salvos da igreja.

Criar evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Criar evento agendado › Corpo da requisição

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · obrigatório

deviceId

string · obrigatório

ID do dispositivo Kaleo Connect de GET /devices.

startsAt

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

Data e hora de início no horário local, sem deslocamento de fuso horário. Interpretadas em timezone.

timezone

string · obrigatório

repeat

string · enum

Frequência de repetição. O padrão ao criar um evento é "once".

Valores do enumeração:

once

daily

weekly

Padrão: once

weekdays

string[] · maxItems: 7 · unique

Dias das repetições semanais. Obrigatório quando repeat é "weekly"; vazio nos demais casos.

Valores do enumeração:

Padrão: []

speakerLanguage

string

Código de GET /languages/speaker. Use "mul" para modo multilíngue.

targetLanguages

string[]

Códigos de GET /languages/target. Use ["ALL"] para todos os alvos suportados, dentro do limite do seu plano.

duration

integer · min: 60 · max: 21600

Tempo até a parada automática, em segundos.

ProPresenterSelection

Escolha a fonte ProPresenter para esta sessão. Configure sua conexão no Connect.

Criar evento agendado › Respostas

Sucesso

ScheduledEventDetails

ScheduledEvent · obrigatório

Atualizar evento agendado

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Altera um evento agendado. Os campos omitidos mantêm os valores atuais. As alterações se aplicam aos próximos inícios.

Atualizar evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

eventId

string · obrigatório

ID do evento agendado de GET /schedule.

Atualizar evento agendado › Corpo da requisição

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID do dispositivo Kaleo Connect de GET /devices.

startsAt

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

Data e hora de início no horário local, sem deslocamento de fuso horário. Interpretadas em timezone.

timezone

string

repeat

string · enum

Frequência de repetição. O padrão ao criar um evento é "once".

Valores do enumeração:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Dias das repetições semanais. Obrigatório quando repeat é "weekly"; vazio nos demais casos.

Valores do enumeração:

speakerLanguage

string

Código de GET /languages/speaker. Use "mul" para modo multilíngue.

targetLanguages

string[]

Códigos de GET /languages/target. Use ["ALL"] para todos os alvos suportados, dentro do limite do seu plano.

duration

integer · min: 60 · max: 21600

Tempo até a parada automática, em segundos.

ProPresenterSelection

Escolha a fonte ProPresenter para esta sessão. Configure sua conexão no Connect.

Atualizar evento agendado › Respostas

Sucesso

ScheduledEventDetails

ScheduledEvent · obrigatório

Remover evento agendado

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Remove um evento agendado e cancela seus próximos inícios. Uma transmissão já em andamento continua.

Remover evento agendado › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

eventId

string · obrigatório

ID do evento agendado de GET /schedule.

Remover evento agendado › Respostas

Sucesso

eventId

string · obrigatório

removed

boolean · enum · obrigatório

Valores do enumeração: