REST-API von Kesru

Was es tut

Ihre Software schickt Anfragen mit einem API-Schlüssel, und jeder Schlüssel darf nur die Bereiche nutzen, die Sie freigeben. Das sind die Anfragen je Bereich:

• Anrufe: Anrufe auflisten, einen Anruf mit Transkript abrufen, seine Aufnahme abrufen und Transkript und Aufnahme eines Anrufs löschen.
• Agenten: Agenten auflisten und abrufen, einen Agenten ändern, veröffentlichen und löschen.
• Rufnummern: Ihre Rufnummern auflisten, eine Rufnummer ändern und löschen.
• Nutzer: die Personen in Ihrem Konto auflisten.
• Chats: einen Chat oder SMS-Chat anlegen, eine Nachricht in einem Chat senden, Chats abrufen, auflisten und beenden und die Nachrichten eines Chats löschen.
• Kontakte: Kontakte auflisten, anlegen, abrufen, ändern und löschen.

API-Schlüssel erstellen

1. Öffnen Sie im Kundenbereich Entwickler → API-Schlüssel.

2. Wählen Sie API-Schlüssel erstellen und benennen Sie den Schlüssel nach der Software, die ihn nutzt.

3. Lassen Sie Schlüssel beschränken an und legen Sie je Bereich fest, was der Schlüssel darf: Kein Zugriff, Lesen oder Lesen und Schreiben. Für Zapier wählen Sie Kein Zugriff oder Zugriff.

   

4. Wählen Sie unter Läuft ab nach, wann der Schlüssel nicht mehr gilt, von 15 Minuten bis 30 Tage, oder Nie.

5. Wählen Sie Erstellen und kopieren Sie den Schlüssel sofort. Später können Sie ihn nicht mehr ansehen.

Anfragen senden

• Senden Sie den Schlüssel im Header Authorization, so wie er ist oder als Bearer-Token.
• Jeder Schlüssel darf bis zu 10 Anfragen pro Sekunde stellen. Darüber antwortet Kesru mit 429 Too Many Requests und bittet, es nach einer Sekunde erneut zu versuchen.
• Zeiten stehen in Unix-Sekunden, etwa der Beginn eines Anrufs.

Schlüssel verwalten

• Ihre Schlüssel zeigt jeden Schlüssel mit seinen letzten vier Zeichen, wer ihn wann erstellt hat, worauf er zugreifen darf, seine Chat-Antworten und wann er abläuft.
• Bearbeiten ändert die Einstellungen eines Schlüssels. Änderungen gelten ab der nächsten Anfrage mit diesem Schlüssel.
• Löschen sperrt einen Schlüssel sofort. Software und Zaps, die ihn nutzen, stehen still, bis Sie ihnen einen anderen Schlüssel geben.
• API-Protokoll zeigt die Anfragen, die mit Ihren Schlüsseln gestellt wurden.

Ein Nutzungslimit begrenzt die Chat-Antworten Ihrer Agenten für einen Schlüssel. Jede Chat-Antwort zählt, und hat der Schlüssel sein Limit erreicht, scheitern Chat-Anfragen bis zum nächsten Abrechnungszeitraum.

Beispiel

Ein Sanitärbetrieb in München verbindet zwei Programme, jedes mit eigenem Schlüssel. crm-sync darf Anrufe lesen und Kontakte lesen und schreiben, damit das CRM neue Anrufe abholt und die Kontakte abgleicht. website-chat darf nur Chats nutzen, mit einem Limit von 5.000 Chat-Antworten je Abrechnungszeitraum, und läuft nach 30 Tagen ab.

Gut zu wissen

Kesru antwortet mit 401

Der Schlüssel ist ungültig oder abgelaufen. Ein abgelaufener Schlüssel steht unter Ihre Schlüssel als Abgelaufen und lässt sich nicht mehr ändern. Erstellen Sie einen neuen Schlüssel und tragen Sie ihn in Ihrer Software ein.

Kesru antwortet mit 403

Entweder fehlt dem Schlüssel das Recht für diesen Bereich, dann ändern Sie seinen Zugriff unter Entwickler → API-Schlüssel, oder Ihr Konto hat kein aktives Abo und keine Testphase.

Kesru antwortet mit 429

Der Schlüssel hat mehr als 10 Anfragen in einer Sekunde gestellt. Warten Sie eine Sekunde und senden Sie die Anfrage erneut.

Dieselben Schlüssel gelten für Zapier

Ein Schlüssel mit Zugriff für Zapier verbindet Kesru mit Zapier. Ohne dieses Recht kann Zapier den Schlüssel nicht nutzen.

Ihre Daten

Rechtliche Fragen zu Ihren Daten beantworten die Datenschutzerklärung und der Auftragsverarbeitungsvertrag.