IntraCord integrációs API

Az integrációs API-val saját backendjéből kérheti le az ügyintézőket és a beszélgetések eredményét. Ez a kiadás önálló verzióval rendelkező, lekérdezésre szolgáló v2 felületet vezet be. Használatához telepítse a hozzá tartozó backendet és átjárót; a dokumentáció frissítése önmagában nem teszi elérhetővé a v2-t régebbi telepítésen.

Csatlakozzon a telepítéséhez

A szolgáltatott átjáró címe https://app.intracord.hu/api/v2. Saját telepítésnél a hostnevet cserélje a publikus alkalmazásátjáró címére. A docs.intracord.hu dokumentációt szolgál ki, API-kéréseket nem fogad.

Hozzon létre alkalmazás-API-kulcsot a Developers oldalon, és tárolja saját szerverén. Az új kulcsok itc_ prefixet kapnak; a meglévők visszavonásig tovább működnek.

curl --fail-with-body 'https://app.intracord.hu/api/v2/agents?page=1&page_size=20' \
  -H "X-API-Key: $INTRACORD_API_KEY"

Először állítsa be az INTRACORD_API_KEY környezeti változót a szerverén. A kérés kizárólag a kulcs szervezetének ügyintézőit listázza. A sikeres listaválasz data és pagination mezőt tartalmaz; utóbbiban a page, page_size és total érték található. Az oldalméret 1 és 100 közötti lehet.

Kérje le az eredményt

Listázza egy ügyintéző beszélgetéseit, majd a numerikus azonosítóval kérje le az adott beszélgetést. A v2 az induló adatokat input, a begyűjtött értékeket result néven adja vissza. A completed a befejezést jelzi, önmagában nem minősíti sikeresnek az ügyintézést. A channel a telepítés által rögzített futtatási módot, a direction a hívás irányát tartalmazza.

Metódus és útvonal az /api/v2 alatt	Feladat
GET /agents	Ügyintézők listázása
GET /agents/{agent_id}	Ügyintéző adatainak lekérése
GET /agents/{agent_id}/conversations	Beszélgetéseinek lapozható listája
GET /conversations/{conversation_id}	Induló adatok és eredmények lekérése
GET /status	A folyamat elérhetősége, szolgáltatói és adatbázis-ellenőrzés nélkül

A v2 meghatározott mezőket ad vissza; a belső naplók, szolgáltatói hitelesítő adatok és publikus felvételtokenek nem részei ennek a szerződésnek. A beszélgetés bemenetébe és eredményébe elhelyezett adatok továbbra is elérhetők a jogosult klienseknek.

Használja a meglévő írási műveleteket

Az ügyintézőszerkesztés, a hívásindítás, a kampánykezelés és a szolgáltatói callbackek továbbra is a dokumentált v1 műveleteken működnek. A meglévő klienskönyvtárak szintén v1-et használnak. Ne módosítson v1-kérést vagy callback URL-t pusztán a verziószám átírásával. A v1-ben a workflow_definition, initial_context és gathered_context változatlan, pontos mezőnév.

A futó v2 sémáját az /api/v2/openapi.json címen találja. A további részleteket a hitelesítés, a hibakezelés és az útmutató alatti referencialapok tartalmazzák.