So aktivieren Sie das Gateway und erstellen einen Schlüssel
Aktualisiert am
In SyBox erfolgt dies unter Einstellungen > Integrationen > API-Schlüssel.
- Gehen Sie zu Einstellungen > Integrationen > API-Schlüssel.
- Aktivieren Sie den Schalter „API-Gateway“.
- Klicken Sie auf „Neuer Schlüssel“.

- Wählen Sie den „Schlüsseltyp“:
- „Über WhatsApp senden“: Das Programm sendet Nachrichten an Ihre Kunden.
- „Fall anlegen“: Das Programm öffnet Vorgänge in SyBox. Es kann keine Nachrichten senden.
- „SMS von einem Telefon importieren“: Ein Smartphone leitet seine SMS-Nachrichten in den Posteingang weiter.
- „Automatisierung starten“: Das Programm startet die Automatisierungen, bei denen unter „Startet, wenn“ die Option „Ein anderes Programm ruft SyBox auf“ gewählt ist (POST /v1/automation mit „phone“ des Kunden sowie optional „event“ und „data“). Es kann keine Nachrichten senden. Siehe Einstellungen > KI und Automatisierung > Automatisierungen.
- „Kontakte lesen und aktualisieren“: Das Programm sucht Kontakte, liest einen Kontakt aus und ändert dessen Namen, E-Mail-Adresse, Kontaktfelder und Labels (POST /v1/contacts/search, /get, /update und /labels). Es kann keine Nachrichten senden. Der Schlüssel handelt im Namen der Person, die ihn erstellt hat: Er sieht nur die Kontakte, die diese Person sehen darf, funktioniert nur, wenn diese Person die Kontaktliste öffnen und Nummern sehen darf, und kann Kontakte nur ändern, wenn diese Person sie bearbeiten darf. Wird diese Person deaktiviert, funktioniert der Schlüssel nicht mehr.
- Tragen Sie den „Geräte- oder Programmname“ ein, z. B. „Büro-PC“ oder „Buchhaltung“. Vergeben Sie für jedes Gerät und Programm einen eigenen Schlüssel.
- Legen Sie für einen Schlüssel vom Typ „Über WhatsApp senden“ außerdem Folgendes fest:
- „Sendet von“: Die WhatsApp-Nummer, über die dieser Schlüssel Nachrichten versendet (Pflichtfeld).
- „Freitextnachrichten erlauben“: Ein oder Aus.
- „Genehmigte Vorlagen erlauben“: Ein oder Aus. Mindestens eine dieser beiden Optionen muss aktiv sein, andernfalls erscheint: „Erlauben Sie mindestens Freitext oder Vorlagen — andernfalls kann der Schlüssel nichts senden.“
- „Senden von Medien erlauben“: Ein oder Aus.
- „Vorlagen“ (optional): Vorlagennamen, durch Kommas getrennt. Leer lassen, um alle Vorlagen zu erlauben.
- „Erlaubte Empfängerländer“ (optional): Ländercodes mit zwei Buchstaben, z. B. DE,AT,CH. Leer lassen, um alle Länder zuzulassen.
- „Senden erlaubt von“ ... „Zu“: Das Zeitfenster, in dem der Schlüssel senden darf. Lassen Sie beide Werte gleich, wenn es keine zeitliche Einschränkung geben soll. Die Zeiten beziehen sich auf die Ortszeit des Arbeitsbereichs.
- „Tägliches Nachrichtenlimit (0 = unbegrenzt)“.
- Aktivieren Sie bei Schlüsseln vom Typ „SMS von einem Telefon importieren“ die Option „Nur Kontakte und Kunden“. Ist sie aktiv, verbleiben SMS von unbekannten Nummern auf dem Telefon und erreichen den Posteingang nicht. Deaktivieren Sie dies nur, wenn das Telefon ausschließlich geschäftlich genutzt wird.
- Klicken Sie auf Speichern.
- Ein Fenster zeigt die „Basis-URL“ und den „API-Schlüssel“ an. Kopieren Sie diese jetzt. „Kopieren Sie diesen Schlüssel jetzt — er wird nur einmal angezeigt.“ Tragen Sie die Daten in den Einstellungen Ihres Programms ein.
Fragen
Ich habe meinen API-Schlüssel verloren. Kann ich ihn noch einmal ansehen?
Nein. Er wird nur ein einziges Mal angezeigt. Erstellen Sie einen neuen Schlüssel, tragen Sie ihn in Ihr Programm ein und löschen Sie danach den alten Schlüssel.
Ich vermute, dass ein Schlüssel offengelegt wurde. Was soll ich tun?
Löschen oder deaktivieren Sie diesen Schlüssel unverzüglich. Nur dieser einzelne Schlüssel verliert seine Gültigkeit. Ihre WhatsApp-Nummer und Ihre übrigen Schlüssel sind davon nicht betroffen.
Die Auswahlliste „Sendet von“ ist leer.
Die Liste enthält nur WhatsApp-Nummern, die verbunden und aktiviert sind. Verbinden Sie zuerst eine Nummer unter Einstellungen > Nachrichten > Kanäle.
Mein Programm erhält beim Senden eine Fehlermeldung.
Prüfen Sie, ob der Schalter „API-Gateway“ eingeschaltet und der Schlüssel aktiv ist. Kontrollieren Sie auch die Limits des Schlüssels: Freitext vs. Vorlagen, Medien, erlaubte Vorlagen, erlaubte Länder, Sendezeiten und das Tageslimit. Zudem gelten weiterhin die Vorgaben von WhatsApp – so ist Freitext beispielsweise nur innerhalb von 24 Stunden nach der letzten Nachricht des Kunden möglich.
Kann ein Schlüssel vom Typ „Fall anlegen“ auch Nachrichten senden?
Nein, das ist bewusst so geregelt. Ein Schlüssel zum Anlegen von Fällen kann keine Nachrichten senden, und ein Sendeschlüssel kann keine Fälle anlegen. Verwenden Sie für jeden Zweck einen eigenen Schlüssel.
Ich habe noch einen alten Schlüssel vom Typ „Von einem Programm empfangen“. Funktioniert dieser noch?
Ja, bestehende Schlüssel dieses Typs funktionieren weiterhin. Neue Schlüssel dieses Typs können jedoch nicht mehr erstellt werden. Verwenden Sie für solche Aufgaben künftig „Fall anlegen“.
Mehr über API-Schlüssel.