TeamSpeak WebQuery REST API

  • Hallo!


    Dieser Artikel gibt eine kurze Einleitung in das Thema "TeamSpeak WebQuery API". Eine mögliche Alternative für die ts3admin.class und das TS3PHPFramework.

    Quote from TeamSpeak Server CHANGELOG

    ## Server Release 3.12.0 18 March 2020


    ### Important

    - New feature WebQuery that allows user to access to query system using http(s) and json.

    Die WebQuery API ist seit März 2020 (TeamSpeak Server Version 3.12.0 und neuer) neben den klassischen ServerQuery Schnittstellen Telnet (query_protocols=raw; Standard Port 10011/TCP; unverschlüsselt) und SSH (query_protocols=ssh, Standard Port 10022/TCP; verschlüsselt) eine weitere Schnittstelle, um ServerQuery Befehle auszuführen.


    Man kann mit Hilfe der WebQuery API zum Beispiel...

    • einen neuen virtuellen Server anlegen, bearbeiten, stoppen, wieder starten und löschen
    • Servereinstellungen ändern
    • Statistiken, wie z.B. die Anzahl der insgesamt verbundenen Clients, Traffic, Latenzen, Packetloss und vieles mehr abfragen
    • Clients ent-/bannen
    • Servergruppen verwalten
    • und vieles mehr.

    Die WebQuery API ist dabei über einfaches HTTP (query_protocols=http; Standard Port 10080/TCP; unverschlüsselt) oder auch mit etwas Aufwand (man benötigt ein SSL Zertifikat) über HTTPS (query_protocols=https; Standard Port 10443/TCP; verschlüsselt) erreichbar. Übergeben tut man der API Header, POST/GET Variablen, JSON Datensätze und erhält eine entsprechende Antwort im JSON Format.


    Insgesamt soll die WebQuery API gegenüber der klassischen raw und ssh Verbindung bei API Aufrufen um einiges schneller sein, da man dazwischen z.B. keine PHP Klasse(n) mehr benötigt und somit z.B. auch weniger Overhead beim programmieren hat.


    So, aber wie fängt man jetzt an? Wie kann man diese WebQuery API benutzen?


    Voraussetzung hierfür ist natürlich erstmal, dass die WebQuery API serverseitig aktiviert ist. Lest hierzu entweder in der Dokumentation vom Server nach oder fragt euren Hoster/Betreiber des TeamSpeak Servers, ob diese entsprechend aktiviert ist.


    Danach benötigt ihr nur noch ein paar grundlegende Programmierfähigkeiten mit (REST) APIs, sowie einen API Key für den entsprechenden TeamSpeak Server, auf welchem ihr die API Befehle entsprechend ausführen wollt.


    So einen API Key könnt ihr mittels eures ServerQuery Benutzer erstellen. Loggt euch hierfür z.B. mit SSH auf die ServerQuery Schnittstelle ein:

    Code
    # ssh <ServerQuery Username>@<IP oder DNS Adresse vom TeamSpeak Server>
    ssh serveradmin@mein-teamspeak.de

    ...und generiert euch einen API Key:

    Code
    # apikeyadd scope={manage|write|read} [lifetime={days}] [cldbid={clientDBID}]
    apikeyadd scope=manage lifetime=180

    Das "Scope" definiert in diesem Fall die Rechte, die dieser API Key erhalten soll:

    • manage: Maximaler Zugriff; Administrator-Rechte
    • write: Einige Schreibrechte werden vergeben, jedoch nicht alle.
    • read: Nur lesende Funktionen sind aufrufbar

    Um herauszufinden, welches Scope man tatsächlich benötigt, kann man in diese Liste schauen:

    Die Lifetime definiert, wie lange dieser API Key in Tagen gültig ist. 0 bedeutet, dass er nie abläuft.


    Die optionale cldbid definiert dann noch, wer der Eigentümer dieses API Keys ist. Standardmäßig gehört er immer dem User, der ihn auch erstellt.


    Gut. Ihr solltet jetzt einen API Key haben, der wie dieser z.B. aussieht: AQB8J1sfuvq4wFAFdo6rsfFq+jAQO9asz3zGq5X


    Wie gesagt: Die API kann man auf verschiedenste Art und Weise ansprechen:

    • curl
    • PHP
    • JavaScript
    • jQuery
    • NodeJS
    • Postman
    • ...

    Wir werden das ganze von einer Befehlszeile aus machen, also nutzen wir in diesem Beispiel einfach mal curl (https://linux.die.net/man/1/curl).


    Dann starten wir doch mal mit einem einfachen API Request: Wer bin ich, der sich hier per API eingeloggt hat?

    Code
    ❯ curl -s -H 'x-api-key: AQB8J1sfuvq4wFAFdo6rsfFq+jAQO9asz3zGq5X' 'http://127.0.0.1:10080/whoami'
    {"body":[{"client_channel_id":"0","client_database_id":"1","client_id":"0","client_login_name":"<internal>","client_nickname":"","client_origin_server_id":"0","client_unique_identifier":"serveradmin","virtualserver_id":"0","virtualserver_port":"0","virtualserver_status":"unknown","virtualserver_unique_identifier":""}],"status":{"code":0,"message":"ok"}}

    So, das hat schon mal funktioniert. Jetzt formatieren wir das JSON aber noch schön, damit es lesbarer ist. Das geht ganz einfach mit json_pp:

    Wie wir sehen, bekommen wir von der API zwei "Blöcke" zurück:

    1. status: Hier kann man sehen und prüfen, ob der API Request erfolgreich war oder Fehler auftraten.
    2. body: Hier werden immer die angeforderten Daten von der API zurück geliefert. In unserem Beispiel von whoami.

    Holen wir uns mal die Liste aller virtuellen Server auf dieser TeamSpeak Instanz:

    Und jetzt mal die clientlist vom TeamSpeak Server mit der virtualserver_id = 4:

    Je nachdem, was man da jetzt alles machen möchte, muss man sich die Dokumentation der ServerQuery Befehle anschauen und seinen API Request entsprechend bauen.


    Weitere Beispiele und Informationen zur WebQuery API liefert z.B. der TeamSpeak Server in der mitgelieferten doc/webquery.md Datei.


    Ansonsten könnt ihr auch gerne eure persönlichen Fragen in einem neuen Thema stellen. :)


    In diesem Sinne: Happy Coding!