API-referencia
Teljes API-dokumentáció a Hanc.AI alkalmazásaiba történő integrálásához. Kezelhet ügynököket, lekérdezhet híváseseti adatokat, indíthat hívásokat és működtetheti programszerűen a platform minden részét.
Gyors áttekintés
| Alap URL | https://api.hanc.ai |
| Hitelesítés | API-kulcs az x-api-key fejlécen keresztül |
| Formátum | JSON |
Generáljon API-kulcsot az Integráció → API-kulcsok menüpontban az irányítópulton. Felhasználónként legfeljebb 3 kulcsot birtokolhat — lásd az API-kulcsok szakaszt az Integrációkban a beállítási, jogosultsági és biztonsági útmutatókért.
curl -X GET "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"
Elérhető végpontok
Hívások
| Művelet | Metódus | Végpont |
|---|---|---|
| Hívások listázása | GET | /v1/call/list |
| Hívás részletei (átirat, hangulat, összefoglaló) | GET | /v1/call/:id |
| Általános analitika (mérőszámok dátum/ügynök szerint) | GET | /v1/call/general-metrics |
| Napi analitika | GET | /v1/call/daily-metrics |
| Hangulati statisztikák | GET | /v1/call/sentiment-stats |
| Költséglebontás | GET | /v1/call/costs-breakdown |
| Hívások exportálása (CSV) | GET | /v1/call/list/export |
| Költségek exportálása (CSV) | GET | /v1/call/costs-breakdown/export |
| Telefonhívás indítása | POST | /v1/call/make-phone-call |
| Webhívás indítása | POST | /v1/call/make-web-call |
Ügynökök
| Művelet | Metódus | Végpont |
|---|---|---|
| Ügynökök listázása | GET | /v1/agent/list |
| Ügynök részletei | GET | /v1/agent/:id |
| Ügynök létrehozása | POST | /v1/agent |
| Ügynök frissítése | PATCH | /v1/agent/:id |
| Ügynök törlése | DELETE | /v1/agent/:id |
| Ügynök hívásstatisztikái | GET | /v1/agent/:id/call-stats |
| Ügynök sablonok listázása | GET | /v1/agent/agent_template/list |
Ügynöki műveletek:
| Művelet | Metódus | Végpont |
|---|---|---|
| Műveletek listázása | GET | /v1/agent/:id/actions |
| Művelet hozzáadása | POST | /v1/agent/:id/actions |
| Művelet frissítése | PATCH | /v1/agent/:id/actions/:actionId |
| Művelet törlése | DELETE | /v1/agent/:id/actions/:actionId |
Ügynöki eszközök:
| Művelet | Metódus | Végpont |
|---|---|---|
| Eszközök listázása | GET | /v1/agent/:id/tools |
| Eszköz hozzáadása | POST | /v1/agent/:id/tools |
| Eszköz frissítése | PATCH | /v1/agent/:id/tools/:toolId |
| Eszköz törlése | DELETE | /v1/agent/:id/tools/:toolId |
Tudásbázis
| Művelet | Metódus | Végpont |
|---|---|---|
| Tudásbázisok listázása | GET | /v1/knowledge-base/list |
| Tudásbázis létrehozása | POST | /v1/knowledge-base |
| Fájl(ok) feltöltése | POST | /v1/knowledge-base/:id/file(s) |
| Fájl törlése | DELETE | /v1/knowledge-base/:id/file |
| Ügynökök hozzárendelése | PUT | /v1/knowledge-base/:id/agents |
Telefonszámok
| Művelet | Metódus | Végpont |
|---|---|---|
| Számok listázása | GET | /v1/phone-number/list |
| Elérhető számok (országonként) | GET | /v1/phone-number/available |
| Szám vásárlása | POST | /v1/phone-number/buy |
| Szám importálása | POST | /v1/phone-number/import |
| Csatlakoztatás SIP-hez | PATCH | /v1/phone-number/connect-to-sip |
Hangok
| Művelet | Metódus | Végpont |
|---|---|---|
| Hangok listázása | GET | /v1/voice/list |
Szűrés nyelv szerint: GET /v1/voice/list?language=de
Előfizetés
| Művelet | Metódus | Végpont |
|---|---|---|
| Előfizetés részletei | GET | /v1/subscription |
| Automatikus feltöltés konfigurálása | PATCH | /v1/subscription/auto-top-up |
| Feltöltési összeg beállítása | PATCH | /v1/subscription/top-up-amount |
Ügyfelek
| Művelet | Metódus | Végpont |
|---|---|---|
| Ügyfelek listázása | GET | /v1/customer/list |
| Ügyfél részletei | GET | /v1/customer/:id |
| Ügyfél létrehozása | POST | /v1/customer |
| Ügyfél frissítése | PATCH | /v1/customer/:id |
| Ügyfél törlése | DELETE | /v1/customer/:id |
Munkaterületek
| Művelet | Metódus | Végpont |
|---|---|---|
| Munkaterület-műveletek | GET/POST/PATCH/DELETE | /v1/workspaces/* |
| Tag meghívása | POST | /v1/workspaces/:id/invite-member |
| Tag eltávolítása | DELETE | /v1/workspaces/:id/invite-member |
Mi nem érhető el API-n keresztül
Néhány művelet csak az irányítópulton keresztül érhető el:
| Funkció | Ok |
|---|---|
| API-kulcsok kezelése | Biztonság — a kulcsok nem hozhatnak létre más kulcsokat |
| Telefonszám beállítása | Interaktív beállítást igényel |
| Google Calendar integráció | Interaktív engedélyezést igényel |
| Számlázás és fizetések | Az irányítópulton keresztül kezelve |
Segítségre van szüksége?
Vegye fel a kapcsolatot támogatási csapatunkkal a support@hanc.ai címen API-val kapcsolatos kérdéseihez.