Sending Commands via the CMS API

The CMS API can be used to send commands to displays which are online via push messaging (XMR), so that predefined actions can be taken on the display.

These are commands initiated by the CMS, usually via API, and pushed to targeted displays or display groups for immediate action using the Xibo Message Relay (XMR), a form of push messaging.

If you want to control the playback of content on your display, check out Xibo's interactive, webhook or data connector functionality.

Use when

Integrating with a central system where access to the local player API is not possible.

Commands

The following commands are available, the link takes you to the associated API documentation.

Command	Description
commandAction	Run a configured Command
triggerWebhook	Send a web hook to the display
criteriaUpdate	Push a schedule criteria update to the display.
collectNow	Run XMDS routine collection immediately

Deprecated commands

Deprecation Notice

Commands (formerly software triggers) to change the content playing on your displays are being removed from the software in the next release. These are marked in the triggers table below, along with their replacement functionality.

The following commands are deprecated and will be removed in future versions of the software.

Action	Description	Params	Replaced by
changeLayout	Immediately change to the specified Layout	layoutId, duration, downloadRequired, changeMode The changeMode parameter can be either “replace” or “queue”, where the value effects the currently active changeLayout actions. The duration is always based on the time since the message was received, even when in “queue” mode.	Interactive webhooks and/or Schedule Criteria.
overlayLayout	Immediately overlay a Layout	layoutId, duration, downloadRequired	Interactive webhooks and/or Schedule Criteria.
revertToSchedule	Revert to the scheduled content, removing any Layouts/Overlays		Interactive webhooks and/or Schedule Criteria.
rekeyAction	Regenerate the Player Public Key and Channel		N/A — no longer required with web socket based XMR.

Security

Commands are sent to the Display via XMR using Web Sockets. In our recommended configuration, this will be over a secure web socket (wss://).

Push messages only contain instructions to communicate with the CMS or show existing content already known to the Display (for example existing Layouts, existing Commands, etc).

Older versions of the CMS, or older Player App versions connected to the latest CMS may use TCP as a fallback where web sockets are not supported. TCP triggers sent over are also sealed with a RSA public key - the private counterpart being held by the Player. The player must then verify the sealed message to ensure it originates from the CMS.