ઇવેન્ટ્સ કેટલોગ

દરેક webhook body માં type ફીલ્ડ હોય છે, જેનું મૂલ્ય આ પેજ પરના ઇવેન્ટ પ્રકારોમાંનું એક હોય છે. જ્યારે તમે કોઈ endpoint ને સબ્સ્ક્રાઇબ કરો છો, ત્યારે events array માં તમને જોઈતા ઇવેન્ટ પ્રકારો હોવા જોઈએ (અથવા દરેક વસ્તુને સબ્સ્ક્રાઇબ કરવા માટે તે ખાલી હોવું જોઈએ).

બે ડિલિવરી શૈલીઓ આ ઇવેન્ટ્સ પહોંચાડે છે:

• Endpoint ડિલિવરીઓ હંમેશા non-blocking સૂચનાઓ હોય છે પુનઃપ્રયાસો સાથે: કોઈપણ 2xx વડે પ્રતિસાદ આપો; envelope માં ડિડુપ્લિકેશન માટે event_id હોય છે.
• Blocking એક્સચેન્જ માત્ર legacy single-URL webhook પર ચાલે છે: telephony.incoming / web.incoming કૉન્ફિગરેશન વિનંતી (webhook-mode નંબરો અને widget keys, 10 s timeout) અને webhook-mode tool dispatch. તમારો પ્રતિસાદ લાઇવ કૉલને આકાર આપે છે.

નીચેના ઉદાહરણ payloads endpoint envelope ને તેના wire order માં દર્શાવે છે (keys ને મૂળાક્ષરક્રમમાં ગોઠવવામાં આવ્યા છે: data, event_id, type); legacy ડિલિવરીઓમાં event_id વિના સમાન data હોય છે.

કૉલ ઇવેન્ટ્સ

telephony.incoming

જ્યારે ઇનબાઉન્ડ કૉલ તમારા કોઈ એક ફોન નંબર સુધી પહોંચે ત્યારે મોકલવામાં આવે છે. Endpoint ડિલિવરીઓ દરેક ઇનબાઉન્ડ કૉલ માટે મોકલાતી ફાયર-એન્ડ-ફર્ગેટ સૂચનાઓ છે, પછી ભલે નંબર એજન્ટ-કન્ફિગર કરેલો હોય કે webhook-કન્ફિગર કરેલો હોય. સોંપાયેલ એજન્ટ વિનાના નંબરોને લેગસી webhook પર વધારાની બ્લોકિંગ કન્ફિગરેશન વિનંતી મળે છે — સંપૂર્ણ વિનંતી / પ્રતિસાદ schema માટે 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

જ્યારે ઇનબાઉન્ડ અથવા આઉટબાઉન્ડ ટેલિફોની કૉલ સમાપ્ત થાય ત્યારે મોકલવામાં આવે છે. નોન-બ્લોકિંગ. ટ્રાન્સક્રિપ્ટ, ઉપલબ્ધ હોય ત્યારે રેકોર્ડિંગ URL અને બિલિંગ સારાંશ શામેલ છે. payload schema માટે telephony.complete / web.complete જુઓ.

telephony.tool

ટેલિફોની કૉલ દ્વારા ફંક્શન ટૂલ ચલાવવામાં આવ્યા પછી મોકલવામાં આવે છે. નોન-બ્લોકિંગ ઑડિટ સૂચના — આ ઇવેન્ટ ડિલિવર થાય ત્યાં સુધીમાં ટૂલ પહેલેથી એક્ઝિક્યુટ થઈ ચૂકેલું હોય છે; તે તમારા પોતાના ફંક્શન ટૂલ્સને આવરી લે છે (બિલ્ટ-ઇન, નોલેજ-બેઝ, એપ-કનેક્શન અથવા MCP ટૂલ્સને નહીં).

