Wallboard API - Channel/Schedule (2.0)

This API manages two fundamentally different systems that share the same underlying data model (Campaign). Understanding the distinction is critical for correct API usage.

Channels are hierarchical content containers assigned to device groups. They organize content into a multi-level structure with sophisticated playback balancing.

Channel Structure

Channel (Campaign with level=WIDGET)
├── Sub-channel Groups (Message Groups) - organizational containers
│   ├── Sub-channel A (Message) - contains content + device tags + schedule
│   └── Sub-channel B (Message) - contains content + device tags + schedule
├── Saturation Setting - proportional playback weight
├── Device Group Targeting - folder/tag/team-based assignment
└── Working Time Restrictions - when channel is active

Channel Content Types (mutually exclusive)

• Content: Slides, playlists, multi-page interactive content
• Media: Images, videos, PDFs
• Sub-channels: Nested sub-channel groups only
• SSP (Vistar): Programmatic advertising

Channel Playback Logic

• Channels play sequentially based on order
• Saturation controls relative airtime between channels (e.g., saturation 2 = 2x airtime)
• Playback slots control how many items play before switching channels

Schedules are temporary content overrides that replace a device's assigned content during specific time periods. When the schedule ends, devices return to their base content.

Schedule Structure

Schedule (Campaign with level=TOP)
├── Single Content Item - exactly one playlist/slide/content
├── Priority Number - higher number wins conflicts
├── Device Targeting - specific devices (manual or dynamic)
└── Time Rules - when override is active

Schedule Priority System

1. Active Schedules - priority-based (higher number wins)
2. Base Assigned Content - default when no schedule active

Schedule Example

Device: Lobby Screen
Base Content: "Daily Playlist"
Schedule A: "Lunch Menu" (Priority 1, 11:30-13:00)
Schedule B: "CEO Announcement" (Priority 2, 12:00-12:15)

Timeline:
- 11:30-12:00 → Lunch Menu (Priority 1 active)
- 12:00-12:15 → CEO Announcement (Priority 2 overrides)
- 12:15-13:00 → Lunch Menu (back to Priority 1)
- After 13:00 → Daily Playlist (schedule ended)

Creating a Channel

1. POST /api/campaign - Create campaign (level defaults to WIDGET = Channel)
2. POST /api/campaign/{id}/messageGroup - Add sub-channel groups
3. POST /api/campaign/{id}/message - Add sub-channels with content

Creating a Schedule

1. POST /api/campaign with level: TOP - Create schedule
2. Assign single content item directly
3. Set priority and device targeting

Use the search parameter with WBQL syntax:

See Getting Started for full WBQL syntax.

Channel and Schedule management. Channels (level: WIDGET) are hierarchical content containers assigned to device groups with saturation balancing. Schedules (level: TOP) are temporary content overrides with priority-based conflict resolution.

Sub-channel group management. Sub-channel groups are organizational containers that group related sub-channels within a channel.