Lịch

Tải xuống sơ đồ

Các sự kiện phát trực tuyến đã lên lịch cho thiết bị Kaleo Connect.

Liệt kê sự kiện đã lên lịch

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Liệt kê các sự kiện đã lên lịch, mới nhất trước.

Liệt kê sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

Liệt kê sự kiện đã lên lịch › Tham số truy vấn

page

integer · min: 1

Số trang, bắt đầu từ 1. Giá trị vượt quá trang cuối trả về trang cuối.

Mặc định: 1

pageSize

integer · min: 1

Số sự kiện mỗi trang. Giá trị trên 100 sẽ dùng 100.

Mặc định: 14

Liệt kê sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventPage

ScheduledEvent[] · bắt buộc

total

integer · min: 0 · bắt buộc

Tổng số sự kiện đã lên lịch phù hợp trên tất cả các trang.

page

integer · min: 1 · bắt buộc

Trang trả về; có thể thấp hơn trang yêu cầu.

pageSize

integer · min: 1 · max: 100 · bắt buộc

Lấy sự kiện đã lên lịch

GET

https://babel.withkaleo.com

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

Bearer (API key)

Đọc một sự kiện đã lên lịch.

Lấy sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

eventId

string · bắt buộc

ID sự kiện đã lên lịch từ GET /schedule.

Lấy sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventDetails

ScheduledEvent · bắt buộc

Tạo sự kiện đã lên lịch

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Tạo một sự kiện đã lên lịch. Các thiết lập phát trực tuyến bị bỏ qua sẽ dùng giá trị mặc định đã lưu của nhà thờ.

Tạo sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

Tạo sự kiện đã lên lịch › Nội dung yêu cầu

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · bắt buộc

deviceId

string · bắt buộc

ID thiết bị Kaleo Connect từ GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · bắt buộc

Ngày và giờ bắt đầu theo giờ địa phương, không có độ lệch múi giờ. Được diễn giải theo timezone.

timezone

string · bắt buộc

Múi giờ IANA, chẳng hạn America/Toronto. Lặp lại theo giờ địa phương; bỏ qua thời điểm không tồn tại khi chuyển giờ mùa hè và chỉ chạy một lần ở thời điểm bị lặp.

repeat

string · enum

Tần suất lặp lại. Mặc định là "once" khi tạo sự kiện.

Giá trị enum:

once

daily

weekly

Mặc định: once

weekdays

string[] · maxItems: 7 · unique

Các ngày lặp hằng tuần. Bắt buộc khi repeat là "weekly"; để trống trong các trường hợp khác.

Giá trị enum:

Mặc định: []

speakerLanguage

string

Mã từ GET /languages/speaker. Sử dụng "mul" cho chế độ đa ngôn ngữ.

targetLanguages

string[]

Mã từ GET /languages/target. Sử dụng ["ALL"] cho tất cả các ngôn ngữ đích được hỗ trợ, trong giới hạn kế hoạch của bạn.

duration

integer · min: 60 · max: 21600

Thời gian đến khi tự động dừng, tính bằng giây.

ProPresenterSelection

Chọn nguồn ProPresenter cho phiên này. Cấu hình kết nối trong Connect.

Tạo sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventDetails

ScheduledEvent · bắt buộc

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

Ví dụ nội dung yêu cầu

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

Ví dụ phản hồi

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

Cập nhật sự kiện đã lên lịch

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Thay đổi một sự kiện đã lên lịch. Các trường bị bỏ qua giữ nguyên giá trị hiện tại. Thay đổi áp dụng cho các lần bắt đầu trong tương lai.

Cập nhật sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

eventId

string · bắt buộc

ID sự kiện đã lên lịch từ GET /schedule.

Cập nhật sự kiện đã lên lịch › Nội dung yêu cầu

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID thiết bị Kaleo Connect từ GET /devices.

startsAt

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

Ngày và giờ bắt đầu theo giờ địa phương, không có độ lệch múi giờ. Được diễn giải theo timezone.

timezone

string

repeat

string · enum

Tần suất lặp lại. Mặc định là "once" khi tạo sự kiện.

Giá trị enum:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Các ngày lặp hằng tuần. Bắt buộc khi repeat là "weekly"; để trống trong các trường hợp khác.

Giá trị enum:

speakerLanguage

string

Mã từ GET /languages/speaker. Sử dụng "mul" cho chế độ đa ngôn ngữ.

targetLanguages

string[]

Mã từ GET /languages/target. Sử dụng ["ALL"] cho tất cả các ngôn ngữ đích được hỗ trợ, trong giới hạn kế hoạch của bạn.

duration

integer · min: 60 · max: 21600

Thời gian đến khi tự động dừng, tính bằng giây.

ProPresenterSelection

Chọn nguồn ProPresenter cho phiên này. Cấu hình kết nối trong Connect.

Cập nhật sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventDetails

ScheduledEvent · bắt buộc

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

Ví dụ nội dung yêu cầu

{
  "duration": 5400
}

json

application/json

Ví dụ phản hồi

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

Xóa sự kiện đã lên lịch

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Xóa một sự kiện đã lên lịch và hủy các lần bắt đầu trong tương lai. Luồng đang phát vẫn tiếp tục.

Xóa sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

eventId

string · bắt buộc

ID sự kiện đã lên lịch từ GET /schedule.

Xóa sự kiện đã lên lịch › Phản hồi

Thành công

eventId

string · bắt buộc

removed

boolean · enum · bắt buộc

Giá trị enum:

Phiên

Liệt kê sự kiện đã lên lịch

GET

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Liệt kê các sự kiện đã lên lịch, mới nhất trước.

