1 Allgemeine Informationen
1.1 HTTP API
Die HTTP API (application programming interface) von veoovibes ermöglicht einen automatisierten, maschinengeeigneten Zugriff zur Steuerung von veoovibes. Der Zugriff erfolgt via HTTP, die Antworten werden als JSON, XML oder PHP zurück geliefert.
Ausnahme: room_now_playing liefert immer einzeiligen UTF-8-Plaintext (text/plain; charset=UTF-8), ohne JSON-/XML-/PHP-Hülle und unabhängig von output. Bei Fehlern bleibt der Antworttext leer; maßgeblich ist der HTTP-Statuscode. Einzelheiten stehen unter „Aktuelle Titelinformation als Plaintext (Raum)“.
1.2 API-Key
Jede veoovibes Installation verfügt über einen eigenen einzigartigen API-Key. Dieser wird benötigt um die jeweilige veoovibes Installation zu steuern. Der API-Key muss bei allen Abfragen im Parameter api_key übermittelt werden. Geschieht dieses nicht oder wird ein ungültiger API-Key verwendet, wird der Befehl nicht ausgeführt und die API meldet den Fehlercode 20 (siehe API Antwort Codes).
1.3 Ausgabeformat
Alle Anfragen und Rückgabewerte sind UTF-8 kodiert. Standardmäßig erfolgt die Rückgabe der API-Schnittstelle im JSON-Format. Das Format kann jedoch geändert werden (siehe API Antwort Format). In diesem Dokument werden alle Ausgaben als JSON dargestellt.
Ausnahme: room_now_playing liefert immer einzeiligen UTF-8-Plaintext (text/plain; charset=UTF-8), ohne JSON-/XML-/PHP-Hülle und unabhängig von output. Bei Fehlern bleibt der Antworttext leer; maßgeblich ist der HTTP-Statuscode. Einzelheiten stehen unter „Aktuelle Titelinformation als Plaintext (Raum)“.
1.4 Systemmanager
Der Systemmanager von veoovibes ist ein eigener Service, welcher auf jeder veoovibes Installation vorhanden ist. Darüber können Wartungsaufgaben und Systemdiagnosen durchgeführt werden. Auch werden über den Systemmanager die API Einstellungen festgelegt.
Den Systemmanager können Sie über die veoovibes Oberfläche über:
„veoovibes Einstellungen -> System -> Systemmanager öffnen“ aufrufen.
1.5 Wiedergabelisten vs. Warteschlangen
In veoovibes werden die Begriffe Wiedergabelisten und Warteschlangen verwendet. Wiedergabelisten sind vom Endbenutzer erstelle Listen, welche eine beliebige Anzahl von Musiktiteln enthalten. Warteschlangen gibt es pro Zone, diese stellen die abzuspielenden Titel der Zone dar.
1.6 Unterstützung
Sie benötigen Hilfe? Unser Support-Team steht Ihnen mit Rat und Tat zur Seite. Bitte senden Sie Ihre Anfragen per E-Mail an: support@veoovibes.com oder besuchen Sie http://support.veoovibes.com
2 API Steuerungsdefinitionen
2.1 Web Service Location
Die folgende Basis URI (Uniform Resource Identifier) wird für alle weiteren Befehle benötigt.
| Name | Wert / Platzhalter | Beschreibung |
|---|---|---|
| IP-Adresse | <IP-Adresse> | IP-Adresse von veoovibes (Hostname kann verwendet werden, wird aber nicht empfohlen) |
| API-Key | <API-Key> | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/?api_key=<API-Key>
2.2 API Antwort Format
Alle Antworten erfolgen standardmäßig in JSON, es kann jedoch über den URL Parameter output das Format geändert werden.
| Beschreibung | Content-Type | Erweiterung |
|---|---|---|
| JSON (Standard) | application/json;charset=UTF-8 | json |
| XML | text/xml;charset=UTF-8 | xml |
| PHP | text/plain;charset=UTF-8 | php |
Beispiel
Antworten als XML Ausgabe erhalten:http://<IP-Adresse>/api/v1/<befehl>/?api_key=<API-Key>&output=xml
Ausnahme: room_now_playing liefert immer einzeiligen UTF-8-Plaintext (text/plain; charset=UTF-8), ohne JSON-/XML-/PHP-Hülle und unabhängig von output. Bei Fehlern bleibt der Antworttext leer; maßgeblich ist der HTTP-Statuscode. Einzelheiten stehen unter „Aktuelle Titelinformation als Plaintext (Raum)“.
2.3 API Antwort Codes
Jede Anfrage / jeder Befehl an die Schnittstelle wird mit folgenden Angaben (im gewählten Format, siehe "API Antwort Format") beantwortet:
| Name | Wert |
|---|---|
| status | Kann entweder "succeeded" (erfolgreich) oder "failed" (fehlgeschlagen) sein |
| code | Sollte immer 0 sein, außer es trat ein Fehler auf, dann wird hier die Fehler ID ausgegeben |
| error_message | Beinhaltet die Fehlermedung (sofern vorhanden), trat kein Fehler auf, bleibt diese leer |
Antwort Code bei erfolgreicher Anfrage
Bei erfolgreichen Abfragen wird zusätzlich auch folgender Wert übertragen:| Name | Wert |
|---|---|
| result | Enthält die angeforderten Daten oder einen Status Text |
Fehler IDs
| Code | Bedeutung | Beschreibung |
|---|---|---|
| 1 | Exception | Ein allgemeiner Fehler ist aufgetreten |
| 2 | Http Method | Die angeforderte http Methode wird für diese Anfrage nicht unterstützt |
| 3 | Required Parameter | Ein benötigter Parameter wurde nicht übergeben oder dessen Wert war leer |
| 10 | API disabled | Die API ist deaktiviert, wenden Sie sich an den Support |
| 20 | Access Token | Ungültiger oder fehlender API Key |
Ausnahme: room_now_playing liefert immer einzeiligen UTF-8-Plaintext (text/plain; charset=UTF-8), ohne JSON-/XML-/PHP-Hülle und unabhängig von output. Bei Fehlern bleibt der Antworttext leer; maßgeblich ist der HTTP-Statuscode. Einzelheiten stehen unter „Aktuelle Titelinformation als Plaintext (Raum)“.
2.4 Gemeinsame Audioziele
Räume, gespeicherte Raumgruppen und aktuelle Wiedergabezonen können über die gemeinsame Zielliste und einen gemeinsamen Befehlsendpunkt angesprochen werden.
Verfügbarkeit
Die Erweiterung ist im Quellcode implementiert und lokal geprüft. Die Prüfung auf den vier vorgesehenen Testsystemen und die Laufzeitbereitstellung stehen aus. Eine freigegebene Softwareversion für diese Endpunkte ist noch nicht festgelegt.
| Zieltyp | Bedeutung |
|---|---|
| room | Ein Raum bleibt auch als Gruppenmitglied für Status und Einzellautstärke ansprechbar. |
| room_group | Eine dauerhaft gespeicherte, benannte Zusammenstellung von Räumen mit eigener ID. |
| zone | Die aktuelle gemeinsame Wiedergabe mit Quelle und Warteschlange. |
Die IDs für Räume sind interne Raum-IDs aus der Zielliste. Die separate api_room_id ist die konfigurierbare Nummer für bestehende Integrationen. Zonen-IDs beschreiben den aktuellen Laufzeitzustand. Vor einem Zonenbefehl die aktuelle Zielliste abfragen. Die bisherigen API-Aufrufe behalten ihr Verhalten.
Die neuen HTTP-Endpunkte liefern ausschließlich JSON und verwenden die bestehende API-Authentifizierung. Bei POST steht der API-Key im JSON-Body. Die Erweiterung wird nicht über die TCP-API angeboten.
2.5 Gemeinsame Zielliste und Zielstatus
GET /api/v1/targets/ liefert Räume, Raumgruppen und befüllte Zonen als gemeinsame Liste in result. Die optionalen Parameter type und id müssen zusammen übergeben werden. Dann liefert result das einzelne Ziel einschließlich playback mit Titel, Quelle und Wiedergabestatus seiner aktuellen Zone oder null.
GET /api/v1/targets/?type=room&id=11&api_key=<API-Key>
| Feld | Bedeutung |
|---|---|
| type, id, name | Zieltyp, Ziel-ID und Anzeigename. |
| member_room_ids | Interne IDs aller zum Ziel gehörenden Räume. |
| available_room_ids | Aktuell erreichbare Mitgliedsräume. |
| zone_ids, zone_id | Aktuelle Zonen der Mitglieder. zone_id ist null, falls das Ziel keiner einzelnen gemeinsamen Zone zugeordnet ist. |
| volume | Raumlautstärke oder gerundeter Mittelwert der Mitgliedsräume. |
| commands | Aufgrund von Gruppierung und Erreichbarkeit mögliche Befehle. Berechtigungen, Automatikvorgaben und Systemzustand werden bei der Ausführung erneut geprüft. |
| api_room_id, room_group_id | Zusätzliche Felder bei Räumen. Separate API-Raumnummer und gespeicherte Raumgruppen-ID, jeweils null ohne Zuordnung. |
Die Zielliste respektiert Raumfreigaben. Gruppen oder Zonen mit nicht freigegebenen Mitgliedern werden nicht angeboten. Das folgende Antwortbeispiel ist ein Ausschnitt der Zielliste.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| type | room, room_group oder zone. Bei der gezielten GET-Abfrage gemeinsam mit id angeben. | wird im Beispiel nicht angezeigt |
| id | Positive Ziel-ID aus der gemeinsamen Zielliste. Bei GET gemeinsam mit type angeben. | wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/targets?api_key=<API-Key>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": [
{
"type": "room_group",
"id": 17,
"name": "Erdgeschoss",
"member_room_ids": [
11,
12
],
"available_room_ids": [
11,
12
],
"zone_ids": [
4
],
"zone_id": 4,
"volume": 30,
"commands": [
"set_volume"
]
}
]
}
2.6 Gemeinsamer Befehlsendpunkt
POST /api/v1/target_command/ erwartet einen JSON-Body mit api_key, target und command.
| Befehl | Wirkung |
|---|---|
| set_volume | Setzt ausschließlich die Lautstärke der Mitglieder des gewählten Ziels. value ist eine Ganzzahl von 0 bis 100. Die vorhandenen Automatik- und Lautstärkevorgaben gelten. |
| play, stop, next, prev | Steuert die Wiedergabe, wenn die aktuelle Zone genau die angeforderten Räume umfasst und alle erreichbar sind. |
Beispiel: Erdgeschoss umfasst Küche und Esszimmer. Spielt zusätzlich die Terrasse in derselben Zone, ändert set_volume für Erdgeschoss nur Küche und Esszimmer. Ein Stopp für Erdgeschoss wird mit 409 shared_playback abgewiesen. Der Client kann ausdrücklich die gemeinsame Zone auswählen oder die Gruppierung in der Anwendung ändern. Ein abgewiesener Befehl löst keine Umgruppierung aus.
Bei Lautstärkebefehlen enthält result die Listen executed_rooms, skipped_rooms und failed_rooms. Sind nur einige Änderungen gelungen, lautet status partial. Bei Wiedergabebefehlen bedeutet eine erfolgreiche Antwort die Annahme durch den Wiedergabecontroller. Den tatsächlichen Wiedergabestatus über das einzelne Ziel abfragen.
| HTTP | reason und Bedeutung |
|---|---|
| 400 | invalid_target, invalid_command, invalid_volume bei ungültigen Angaben. |
| 403 | volume_not_allowed oder playback_not_allowed bei gesperrter Bedienung. |
| 404 | target_not_found bei fehlendem oder nicht freigegebenem Ziel. |
| 405 | method_not_allowed bei einer falschen HTTP-Methode. |
| 409 | shared_playback bei gemeinsamer Wiedergabe über das gewählte Ziel hinaus, rooms_unavailable bei nicht erreichbaren Räumen, group_busy bei laufender Gruppenänderung, system_locked bei Haussperre, automatic_room_playback bei ungeeigneter automatischer Raumwiedergabe. |
| 502 | volume_failed, wenn keine Lautstärkeänderung gelang, oder playback_unconfirmed bei einem nicht bestätigten Wiedergabebefehl. |
| 503 | system_maintenance bei Wartung. |
Konfliktantworten enthalten das gewählte Ziel mit seiner aktuellen Zonenzuordnung in result. Die bestehenden allgemeinen API- und Lizenzprüfungen gelten zusätzlich.
Parameter
| Name | Platzhalter | Beschreibung |
|---|---|---|
| IP-Adresse | <IP-Adresse> | IPv4 Adresse von veoovibes |
| api_key | <API-Key> | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
| target | <Ziel> | JSON-Objekt mit type (room, room_group oder zone) und id aus der Zielliste. |
| command | <Befehl> | set_volume, play, stop, next oder prev. |
| value | <Lautstärke> | Nur bei set_volume erforderlich. Ganzzahl von 0 bis 100. |
Aufruf
POST http://<IP-Adresse>/api/v1/target_command/
Content-Type: application/json
{
"api_key": "<API-Key>",
"target": {
"type": "room_group",
"id": 17
},
"command": "set_volume",
"value": 30
}
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": {
"target": {
"type": "room_group",
"id": 17
},
"executed_rooms": [
11,
12
],
"skipped_rooms": [],
"failed_rooms": []
}
}
3 Räume steuern
3.1 Wiedergabe starten (Raum)
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_play?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.2 Wiedergabe stoppen (Raum)
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_stop?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.3 Nächste Titel (Raum)
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_next?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.4 Vorheriger Titel (Raum)
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_prev?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.5 Lautstärke erhöhen (Raum)
Lautstärke des angegebenen Raumes schrittweise erhöhen. Hinweis: Ist der Raum als einziger Raum mit der Zone verbunden, so wird die Zonenlautstärke mit der neuen Lautstärke des Raums gleichgesetzt.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_vol_up?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.6 Lautstärke verringern (Raum)
Lautstärke des angegebenen Raumes schrittweise verringern. Hinweis: Ist der Raum als einziger Raum mit der Zone verbunden, so wird die Zonenlautstärke mit der neuen Lautstärke des Raums gleichgesetzt.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_vol_down?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.7 Lautstärke einstellen (Raum)
Lautstärke des angegebenen Raumes auf einen Wert zwischen 0 – 100% einstellen.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes | |
| vol | Ein Wert zwischen 0 und 100 als Ganzzahl. Es ist auch möglich eine relative Änderung mit +XX oder -XX anzugeben (Achtung: '+' muss URL-Codiert sein!). |
Aufruf
http://<IP-Adresse>/api/v1/room_vol_set?api_key=<API-Key>&room=<Room-ID>&vol=<Volume>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.8 Musik abspielen (Raum)
Für das Abspielen von einem Speicherplatz in einem Raum. Dabei gilt folgende Logik: Ist der Raum der einzige in der Zone, so wird der angegebene Speicherplatz in die Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) aufgenommen und abgespielt. Befinden sich in der Zone des angegebenen Raumes mehrere Räume, so wird der Raum aus der Zone entfernt und der angegebene Speicherplatz wiedergegeben.
Für die Musikwiedergabe müssen im Systemmanager die „Programme“ festgelegt werden, welche hier über den Befehl „Musik Wiedergeben“ abgespielt werden können. Dabei gilt es zu beachten, dass max. 12 Programmgruppen angelegt werden können. Jede Programmgruppe kann bis zu 12 „Speicherplätze“ enthalten. Pro Speicherplatz kann jeweils ein „Radiosender“ oder ein „pers. Radiosender“ oder eine „Wiedergabeliste“ (siehe Wiedergabelisten vs. Warteschlangen) hinterlegt werden.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes | |
| group | Die ID der zur verwendenden Programmgruppe | |
| prog | Die ID des Speicherplatzes innerhalb der Programmgruppe |
Aufruf
http://<IP-Adresse>/api/v1/music_room?api_key=<API-Key>&room=<Room-ID>&group=<Group-ID>&prog=<Prog-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.9 Zufallswiedergabe (Raum)
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_random?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.10 Endloswiedergabe (Raum)
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_repeat?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
3.11 Player Status Abfragen (Raum)
ab Version 1.1.780 verfügbar
Gibt eine Auflistung aller Informationen über den Wiedergabestatus inkl. Metadaten für den Raum aus.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/room_player_status?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status":"succeeded",
"code":0,
"error_message":"",
"result":{
"mediatime_total":"",
"mediatime_now":"",
"mediatime_progress":100,
"is_playing":1,
"zone_volume":33,
"random":0,
"repeat":1,
"status_code":"playing",
"status":"Wiedergabe",
"album":"",
"artist":"",
"title":"Soap&Skin; - Heal | FM4 Reality Check",
"cover":"http://api.veoovibes.com/radiostations/220c77af02f8ad8561b150d93000ddff.png",
"is_radio":true,
"radio_name":"FM4",
"type":"",
"current_volume":19
}
}
3.12 Aktuelle Titelinformation als Plaintext (Raum)
GET-Abfrage der aktuellen Titelinformation eines einzelnen Raums. Die Antwort ist ausschließlich einzeiliger Plaintext in UTF-8 (Content-Type: text/plain; charset=UTF-8), ohne JSON, Anführungszeichen, Feldnamen oder Statushülle. Ein zusätzlicher Parameter output ist nicht erforderlich.
Bei Musik lautet die Ausgabe Interpret - Titel; fehlt eines der Felder, wird nur das vorhandene Feld ausgegeben. Bei Radio und Livestreams wird die aktuelle Titelinformation verwendet, sofern vorhanden; bei Radio ohne Titelinformation der Sendername. Zeilenumbrüche werden durch Leerzeichen ersetzt. Räume derselben Wiedergabezone liefern dieselbe Titelinformation.
room muss eine positive numerische API-Raum-ID sein. Die bisherige Auflösung über interne Raum-IDs als Rückfall bleibt erhalten. Raumkurznamen, Zonen-IDs und Raumgruppen-IDs sind hier keine Parameter.
Bei Pause, Stopp, fehlendem Player oder fehlender Zonenzuordnung ist die Antwort mit HTTP 200 leer. Fehlerantworten enthalten ebenfalls keinen Text und kein JSON: HTTP 400 bei ungültigem oder fehlendem Parameter/API-Schlüssel oder abgelaufenem Authentifizierungstoken, 403 bei ungültiger Lizenz, 404 bei unbekanntem Raum, 405 bei nicht freigegebener API oder unzulässiger Methode, 500 bei internem Fehler und 503 im Wartungsmodus. Die bestehende API-Authentifizierung und Lizenzprüfung bleiben wirksam.
Die Antwort wird mit Cache-Control: no-store ausgeliefert. Der Endpunkt ändert weder Wiedergabe noch Raumzuordnung.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Positive numerische API-Raum-ID (kein Kurzname); interne Raum-ID als Rückfall |
Aufruf
http://<IP-Adresse>/api/v1/room_now_playing?api_key=<API-Key>&room=<Room-ID>
Antwort
Daft Punk - One More Time
3.13 Räume Abfragen
Gibt eine Liste mit allen im System konfigurierten Räumen zurück.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/listrooms?api_key=<API-Key>
Antwort
{
"status":"succeeded",
"code":0,
"error_message":"",
"result":{
"95":{
"id_room":95,
"api_room_id":12,
"api_room_name":"kueche",
"type":"Soundkarte",
"name":"Küche",
"current_volume":13,
"eq_bands":"",
"is_hidden":0,
"is_available":true
},
"91":{
"id_room":91,
"api_room_id":91,
"api_room_name":"allgemein",
"type":"Soundkarte",
"name":"Allgemein",
"current_volume":13,
"eq_bands":"",
"is_hidden":0,
"is_available":true
}
}
}
3.14 Raum stoppen
Da die Zone die Musik steuert, ist es im Normalfall erforderlich, die mit dem Raum verbundene Zone zu stoppen. Diese Funktion ermöglicht Ihnen die Zone aufgrund des angegebenen Raums zu stoppen ohne vorher die dazugehörige Zone abzufragen. Dabei kann entschieden werden, ob die gesamte Zone gestoppt werden soll oder ob der angegebene Raum aus der Zone entfernt werden soll.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes | |
| action | 1 = (Standard) Den Raum aus der aktuellen Zone entfernen – somit wird der Raum gestoppt und verliert gleichzeitig jedoch die Warteschlange aufgrund der neuen Zone. 2 = Die für den Raum zuständige Zone stoppen, somit werden ev. weitere verbunden Räume ebenfalls nichts mehr Wiedergeben. |
Aufruf
http://<IP-Adresse>/api/v1/stop_room?api_key=<API-Key>&room=<Room-ID>&action=<Action-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4 Zone steuern
4.1 Wiedergabe starten (Zone)
Setzt die Wiedergabe an der letzten Position der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) fort.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/play?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.2 Wiedergabe stoppen (Zone)
Stoppt die Wiedergabe der angegeben Zone.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/stop?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.3 Nächster Titel (Zone)
Den nächsten Titel der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) abspielen.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/next?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.4 Vorheriger Titel (Zone)
Den vorherigen Titel der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) abspielen.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/prev?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.5 Lautstärke erhöhen (Zone)
Lautstärke aller mit der Zone verbundenen Räumen schrittweise erhöhen.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/vol_up?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.6 Lautstärke verringern (Zone)
Lautstärke aller mit der Zone verbundenen Räumen schrittweise verringern.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/vol_down?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.7 Lautstärke einstellen (Zone)
Setzt die Lautstärke aller mit der Zone verbundenen Räume auf einen Wert zwischen 0 – 100%.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| vol | Ein Wert zwischen 0 und 100 als Ganzzahl. Es ist auch möglich eine relative Änderung mit +XX oder -XX anzugeben (Achtung: '+' muss URL-Codiert sein!). | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/vol_set?api_key=<API-Key>&zone=<Zone-ID>&vol=<Volume>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.8 Musik abspielen (Zone)
Für das Abspielen von einem Speicherplatz in einer Zone. Alle mit der Zone verbunden Räume geben diesen Speicherplatz wieder.
Für die Musikwiedergabe müssen im Systemmanager die „Programme“ festgelegt werden, welche hier über den Befehl „Musik Wiedergeben“ abgespielt werden können. Dabei gilt es zu beachten, dass max. 12 Programmgruppen angelegt werden können. Jede Programmgruppe kann bis zu 12 „Speicherplätze“ enthalten. Pro Speicherplatz kann jeweils ein „Radiosender“ oder ein „pers. Radiosender“ oder eine „Wiedergabeliste“ (siehe Wiedergabelisten vs. Warteschlangen) hinterlegt werden.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| group | Die ID der zur verwendenden Programmgruppe | |
| prog | Die ID des Speicherplatzes innerhalb der Programmgruppe | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/music_zone?api_key=<API-Key>&zone=<Zone-ID>&group=<Group-ID>&prog=<Prog-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.9 Zufallswiedergabe (Zone)
Die Zufallswiedergabe der Zone für die aktuelle Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) aktivieren / deaktivieren.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/random?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.10 Endloswiedergabe (Zone)
Die Einträge der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) wiederholen aktivieren / deaktivieren.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/repeat?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.11 Player Status Abfragen (Zone)
in Version 1.1.780 geändert
Gibt eine Auflistung aller Informationen über den Wiedergabestatus inkl. Metadaten für alle Zonen oder einen bestimmten Zone aus.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | wird im Beispiel nicht angezeigt |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/player_status?api_key=<API-Key>
Antwort
{
"status":"succeeded",
"code":0,
"error_message":"",
"result":{
"1":{
"id_zone":1,
"player":{
"mediatime_total":"",
"mediatime_now":"",
"mediatime_progress":100,
"is_playing":1,
"zone_volume":13,
"random":0,
"repeat":1,
"status_code":"playing",
"status":"Wiedergabe",
"album":"",
"artist":"",
"title":"Sarah Jane Morris - Nothing Comes From Nothing",
"cover":"http://api.veoovibes.com/radiostations/c4fa856e631d52fce97c4eb37d17bb19.png",
"is_radio":true,
"radio_name":"Lounge FM Digital",
"type":""
}
},
"2":{
"id_zone":2,
"player":{
"mediatime_total":"",
"mediatime_now":"",
"mediatime_progress":100,
"is_playing":0,
"zone_volume":24,
"random":0,
"repeat":1,
"status_code":"stopped",
"status":null,
"album":"",
"artist":"",
"title":"",
"cover":"",
"is_radio":false,
"radio_name":"",
"type":""
}
}
}
}
4.12 Zonen Abfragen
Gibt eine Liste mit der aktuellen Zonenkonfiguration zurück. Die Rückgabe enthält die API Antwort Codes und das Element result, welche alle Zonen auflistet.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/listzones?api_key=<API-Key>
Antwort
{
"status":"succeeded",
"code":0,
"error_message":"",
"result":{
"1":{
"id_zone":1,
"rooms":"91,90,96",
"room_detail":{
"91":{
"id_room":91,
"api_room_id":91,
"api_room_name":"allgemein",
"type":"Soundkarte",
"name":"Allgemein",
"current_volume":13,
"eq_bands":"",
"is_hidden":0,
"is_available":true
},
"90":{
"id_room":90,
"api_room_id":90,
"api_room_name":"kueche",
"type":"Soundkarte",
"name":"Küche",
"current_volume":13,
"eq_bands":"",
"is_hidden":0,
"is_available":true
}
}
},
"2":{
"id_zone":2,
"rooms":126,
"room_detail":{
"126":{
"id_room":126,
"api_room_id":126,
"api_room_name":"terrasse",
"type":"Soundkarte",
"name":"Dachterrasse",
"current_volume":24,
"eq_bands":"-8,-5.2,-2.8,0,0,0,0,0,0,0",
"is_hidden":0,
"is_available":true
}
}
}
}
}
4.13 Zonen & Player Status kombiniert
Gibt eine kombinierte Antwort aus den beiden Einzelabfragen "Zonen Abfragen" und "Player Status Abfragen" zurück.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/listzones_player_status?api_key=<API-Key>
Antwort
{
"status":"succeeded",
"code":0,
"error_message":"",
"result":{
"1":{
"id_zone":1,
"rooms":"91,90",
"room_detail":{
"91":{
"id_room":91,
"api_room_id":91,
"api_room_name":"allgemein",
"type":"Soundkarte",
"name":"Allgemein",
"current_volume":13,
"eq_bands":"",
"is_hidden":0,
"is_available":true
},
"90":{
"id_room":90,
"api_room_id":90,
"api_room_name":"guenter",
"type":"Soundkarte",
"name":"G\u00fcnters B\u00fcro",
"current_volume":13,
"eq_bands":"",
"is_hidden":0,
"is_available":true
}
},
"player":{
"mediatime_total":"",
"mediatime_now":"",
"mediatime_progress":100,
"is_playing":1,
"zone_volume":13,
"random":0,
"repeat":1,
"status_code":"playing",
"status":"Wiedergabe",
"album":"",
"artist":"",
"title":"DJ Vadim featuring Katherin DeBoer - Black Is the Night",
"cover":"http:\/\/api.veoovibes.com\/radiostations\/c4fa856e631d52fce97c4eb37d17bb19.png",
"is_radio":true,
"radio_name":"Lounge FM Digital",
"type":""
}
},
"2":{
"id_zone":2,
"rooms":126,
"room_detail":{
"126":{
"id_room":126,
"api_room_id":126,
"api_room_name":"terrasse",
"type":"Soundkarte",
"name":"Dachterrasse",
"current_volume":24,
"eq_bands":"-8,-5.2,-2.8,0,0,0,0,0,0,0",
"is_hidden":0,
"is_available":true
}
},
"player":{
"mediatime_total":"",
"mediatime_now":"",
"mediatime_progress":100,
"is_playing":0,
"zone_volume":24,
"random":0,
"repeat":1,
"status_code":"stopped",
"status":null,
"album":"",
"artist":"",
"title":"",
"cover":"",
"is_radio":false,
"radio_name":"",
"type":""
}
}
}
}
4.14 Warteschlange einer Zone anzeigen
ab Version 1.0.860 verfügbar
Gibt die komplette Warteschlange der angegebenen Zone aus.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone |
Aufruf
http://<IP-Adresse>/api/v1/list_queue?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status":"succeeded",
"code":0,
"error_message":"",
"result":[
{
"id":6,
"title":"Lounge FM Digital",
"artist":"",
"duration":0
},
{
"id":16,
"title":"ANTENNE BAYERN - Top 40",
"artist":"",
"duration":0
}
]
}
4.15 Wiedergabe eines Eintrags der Warteschlange
ab Version 1.0.860 verfügbar
Spielt den angegebenen Eintrag der Warteschlange ab. Hinweis: Dieser Befehl startet ggf. die Wiedergabe!
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| item | Die ID des Eintrags der Warteschlange |
Aufruf
http://<IP-Adresse>/api/v1/play_queue_item?api_key=<API-Key>&zone=<Zone-ID>&item=<Item-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.16 Warteschlange einer Zone leeren
ab Version 1.0.854 verfügbar
Leert / Löscht die komplette Warteschlange der angegebenen Zone.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| zone | Die ID der zu steuernden Zone | |
| zoneroom | Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben). |
wird im Beispiel nicht angezeigt |
Aufruf
http://<IP-Adresse>/api/v1/empty_queue?api_key=<API-Key>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
4.17 Alle Zonen stoppen
Stoppt die Wiedergabe in allen Zonen.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/stop_all?api_key=<API-Key>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
5 veoovibes Steuerung
5.1 Haussperre aktivieren
Aktiviert die Haussperre. Mehr Informationen zur Haussperre unter "Grundfunktionalität".
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/lock_system?api_key=<API-Key>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
5.2 Haussperre deaktivieren
Deaktiviert die Haussperre. Mehr Informationen zur Haussperre unter "Grundfunktionalität".
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/unlock_system?api_key=<API-Key>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
5.3 Türgong abspielen
ab Version 1.2.217 verfügbar
Spielt einen Türgong in den im Admin-Bereich hinterlegten Räumen (und eingestellten Lautstärke) ab.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/chime?api_key=<API-Key>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
5.4 Türgong 2 abspielen
Spielt den zweiten Türgong mit den dafür eingestellten Räumen, dem Signalton und der Lautstärke ab. "Türgong 2 zulassen" muss aktiviert sein.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden |
Aufruf
http://<IP-Adresse>/api/v1/chime2?api_key=<API-Key>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
6 Raum / Zonen Zuordnung
6.1 Raum zu einer Zone hinzufügen
Fügt einen Raum einer Zone hinzu.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes | |
| zone | Die ID der zu steuernden Zone |
Aufruf
http://<IP-Adresse>/api/v1/add_room_to_zone?api_key=<API-Key>&room=<Room-ID>&zone=<Zone-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}
6.2 Raum aus einer Zone entfernen
Entfernt einen Raum aus einer Zone.
Parameter
| Name | Beschreibung | Werte angeben |
|---|---|---|
| IP-Adresse | IPv4 Adresse von veoovibes | |
| api_key | API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden | |
| room | Die Raum-ID oder der Kurzname des zu steuernden Raumes |
Aufruf
http://<IP-Adresse>/api/v1/remove_room_from_zone?api_key=<API-Key>&room=<Room-ID>
Antwort
{
"status": "succeeded",
"code": 0,
"error_message": "",
"result": "OK"
}