日程

下载架构

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 · 必需

来自 GET /schedule 的预定活动 ID。

获取预定活动 › 响应

成功

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 · 必需

来自 GET /devices 的 Kaleo Connect 设备 ID。

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 · 必需

来自 GET /schedule 的预定活动 ID。

更新预定活动 › 请求体

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

来自 GET /devices 的 Kaleo Connect 设备 ID。

startsAt

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

本地时间的开始日期和时间，不带时区偏移量。按 timezone 解释。

timezone

string

IANA 时区，例如 America/Toronto。重复活动遵循本地时间；跳过夏令时切换时不存在的时间，重复的时间只运行一次。

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 · 必需

来自 GET /schedule 的预定活动 ID。

移除预定活动 › 响应

成功

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 · 必需

来自 GET /schedule 的预定活动 ID。

获取预定活动 › 响应

成功

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 · 必需

来自 GET /devices 的 Kaleo Connect 设备 ID。

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 · 必需

更新预定活动

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

修改一个预定活动。省略的字段保留当前值。更改适用于今后的启动。

更新预定活动 › 路径参数

churchId

string · 必需

您的教会 ID。从仪表板中“集成”下的 API 页面复制。

eventId

string · 必需

来自 GET /schedule 的预定活动 ID。

更新预定活动 › 请求体

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

来自 GET /devices 的 Kaleo Connect 设备 ID。

startsAt

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

本地时间的开始日期和时间，不带时区偏移量。按 timezone 解释。

timezone

string

IANA 时区，例如 America/Toronto。重复活动遵循本地时间；跳过夏令时切换时不存在的时间，重复的时间只运行一次。

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 · 必需

来自 GET /schedule 的预定活动 ID。

移除预定活动 › 响应

成功

eventId

string · 必需

removed

boolean · enum · 必需

枚举值：