디스플레이 화면

핵심 플랫폼
display_brand_settings_write디스플레이 화면

Changes Display Screens settings shared by every facility in the facility's brand: the boot screen shown while screens start up, the settings new screens start with, and what templated content shows. Organisation admins only; read the current values and canEdit with display_settings_read boot_screen, screen_defaults or templated.

Actions:

  • save_boot_screen: Save the boot screen. Sets the boot screen image (PNG, JPEG or WebP, up to 10 MB, from a public https imageUrl or imageBase64) and/or how it is laid out. Without an image, fit and background re-render the current one. Screens pick it up when they next start. Asks for confirmation.
  • reset_boot_screen: Reset the boot screen. Removes the brand's boot screen; screens go back to the default one when they next start. Asks for confirmation.
  • save_screen_defaults: Save the screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities. Only the settings you pass change. Screens that are already paired keep their own settings; change those with device_inventory_write configure_screen. Asks for confirmation.
  • save_templated: Save templated content settings. What templated content screens and the Schedule show: the data source name, workout names, programs in the Schedule and how far ahead, training phases and how far ahead, and Program Builder training camps (one banner per week) and how far ahead. Asks for confirmation.

매개변수

이름유형설명
action*"save_boot_screen" | "reset_boot_screen" | "save_screen_defaults" | "save_templated"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
imageUrlstring이미지의 공개 https URL (save_boot_screen)
imageBase64stringURL이 없을 때 base64로 인코딩한 이미지 (save_boot_screen)
fit"logo" | "fill"(save_boot_screen)
backgroundstring배경색(#RRGGBB) (save_boot_screen)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
orientation"normal" | "left" | "right" | "inverted"Screen rotation (save_screen_defaults)
airplayEnabledbooleanScreens accept AirPlay (save_screen_defaults)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (save_screen_defaults)
sonosEnabledbooleanSonos speaker control (save_screen_defaults)
duressEnabledbooleanBluetooth duress button monitoring (save_screen_defaults)
cameraRestreamingEnabledbooleanRestream local camera feeds from the screen (save_screen_defaults)
wifiSupportbooleanCaptive Wi-Fi setup portal (save_screen_defaults)
showSourceNameboolean(save_templated)
showWorkoutNamesboolean(save_templated)
showProgramsInScheduleboolean(save_templated)
programLookaheadDaysintegernull미리 표시할 일수(0–90), 제한이 없으면 null (save_templated)
showTrainingPhasesboolean(save_templated)
phaseLookaheadDaysintegernull미리 표시할 일수(0–90), 제한이 없으면 null (save_templated)
showTrainingCampsboolean(save_templated)
campLookaheadDaysintegernull미리 표시할 일수(0–90), 제한이 없으면 null (save_templated)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_groups_write디스플레이 화면

시설의 Display Screen 그룹을 생성, 이름 변경, 삭제하고 그룹에 포함할 화면을 설정합니다. 그룹은 게시 대상(display_publish targets.groupIds)이자 명령 대상(display_screen_command groupIds)입니다. 여러 화면, 그룹 또는 대상이 지정되면 한 번의 호출로 모두에 적용됩니다. 많은 대상에 작업하기 전에 사용자에게 확인하십시오.

작업:

  • save: 그룹을 저장합니다. 생성: name(선택적으로 screenIds). 이름 변경: groupId(ID 또는 현재 이름)와 name. screenIds는 구성원을 대체합니다. 목록에 없는 화면은 이 그룹에서 빠지지만 다른 그룹은 유지합니다.
  • delete: 그룹을 삭제합니다. 그룹을 삭제하면 해당 화면은 그룹에서 빠지고(다른 그룹은 유지) 그룹에 게시된 콘텐츠는 일정에서 제거됩니다. groupId가 필요합니다. 확인을 요청합니다.

매개변수

이름유형설명
action*"save" | "delete"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
groupIdstring이름을 변경하거나 구성원을 바꿀 기존 그룹 ID 또는 이름
namestring그룹 이름(생성 시 필수) (save)
screenIdsarray그룹에 포함할 화면입니다. 현재 구성원을 대체합니다 (save)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_hosted_apps_write디스플레이 화면

Display Screens용 정적 HTML 앱("hosted apps")을 게시합니다. 화면 크기, 디자인 규칙, 제한 및 SDK를 확인하려면 먼저 display_library_read app_guidelines를 호출하고, 이후 display_screenshot으로 화면에서 결과를 확인하십시오. 여러 화면, 그룹 또는 대상이 지정되면 한 번의 호출로 모두에 적용됩니다. 많은 대상에 작업하기 전에 사용자에게 확인하십시오.

작업:

  • publish: 호스팅 앱을 게시합니다. 호스팅 앱을 생성(name + files)하거나 새 버전을 게시(appId + files)합니다. 새 버전은 앱이 표시되는 모든 곳에 즉시 적용되며 rollback으로 되돌릴 수 있습니다. publishTo는 display_publish와 마찬가지로 화면에도 앱을 배치합니다. 브랜드 또는 조직 대상에는 confirm이 필요합니다. files가 필요합니다. 확인을 요청할 수 있습니다.
  • rollback: 호스팅 앱을 롤백합니다. 앱이 표시되는 모든 곳에서 이전 버전을 다시 현재 버전으로 지정합니다. 버전 목록은 display_library_read app_versions로 확인하십시오. appId, version이 필요합니다.

매개변수

이름유형설명
action*"publish" | "rollback"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
appIdstring새 버전을 게시할 기존 호스팅 앱 ID(app_…)
namestring앱 이름(생성 시 필수) (publish)
filesarray앱 파일입니다. encoding은 utf8(기본값) 또는 바이너리 파일의 경우 base64입니다. (publish)
entrystring시작 HTML 파일(기본값 index.html) (publish)
durationSecnumber재생 목록에서의 기본 화면 표시 시간(초) (publish)
tagsarray(publish)
ownerScope"facility" | "brand" | "organisation"새 콘텐츠의 소유자(기본값 facility)입니다. brand와 organisation에는 조직 전체 접근 권한이 필요합니다. (publish)
publishToobject(publish)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
versioninteger현재 버전으로 지정할 버전 (rollback)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_library_read디스플레이 화면

시설에서 볼 수 있는 Display Screens 콘텐츠 라이브러리를 읽습니다: 미디어(이미지, 동영상), 앱(웹 페이지, 호스팅 HTML 앱, AI 에이전트 앱, CCTV 뷰)과 재생 목록, 그리고 추가할 수 있는 AI 에이전트 앱과 CCTV 소스입니다.

각 항목에는 display_publish와 재생 목록에 사용할 contentRef(media#…, app#…, playlist#…)가 있습니다. ownerScope는 소유자(facility#, brand# 또는 org#)를 나타내며, 콘텐츠는 소유자 범위 안에서만 게시할 수 있습니다. status가 processing인 미디어는 아직 준비되지 않았고, failed인 미디어는 다시 업로드해야 합니다. frameable: false인 웹 페이지는 재생 목록에서 재생할 수 없으며 전체 페이지 화면으로만 표시할 수 있습니다. displayIssue가 있는 항목은 화면에서 건너뜁니다: 게시 취소, 일시 중지, display-off, 대상 제한 상태이거나 Custom Apps가 없는 AI 에이전트 앱, 그리고 no-cctv, cctv-off(시설 관리자가 Display Screens 설정에서 화면의 CCTV를 켭니다) 또는 no-cameras 상태인 CCTV 뷰입니다.

작업:

  • list: 라이브러리 항목을 나열합니다. 미디어와 앱(페이지 단위, type, kind, tag 또는 이름으로 필터링)을 나열하거나, type을 agent-apps로 지정하면 화면에 허용되어 display_publish content.agentAppId로 게시할 수 있는 AI 에이전트 앱을 나열합니다. 각 항목의 type은 media, app 또는 agent-app입니다.
  • cctv_sources: CCTV 소스를 나열합니다. display_publish content.cctv에 사용할 시설의 카메라와 공유 Live Views, 그리고 화면의 CCTV가 켜져 있는지 여부입니다. 시설에서 CCTV 접근 권한이 필요합니다.
  • get: 라이브러리 항목을 가져옵니다. contentRef로 미디어 항목, 앱 또는 재생 목록 하나를 가져옵니다. contentRef가 필요합니다.
  • usages: 콘텐츠가 사용되는 위치입니다. 미디어 항목이나 앱을 사용하는 활성 일정 할당과 재생 목록(재생 목록의 경우 해당 할당)입니다. 사용 중인 콘텐츠는 삭제할 수 없습니다. contentRef가 필요합니다.
  • app_versions: 호스팅 앱 버전을 나열합니다. display_hosted_apps_write rollback에 사용할 호스팅 앱의 버전과 현재 버전입니다. appId가 필요합니다.
  • app_guidelines: 호스팅 앱 가이드라인입니다. 화면 크기, 디자인 규칙, 번들 제한, Display App SDK 및 시작 템플릿입니다. display_hosted_apps_write publish용 앱을 만들기 전에 호출하십시오.
  • check_url: 웹 페이지를 확인합니다. 웹 페이지를 재생 목록 안에 표시할 수 있는지(일부 사이트는 프레임 삽입을 거부함)와 표시 모양에 대한 힌트를 제공합니다. 프레임 삽입을 거부하는 페이지도 전체 페이지 화면으로는 표시할 수 있습니다. url이 필요합니다.
  • playlists: 재생 목록을 나열합니다. 시설에서 볼 수 있는 재생 목록(페이지 단위)과 각 재생 목록의 항목(contentRef, duration, fit)입니다.

매개변수

이름유형설명
action*"list" | "cctv_sources" | "get" | "usages" | "app_versions" | "app_guidelines" | "check_url" | "playlists"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
type"media" | "apps" | "agent-apps"한 종류의 항목만(기본값: 미디어와 앱) (list)
kind"image" | "video" | "url" | "hosted" | "agent-app" | "cctv-view"(list)
tagstring이 태그가 있는 항목만 (list)
searchstring대소문자를 구분하지 않는 이름 필터 (list)
limitinteger페이지당 항목 수(기본값 25, 최대 100) (list, playlists)
cursorstring이전 페이지의 nextCursor (list, playlists)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다. (list, cctv_sources, get, usages, app_versions, check_url, playlists)
contentRefstringdisplay_library_read list 또는 playlists에서 가져온 media#<id>, app#<id> 또는 playlist#<id> (get, usages)
appIdstring호스팅 앱 ID(app_…) (app_versions)
urlstring공개 https URL (check_url)
display_library_write디스플레이 화면

Display Screens 라이브러리 콘텐츠를 추가하고 변경합니다: 이미지와 동영상 업로드, 웹 페이지, AI 에이전트 앱 및 CCTV 뷰 앱 생성, 이름, 태그, 재생 시간 및 날짜 편집, 사용하지 않는 항목 삭제, 앱 미리 보기 새로 고침. 호스팅 HTML 앱은 display_hosted_apps_write로, 재생 목록은 display_playlists_write로 게시합니다.

이미지는 1920×1080(가로) 또는 1080×1920(세로)으로 디자인하십시오. 새 미디어는 웹용 버전이 만들어지는 동안 processing 상태로 시작합니다. 바로 재생 목록에 추가할 수 있으며 준비되면 재생됩니다. ownerScope: facility(기본값), brand 또는 organisation(brand와 organisation에는 조직 전체 접근 권한이 필요함).

작업:

  • upload_media: 이미지 또는 동영상을 업로드합니다. 공개 https url(권장, 이미지 최대 25 MB, 동영상 최대 200 MB) 또는 mimeType과 함께 base64(최대 20 MB)로 이미지나 동영상을 추가합니다. JPEG, PNG, WebP, GIF 이미지와 MP4, WebM, MOV 동영상(최대 1080p의 H.264 MP4로 변환)을 지원합니다. 더 큰 동영상: create_video_upload.
  • create_video_upload: 대용량 동영상 업로드를 시작합니다. 최대 2 GB의 동영상용입니다: 동영상을 등록하고 사전 서명된 업로드를 반환합니다(upload.expiresAt 전에 upload.headers와 함께 파일을 upload.url로 PUT). 그런 다음 해당 contentRef로 transcode를 호출하십시오. name, mimeType, bytes가 필요합니다.
  • transcode: 동영상을 처리합니다. 화면용으로 동영상을 변환합니다: create_video_upload 후, 실패 후 재시도, 또는 화면에서 재생할 수 없는 이전 동영상에 사용합니다. contentRef가 필요합니다.
  • create_app: 앱을 추가합니다. 웹 페이지(kind url, url 전달, 프레임 삽입 가능 여부 확인), AI 에이전트 앱(kind agent-app, display_library_read list type agent-apps에서 가져온 agentAppId 전달) 또는 CCTV 뷰(kind cctv-view, 시설 소유, CCTV 접근 권한 필요)를 추가합니다. kind, name이 필요합니다.
  • update: 라이브러리 항목을 업데이트합니다. 미디어 항목이나 앱의 이름, 태그 또는 재생 시간, 미디어 항목의 validFrom/validTo(ISO, null이면 해제, 기간 밖에서는 건너뜀), 웹 페이지의 url, 또는 CCTV 뷰의 cameras, view, layout, quality를 변경합니다. contentRef가 필요합니다.
  • delete: 라이브러리 항목을 삭제합니다. 미디어 항목이나 앱을 삭제합니다. 활성 일정이나 재생 목록에 있는 동안에는 차단되며, 오류에 해당 일정과 재생 목록이 표시됩니다(먼저 display_schedule_write delete 또는 display_playlists_write save로 제거하십시오). contentRef가 필요합니다. 확인을 요청합니다.
  • refresh_preview: 앱 미리 보기를 새로 고칩니다. 라이브러리 미리 보기용으로 앱의 새 스크린샷을 찍습니다(예: 페이지가 변경된 후). contentRef가 필요합니다.

매개변수

이름유형설명
action*"upload_media" | "create_video_upload" | "transcode" | "create_app" | "update" | "delete" | "refresh_preview"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
urlstring이미지 또는 동영상의 공개 https URL(권장) (upload_media, create_app, update)
base64stringURL이 없을 때 base64로 인코딩한 파일 내용(최대 20 MB) (upload_media)
mimeTypestringbase64와 함께 필수, 예: image/png (upload_media, create_video_upload)
namestring라이브러리 이름 (upload_media, create_video_upload, create_app, update)
tagsarray태그(현재 태그를 대체함) (upload_media, create_video_upload, create_app, update)
ownerScope"facility" | "brand" | "organisation"새 콘텐츠의 소유자(기본값 facility)입니다. brand와 organisation에는 조직 전체 접근 권한이 필요합니다. (upload_media, create_video_upload, create_app)
durationSecnumber이미지의 기본 화면 표시 시간(초) (upload_media, create_app, update)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
bytesinteger파일 크기(바이트) (create_video_upload)
resolution"720" | "1080" | "1440" | "2160" | "original"화면용으로 변환할 동영상의 최대 크기(기본값 1080, original은 원본 크기 유지) (create_video_upload, transcode)
contentRefstringdisplay_library_read list 또는 playlists에서 가져온 media#<id>, app#<id> 또는 playlist#<id> (transcode, update, delete, refresh_preview)
kind"url" | "agent-app" | "cctv-view"(create_app)
agentAppIdstringAI 에이전트 앱: 앱 ID (create_app)
source"view" | "cameras"CCTV 뷰: view(viewId 전달) 또는 cameras(cameras 전달) (create_app, update)
viewIdstringCCTV 뷰: Live View ID(display_library_read cctv_sources) (create_app, update)
camerasarrayCCTV 뷰: 카메라 ID(display_library_read cctv_sources) (create_app, update)
layout"auto" | "1x1" | "2x1" | "1+2" | "2x2" | "1+5" | "2x3" | "3x3"CCTV 뷰: 타일 레이아웃 (create_app, update)
quality"auto" | "native" | "1080p" | "720p" | "480p" | "360p" | "240p"CCTV 뷰: 스트림 품질 (create_app, update)
showNamesbooleanCCTV 뷰: 타일에 카메라 이름 표시 (create_app, update)
validFromstringnull미디어: 재생을 시작하는 ISO 날짜/시간, null이면 해제 (update)
validTostringnull미디어: 재생을 중지하는 ISO 날짜/시간, null이면 해제 (update)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_playlists_write디스플레이 화면

Display Screens 재생 목록(미디어와 앱을 순서대로 반복 재생하는 목록)을 생성, 업데이트, 삭제합니다. 변경 사항은 몇 초 안에 해당 재생 목록을 표시하는 모든 화면에 적용됩니다. 재생 목록은 display_publish content.contentRef "playlist#"로 게시합니다.

작업:

  • save: 재생 목록을 저장합니다. 생성: name + items(items는 비워 둘 수 있음). 업데이트: playlistId + name, items, transition 중 원하는 항목. items는 전체 목록을 대체하므로 모든 항목을 순서대로 보내십시오.
  • delete: 재생 목록을 삭제합니다. 재생 목록을 삭제합니다. 어딘가에 게시되어 있는 동안에는 차단되며, 오류에 먼저 제거할 할당이 표시됩니다(display_schedule_write delete). playlistId가 필요합니다. 확인을 요청합니다.

매개변수

이름유형설명
action*"save" | "delete"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
playlistIdstring업데이트할 기존 재생 목록 ID(pl_…)
namestring재생 목록 이름(생성 시 필수) (save)
transition"fade" | "none"(save)
ownerScope"facility" | "brand" | "organisation"새 콘텐츠의 소유자(기본값 facility)입니다. brand와 organisation에는 조직 전체 접근 권한이 필요합니다. (save)
itemsarray순서대로 정렬된 전체 목록(현재 항목을 대체함, 항목을 유지하려면 itemId를 유지). frameable: false인 웹 페이지는 재생되지 않습니다. (save)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_publish디스플레이 화면

Display Screens에 콘텐츠를 표시합니다: 미디어 항목, 재생 목록, 앱, 웹 페이지, AI 에이전트 앱 또는 CCTV 라이브 뷰를 화면, 그룹, 시설, 시설의 브랜드 또는 조직에 게시합니다.

mode: now(기본값)는 대상에 평소 표시되는 내용을 대체합니다. scheduled는 주간 시간대(시설 시간대 기준) 및/또는 from과 to 사이에만 표시합니다. takeover는 durationMin 동안(또는 지정한 시간까지) 모든 콘텐츠를 중단하고 표시한 뒤 자동으로 종료됩니다(display_takeover_stop으로 일찍 중지할 수 있음). 화면은 먼저 레이어(takeover > scheduled > default), 그다음 대상의 구체성(screen > group > facility > brand > organisation)에 따라 표시할 내용을 결정합니다.

CCTV: 라이브 카메라 피드는 화면 근처에 있는 누구나 볼 수 있습니다. 첫 번째 호출은 requiresConfirmation(code CCTV_CONFIRMATION_REQUIRED)을 반환합니다. 사용자에게 확인한 후 confirmCctv: true로 다시 호출하십시오. 시설에서 "Allow CCTV on display screens"가 켜져 있어야 합니다.

게시된 콘텐츠는 player 모드 화면에만 표시되며, 나머지 화면은 warnings에 나열됩니다. batchId를 반환하며, 이 값으로 display_schedule_write delete를 실행하면 게시 전체가 취소됩니다. 여러 화면, 그룹 또는 대상이 지정되면 한 번의 호출로 모두에 적용됩니다. 많은 대상에 작업하기 전에 사용자에게 확인하십시오.

매개변수

이름유형설명
targets*object콘텐츠를 표시할 위치입니다. 이 항목들을 자유롭게 조합할 수 있습니다. 그룹은 ID뿐 아니라 이름으로도 지정할 수 있습니다. brand와 organisation에는 조직 전체 Display Screens 접근 권한이 필요합니다.
content*object표시할 내용: contentRef, url, agentAppId 또는 cctv 중 정확히 하나입니다.
mode"now" | "default" | "scheduled" | "takeover"`now`/`default`(기본값): 대상에 평소 표시되는 내용을 대체합니다. `scheduled`: windows 동안 및/또는 from과 to 사이에만 표시합니다. `takeover`: durationMin 동안(또는 지정한 시간까지) 모든 콘텐츠를 중단하고 표시한 뒤 자동으로 종료됩니다.
windowsarray시설 시간대 기준의 주간 시간대입니다. days는 ISO 요일(1 = 월요일 … 7 = 일요일)이며, start/end는 "HH:MM" 형식입니다(end "24:00" 허용).
fromstring예약 게시가 시작되는 ISO 날짜/시간
tostring예약 게시가 종료되는 ISO 날짜/시간
durationMinnumberTakeover 지속 시간(분, 최대 7일)
untilstringTakeover가 종료되는 ISO 날짜/시간(durationMin 대신 사용)
priorityinteger겹치는 예약 항목 간의 우선순위를 정합니다(값이 높을수록 우선)
confirmCctvboolean사용자가 라이브 CCTV 표시를 명시적으로 확인한 후에만 설정합니다
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_schedule_read디스플레이 화면

Display Screens에 게시된 내용을 읽습니다: 한 화면의 경우 특정 시점과 기간에 표시되는 내용(상속받는 모든 레이어와 대상을 반영하여 결정됨)과 해당 화면에 적용되는 할당, 또는 그룹, 시설, 시설의 브랜드나 조직에 게시된 할당입니다.

할당 ID(as_…)와 배치 ID(bt_…)는 display_schedule_write로 업데이트하거나 삭제할 때 사용합니다. 시간은 ISO 형식이며, 시간대(windows)는 시설 시간대 기준입니다.

작업:

  • get: 화면의 일정을 가져옵니다. 화면이 at(기본값 현재)에 표시하는 내용, from부터 to까지의 타임라인(기본값 24시간), 그리고 해당 화면에 적용되는 모든 할당입니다. screenId가 필요합니다.
  • list_assignments: 할당을 나열합니다. 그룹(groupId) 또는 시설, 시설의 브랜드나 조직(target, 기본값 facility)에 게시된 할당입니다. 페이지 단위로 반환되며 최근 변경 순입니다.

매개변수

이름유형설명
action*"get" | "list_assignments"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
screenIdstringdisplay_screens_read list에서 가져온 화면 ID(6자리 코드) (get)
atstring표시 내용을 확인할 ISO 날짜/시간(기본값 현재) (get)
fromstringISO 타임라인 시작(기본값 at, 없으면 현재) (get)
tostringISO 타임라인 종료(기본값 from으로부터 24시간 후) (get)
includeExpiredboolean종료된 할당 포함
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
groupIdstringdisplay_screens_read groups에서 가져온 화면 그룹 ID 또는 이름 (list_assignments)
target"facility" | "brand" | "organisation"groupId를 지정하지 않은 경우(기본값 facility) (list_assignments)
limitinteger페이지당 항목 수(기본값 25, 최대 100) (list_assignments)
cursorstring이전 페이지의 nextCursor (list_assignments)
display_schedule_write디스플레이 화면

Display Screens에 게시된 내용을 변경합니다: 할당의 시간, 우선순위 또는 콘텐츠를 편집하거나(선택적으로 게시 전체에 적용), 할당 하나 또는 게시 전체를 제거합니다. ID는 display_schedule_read로 찾으십시오. 일정에서 콘텐츠를 제거해도 라이브러리에는 남아 있습니다. Takeover를 일찍 종료하면서 기록은 유지하려면 display_takeover_stop을 사용하십시오.

작업:

  • update: 할당을 업데이트합니다. 할당의 시간(주간 시간대, from/to, null이면 날짜 해제), 우선순위 또는 콘텐츠를 변경합니다. applyToBatch를 사용하면 게시의 모든 대상에 동일하게 변경합니다. Takeover는 새 종료 시간만 지정할 수 있습니다. CCTV 콘텐츠는 사용자가 동의한 후 confirmCctv가 필요합니다. assignmentId가 필요합니다.
  • delete: 일정에서 제거합니다. 할당 하나(assignmentId) 또는 한 게시의 전체 내용(batchId)을 제거합니다. 화면은 몇 초 안에 원래 표시하던 내용으로 돌아갑니다. 확인을 요청합니다.

매개변수

이름유형설명
action*"update" | "delete"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
assignmentIdstringdisplay_schedule_read에서 가져온 할당 하나(as_…)
applyToBatchboolean게시의 모든 대상에 동일하게 변경 (update)
windowsarray시설 시간대 기준의 주간 시간대입니다. days는 ISO 요일(1 = 월요일 … 7 = 일요일)이며, start/end는 "HH:MM" 형식입니다(end "24:00" 허용). (update)
fromstringnull시작하는 ISO 날짜/시간, null이면 해제 (update)
tostringnull종료하는 ISO 날짜/시간, null이면 해제 (update)
priorityinteger겹치는 예약 항목 간의 우선순위를 정합니다(값이 높을수록 우선) (update)
contentRefstringdisplay_library_read list 또는 playlists에서 가져온 media#<id>, app#<id> 또는 playlist#<id> (update)
confirmCctvboolean사용자가 라이브 CCTV 표시를 명시적으로 확인한 후에만 설정합니다 (update)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
batchIdstringdisplay_publish 또는 display_schedule_read에서 가져온 게시 전체(bt_…), 모든 대상에 적용 (delete)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_screen_command디스플레이 화면

시설의 Display Screens에 실시간 명령을 보냅니다: reload(player 화면이 일정을 다시 가져옴), identify(화면의 이름과 코드를 깜박여 현장에서 화면을 찾음), displayOn/displayOff(TV 패널), rebootDevice(화면의 컴퓨터를 다시 시작하며 1–2분 동안 화면이 꺼짐, confirm: true 필요) 또는 osd(짧은 화면 메시지, message 전달).

screenIds 및/또는 groupIds(시설에서 해당 그룹에 속한 모든 화면)로 화면을 선택하거나, allScreens: true로 시설의 모든 화면을 선택합니다(이 경우 displayOn/displayOff는 Templated content 화면에도 적용됨). 화면별 결과를 반환합니다. 여러 화면, 그룹 또는 대상이 지정되면 한 번의 호출로 모두에 적용됩니다. 많은 대상에 작업하기 전에 사용자에게 확인하십시오.

매개변수

이름유형설명
screenIdsarraydisplay_screens_read list에서 가져온 화면 ID(6자리 코드)입니다. allScreens를 사용할 때는 생략합니다.
groupIdsarray화면 그룹 ID 또는 이름: 시설에서 해당 그룹에 속한 모든 화면
allScreensbooleanTemplated content 화면을 포함한 시설의 모든 화면
command*"reload" | "identify" | "displayOn" | "displayOff" | "rebootDevice" | "osd"수행할 작업(rebootDevice에는 confirm 필요)
messagestringosd에 표시할 텍스트
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_screens_read디스플레이 화면

시설의 Display Screens를 읽습니다: 상태와 현재 및 다음에 표시될 내용과 함께 화면을 나열하거나(그룹, 상태 또는 디스플레이 모드로 필터링), 화면 하나의 전체 세부 정보와 타임라인을 가져오거나, 화면 그룹과 소속 화면을 나열합니다.

디스플레이 모드는 사용자에게 "Data Source"로 표시됩니다: player는 "User managed content", program-builder는 "Templated content"(사용자에게는 항상 이 이름을 사용하십시오), url은 "Full-page website (Kiosk Mode)"입니다. 시간은 ISO 형식이며, 시설 시간대가 함께 반환됩니다.

작업:

  • list: 화면을 나열합니다. 시설의 화면(페이지 단위)과 각 화면의 상태, 마지막 하트비트, 그룹, 태그, 현재 및 다음에 표시될 내용입니다. 그룹도 함께 반환합니다.
  • get: 화면을 가져옵니다. 화면 하나의 전체 세부 정보(상태, 하트비트, 플레이어 버전, 최근 오류)와 player 화면의 경우 특정 기간(기본값 다음 24시간, 최대 14일)에 표시되는 내용입니다. screenId가 필요합니다.
  • groups: 화면 그룹을 나열합니다. 시설의 화면 그룹(페이지 단위)과 각 그룹의 화면입니다.

매개변수

이름유형설명
action*"list" | "get" | "groups"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
groupIdstring이 그룹(ID 또는 이름)에 속한 화면만 (list)
status"playing" | "provisioning" | "display-off" | "not-responding" | "offline" | "online"(list)
mode"player" | "program-builder" | "url"(list)
limitinteger페이지당 항목 수(기본값 25, 최대 100) (list, groups)
cursorstring이전 페이지의 nextCursor (list, groups)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
screenIdstringdisplay_screens_read list에서 가져온 화면 ID(6자리 코드) (get)
fromstring타임라인의 ISO 시작(기본값 현재) (get)
tostring타임라인의 ISO 종료(기본값 from으로부터 24시간 후) (get)
display_screens_write디스플레이 화면디바이스 관리

Display Screens를 변경합니다: 페어링 코드로 새 화면을 페어링하고, 화면 이름 변경, 그룹 및 태그 설정, 디스플레이 모드(사용자에게 "Data Source"로 표시됨) 전환, player 화면의 토큰 교체, 화면이나 콘텐츠의 기간 제한 미리 보기 링크 생성, 또는 화면 초기화(시설에서 제거됨)를 수행합니다.

디스플레이 모드: player("User managed content"), url("Full-page website (Kiosk Mode)", url 전달, https만 가능), program-builder("Templated content", 사용자에게는 항상 이 이름을 사용하십시오). 모드를 변경하면 화면이 즉시 다시 로드되고 회원에게 보이는 내용이 바뀌므로 사용자의 확인이 필요합니다.

작업:

  • update: 화면을 업데이트합니다. 화면의 이름, 그룹(ID 또는 이름, 현재 그룹을 대체함), 태그(현재 태그를 대체함) 및/또는 디스플레이 모드를 설정합니다. 모드를 변경하면 먼저 requiresConfirmation을 반환합니다. screenId가 필요합니다. 확인을 요청할 수 있습니다.
  • rotate_token: 화면 토큰을 교체합니다. player 화면에 새 토큰을 발급하고 화면을 다시 로드하며, 이전 토큰은 더 이상 작동하지 않습니다. 화면의 player URL이 유출되었을 수 있을 때 사용하십시오. screenId가 필요합니다. 확인을 요청합니다.
  • create_preview_link: 미리 보기 링크를 생성합니다. 화면에 표시되는 내용이나 콘텐츠가 표시되는 모양을 보여 주는 링크(제한된 시간 동안 유효)이며, 선택적으로 미래 시점을 지정할 수 있습니다. 링크가 있는 사람은 누구나 만료될 때까지 볼 수 있습니다.
  • reset: 화면을 초기화합니다. 시설에서 화면을 제거하고 공장 초기화합니다. 전원이 꺼진 화면은 다음에 온라인 상태가 될 때 초기화된 후 페어링 페이지를 표시합니다. confirmName에는 사용자가 입력한 그대로의 화면 이름을 전달하십시오. Device Management가 필요합니다. screenId, confirmName이 필요합니다. 확인을 요청합니다.
  • pair: 새 화면을 페어링합니다. 페어링 페이지에 표시된 6자리 코드로 시설에 새 화면을 추가한 후 다시 로드합니다. Display Screens만 있는 시설에서는 player 모드로 시작하고, Templated content도 있는 시설에서는 mode로 선택합니다(기본값 program-builder). Device Management가 필요합니다. pairingCode, name이 필요합니다. 확인을 요청합니다.

매개변수

이름유형설명
action*"update" | "rotate_token" | "create_preview_link" | "reset" | "pair"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
screenIdstringdisplay_screens_read list에서 가져온 화면 ID(6자리 코드) (update, rotate_token, create_preview_link, reset)
namestring화면 이름 (update, pair)
groupIdsarray그룹 ID 또는 이름입니다. 현재 그룹을 대체합니다(그룹은 display_groups_write save로 생성) (update)
tagsarray현재 태그를 대체합니다 (update)
mode"player" | "program-builder" | "url"디스플레이 모드("Data Source") (update, pair)
urlstringurl 모드용 웹사이트(https) (update)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
contentRefstringdisplay_library_read list 또는 playlists에서 가져온 media#<id>, app#<id> 또는 playlist#<id> (create_preview_link)
orientation"landscape" | "portrait"contentRef 미리 보기용(기본값 landscape) (create_preview_link)
atstring미리 볼 ISO 날짜/시간(기본값 현재) (create_preview_link)
confirmNamestring확인을 위해 사용자가 입력한 화면 이름(정확히 일치해야 함) (reset)
pairingCodestring화면의 페어링 페이지에 표시되는 코드(0과 O는 비슷하게 보임) (pair)
contentStreamstringTemplated content: 화면이 재생할 스트림(라운드), 기본값 1 (pair)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_screenshot디스플레이 화면

Display Screen에 지금 표시되고 있는 내용을 캡처하여 이미지를 반환하므로, 게시 후 직접 결과를 확인할 수 있습니다(레이아웃, 텍스트 크기, 잘리거나 스크롤되는 부분이 없는지). 화면이 응답할 때까지 최대 15초 동안 기다리며, 오프라인 화면은 시간이 초과됩니다. JPEG의 포털 URL도 반환합니다(로그인한 사용자만 이용 가능, 10분 동안 보관).

스크린샷에는 라이브 CCTV와 화면에 보이는 회원이 포함될 수 있으므로 대화 밖에서 공유하지 마십시오.

매개변수

이름유형설명
screenId*stringdisplay_screens_read list에서 가져온 화면 ID(6자리 코드)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
display_settings_read디스플레이 화면

Reads Display Screens settings for a facility: the fallback slate, polling and nightly reload, CCTV on screens; the screen power schedule (with the next days' on/off times); automations (brightness, bell volume, check-in power, round timer state); the brand's boot screen, screen defaults and templated content settings; and, with templated content, the scheduled program dates and the templated schedule.

Actions:

  • settings: Get facility display settings. The fallback slate (message, background, logo, facility name), polling interval, nightly reload time and whether CCTV may be shown on screens.
  • power_schedule: Get the power schedule. When screens turn on and off: the saved schedule (or the older automations' equivalent), the facility time zone and the on/off times for the next 7 days.
  • power_schedule_preview: Preview a power schedule. The on/off times a schedule would give over the next 7 days, without saving it. Needs schedule.
  • automations: Get display automations. Automatic brightness (day/night levels and triggers), bell volume levels and schedule (decimal hours, 6.5 = 06:30), check-in power, and the round timer state, for one or several facilities. usesGlobalDefaults is true until the facility saves its own.
  • boot_screen: Get the brand's boot screen. The image the facility's brand shows while screens start up (fit, background, image URLs) and whether you can change it (organisation admins).
  • screen_defaults: Get the brand's screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities (orientation, screen mirroring, session timer, speaker control, duress monitoring, camera restreaming, Wi-Fi support) and whether you can change them (organisation admins). Screens that are already paired keep their own settings; see device_inventory_read for those.
  • templated: Get the brand's templated content settings. What templated content screens and the Schedule show for the facility's brand (source name, workout names, programs and training phases, look-ahead days) and whether you can change it (organisation admins).
  • program_dates: List scheduled program dates. The dates with a workout program, from the start of this month to the brand's look-ahead. Needs templated content (Program Builder) at the facility.
  • templated_schedule: Get the templated schedule. Programs and training phases between two dates (YYYY-MM-DD, at most 62 days), as the brand shows them. Needs templated content (Program Builder) at the facility. Needs from, to.

매개변수

이름유형설명
action*"settings" | "power_schedule" | "power_schedule_preview" | "automations" | "boot_screen" | "screen_defaults" | "templated" | "program_dates" | "templated_schedule"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
scheduleobject화면은 직원 상주 시간(오프셋만큼 확장) 또는 사용자 지정 주간 시간대 동안 켜지며, 휴일 규칙이 적용됩니다. (power_schedule_preview)
facilityIdsarray동일한 요청을 각 시설에서 실행할 여러 시설 ID입니다. facilityId 대신 사용합니다. (automations)
fromstring첫 날짜(YYYY-MM-DD) (templated_schedule)
tostring마지막 날짜(YYYY-MM-DD) (templated_schedule)
display_settings_write디스플레이 화면

시설의 Display Screens 설정을 변경합니다: Fallback Slate, 폴링 및 야간 재로드, "Allow CCTV on display screens", 화면 전원 일정, 자동화(밝기, 벨 볼륨, 체크인 시 전원). 지정하지 않은 필드는 현재 값을 유지합니다. 브랜드 전체 설정(부팅 화면, Templated content)은 display_brand_settings_write에 있습니다.

작업:

  • save_settings: 시설 디스플레이 설정을 저장합니다. 예약된 콘텐츠가 없을 때 표시되는 Fallback Slate, 폴링 간격(30–300초), 야간 재로드 시간(HH:mm), allowCctv입니다. allowCctv를 켜려면 사용자의 확인과 CCTV 접근 권한이 있는 시설 관리자가 필요합니다. 확인을 요청할 수 있습니다.
  • save_power_schedule: 전원 일정을 저장합니다. 화면이 켜지고 꺼지는 시간을 변경하며, 전달한 필드는 저장된 일정에 병합됩니다. 향후 7일간의 켜짐/꺼짐 시간을 반환합니다. 먼저 display_settings_read power_schedule_preview로 확인하십시오. schedule이 필요합니다.
  • save_automations: 디스플레이 자동화를 저장합니다. 자동 밝기, 벨 볼륨 및 체크인 시 전원 설정을 변경합니다. 이후 시설은 전역 기본값 대신 자체 설정을 유지합니다.

매개변수

이름유형설명
action*"save_settings" | "save_power_schedule" | "save_automations"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
slateobject(save_settings)
pollIntervalSecinteger(save_settings)
nightlyReloadTimestringHH:mm (save_settings)
allowCctvboolean디스플레이 화면에서 CCTV 허용 (save_settings)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
scheduleobject화면은 직원 상주 시간(오프셋만큼 확장) 또는 사용자 지정 주간 시간대 동안 켜지며, 휴일 규칙이 적용됩니다. (save_power_schedule)
autoPowerDisplaysboolean이전 전원 자동화 켜기/끄기(전원 일정이 이를 대체함) (save_automations)
minsBeforeOpenDisplayOninteger이전 전원 자동화: 개장 전 분 (save_automations)
minsAfterCloseDisplayOffinteger이전 전원 자동화: 마감 후 분 (save_automations)
displaysOnCheckInboolean누군가 체크인하면 화면 켜기 (save_automations)
minsLastCheckInDisplayOffintegerdisplaysOnCheckIn 사용 시: 마지막 체크인 후 화면이 꺼질 때까지의 시간(분) (save_automations)
enableAutoBrightnessboolean주간 밝기와 야간 밝기 간 전환 (save_automations)
dayTriggerType"auto" | "staffed" | "custom"주간 밝기가 시작되는 시점 (save_automations)
dayTimeStartstringdayTriggerType custom용: HH:mm(시설 시간) (save_automations)
dayOffsetMinutesinteger새벽 또는 개장 후 분 (save_automations)
dayBrightnessLevelinteger주간 밝기, % (save_automations)
nightTriggerType"auto" | "staffed" | "custom"야간 밝기가 시작되는 시점 (save_automations)
nightTimeStartstringnightTriggerType custom용: HH:mm(시설 시간) (save_automations)
nightOffsetMinutesinteger해 질 녘 이후 또는 마감 전 분 (save_automations)
nightBrightnessLevelinteger야간 밝기, % (save_automations)
bellMasterLevelinteger마스터 벨 볼륨, % (save_automations)
bellClubHoursLevelinteger직원 상주 시간의 벨 볼륨, % (save_automations)
bellExtendedHoursLevelinteger연장 운영 시간의 벨 볼륨, % (save_automations)
enableBellAutoVolumeboolean벨 볼륨 일정 따르기 (save_automations)
bellVolumeScheduleobject요일별(mon … sun) 주간 벨 볼륨 블록입니다. 전체 일정을 대체합니다 (save_automations)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다
display_takeover_stop디스플레이 화면

실행 중인 Display Screens Takeover를 즉시 종료합니다: 한 게시(display_publish에서 가져온 batchId), 대상(기본값: 시설 전체에 게시된 Takeover), 또는 allScreens를 사용하면 시설, 시설의 화면이나 그룹에 게시된 모든 Takeover가 대상입니다. 브랜드 및 조직 Takeover는 batchId로만 중지할 수 있습니다. 화면은 몇 초 안에 예약된 콘텐츠나 기본 콘텐츠로 돌아가며, 중지된 개수를 반환합니다. 여러 화면, 그룹 또는 대상이 지정되면 한 번의 호출로 모두에 적용됩니다. 많은 대상에 작업하기 전에 사용자에게 확인하십시오.

매개변수

이름유형설명
batchIdstringdisplay_publish에서 가져온 Takeover 게시(bt_…)
targetsobject콘텐츠를 표시할 위치입니다. 이 항목들을 자유롭게 조합할 수 있습니다. 그룹은 ID뿐 아니라 이름으로도 지정할 수 있습니다. brand와 organisation에는 조직 전체 Display Screens 접근 권한이 필요합니다.
allScreensboolean시설, 시설의 화면 또는 그룹에 게시된 모든 Takeover
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
display_templated_write디스플레이 화면

Templated content 화면(display_screens_read의 디스플레이 모드 "Templated content")을 제어합니다: 하루치 운동 프로그램을 화면에 로드하거나 라운드 타이머를 제어합니다. User managed content 및 전체 페이지 웹사이트 화면은 영향을 받지 않습니다.

작업:

  • load_program: 운동 프로그램을 로드합니다. 시설의 데이터 소스에서 특정 날짜(YYYY-MM-DD, 기본값 오늘)의 운동 프로그램을 하나 또는 여러 시설의 모든 Templated content 화면에 로드하며, 화면은 몇 초 안에 다시 로드됩니다. 오늘 또는 다른 날의 운동을 표시하거나 화면에 잘못된 운동이 표시될 때 사용하십시오. 여러 시설에는 confirm이 필요합니다. 확인을 요청할 수 있습니다.
  • clock: 라운드 타이머를 제어합니다. Templated content 화면에서 라운드 타이머를 재생, 일시 중지, 다시 시작 또는 중지하고, 라운드 소리를 음소거하거나 음소거 해제하고, 벨 볼륨을 설정하거나(volume 0–100과 함께 setvolume) 타이머 상태를 요청합니다. 시설에 Templated content가 필요합니다. command가 필요합니다.

매개변수

이름유형설명
action*"load_program" | "clock"수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
facilityIdsarray동일한 요청을 각 시설에서 실행할 여러 시설 ID입니다. facilityId 대신 사용합니다. (load_program)
datestring운동 날짜, YYYY-MM-DD(기본값 오늘) (load_program)
facilityIdstring시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
command"getstate" | "play" | "pause" | "restart" | "stop" | "mute" | "unmute" | "setvolume"(clock)
volumeintegersetvolume용: 벨 볼륨, % (clock)
confirmboolean첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다