Ugrás a fő tartalomhoz

API Trigger

Az API Trigger Node lehetővé teszi, hogy programozottan kezdeményezzen kimenő hívásokat a Voice Agenthez. Amikor hozzáad egy API Trigger Node-ot a workflow-hoz, az IntraCord létrehoz egy egyedi endpoint URL-t, amelyet a külső rendszerek meghívhatnak a beszélgetés elindításához.

Ez akkor hasznos, ha saját háttérrendszeréből, CRM-ből vagy olyan workflow Toolokból szeretne hívásokat indítani, mint az n8n és a Zapier.

Előfeltételek​

Az aktiválási URL megkeresése​

Amikor hozzáad egy API Trigger Node-ot a workflow-hoz, az IntraCord egyedi UUID-t rendel hozzá. A trigger Node két olyan URL-t tesz közzé, amelyek megosztják ezt az UUID-t:

  • A közzétett workflow gyártási URL-je
  • Egy teszt URL a legújabb piszkozathoz

Bármelyik URL-címet kimásolhatja a trigger Node beállítási párbeszédpaneljéről.

POST https://your-IntraCord-instance/api/v1/public/agent/{uuid}        # Production
POST https://your-IntraCord-instance/api/v1/public/agent/test/{uuid}   # Test

Ha a hosztolt verziót használja, cserélje ki a your-IntraCord-instance-t a api.IntraCord.com-re.

Teszt vs gyártás​

módURLFut
Termelés/api/v1/public/agent/{uuid}Az ügynök közzétett verziója.
Teszt/api/v1/public/agent/test/{uuid}A legújabb tervezet. Ha nem létezik vázlat, visszaáll a közzétett verzióra.

Használja a teszt URL-t a módosítások iterációja közben, hogy az éles forgalom továbbra is elérje a közzétett verziót.

Az éles URL csak egy közzétett workflow-t hajt végre. Ha frissíti a workflow-t, de nem teszi közzé, az éles eseményindító továbbra is a régebbi közzétett verziót futtatja.

A piszkozat közzététele után mindkét URL ugyanazt a definíciót futtatja.

A kérés törzse, a fejlécek és a válasz alakja mindkét URL esetében azonos.

Kérés megfogalmazása​

Hitelesítéshez adja át API-kulcsát a X-API-Key fejlécben. A kérelem törzséhez phone_number szükséges, és elfogadja az opcionális initial_context és telephony_configuration_id mezőket.

curl -X POST https://your-IntraCord-instance/api/v1/public/agent/{uuid} \
  -H "Content-Type: application/json" \
  -H "X-API-Key: dg_your_api_key" \
  -d '{
    "phone_number": "+14155550100",
    "initial_context": {
      "customer_name": "Jane",
      "appointment_date": "March 15"
    }
  }'
curl -X POST https://your-IntraCord-instance/api/v1/public/agent/test/{uuid} \
  -H "Content-Type: application/json" \
  -H "X-API-Key: dg_your_api_key" \
  -d '{
    "phone_number": "+14155550100",
    "initial_context": {
      "customer_name": "Jane",
      "appointment_date": "March 15"
    }
  }'

Használja a teszt URL-t, ha a közzététel előtt ellenőrizni szeretné a módosítástervezeteket.

Válasz​

A sikeres kérés egy workflow_run_id értéket ad vissza, amellyel lekérheti a Workflow Run részleteit, felvételeit és átiratát.

{
  "status": "initiated",
  "workflow_run_id": 12345,
  "workflow_run_name": "WR-API-7823"
}

Hibaválaszok​

ÁllapotOk
400A telefonszolgáltató nincs konfigurálva, vagy a hívás kezdeményezése nem sikerült
401Hiányzó vagy érvénytelen API-kulcs
403Az API-kulcs nem fér hozzá ehhez az ügynökhöz
404A trigger nem található vagy nem aktív

Kezdeti kontextus​

A initial_context egy JSON-objektum, amely minden olyan információt tartalmaz, amelyhez hozzá szeretne férni a Voice Agentnek a hívás során. Ezekre az értékekre a promptokban hivatkozhat a sablonváltozók használatával – a {{ és }} mezőkben található értékek.

Például, ha kérése a következőket tartalmazza:

{
    "phone_number": "+14155550100",
    "initial_context": {
        "user": {
            "name": "John"
        }
    }
}

Az Agent Promptban {{user.name}} formában hivatkozhat a felhasználó nevére. Az initial_context mezői közvetlenül, az initial_context. előtag nélkül érhetők el. A promptokban és webhook payloadokban használható pontos szintaxist a Sablonváltozók oldal mutatja be.

Tekintse meg a Kontextus és változók részt, ha többet szeretne megtudni arról, hogyan áramlik át az adatok egy híváson keresztül.

Telefóniai beállítás kiválasztása​

Alapértelmezés szerint a hívások a szervezet alapértelmezett kimenő telefóniai beállításában keresztül történnek. Egy adott hívás másik konfiguráción keresztül történő átirányításához – például regionális számról történő tárcsázáshoz – adja meg a telephony_configuration_id jelet a kérés törzsében.

{
  "phone_number": "+14155550100",
  "telephony_configuration_id": 42
}

Az azonosító a Telefónia beállításai minden sorában megjelenik (https://app.IntraCord.com/telephony-configurations a hosztolt vagy http://localhost:3010/telephony-configurations helyi esetén). A konfigurációnak ugyanahhoz a szervezethez kell tartoznia, mint az API Trigger; ellenkező esetben a kérés a következőt adja vissza: 404.