Public API v2¶

Verfügbar ab dem Plus-Tarif

Public API v2 ist für Nutzer der Tarife Plus und Pro verfügbar.

Public API v2 bietet programmatischen Zugriff auf die wichtigsten Hotline-Funktionen für die Integration mit CRM-Systemen, internen Diensten, Analysen und Automatisierungswerkzeugen.

Die aktuelle interaktive Dokumentation, der vollständige Methodenumfang, Datenmodelle und Anfragebeispiele sind in der Scalar-Oberfläche der Hotline API verfügbar.

Die Scalar-Oberfläche ermöglicht:

aktuelle Methoden sowie Anfrage- und Antwortmodelle anzuzeigen
sich mit Instance-Id und Instance-Token zu autorisieren
Testanfragen im Browser auszuführen
Anfragebeispiele für Shell, Python und Node.js anzuzeigen

Verwenden Sie zum Testen der Methoden eine Testverbindung und führen Sie keine ändernden oder massenhaften Operationen auf einer produktiven Verbindung aus, ohne die Parameter vorher zu prüfen.

Hotline API v2 öffnen

Hauptfunktionen¶

Die API-Methoden sind nach den wichtigsten Hotline-Objekten und -Abläufen gruppiert:

Instance — Informationen zur Verbindung und zugehörigen Telegram-Profilen abrufen; Verbindung starten, stoppen und neu starten
Dialog — Dialoge suchen und abrufen, neue Dialoge erstellen und ihren Status ändern
Message — Nachrichten an Dialoge und die Backend-Gruppe senden sowie Nachrichteninformationen abrufen
Say — Schnellantworten erstellen, anzeigen, umbenennen und löschen sowie in Dialoge senden
Mark — Markierungen, ihre Parameter und Zuweisungen zu Dialogen verwalten
Sending — Vorlagen, Sendings, Empfänger, Versandstatus und Berichte verwalten
Export — Datenexporte starten, Status prüfen und fertige Berichte herunterladen

Der Methodenumfang wird laufend erweitert. Prüfen Sie bei der Planung einer Integration immer die aktuelle API-Dokumentation.

Adresse und Autorisierung¶

Basisadresse der Public API v2:

https://api.production.hotline.tg/api/v2/

Alle API-Anfragen verwenden HTTP Basic:

HTTP-Basic-Feld	Daten der Hotline-Verbindung
`Username`	`Instance-Id`
`Password`	`Instance-Token`

Öffnen Sie die gewünschte Verbindung im Setup-Bot @hotlinetg_bot. In den Verbindungsdetails gilt:

Instance ID wird als Instance-Id verwendet
API key wird als Instance-Token verwendet

Beispielanfrage für Verbindungsinformationen:

curl --user "$INSTANCE_ID:$INSTANCE_TOKEN" \
  https://api.production.hotline.tg/api/v2/instance

Instance-Token geheim halten

Veröffentlichen Sie Instance-Token nicht in Code, Logs oder öffentlichen Repositories. Speichern Sie ihn in Umgebungsvariablen oder einem Secret-Speicher.

Nach dem Zurücksetzen des API key im Setup-Bot funktioniert der vorherige Token nicht mehr. Aktualisieren Sie die Zugangsdaten in allen Integrationen dieser Verbindung.