Liệt kê sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

Liệt kê sự kiện đã lên lịch › Tham số truy vấn

page

integer · min: 1

Số trang, bắt đầu từ 1. Giá trị vượt quá trang cuối trả về trang cuối.

Mặc định: 1

pageSize

integer · min: 1

Số sự kiện mỗi trang. Giá trị trên 100 sẽ dùng 100.

Mặc định: 14

Liệt kê sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventPage

ScheduledEvent[] · bắt buộc

total

integer · min: 0 · bắt buộc

Tổng số sự kiện đã lên lịch phù hợp trên tất cả các trang.

page

integer · min: 1 · bắt buộc

Trang trả về; có thể thấp hơn trang yêu cầu.

pageSize

integer · min: 1 · max: 100 · bắt buộc

Lấy sự kiện đã lên lịch

GET

https://babel.withkaleo.com

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

Bearer (API key)

Đọc một sự kiện đã lên lịch.

Lấy sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

eventId

string · bắt buộc

ID sự kiện đã lên lịch từ GET /schedule.

Lấy sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventDetails

ScheduledEvent · bắt buộc

Tạo sự kiện đã lên lịch

POST

https://babel.withkaleo.com

/v1/church/{churchId}/schedule

Bearer (API key)

Tạo một sự kiện đã lên lịch. Các thiết lập phát trực tuyến bị bỏ qua sẽ dùng giá trị mặc định đã lưu của nhà thờ.

Tạo sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

Tạo sự kiện đã lên lịch › Nội dung yêu cầu

CreateScheduledEvent

name

string · minLength: 1 · maxLength: 120 · bắt buộc

deviceId

string · bắt buộc

ID thiết bị Kaleo Connect từ GET /devices.

startsAt

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · bắt buộc

Ngày và giờ bắt đầu theo giờ địa phương, không có độ lệch múi giờ. Được diễn giải theo timezone.

timezone

string · bắt buộc

repeat

string · enum

Tần suất lặp lại. Mặc định là "once" khi tạo sự kiện.

Giá trị enum:

once

daily

weekly

Mặc định: once

weekdays

string[] · maxItems: 7 · unique

Các ngày lặp hằng tuần. Bắt buộc khi repeat là "weekly"; để trống trong các trường hợp khác.

Giá trị enum:

Mặc định: []

speakerLanguage

string

Mã từ GET /languages/speaker. Sử dụng "mul" cho chế độ đa ngôn ngữ.

targetLanguages

string[]

Mã từ GET /languages/target. Sử dụng ["ALL"] cho tất cả các ngôn ngữ đích được hỗ trợ, trong giới hạn kế hoạch của bạn.

duration

integer · min: 60 · max: 21600

Thời gian đến khi tự động dừng, tính bằng giây.

ProPresenterSelection

Chọn nguồn ProPresenter cho phiên này. Cấu hình kết nối trong Connect.

Tạo sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventDetails

ScheduledEvent · bắt buộc

Cập nhật sự kiện đã lên lịch

PATCH

https://babel.withkaleo.com

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

Bearer (API key)

Thay đổi một sự kiện đã lên lịch. Các trường bị bỏ qua giữ nguyên giá trị hiện tại. Thay đổi áp dụng cho các lần bắt đầu trong tương lai.

Cập nhật sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

eventId

string · bắt buộc

ID sự kiện đã lên lịch từ GET /schedule.

Cập nhật sự kiện đã lên lịch › Nội dung yêu cầu

UpdateScheduledEvent

name

string · minLength: 1 · maxLength: 120

deviceId

string

ID thiết bị Kaleo Connect từ GET /devices.

startsAt

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

Ngày và giờ bắt đầu theo giờ địa phương, không có độ lệch múi giờ. Được diễn giải theo timezone.

timezone

string

repeat

string · enum

Tần suất lặp lại. Mặc định là "once" khi tạo sự kiện.

Giá trị enum:

once

daily

weekly

weekdays

string[] · maxItems: 7 · unique

Các ngày lặp hằng tuần. Bắt buộc khi repeat là "weekly"; để trống trong các trường hợp khác.

Giá trị enum:

speakerLanguage

string

Mã từ GET /languages/speaker. Sử dụng "mul" cho chế độ đa ngôn ngữ.

targetLanguages

string[]

Mã từ GET /languages/target. Sử dụng ["ALL"] cho tất cả các ngôn ngữ đích được hỗ trợ, trong giới hạn kế hoạch của bạn.

duration

integer · min: 60 · max: 21600

Thời gian đến khi tự động dừng, tính bằng giây.

ProPresenterSelection

Chọn nguồn ProPresenter cho phiên này. Cấu hình kết nối trong Connect.

Cập nhật sự kiện đã lên lịch › Phản hồi

Thành công

ScheduledEventDetails

ScheduledEvent · bắt buộc

Xóa sự kiện đã lên lịch

DELETE

https://babel.withkaleo.com

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

Bearer (API key)

Xóa một sự kiện đã lên lịch và hủy các lần bắt đầu trong tương lai. Luồng đang phát vẫn tiếp tục.

Xóa sự kiện đã lên lịch › Tham số đường dẫn

churchId

string · bắt buộc

ID nhà thờ của bạn. Sao chép từ trang API (dưới mục Tích hợp) trong bảng điều khiển.

eventId

string · bắt buộc

ID sự kiện đã lên lịch từ GET /schedule.

Xóa sự kiện đã lên lịch › Phản hồi

Thành công

eventId

string · bắt buộc

removed

boolean · enum · bắt buộc

Giá trị enum: