Sündmuste kataloog

Igal webhooki sisul on väli type, mille väärtus on üks selle lehe sündmustüüpidest. Kui tellid lõpp-punkti, peab massiiv events sisaldama soovitud sündmustüüpe (või olema tühi, et tellida kõik sündmused).

Neid sündmusi edastatakse kahel viisil:

• Lõpp-punkti edastused on alati mitteblokeerivad teavitused koos korduskatsetega: vasta mis tahes 2xx-koodiga; ümbrik sisaldab duplikaatide eemaldamiseks välja event_id.
• Blokeerivad vahetused toimuvad ainult pärandatud ühe URL-iga webhookis: telephony.incoming / web.incoming konfiguratsioonipäring (webhooki režiimis numbrid ja vidinaklahvid, 10 s ajalimiit) ning webhooki režiimis tööriista väljakutse. Sinu vastus kujundab reaalajas kõnet.

Allolevad näidiskoormused näitavad lõpp-punkti ümbrikku selle edastusjärjekorras (võtmed on sorditud tähestikulises järjekorras: data, event_id, type); pärandedastused sisaldavad sama data-t ilma väljata event_id.

Kõnesündmused

telephony.incoming

Saadetakse, kui sissetulev kõne jõuab ühele sinu telefoninumbritest. Lõpp-punkti edastused on tule-ja-unusta teavitused, mis saadetakse iga sissetuleva kõne korral, olenemata sellest, kas number on häälagendi või webhooki jaoks seadistatud. Numbrid, millele pole häälagenti määratud, saavad lisaks pärandwebhookis blokeeriva seadistustaotluse — täieliku taotluse/vastuse skeemi vaata telephony.incoming / web.incoming.

{
  "data": {
    "call_id": 987654321,
    "from_number": "+14155550199",
    "to_number": "+15551234567"
  },
  "event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
  "type": "telephony.incoming"
}

telephony.complete

Saadetakse, kui sissetulev või väljaminev telefonikõne lõpeb. Mitteblokeeriv. Sisaldab transkriptsiooni, salvestise URL-i, kui see on saadaval, ja arvelduse kokkuvõtet. Kasuliku koormuse skeemi vaata telephony.complete / web.complete.

telephony.tool

Saadetakse pärast seda, kui telefonikõne käivitab funktsioonitööriista. Mitteblokeeriv auditeerimisteavitus — tööriist on selle sündmuse edastamise ajaks juba käivitatud; see hõlmab sinu enda funktsioonitööriistu, mitte sisseehitatud, teadmistebaasi, rakenduseühenduse ega MCP tööriistu.

{
  "data": {
    "arguments": { "date": "2026-04-21" },
    "call_id": 987654321,
    "from_number": "+14155550199",
    "response": {
      "response": { "available_slots": ["9:00 AM", "2:00 PM"] },
      "status": 200
    },
    "to_number": "+15551234567",
    "tool_name": "search_appointments"
  },
  "event_id": "1f0a7c3e-52d4-4a0e-8f4b-b1a6a1c0d9e2",
  "type": "telephony.tool"
}

