Расписание

Скачать схему

Запланированные события трансляции для устройств Kaleo Connect.

Список запланированных событий

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Возвращает запланированные события, начиная с новых.

Список запланированных событий › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

Список запланированных событий › Параметры запроса

page

integer · min: 1

Номер страницы, начиная с 1. Значения выше последней страницы возвращают последнюю страницу.

По умолчанию: 1

pageSize

integer · min: 1

Событий на странице. Значения выше 100 ограничиваются 100.

По умолчанию: 14

Список запланированных событий › Ответы

Успешно

ScheduledEventPage

ScheduledEvent[] · обязательно

total

integer · min: 0 · обязательно

Общее число подходящих запланированных событий на всех страницах.

page

integer · min: 1 · обязательно

Возвращённая страница; может быть меньше запрошенной.

pageSize

integer · min: 1 · max: 100 · обязательно

Получить запланированное событие

GET

https://babel.withkaleo.com

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

Bearer (API key)

Читает одно запланированное событие.

Получить запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

eventId

string · обязательно

ID запланированного события из GET /schedule.

Получить запланированное событие › Ответы

Успешно

ScheduledEventDetails

ScheduledEvent · обязательно

Создать запланированное событие

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Создаёт запланированное событие. Для пропущенных настроек трансляции используются сохранённые настройки церкви.

Создать запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

Создать запланированное событие › Тело запроса

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · обязательно

deviceId

string · обязательно

ID устройства Kaleo Connect из GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · обязательно

Дата и время начала по местному времени, без смещения часового пояса. Интерпретируются в timezone.

timezone

string · обязательно

Часовой пояс IANA, например America/Toronto. Повторения следуют местному времени; несуществующее время при переходе на летнее время пропускается, повторяющееся время запускается один раз.

repeat

string · enum

Частота повторения. При создании события по умолчанию используется "once".

Значения перечисления:

once

daily

weekly

По умолчанию: once

weekdays

string[] · maxItems: 7 · unique

Дни еженедельных повторений. Обязательно, если repeat равно "weekly"; иначе пусто.

Значения перечисления:

По умолчанию: []

speakerLanguage

string

Код из GET /languages/speaker. Используйте "mul" для многоязычного режима.

targetLanguages

string[]

Коды из GET /languages/target. Используйте ["ALL"] для всех поддерживаемых целей в пределах вашего плана.

duration

integer · min: 60 · max: 21600

Время до автоматической остановки в секундах.

ProPresenterSelection

Выберите источник ProPresenter для этой сессии. Настройте его подключение в Connect.

Создать запланированное событие › Ответы

Успешно

ScheduledEventDetails

ScheduledEvent · обязательно

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

Пример тела запроса

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

Примеры ответов

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

Обновить запланированное событие

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Изменяет запланированное событие. Пропущенные поля сохраняют текущие значения. Изменения применяются к будущим запускам.

Обновить запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

eventId

string · обязательно

ID запланированного события из GET /schedule.

Обновить запланированное событие › Тело запроса

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID устройства Kaleo Connect из GET /devices.

startsAt

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

Дата и время начала по местному времени, без смещения часового пояса. Интерпретируются в timezone.

timezone

string

repeat

string · enum

Частота повторения. При создании события по умолчанию используется "once".

Значения перечисления:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Дни еженедельных повторений. Обязательно, если repeat равно "weekly"; иначе пусто.

Значения перечисления:

speakerLanguage

string

Код из GET /languages/speaker. Используйте "mul" для многоязычного режима.

targetLanguages

string[]

Коды из GET /languages/target. Используйте ["ALL"] для всех поддерживаемых целей в пределах вашего плана.

duration

integer · min: 60 · max: 21600

Время до автоматической остановки в секундах.

ProPresenterSelection

Выберите источник ProPresenter для этой сессии. Настройте его подключение в Connect.

Обновить запланированное событие › Ответы

Успешно

ScheduledEventDetails

ScheduledEvent · обязательно

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

Пример тела запроса

{
  "duration": 5400
}

json

application/json

Примеры ответов

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

Удалить запланированное событие

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Удаляет запланированное событие и отменяет его будущие запуски. Уже идущая трансляция продолжается.