{
  "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 એ એક્ઝિક્યુટ થયેલ પરિણામ છે: સફળતા પર {"status": <http status>, "response": <your endpoint's JSON>}, અથવા નિષ્ફળતા પર {"status": <status>, "error": "<message>"}.

web.incoming

telephony.incoming નો વેબ-ચેનલ સમકક્ષ, જે ત્યારે મોકલવામાં આવે છે જ્યારે વેબ વિજેટ સત્ર અથવા બિલ્ડર માઇક ટેસ્ટ કૉલ શરૂ થાય. Endpoint ડિલિવરીઓ દરેક વેબ સત્ર માટે ફાયર-એન્ડ-ફર્ગેટ હોય છે. mode="webhook" માંની પ્રકાશિત કરી શકાય તેવી કીઓને લેગસી webhook પર વધારાની બ્લોકિંગ કન્ફિગરેશન વિનંતી મળે છે — તે બ્લોકિંગ વિનંતીનો આકાર અલગ હોય છે (origin_domain, publishable_key_prefix; ફોન નંબરો નથી). 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 હંમેશા શાબ્દિક "web" હોય છે. webhook-મોડ વિજેટ સત્રો માટે to_number ખાલી હોય છે (કન્ફિગરેશન પછી સત્રનો એજન્ટ નંબર સોંપવામાં આવે છે); બિલ્ડર માઇક ટેસ્ટ કૉલ માટે origin_domain અને publishable_key_prefix ખાલી હોય છે.

web.complete

telephony.complete નો વેબ-ચેનલ સમકક્ષ, જે વેબ વિજેટ કૉલ્સ (direction: "web") અને બિલ્ડર માઇક ટેસ્ટ કૉલ્સને (direction: "test") આવરી લે છે. નોન-બ્લોકિંગ. telephony.complete જેવો જ payload આકાર, ઉપરાંત origin_domain, અને from_number ને "web" પર સેટ કરેલ હોય છે.

web.tool

telephony.tool નો વેબ-ચેનલ સમકક્ષ. data માં from_number / to_number ને બદલે origin_domain હોય છે.

વૉઇસ ઇવેન્ટ્સ

કસ્ટમ વૉઇસ બનાવવાની પ્રક્રિયા અસિંક્રોનસ છે. આ નૉન-બ્લૉકિંગ ઇવેન્ટ્સ તમને પોલિંગ કરવાને બદલે ક્લોન વિગત એન્ડપૉઇન્ટના અંતિમ પરિણામ પર પ્રતિસાદ આપવા દે છે.

voice.ready

કસ્ટમ વૉઇસની પ્રક્રિયા પૂર્ણ થાય અને તેને એજન્ટને અસાઇન કરી શકાય ત્યારે મોકલવામાં આવે છે.

{
  "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

કસ્ટમ વૉઇસની પ્રક્રિયા કાયમી નિષ્ફળતા પર પહોંચે ત્યારે મોકલવામાં આવે છે.

{
  "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"
}

ગુણવત્તા ઇવેન્ટ્સ

call.graded

કૉલ માટે AI ગ્રેડિંગ રન પૂર્ણ થાય ત્યારે મોકલવામાં આવે છે. અવરોધરહિત.

{
  "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

જ્યારે સમસ્યા રિપોર્ટ બનાવવામાં આવે ત્યારે મોકલવામાં આવે છે — કાં તો ડેશબોર્ડમાંથી વપરાશકર્તા દ્વારા નોંધાવવામાં આવે છે (source: "user") અથવા કૉલ ગ્રેડિંગ દ્વારા આપમેળે બનાવવામાં આવે છે (source: "system"). અવરોધરહિત.

{
  "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"
}

ટેસ્ટ કૉલ ઇવેન્ટ્સ

test-call.completed

જ્યારે ટેસ્ટ-કૉલ રન અંતિમ સ્થિતિ — completed અથવા failed — સુધી પહોંચે ત્યારે મોકલવામાં આવે છે, જેમાં લોન્ચ વખતે નિષ્ફળ થયેલા અને ક્યારેય કૉલ ન બનાવનારા રનનો પણ સમાવેશ થાય છે. અવરોધરહિત. તમારી ચેટ/સૂચના સિસ્ટમ્સમાં બેચ CI રનને જોડવા માટે ઉપયોગી.

{
  "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"
}

ચેતવણી ઇવેન્ટ્સ

alert.triggered

ડેવલપર વેબહુક્સને મોકલો ચેનલ સક્રિય ધરાવતો ચેતવણી નિયમ તેની મર્યાદા પાર કરે ત્યારે મોકલવામાં આવે છે. બ્લોક કરતું નથી. નિયમ એકવાર ટ્રિગર થાય છે અને પછી તેના કૂલડાઉનનું પાલન કરે છે, તેથી સતત ઉલ્લંઘન દરેક કૂલડાઉન વિન્ડો દીઠ એક ઇવેન્ટ બનાવે છે.

{
  "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"
}

નિયમો, મેટ્રિક્સ, કૂલડાઉન્સ અને ઈમેઇલ / Slack ચેનલો બનાવવા માટે ચેતવણીઓ માર્ગદર્શિકા જુઓ.

સંબંધિત