Pause API#

For special programming, it may be desirable for the Replacer to temporarily stop replacing content and swapping tracks, for example during a hit countdown. For this purpose, the Replacer can be put into pause mode. During this time, the simulcast signal is simply passed through. The pause applies to all channels on the Replacer, so it is not possible to pause just a single channel.

Pause mode is triggered by calling a URL of the Replacer API. Two parameters must be provided:

  • sleep_duration: The pause duration in minutes, for example 60 for a one-hour pause.

  • api_key: The access key for the API.

Structure of the pause URL#

replacer-<station_key>.radio-creator.com:5008/api/pause?sleep_duration=<sleep_duration>&api_key=<api_key>

Example:

replacer-ffh.radio-creator.com:5008/api/pause?sleep_duration=60&api_key=12345678-1234-5678-1234-123456789012

Ending a Pause: Resume#

After the configured time has elapsed, the Replacer automatically resumes replacing content. The pause duration can be extended or shortened by calling the Pause API again. In every case, the pause duration in minutes is counted from the time the API is called. However, the pause can also be ended immediately using the resume command. This API endpoint requires only the api_key parameter:

replacer-<station_key>.radio-creator.com:5008/api/resume?api_key=<api_key>