MobileConnect API and 3rd Party plugins¶
It is common in the AV sector for products to connect to 3rd party integrations. These can be media control systems which are already installed on the venue and give the opportunity to control a room’s lights, window blinds and also audio & video devices in an automated way. A possible challenge in daily use of a MobileConnect system is to distribute the channel access information, e.g. the QR code or PIN code. The solution is to connect MobileConnect to the existing media system and thus to the digital displays that are typically present in larger rooms.
We introduced the MobileConnect API which enables MobileConnect to be connected to 3rd party media control systems. Based on the API, Sennheiser provides dedicated 3rd party plugins. They implement the MobileConnect API and help you to reduce the integration effort. You can use the plugins as they are or customize the plugin code to fit your needs.
You have multiple options, supported in both Manager and Standalone Modes:
Q-SYS module
Crestron module
Extron driver
Your media control system is not supported? Make your own implementation using the API
Alternatively, you can contact us at https://www.sennheiser.com/de-de/support as we may have a beta version of your preferred system.
3rd Party Plugins¶
To download the MobileConnect 3rd party plugins:
For the Q-SYS and Crestron modules go to the MobileConnect Accounts website
The Extron driver is available on the Extron store
To use the plugins you need to configure 3 parameters:
API token
Manager Mode: Manager Token
Standalone Mode: Standalone Token
The End Point URL depending on the system mode
Manager Mode: configure the URL or IP address of your Manager.
Standalone Mode: configure the IP address of the Station you want to connect to.
API version - find the API version of your Manager/Station here
Each plugin comes with a detailed Readme containing all supported functions and required configuration.
MobileConnect API¶
The MobileConnect API is a REST API. It is encrypted and requires the usage of an authorization token.
The full API specifications are provided in current MobileConnect API v3.0. Below you can find a list of API functions and in which MobileConnect versions they are supported.
Verb |
Function |
API Version |
Available from Manager Version |
Available from Standalone Version |
Available in Manager Mode |
Available in Standalone Mode |
GET |
Query the list of stations |
All |
v1.3.0 |
v6.7.0 |
Y |
Y |
GET |
Query the connection state of a station |
|||||
GET |
Query the channels of a station |
|||||
POST |
Regenerate channel access |
|||||
GET |
Download the QR code for a channel available formats:
|
All |
v1.3.0 |
v6.7.0 |
Y |
Only for
(svg and jpg return “501 - not implemented)” |
GET |
Query the details of a channel |
>v1.0 |
v1.4.0 |
v6.7.0 |
Y |
Y |
PUT |
Update the details of a channel |
|||||
GET |
Query the access details of a channel |
>v1.0 |
v1.4.0 |
v6.7.0 |
Y |
N |
GET |
Query the pin protection settings of a channel |
>v1.0 |
v1.4.0 |
v6.7.0 |
Y |
Y |
PUT |
Update the pin settings of a channel |
|||||
DEL |
Remove the pin protection of a channel |
|||||
GET |
Query the mDNS status |
>v2.0 |
v2.1.0 |
v7.2.0 |
N |
Y |
PUT |
Update the mDNS status |
|||||
POST |
Revoke current speakers permission |
>v2.0 |
v2.1.0 |
v7.2.0 |
Y |
Y |
POST |
Clear all speakers and queue |
|||||
GET |
Query the number of speakers |
To see older versions of the API documentation visit: MobileConnect API v1.0, MobileConnect API v2.0 or MobileConnect API v2.1
Note
In case you have feedback or requests for the MobileConnect API, contact us at https://www.sennheiser.com/de-de/support.
Topics related to the API: