API-Referenz
Vollständige API-Dokumentation für die Integration von Hanc.AI in Ihre Anwendungen. Verwalten Sie Agenten, rufen Sie Anrufdaten ab, starten Sie Anrufe und steuern Sie jeden Teil der Plattform programmatisch.
Kurzübersicht
| Basis-URL | https://api.hanc.ai |
| Authentifizierung | API-Key per x-api-key-Header |
| Format | JSON |
Erzeugen Sie einen API-Key unter Integration → API Keys im Dashboard. Sie können bis zu 3 Keys pro Benutzer haben — Setup, Berechtigungen und Sicherheitshinweise finden Sie im API-Keys-Abschnitt in Integrationen.
curl -X GET "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"
Verfügbare Endpoints
Anrufe
| Aktion | Methode | Endpoint |
|---|---|---|
| Anrufe auflisten | GET | /v1/call/list |
| Anrufdetails (Transkript, Sentiment, Zusammenfassung) | GET | /v1/call/:id |
| Allgemeine Analytik (Metriken nach Datum/Agent) | GET | /v1/call/general-metrics |
| Tages-Analytik | GET | /v1/call/daily-metrics |
| Sentiment-Statistiken | GET | /v1/call/sentiment-stats |
| Kostenaufschlüsselung | GET | /v1/call/costs-breakdown |
| Anrufe exportieren (CSV) | GET | /v1/call/list/export |
| Kosten exportieren (CSV) | GET | /v1/call/costs-breakdown/export |
| Telefonanruf starten | POST | /v1/call/make-phone-call |
| Web-Call starten | POST | /v1/call/make-web-call |
Agenten
| Aktion | Methode | Endpoint |
|---|---|---|
| Agenten auflisten | GET | /v1/agent/list |
| Agent-Details | GET | /v1/agent/:id |
| Agent erstellen | POST | /v1/agent |
| Agent aktualisieren | PATCH | /v1/agent/:id |
| Agent löschen | DELETE | /v1/agent/:id |
| Anrufstatistik eines Agenten | GET | /v1/agent/:id/call-stats |
| Agent-Templates auflisten | GET | /v1/agent/agent_template/list |
Agent Actions:
| Aktion | Methode | Endpoint |
|---|---|---|
| Aktionen auflisten | GET | /v1/agent/:id/actions |
| Aktion hinzufügen | POST | /v1/agent/:id/actions |
| Aktion aktualisieren | PATCH | /v1/agent/:id/actions/:actionId |
| Aktion löschen | DELETE | /v1/agent/:id/actions/:actionId |
Agent Tools:
| Aktion | Methode | Endpoint |
|---|---|---|
| Tools auflisten | GET | /v1/agent/:id/tools |
| Tool hinzufügen | POST | /v1/agent/:id/tools |
| Tool aktualisieren | PATCH | /v1/agent/:id/tools/:toolId |
| Tool löschen | DELETE | /v1/agent/:id/tools/:toolId |
Knowledge Base
| Aktion | Methode | Endpoint |
|---|---|---|
| Knowledge Bases auflisten | GET | /v1/knowledge-base/list |
| Knowledge Base erstellen | POST | /v1/knowledge-base |
| Datei(en) hochladen | POST | /v1/knowledge-base/:id/file(s) |
| Datei löschen | DELETE | /v1/knowledge-base/:id/file |
| Agenten zuweisen | PUT | /v1/knowledge-base/:id/agents |
Telefonnummern
| Aktion | Methode | Endpoint |
|---|---|---|
| Nummern auflisten | GET | /v1/phone-number/list |
| Verfügbare Nummern (nach Land) | GET | /v1/phone-number/available |
| Nummer kaufen | POST | /v1/phone-number/buy |
| Nummer importieren | POST | /v1/phone-number/import |
| Mit SIP verbinden | PATCH | /v1/phone-number/connect-to-sip |
Stimmen
| Aktion | Methode | Endpoint |
|---|---|---|
| Stimmen auflisten | GET | /v1/voice/list |
Nach Sprache filtern: GET /v1/voice/list?language=de
Abonnement
| Aktion | Methode | Endpoint |
|---|---|---|
| Abonnement-Details | GET | /v1/subscription |
| Auto-Top-up konfigurieren | PATCH | /v1/subscription/auto-top-up |
| Top-up-Betrag festlegen | PATCH | /v1/subscription/top-up-amount |
Kunden
| Aktion | Methode | Endpoint |
|---|---|---|
| Kunden auflisten | GET | /v1/customer/list |
| Kundendetails | GET | /v1/customer/:id |
| Kunde erstellen | POST | /v1/customer |
| Kunde aktualisieren | PATCH | /v1/customer/:id |
| Kunde löschen | DELETE | /v1/customer/:id |
Workspaces
| Aktion | Methode | Endpoint |
|---|---|---|
| Workspace-Operationen | GET/POST/PATCH/DELETE | /v1/workspaces/* |
| Mitglied einladen | POST | /v1/workspaces/:id/invite-member |
| Mitglied entfernen | DELETE | /v1/workspaces/:id/invite-member |
Was nicht über die API verfügbar ist
Einige Operationen sind nur über das Dashboard verfügbar:
| Feature | Grund |
|---|---|
| API-Key-Verwaltung | Sicherheit — Keys können keine weiteren Keys erstellen |
| Telefonnummern-Einrichtung | Erfordert interaktive Einrichtung |
| Google-Calendar-Integration | Erfordert interaktive Autorisierung |
| Abrechnung & Zahlungen | Über das Dashboard verwaltet |
Brauchen Sie Hilfe?
Kontaktieren Sie unser Support-Team unter support@hanc.ai für API-bezogene Fragen.