response on käivitatud tulemus: õnnestumisel {"status": <http status>, "response": <your endpoint's JSON>} või ebaõnnestumisel {"status": <status>, "error": "<message>"}.

web.incoming

telephony.incoming veebikanali vaste, mis saadetakse, kui veebividina seanss või koostaja mikrofoni testkõne algab. Lõpp-punkti edastused on tule-ja-unusta teavitused iga veebiseansi korral. Avaldatavad võtmed režiimis mode="webhook" saavad lisaks pärandwebhookis blokeeriva seadistustaotluse — selle blokeeriva taotluse kuju on erinev (origin_domain, publishable_key_prefix; telefoninumbreid pole). Vaata telephony.incoming / web.incoming.

{
  "data": {
    "call_id": 987654322,
    "from_number": "web",
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2",
    "to_number": "+15551234567"
  },
  "event_id": "9a2b4c6d-8e0f-4a1b-9c2d-3e4f5a6b7c8d",
  "type": "web.incoming"
}

from_number on alati sõneliteral "web". Webhooki režiimis veebividina seansside puhul on to_number tühi (seansi häälagendi number määratakse pärast seadistamist); koostaja mikrofoni testkõnede puhul on origin_domain ja publishable_key_prefix tühjad.

web.complete

telephony.complete veebikanali vaste, mis hõlmab veebividina kõnesid (direction: "web") ja koostaja mikrofoni testkõnesid (direction: "test"). Mitteblokeeriv. Kasuliku koormuse kuju on sama mis telephony.complete puhul, lisaks origin_domain, kusjuures from_number väärtuseks on "web".

web.tool

telephony.tool veebikanali vaste. data sisaldab välja from_number / to_number asemel origin_domain.

Häälesündmused

Kohandatud hääle loomine on asünkroonne. Need mitteblokeerivad sündmused võimaldavad sul reageerida lõpptulemusele, selle asemel et küsitleda pidevalt klooni üksikasjade lõpp-punkti.

voice.ready

Saadetakse, kui kohandatud hääle töötlemine on lõpetatud ja hääle saab määrata agendile.

{
  "data": {
    "voice": {
      "created_at": "2026-07-30T14:12:08.317Z",
      "display_name": "Support voice",
      "failure_reason": "",
      "gender": "female",
      "id": "cv_2f6f90b0e9a34ee8b39be7d1",
      "language": "en",
      "name": "custom:cv_2f6f90b0e9a34ee8b39be7d1",
      "status": "ready",
      "updated_at": "2026-07-30T14:13:31.605Z"
    }
  },
  "event_id": "2d5f0a61-e9b5-4a3c-b684-29d7d9e4b214",
  "type": "voice.ready"
}

voice.failed

Saadetakse, kui kohandatud hääle töötlemine ebaõnnestub jäädavalt.

{
  "data": {
    "reason": "audio sample could not be processed",
    "voice": {
      "created_at": "2026-07-30T14:12:08.317Z",
      "display_name": "Support voice",
      "failure_reason": "audio sample could not be processed",
      "gender": "female",
      "id": "cv_2f6f90b0e9a34ee8b39be7d1",
      "language": "en",
      "name": "custom:cv_2f6f90b0e9a34ee8b39be7d1",
      "status": "failed",
      "updated_at": "2026-07-30T14:13:31.605Z"
    }
  },
  "event_id": "3493e985-1a75-4f77-a10a-e74af440cd31",
  "type": "voice.failed"
}

Kvaliteedisündmused

call.graded

Saadetakse alati, kui kõne tehisintellektipõhine hindamine on lõpule viidud. Ei blokeeri.

{
  "data": {
    "call_id": 987654321,
    "grade": {
      "call_outcome": "success",
      "created_at": "2026-04-20T18:25:11.002Z",
      "detected_issues": [],
      "graded_at": "2026-04-20T18:25:11.002Z",
      "grader_model": "heuristic-v1",
      "id": 5512,
      "score": 92,
      "status": "completed",
      "summary": "Caller asked about their policy and got a full answer…"
    }
  },
  "event_id": "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
  "type": "call.graded"
}

issue.reported

Saadetakse, kui luuakse probleemiaruanne — kasutaja esitab selle juhtpaneelilt (source: "user") või see luuakse automaatselt kõne hindamise käigus (source: "system"). Ei blokeeri.

{
  "data": {
    "call_id": 987654321,
    "issue_report": {
      "created_at": "2026-04-20T18:25:11.002Z",
      "description": "Five-second silence before responding to the main question.",
      "id": 4321,
      "severity": "warning",
      "source": "system",
      "status": "open",
      "title": "Agent paused too long"
    }
  },
  "event_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "type": "issue.reported"
}

Testkõnede sündmused

test-call.completed

Saadetakse, kui testkõne käivitus jõuab lõppolekusse — completed või failed, sealhulgas käivitused, mis ebaõnnestusid alustamisel ega loonud kunagi kõnet. Ei blokeeri. Kasulik partii-CI käivituste ühendamiseks sinu vestlus- ja teavitussüsteemidega.

{
  "data": {
    "test_call_run": {
      "call_id": 987654321,
      "completed_at": "2026-04-20T18:25:04.822Z",
      "error_message": "",
      "id": 7110,
      "status": "completed",
      "target_id": 12,
      "target_type": "agent"
    }
  },
  "event_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
  "type": "test-call.completed"
}

Hoiatuste sündmused

alert.triggered

Saadetakse, kui hoiatusreegel, mille kanal Edasta arendaja veebikonksudesse on lubatud, ületab oma lävendi. Mitteblokeeriv. Reegel käivitub üks kord ja järgib seejärel oma ooteaega, seega põhjustab püsiv rikkumine ühe sündmuse iga ooteaja akna kohta.

{
  "data": {
    "comparator": "lt",
    "event_id": "b8e6a1d4-2c3f-4a5b-9c8d-7e6f5a4b3c2d",
    "fired_at": "2026-04-20T18:00:00+00:00",
    "metric": "success_rate",
    "metric_value": 71.4,
    "rule_id": "d2c3b4a5-6f7e-4d8c-9b0a-1c2d3e4f5a6b",
    "rule_name": "Success rate below 80%",
    "threshold": 80.0,
    "window_hours": 24
  },
  "event_id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
  "type": "alert.triggered"
}

Reeglite, mõõdikute, ooteaegade ning e-posti- ja Slacki kanalite loomise kohta vaata hoiatuste juhendit.

Seotud