Удалить запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

eventId

string · обязательно

ID запланированного события из GET /schedule.

Удалить запланированное событие › Ответы

Успешно

eventId

string · обязательно

removed

boolean · enum · обязательно

Значения перечисления:

Сессии

Список запланированных событий

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Возвращает запланированные события, начиная с новых.

Список запланированных событий › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

Список запланированных событий › Параметры запроса

page

integer · min: 1

Номер страницы, начиная с 1. Значения выше последней страницы возвращают последнюю страницу.

По умолчанию: 1

pageSize

integer · min: 1

Событий на странице. Значения выше 100 ограничиваются 100.

По умолчанию: 14

Список запланированных событий › Ответы

Успешно

ScheduledEventPage

ScheduledEvent[] · обязательно

total

integer · min: 0 · обязательно

Общее число подходящих запланированных событий на всех страницах.

page

integer · min: 1 · обязательно

Возвращённая страница; может быть меньше запрошенной.

pageSize

integer · min: 1 · max: 100 · обязательно

Получить запланированное событие

GET

https://babel.withkaleo.com

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

Bearer (API key)

Читает одно запланированное событие.

Получить запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

eventId

string · обязательно

ID запланированного события из GET /schedule.

Получить запланированное событие › Ответы

Успешно

ScheduledEventDetails

ScheduledEvent · обязательно

Создать запланированное событие

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Создать запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

Создать запланированное событие › Тело запроса

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · обязательно

deviceId

string · обязательно

ID устройства Kaleo Connect из GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · обязательно

Дата и время начала по местному времени, без смещения часового пояса. Интерпретируются в timezone.

timezone

string · обязательно

repeat

string · enum

Частота повторения. При создании события по умолчанию используется "once".

Значения перечисления:

once

daily

weekly

По умолчанию: once

weekdays

string[] · maxItems: 7 · unique

Дни еженедельных повторений. Обязательно, если repeat равно "weekly"; иначе пусто.

Значения перечисления:

По умолчанию: []

speakerLanguage

string

Код из GET /languages/speaker. Используйте "mul" для многоязычного режима.

targetLanguages

string[]

Коды из GET /languages/target. Используйте ["ALL"] для всех поддерживаемых целей в пределах вашего плана.

duration

integer · min: 60 · max: 21600

Время до автоматической остановки в секундах.

ProPresenterSelection

Выберите источник ProPresenter для этой сессии. Настройте его подключение в Connect.

Создать запланированное событие › Ответы

Успешно

ScheduledEventDetails

ScheduledEvent · обязательно

Обновить запланированное событие

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Обновить запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

eventId

string · обязательно

ID запланированного события из GET /schedule.

Обновить запланированное событие › Тело запроса

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID устройства Kaleo Connect из GET /devices.

startsAt

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

Дата и время начала по местному времени, без смещения часового пояса. Интерпретируются в timezone.

timezone

string

repeat

string · enum

Частота повторения. При создании события по умолчанию используется "once".

Значения перечисления:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Дни еженедельных повторений. Обязательно, если repeat равно "weekly"; иначе пусто.

Значения перечисления:

speakerLanguage

string

Код из GET /languages/speaker. Используйте "mul" для многоязычного режима.

targetLanguages

string[]

Коды из GET /languages/target. Используйте ["ALL"] для всех поддерживаемых целей в пределах вашего плана.

duration

integer · min: 60 · max: 21600

Время до автоматической остановки в секундах.

ProPresenterSelection

Выберите источник ProPresenter для этой сессии. Настройте его подключение в Connect.

Обновить запланированное событие › Ответы

Успешно

ScheduledEventDetails

ScheduledEvent · обязательно

Удалить запланированное событие

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Удаляет запланированное событие и отменяет его будущие запуски. Уже идущая трансляция продолжается.

Удалить запланированное событие › Параметры пути

churchId

string · обязательно

ID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.

eventId

string · обязательно

ID запланированного события из GET /schedule.

Удалить запланированное событие › Ответы

Успешно

eventId

string · обязательно

removed

boolean · enum · обязательно

Значения перечисления: