Ugrás a fő tartalomhoz

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 URLhttps://api.hanc.ai
HitelesítésAPI-kulcs az x-api-key fejlécen keresztül
FormátumJSON

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űveletMetódusVégpont
Hívások listázásaGET/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 analitikaGET/v1/call/daily-metrics
Hangulati statisztikákGET/v1/call/sentiment-stats
KöltséglebontásGET/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ásaPOST/v1/call/make-phone-call
Webhívás indításaPOST/v1/call/make-web-call

Ügynökök

MűveletMetódusVégpont
Ügynökök listázásaGET/v1/agent/list
Ügynök részleteiGET/v1/agent/:id
Ügynök létrehozásaPOST/v1/agent
Ügynök frissítésePATCH/v1/agent/:id
Ügynök törléseDELETE/v1/agent/:id
Ügynök hívásstatisztikáiGET/v1/agent/:id/call-stats
Ügynök sablonok listázásaGET/v1/agent/agent_template/list

Ügynöki műveletek:

MűveletMetódusVégpont
Műveletek listázásaGET/v1/agent/:id/actions
Művelet hozzáadásaPOST/v1/agent/:id/actions
Művelet frissítésePATCH/v1/agent/:id/actions/:actionId
Művelet törléseDELETE/v1/agent/:id/actions/:actionId

Ügynöki eszközök:

MűveletMetódusVégpont
Eszközök listázásaGET/v1/agent/:id/tools
Eszköz hozzáadásaPOST/v1/agent/:id/tools
Eszköz frissítésePATCH/v1/agent/:id/tools/:toolId
Eszköz törléseDELETE/v1/agent/:id/tools/:toolId

Tudásbázis

MűveletMetódusVégpont
Tudásbázisok listázásaGET/v1/knowledge-base/list
Tudásbázis létrehozásaPOST/v1/knowledge-base
Fájl(ok) feltöltésePOST/v1/knowledge-base/:id/file(s)
Fájl törléseDELETE/v1/knowledge-base/:id/file
Ügynökök hozzárendelésePUT/v1/knowledge-base/:id/agents

Telefonszámok

MűveletMetódusVégpont
Számok listázásaGET/v1/phone-number/list
Elérhető számok (országonként)GET/v1/phone-number/available
Szám vásárlásaPOST/v1/phone-number/buy
Szám importálásaPOST/v1/phone-number/import
Csatlakoztatás SIP-hezPATCH/v1/phone-number/connect-to-sip

Hangok

MűveletMetódusVégpont
Hangok listázásaGET/v1/voice/list

Szűrés nyelv szerint: GET /v1/voice/list?language=de

Előfizetés

MűveletMetódusVégpont
Előfizetés részleteiGET/v1/subscription
Automatikus feltöltés konfigurálásaPATCH/v1/subscription/auto-top-up
Feltöltési összeg beállításaPATCH/v1/subscription/top-up-amount

Ügyfelek

MűveletMetódusVégpont
Ügyfelek listázásaGET/v1/customer/list
Ügyfél részleteiGET/v1/customer/:id
Ügyfél létrehozásaPOST/v1/customer
Ügyfél frissítésePATCH/v1/customer/:id
Ügyfél törléseDELETE/v1/customer/:id

Munkaterületek

MűveletMetódusVégpont
Munkaterület-műveletekGET/POST/PATCH/DELETE/v1/workspaces/*
Tag meghívásaPOST/v1/workspaces/:id/invite-member
Tag eltávolításaDELETE/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éseBiztonság — a kulcsok nem hozhatnak létre más kulcsokat
Telefonszám beállításaInteraktív beállítást igényel
Google Calendar integrációInteraktív engedélyezést igényel
Számlázás és fizetésekAz 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.