行程

下載結構

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

列舉值：