/
Station-IC API for remote control

Station-IC API for remote control

Translate page

Software plugins for Stream Deck and 3rd party module for the Bitfocus Companion are available and described in other articles.

This article is about specifically about the raw API capability of Station-IC 1.6 and higher.

This article describes use of a Clear-Com with 3rd party software and hardware which are outside of Clear-Com’s control. Clear-Com may have limited ability to troubleshoot and fix third party hardware and software.

The Station-IC remote control API is intended for use by qualified programmers who are proficient in the use of WebSockets and JSON.
Users of this API are responsible for ensuring that their software implementation have adequate error handling and testing before before deploying this API with their systems.

Station-IC 1.6 and higher include a websocket API to enable 3rd party software to be able to control and receive status of certain aspects of Station-IC.

The API can control and receive states of the following:

  • Keysets

    • Labels

    • Levels

    • Buttons

  • Global Mutes

    • Talk

    • Listen

  • Reply

    • Caller Label

    • Back, Front, Clear

  • Favorties

    • As configured by the user of Station-IC

The websocket API requires an API key which is unique to the installation of Station-IC on the computer to ensure the 3rd party software is using the correct Station-IC.

The Station IC API websocket, is protected by an API Key which is unique to the installation and only retrieved from the settings menu of the

Without the API Key the software does not process anything.

image-20251218-150939.png

 

 

When the 3rd party software opens the websocket to Station-IC connected to an intercom it retrieves a JSON list of all Keysets, Favorites and States. The 3rd party software can then control these, get a response upon any change (made from Station-IC or the API) and request a certain state by sending a control state without a variable.

 

Solution update Feb 10, 2026

Detailed information is provided in the Station-IC API protocol document

The API document is embedded in the Station IC App 

The screenshot is from Station IC  v1.7.2 build 3 

image-20260210-084738.png

 

 

 

See also

Station-IC with Stream Deck

Station-IC Bitfocus Companion Module

CAN'T FIND YOUR ANSWER? CLICK HERE TO CONTACT SUPPORT

This solution was provided by Clear-Com via a question submitted to us by customers like you. If you wish to share with us a new solution or update an old one, please follow this link..

The information on this page is owned by Clear-Com and constitutes Clear-Com’s confidential and proprietary information, may be used solely for purposes related to the furtherance of Clear-Com’ business and shall not be disclosed, distributed, copied or disseminated without Clear-Com’s prior written consent. Click Here for Clear-Com's privacy statement.