ThunderPhone v3 اب لائیو ہے۔سیلف سرو، قیمت 2¢ فی منٹ سے شروع۔اعلان پڑھیں

Webhooks

ایونٹس کی فہرست

وہ تمام ویب ہُک ایونٹ اقسام جو ThunderPhone بھیجتا ہے۔

ہر webhook باڈی میں ایک type فیلڈ ہوتا ہے جس کی قدر اس صفحے پر موجود ایونٹ اقسام میں سے ایک ہوتی ہے۔ جب آپ کسی اینڈپوائنٹ کو سبسکرائب کرتے ہیں، تو events ارے میں وہ ایونٹ اقسام شامل ہونی چاہئیں جو آپ چاہتے ہیں (یا ہر چیز کو سبسکرائب کرنے کے لیے خالی ہو — سوائے فی ٹرن ایونٹس telephony.turn / web.turn اور لائیو پیش رفت ایونٹ call.status_changed کے، جو صرف ان اینڈپوائنٹس کو بھیجے جاتے ہیں جو انہیں واضح طور پر نامزد کرتے ہیں)۔

یہ ایونٹس دو ڈیلیوری طرزوں کے ذریعے منتقل ہوتے ہیں:

  • اینڈ پوائنٹ ڈیلیوریز ہمیشہ دوبارہ کوششوں کے ساتھ غیر بلاکنگ اطلاعات ہوتی ہیں: کسی بھی 2xx کے ساتھ جواب دیں؛ لفافے میں ڈی ڈپلی کیشن کے لیے event_id شامل ہوتا ہے۔
  • بلاکنگ تبادلے صرف لیگیسی سنگل-URL ویب ہک پر چلتے ہیں: telephony.incoming / web.incoming کی کنفیگریشن درخواست (ویب ہک موڈ نمبرز: ایک دوبارہ کوشش سمیت 13 سیکنڈ؛ ویب ہک موڈ ویجٹ کیز: 10 سیکنڈ) اور ویب ہک موڈ ٹول ڈسپیچ۔ آپ کا جواب لائیو کال کی صورت تشکیل دیتا ہے۔

ذیل کی مثال پے لوڈز منتقلی کی ترتیب میں اینڈپوائنٹ اینویلپ دکھاتی ہیں (کیز حروفِ تہجی کے لحاظ سے ترتیب شدہ ہیں: data، event_id، type)؛ لیگیسی ڈیلیوریز میں event_id کے بغیر وہی data شامل ہوتا ہے۔

کال ایونٹس

telephony.incoming

جب ایک آنے والی کال آپ کے کسی فون نمبر تک پہنچتی ہے تو بھیجا جاتا ہے۔ اینڈ پوائنٹ ڈیلیوریز ہر آنے والی کال کے لیے فائر اینڈ فارگیٹ اطلاعات ہوتی ہیں، چاہے نمبر ایجنٹ کے لیے ترتیب دیا گیا ہو یا ویب ہک کے لیے۔ کسی تفویض شدہ ایجنٹ کے بغیر نمبرز کو پرانے ویب ہک پر اضافی طور پر بلاکنگ کنفیگریشن درخواست موصول ہوتی ہے — مکمل درخواست / جواب اسکیما کے لیے telephony.incoming / web.incoming دیکھیں۔

{
  "data": {
    "call_id": 987654321,
    "from_number": "+14155550199",
    "to_number": "+15551234567"
  },
  "event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
  "type": "telephony.incoming"
}
فیلڈقسمتفصیل
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، جب کوئی ایجنٹ تفویض کیا گیا ہو
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، جب کوئی ایجنٹ تفویض کیا گیا ہو
returning_callobjectصرف اس صورت میں موجود ہوتا ہے جب نمبر نے گزشتہ 30 دنوں میں اس کالر کو کال کی ہو: پہلے والی کال کا call_id، agent_id، started_at اور outcome۔ واپس کالز دیکھیں
sip_headersobjectصرف اس صورت میں موجود ہوتا ہے جب کال X-* یا User-to-User SIP ہیڈرز کے ساتھ موصول ہوئی ہو (SIP ایڈریسز اور دستی SIP کنکشنز): ہیڈر کا نام لوئر کیس میں → ویلیو۔ SIP ہیڈرز دیکھیں

telephony.complete

جب آنے والی یا جانے والی ٹیلی فونی کال ختم ہوتی ہے تو بھیجا جاتا ہے۔ غیر بلاکنگ۔ اس میں ٹرانسکرپٹ، دستیاب ہونے پر ریکارڈنگ کا URL، اور بلنگ خلاصہ شامل ہوتا ہے۔ پے لوڈ اسکیما کے لیے telephony.complete / web.complete دیکھیں۔

فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا

telephony.tool

جب کوئی ٹیلی فونی کال فنکشن ٹول کو کال کرتی ہے تو اس کے بعد بھیجا جاتا ہے۔ غیر بلاکنگ آڈٹ اطلاع — یہ ایونٹ ڈیلیور ہونے تک ٹول پہلے ہی چل چکا ہوتا ہے؛ اس میں آپ کے اپنے فنکشن ٹولز اور بلٹ اِن send_sms ٹول شامل ہوتے ہیں (دیگر بلٹ اِن، نالج بیس، ایپ کنکشن، یا MCP ٹولز نہیں)۔ send_sms کے لیے، arguments.to اور arguments.body دونوں [REDACTED] ہوتے ہیں۔ تکمیلی ٹرانسکرپٹس بھی انہیں مخفی کرتے ہیں؛ جواب کے message_id کا استعمال کرتے ہوئے تنظیم کے دائرہ کار والے SMS ریسورس سے مواد اور وصول کنندہ حاصل کریں۔

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

فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا

telephony.turn

ٹیلی فونی کال جاری ہونے کے دوران، ہر گفتاری ٹرن کے وقوع پذیر ہونے پر بھیجا جاتا ہے — ایجنٹ کے بولے گئے جوابات اور کال کرنے والے کے ٹرانسکرائب شدہ ٹرنز۔ اس سے آپ سادہ ویب ہکس کے ذریعے براہ راست گفتگو کو فالو کر سکتے ہیں، بجائے اس کے کہ GET /v1/calls/{call_id}/transcript کو پول کریں۔ غیر بلاکنگ۔

{
  "data": {
    "call_id": 987654321,
    "entry_type": "completion",
    "from_number": "+14155550199",
    "position": 7,
    "role": "assistant",
    "start_ms": 15200,
    "text": "How many employees does your company have?",
    "to_number": "+15551234567"
  },
  "event_id": "8d3f5a2c-7b1e-4c9a-b6d0-2e4f6a8c0d1e",
  "type": "telephony.turn"
}
فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا
positionintegerکال ہسٹری میں ٹرن کا انڈیکس — ترتیب کے لیے ایک مستحکم شناخت
rolestringassistant (ایجنٹ کی گفتگو) یا user (کال کرنے والے کی گفتگو)
textstringاخراج کے وقت معلوم ٹرن کا ٹرانسکرپٹ متن
entry_typestringبنیادی ہسٹری اندراج کی قسم: completion (ایجنٹ)، یا user_turn / span (کال کرنے والا)
start_ms, end_msintegerکال شروع ہونے کے بعد سے ملی سیکنڈ میں آڈیو آف سیٹس؛ صرف اس وقت موجود ہوتے ہیں جب اخراج کے وقت پلے آؤٹ ٹائمنگ پہلے سے معلوم ہو

web.incoming

telephony.incoming کا ویب چینل متبادل، جو ویب وِجٹ سیشن یا بلڈر مائیک ٹیسٹ کال شروع ہونے پر بھیجا جاتا ہے۔ ہر ویب سیشن کے لیے اینڈ پوائنٹ ڈیلیوریز فائر اینڈ فارگیٹ ہوتی ہیں۔ mode="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" ہوتا ہے۔ ویب ہک موڈ وِجٹ سیشنز کے لیے to_number خالی ہوتا ہے (سیشن کا ایجنٹ نمبر کنفیگریشن کے بعد تفویض کیا جاتا ہے)؛ بلڈر مائیک ٹیسٹ کالز کے لیے origin_domain اور publishable_key_prefix خالی ہوتے ہیں۔

فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا

web.complete

telephony.complete کا ویب چینل متبادل، جس میں ویب وِجٹ کالز (direction: "web") اور بلڈر مائیک ٹیسٹ کالز (direction: "test") شامل ہیں۔ غیر بلاکنگ۔ پے لوڈ کی ساخت telephony.complete جیسی ہی ہے، اضافی origin_domain کے ساتھ، اور from_number کو "web" پر سیٹ کیا جاتا ہے۔

فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا

web.tool

telephony.tool کا ویب چینل متبادل۔ data میں from_number / to_number کے بجائے origin_domain ہوتا ہے۔

فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا

web.turn

telephony.turn کا ویب چینل متبادل، جس میں ویب وِجٹ کالز اور بلڈر مائیک ٹیسٹ کالز شامل ہیں۔ پے لوڈ کی ساخت یکساں ہے، مگر from_number / to_number کے بجائے origin_domain ہوتا ہے۔ telephony.turn کی طرح، اس کے لیے واضح سبسکرپشن درکار ہے — یہ کبھی خالی events ارے کے ذریعے ڈیلیور نہیں ہوتا۔

فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا تھا
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، اگر کوئی تفویض کیا گیا تھا

call.transfer_completed

ہر کال کے لیے ایک مرتبہ کال ٹرانسفر کے حتمی نتیجے کے ساتھ بھیجا جاتا ہے: کولڈ ٹرانسفر، یا وہ انسانی پل جو وارم ٹرانسفر میں ایجنٹ کے الگ ہونے کے بعد باقی رہتا ہے۔ یہ غیر بلاکنگ ہے اور صرف اینڈپوائنٹس پر پہنچایا جاتا ہے (پرانے سنگل-URL ویب ہک پر کبھی نہیں)۔ یہ کال کے telephony.complete کے بعد آتا ہے: جب کیریئر کال سنبھال لے یا ٹرانسفر ناکام ہو جائے، یا جب ThunderPhone نے کال کو پل کے ذریعے منسلک کیا ہو تو پل ختم ہونے کے بعد۔

{
  "data": {
    "agent_id": 12,
    "agent_name": "Front desk",
    "bridge_kind": "cold_fallback",
    "bridge_seconds": 255,
    "bridge_total_cents": 5,
    "call_id": 987654321,
    "destination": "+15555550102",
    "sip_status": 403,
    "transfer_outcome": "bridged"
  },
  "event_id": "5b0f6c1e-9d2a-5e7b-8c4d-1a2b3c4d5e6f",
  "type": "call.transfer_completed"
}
فیلڈقسموضاحت
call_idintegerوہ کال جسے منتقل کیا گیا تھا
agent_idinteger | nullوہ ایجنٹ جس نے کال سنبھالی، اگر کوئی ایجنٹ مقرر تھا
agent_namestring | nullوہ ایجنٹ جس نے کال سنبھالی، اگر کوئی ایجنٹ مقرر تھا
transfer_outcomestringrefer_accepted: کیریئر نے کال سنبھال لی۔ bridged: ThunderPhone نے کال کرنے والے اور منزل کو خود منسلک رکھا، یا تو اس لیے کہ کیریئر نے کولڈ ٹرانسفر مسترد کر دیا یا اس لیے کہ وارم ٹرانسفر کا ایجنٹ الگ ہو گیا۔ bridge_unanswered: کیریئر نے کولڈ ٹرانسفر مسترد کر دیا اور منزل نے ThunderPhone کی اپنی کال کا جواب نہیں دیا۔ failed: ٹرانسفر مکمل نہیں ہوا اور کال ختم ہو گئی
destinationstring | nullوہ نمبر جس پر کال منتقل کی گئی تھی
sip_statusinteger | nullکولڈ ٹرانسفر مسترد کرنے پر کیریئر کی SIP حیثیت: 403 (مثلاً ایسا Twilio ٹرنک جس میں کال ٹرانسفر نہیں ہے)، 405 یا 501۔ جب کیریئر نے اسے مسترد نہیں کیا تو null
bridge_kindstring | nullصرف bridged: cold_fallback (ایک مسترد شدہ کولڈ ٹرانسفر جسے ThunderPhone نے منسلک کیا) یا warm (ایجنٹ کے الگ ہونے کے بعد وارم ٹرانسفر کے دو افراد)
bridge_secondsinteger | nullصرف bridged: پل کے ذریعے منسلک وقت جس کا ThunderPhone نے بل کیا، سیکنڈز میں
bridge_total_centsinteger | nullصرف bridged: کسی بھی مفت کال کریڈٹ کے بعد USD سینٹس میں پل کی لاگت، جس کا بل کال کے billing_total_cents سے الگ کیا جاتا ہے

یہی اقدار کال آبجیکٹ پر بھی transfer_outcome، transfer_destination، transfer_sip_status، transfer_bridge_kind، transfer_bridge_seconds اور transfer_bridge_total_cents کے طور پر موجود ہیں۔ event_id ہر ڈیلیوری میں ایک ہی ہوتا ہے ایک کال کے لیے، لہٰذا بار بار آنے والی رپورٹ کبھی دوسرا ایونٹ پیدا نہیں کرتی۔

call.billed

استعمال کی پیمائش کی بنیاد پر بل کی گئی کال کے لیے بھیجا جاتا ہے: جب اس کا چارج طے ہو جائے، کال ختم ہونے کے چند منٹ بعد جب اس کا استعمال موصول ہو جائے، اور دوبارہ جب بعد میں موصول ہونے والا استعمال چارج بڑھا دے۔ کال کا telephony.complete / web.complete ایونٹ billing_pending: true اور null بلنگ فیلڈز رکھتا ہے۔ یہ عمل کو نہیں روکتا، اور صرف اینڈ پوائنٹس پر پہنچایا جاتا ہے (پرانے واحد URL ویب ہک پر کبھی نہیں)۔ جن کالز کی بلنگ ختم ہوتے ہی ہو جاتی ہے، ان کی بلنگ تکمیلی ایونٹ میں شامل ہوتی ہے اور انہیں call.billed نہیں ملتا۔

ترتیب کی ضمانت نہیں ہے: چارج عموماً تکمیلی ایونٹ کا انتظار کرتا ہے، لیکن call.billed اس سے پہلے پہنچ سکتا ہے (ایک تکمیلی ایونٹ جو ایک گھنٹے تک رکا رہا ہو، یا مختلف اوقات میں دوبارہ کوشش کی گئی ترسیلات)، اور دو call.billed ایونٹس بے ترتیب پہنچ سکتے ہیں۔ ہر call_id کے لیے سب سے زیادہ billing_seq والا ایونٹ رکھیں۔

{
  "data": {
    "adjustment_cents": null,
    "agent_id": 12,
    "agent_name": "Front desk",
    "billable_minutes": 3.0,
    "billing_seq": 1,
    "billing_total_cents": 10,
    "call_id": 987654321,
    "reason": "settled"
  },
  "event_id": "7c1d2e3f-4a5b-5c6d-8e7f-9a0b1c2d3e4f",
  "type": "call.billed"
}
فیلڈقسموضاحت
call_idintegerوہ کال جس کی بلنگ کی گئی
agent_idinteger | nullوہ ایجنٹ جس نے کال سنبھالی، جب کوئی ایجنٹ مقرر کیا گیا ہو
agent_namestring | nullوہ ایجنٹ جس نے کال سنبھالی، جب کوئی ایجنٹ مقرر کیا گیا ہو
reasonstringsettled: کال کا چارج۔ adjusted: وہ استعمال جو چارج کے بعد موصول ہوا اور اسے بڑھا دیا (چارج کبھی کم نہیں کیا جاتا)
billing_seqintegerچارج کے لیے 1، پھر ہر اضافے کے لیے 2، 3، ...۔ موصول ہونے والا سب سے زیادہ نمبر کال کی موجودہ بلنگ ہے
billable_minutesnumberبل کیے گئے منٹ، قریب ترین چوتھائی منٹ تک گول کیے گئے
billing_total_centsintegerمفت کال کریڈٹ کے بعد، اب تک کال پر عائد کردہ ہر چیز امریکی ڈالر سینٹس میں، جس میں adjusted اضافے شامل ہیں
adjustment_centsinteger | nullصرف adjusted: مفت کال کریڈٹ کے بعد امریکی ڈالر سینٹس میں یہ اضافہ

یہی مجموعے کال آبجیکٹ پر billable_minutes اور billing_total_cents کے طور پر موجود ہیں۔ event_id ہر billing_seq کی ہر ترسیل پر یکساں ہوتا ہے، اس لیے دہرائی گئی رپورٹ کبھی دوسرا ایونٹ پیدا نہیں کرتی۔

call.status_changed

کال جاری ہونے کے دوران، جب بھی وہ کسی نئے مرحلے میں پہنچتی ہے، یہ بھیجا جاتا ہے: ThunderPhone ڈائل کرنا شروع کرتا ہے، شخص یا اس کا فون جواب دیتا ہے، ایجنٹ وائس میل تک پہنچتا ہے، یا ایجنٹ کو ہولڈ پر رکھا اور ہولڈ سے ہٹایا جاتا ہے۔ اسے لائیو کال کی پیش رفت دکھانے کے لیے استعمال کریں، مثلاً کال کی پیروی کرنے والی چیٹ تھریڈ میں "ڈائل ہو رہا ہے…"، "جواب دیا گیا"، "ہولڈ پر" اور "4 منٹ بعد ہولڈ سے ہٹا دیا گیا"۔ یہ نان بلاکنگ ہے اور صرف اینڈپوائنٹس کو پہنچایا جاتا ہے (لیگیسی سنگل-URL ویب ہک کو کبھی نہیں)۔

{
  "data": {
    "agent_id": 12,
    "agent_name": "Front desk",
    "call_id": 987654321,
    "direction": "outbound",
    "hold_seconds": 240,
    "occurred_at": "2026-11-07T17:04:12.418Z",
    "status": "off_hold"
  },
  "event_id": "2f6a1c9e-3b7d-5e8f-9a0b-4c5d6e7f8a9b",
  "type": "call.status_changed"
}
فیلڈقسمتفصیل
call_idعدد صحیحکال
agent_idعدد صحیح | خالیاگر کوئی ایجنٹ مقرر تھا تو وہ ایجنٹ جس نے کال سنبھالی
agent_nameمتن | خالیاگر کوئی ایجنٹ مقرر تھا تو وہ ایجنٹ جس نے کال سنبھالی
directionمتنکال کی سمت، جیسا کہ کال آبجیکٹ میں ہے
statusمتنوہ مرحلہ جس تک کال پہنچی؛ نیچے دی گئی جدول دیکھیں
occurred_atٹائم اسٹیمپجب یہ ہوا
hold_secondsعدد صحیح | خالیصرف off_hold: ہولڈ کتنی دیر رہا، سیکنڈز میں۔ ہر دوسری اسٹیٹس کے لیے null
statusکب بھیجا جاتا ہے
dialingآؤٹ باؤنڈ کالز: ThunderPhone کال کر رہا ہے۔ کال مسترد کرنے والی ہر جانچ مکمل ہونے کے بعد، ڈائل کیریئر تک جانے سے فوراً پہلے بھیجا جاتا ہے۔ ڈیش بورڈ سے شروع کی گئی ٹیسٹ کالز اسے نہیں بھیجتیں
answeredآؤٹ باؤنڈ کالز: کیریئر نے اطلاع دی کہ کال کا جواب دیا گیا۔ وائس میل باکس یا کال اسکرینر کا جواب دینا بھی شمار ہوتا ہے، اس لیے اس کے بعد voicemail آ سکتا ہے۔ جب ThunderPhone کو جواب کا علم صرف کال ختم ہونے کی رپورٹ سے ہو، تو کال ختم ہوتے وقت answered بھیجا جاتا ہے
voicemailآؤٹ باؤنڈ کالز: ایجنٹ وائس میل باکس تک پہنچ گیا ہے اور، ایجنٹ کے voicemail_action کے مطابق، اپنا پیغام چھوڑ رہا ہے یا کال بند کر رہا ہے۔ میل باکس کی تصدیق ہونے پر بھیجا جاتا ہے (اس کی بیپ، یا جواب نہ ملنے پر)، ابتدائی اندازے پر نہیں
on_holdایجنٹ کو ہولڈ پر رکھا گیا ہے اور وہ خاموشی سے انتظار کر رہا ہے (wait_on_hold ٹول)
off_holdایک شخص دوبارہ لائن پر آ گیا ہے اور ایجنٹ پھر بات کر رہا ہے۔ hold_seconds بتاتا ہے کہ ہولڈ کتنی دیر رہا

ہر کال ہر اسٹیٹس کو زیادہ سے زیادہ ایک بار بھیجتی ہے، سوائے on_hold اور off_hold کے، جو ہر ہولڈ کے لیے ایک بار بھیجے جاتے ہیں۔ ایک عام آؤٹ باؤنڈ کال جو ہولڈ پر انتظار کرتی ہے dialing، answered، on_hold، off_hold، اور پھر ختم ہونے پر telephony.complete بھیجتی ہے۔

رنگنگ کی اطلاع نہیں دی جاتی: آیا کوئی کیریئر رنگنگ کا سگنل دیتا ہے، اس میں اتنا تفاوت ہوتا ہے کہ اس پر بھروسا نہیں کیا جا سکتا۔ ان چند voicemail_action: "prompt" کالز میں جہاں ThunderPhone کے بجائے ایجنٹ کا prompt فیصلہ کرتا ہے کہ وائس میل باکس پر کیا کرنا ہے، کوئی voicemail اسٹیٹس نہیں بھیجا جاتا؛ telephony.complete میں موجود answered_by پھر بھی voicemail بتاتا ہے۔ پے لوڈز میں کوئی ٹرانسکرپٹ، فون نمبر یا ویری ایبلز شامل نہیں ہوتے، اس لیے call.status_changed ان کالز کے لیے بھی بھیجا جاتا ہے جن کی ریکارڈنگ بند ہو۔


SMS ایونٹس

SMS ایونٹس تنظیم کے منسلک Twilio یا Telnyx اکاؤنٹ کے ذریعے بھیجے گئے پیغامات کی وضاحت کرتے ہیں۔ پیغام کا متن شامل نہیں ہوتا اور to کو مخفی کر دیا جاتا ہے۔ جب مواد یا وصول کنندہ درکار ہو تو GET /v1/sms/{message_id} سے تنظیم کے دائرہ کار والا پیغام حاصل کریں۔ source، message object کی طرح، api، agent_tool، followup یا pre_call ہوتا ہے (کال کرنے سے پہلے مہم کا متن)۔

ہر SMS ایونٹ میں scheduled_send_id شامل ہوتا ہے: اس scheduled send کی آئی ڈی جس کے لیے متن بھیجا گیا تھا، یا ایسے متن کے لیے null جو شیڈول نہیں تھا۔ شیڈول شدہ متون کا source "scheduled" ہوتا ہے۔

sms.sent

اس وقت بھیجا جاتا ہے جب صارف کا کیریئر باہر جانے والی SMS درخواست قبول کر لے۔ یہ ہینڈ سیٹ پر پہنچنے کی رسید نہیں ہے۔

{
  "data": {
    "accepted_at": "2026-09-19T15:42:10.113Z",
    "agent_id": 12,
    "call_id": 987654321,
    "created_at": "2026-09-19T15:42:09.901Z",
    "direction": "outbound",
    "error_code": null,
    "error_message": null,
    "from_number": "+15551234567",
    "id": "313a3117-827b-46e9-a01a-ac1493838724",
    "provider": "twilio",
    "provider_id": "SM0123456789abcdef0123456789abcdef",
    "scheduled_send_id": null,
    "segment_count": 1,
    "source": "agent_tool",
    "status": "accepted",
    "to": "[REDACTED]"
  },
  "event_id": "0ae347b4-1716-45bb-9a0e-b52373586e37",
  "type": "sms.sent"
}

sms.failed

مستقل کیریئر مسترد ہونے کے بعد، عارضی دوبارہ کوششیں ختم ہونے کے بعد، جب نتیجہ حتمی طور پر نامعلوم ہو، یا جب Twilio کسی منظور شدہ پیغام کو نہ پہنچنے والا یا ناکام رپورٹ کرے، یہ بھیجا جاتا ہے۔ آخری صورت میں پیغام کا sms.sent پہلے ہی بھیجا جا چکا ہوتا ہے، اور status "accepted" رہتا ہے۔ error_code ایک مستحکم ThunderPhone کوڈ ہے اور error_message، جب دستیاب ہو، کسٹمر کی مطلوبہ کارروائی بتاتا ہے۔ status: "unknown" کا مطلب ہے کہ کیریئر نے ممکنہ طور پر SMS قبول کر لیا ہے؛ اسے کیریئر لاگ میں ہم آہنگ کریں کیونکہ ThunderPhone اسے خودکار طور پر دوبارہ نہیں بھیجے گا۔

sms.received

آنے والے SMS سپورٹ کے لیے محفوظ ہے۔ موجودہ ریلیز میں کوئی sms.received ایونٹ نہیں بھیجا جاتا۔ آنے والے کیریئر ویب ہک کی ترتیب اور دستخط کی تصدیق الگ سے فراہم کی جائے گی۔


شیڈول شدہ ایونٹس

شیڈول شدہ بھیجنے جو ارسال نہیں ہوتے، ان میں سے کوئی ایک ایونٹ ٹرگر ہوتا ہے۔ جو بھیجنا ارسال ہو جائے، اس کے بجائے معمول کے ایونٹس ٹرگر ہوتے ہیں: متن کے لیے scheduled_send_id سیٹ ہونے کے ساتھ sms.* ایونٹس، کال کے لیے کال ایونٹس، اور اس کے telephony.complete پر scheduled_send_id۔ دونوں نان بلاکنگ ہیں۔ جب بھیجنے میں کوئی ایجنٹ ہو تو اس ایجنٹ کے لیے ایجنٹ-مخصوص اینڈپوائنٹس بھی انہیں وصول کرتے ہیں۔

پے لوڈ میں صرف IDs، اسٹیٹس اور اوقات ہوتے ہیں: کبھی بھی متن کا باڈی یا کال کے ویری ایبلز یا سیاق نہیں، اور to ریڈیکٹ کیا جاتا ہے۔ باقی کے لیے GET /v1/scheduled/{id} حاصل کریں۔

scheduled.skipped

اس وقت بھیجا جاتا ہے جب کوئی بھیجنا جان بوجھ کر ارسال نہ کیا جائے۔ reason یہ ہو سکتا ہے: expired (وہ expires_at سے پہلے ارسال نہیں ہو سکا)، opted_out (نمبر آپٹ آؤٹ فہرست میں ہے، جس میں بھیجنا بننے کے بعد شامل کیا گیا نمبر بھی شامل ہے)، quiet_hours (وہ وصول کنندہ کے ٹائم زون میں صبح 8 بجے سے رات 9 بجے کے باہر مقرر ہوا)، sender_not_ready (متن کا نمبر اب ارسال نہیں کر سکتا) یا outbound_tcpa_unconfirmed (کال تنظیم کی TCPA تصدیق ریکارڈ ہونے سے پہلے مقرر ہوئی)۔

{
  "data": {
    "agent_id": null,
    "created_at": "2026-11-01T18:02:11.204Z",
    "detail": "The send could not go out before its expires_at, so it was not sent late.",
    "expires_at": "2026-11-03T17:30:00Z",
    "external_id": "appointment-4815",
    "from_number": "+15551234567",
    "id": "6f1c0b8e-3a52-4c1f-9a0b-2f4f7d8a91c3",
    "reason": "expired",
    "send_at": "2026-11-03T17:00:00Z",
    "source": "api",
    "status": "skipped",
    "to": "[REDACTED]",
    "type": "sms"
  },
  "event_id": "2b0f6c43-74c9-4d43-a1f4-0d6a2f8e51a7",
  "type": "scheduled.skipped"
}

scheduled.failed

اس وقت بھیجا جاتا ہے جب ThunderPhone نے بھیجنے کی کوشش کی ہو اور وہ ارسال نہ ہو سکا ہو۔ reason بھیجنے کی اپنی خرابی ہے: کسی ٹیکسٹ کے لیے SMS ایرر کوڈ، جیسے carrier_rejected، یا کال کے مسترد ہونے یا ناکام ہونے کی وجہ، جیسے بلاک شدہ منزل کا اصول (مثلاً premium_rate) یا agent_deleted۔ پے لوڈ میں scheduled.skipped جیسے ہی فیلڈز ہوتے ہیں۔

فیلڈقسموضاحت
idstringشیڈول شدہ بھیجنے کا id
typestringsms یا call
statusstringskipped یا failed
reasonstringوجہ، جیسا کہ اوپر بیان ہوا؛ بھیجنے کے status_reason جیسی ہی قدر
detailstringقابلِ فہم وضاحت
sourcestringبھیجنے کو کس نے بنایا: api
external_idstring | nullبھیجنے کے لیے آپ کی کلید، یا null
from_numberstringبھیجنے والا نمبر
tostringہمیشہ "[REDACTED]"
agent_idinteger | nullکالز: ایجنٹ؛ ٹیکسٹس: null
send_at, expires_at, created_attimestampISO 8601

وائس ایونٹس

حسب ضرورت وائس کی تخلیق غیر ہم وقت ہے۔ یہ نان بلاکنگ ایونٹس آپ کو کلون تفصیل اینڈ پوائنٹ کو بار بار جانچنے کے بجائے کسی حتمی نتیجے پر ردعمل دینے دیتے ہیں۔

voice.ready اور voice.failed صرف events: [] والے تنظیم بھر کے اینڈ پوائنٹ پر پہنچائے جاتے ہیں۔ انہیں واضح ایونٹ فلٹرز کے طور پر منتخب نہیں کیا جا سکتا۔

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"
}
فیلڈقسمتفصیل
voice.idسٹرنگحسب ضرورت وائس کی عوامی شناخت
voice.nameسٹرنگcustom:<public_id> کی صورت میں ایجنٹ وائس کی قدر
voice.display_nameسٹرنگتنظیم کے لیے وائس کا نام
voice.languageسٹرنگکلون کا واحد زبان کوڈ
voice.genderسٹرنگmale، female، یا خالی سٹرنگ
voice.statusسٹرنگvoice.ready کے لیے ready؛ voice.failed کے لیے failed
voice.failure_reasonسٹرنگکامیابی پر خالی؛ ناکامی پر پروسیسنگ کی ناکامی کی تفصیل
voice.created_at, voice.updated_atٹائم اسٹیمپISO 8601 ٹائم اسٹیمپس
reasonسٹرنگناکامی کی تفصیل؛ صرف 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…"
    },
    "report": null
  },
  "event_id": "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
  "type": "call.graded"
}
فیلڈقسموضاحت
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، جب کوئی مقرر کیا گیا ہو
agent_namestring | nullکال سنبھالنے والے ایجنٹ کا نام، جب کوئی مقرر کیا گیا ہو
grade.idintegerگریڈ کا id
grade.scoreinteger | null0–100
grade.call_outcomestringsuccess، failure، unknown، یا no_conversation
grade.summarystringایک پیراگراف کا خلاصہ
grade.detected_issuesarrayگریڈر کو ملنے والے مسئلے کے اسٹرنگز
grade.statusstringہمیشہ completed — صرف مکمل شدہ رنز خارج ہوتے ہیں
grade.grader_modelstringنتیجہ تیار کرنے والا گریڈر: فوری عارضی گریڈ کے لیے heuristic-v1 (یا ThunderPhone کا کوئی دوسرا قواعد پر مبنی گریڈر)، مکمل گریڈ کے لیے thunderphone-grader۔ یہ ThunderPhone کا لیبل ہے، AI ماڈل کا نام نہیں
grade.graded_at, grade.created_attimestamp
reportobject | nullصارف کے لیے کال رپورٹ: نتیجے کا لیبل، توجہ درکار ہونے کا پرچم اور وجہ، کالر، ایک سطر کا خلاصہ، کالر کا تجربہ۔ ابتدائی ہیورسٹک گریڈ میں یہ null ہوتا ہے یا pending رپورٹ ہوتی ہے جس کے فیلڈز پلیس ہولڈرز ہوتے ہیں؛ مکمل گریڈ کے ایونٹ میں مکمل رپورٹ شامل ہوتی ہے

call.data_extracted

منظم ڈیٹا نکالنے کا عمل کامیابی سے مکمل ہونے پر بھیجا جاتا ہے، جس میں telephony.complete / web.complete کے بعد کی تاخیر سے کی گئی دوبارہ کوشش یا POST /v1/calls/{call_id}/extract کے ذریعے دستی دوبارہ رن بھی شامل ہے۔ نان بلاکنگ۔

بلاکنگ ایکسٹریکشن موڈ میں، تکمیلی ایونٹ عموماً 75 سیکنڈ کے ایکسٹریکشن بجٹ سے زیادہ انتظار نہیں کرتا۔ اگر ایکسٹریکشن ورکر پراسیس ختم ہو جائے، تو پروڈکشن فائنلائزیشن ڈرین (ہر پانچ منٹ بعد) ایکسٹریکشن کی نئی کوشش شروع کرنے سے پہلے ایسی تکمیل جاری کرتا ہے جس کا blocking_deadline_at گزر چکا ہو۔ بعد کی کامیابی اس ایونٹ کے طور پر الگ سے فراہم کی جاتی ہے۔

{
  "data": {
    "call_id": 987654321,
    "agent_id": 12,
    "agent_name": "Acme intake",
    "extracted_data": {
      "status": "completed",
      "fields": {
        "customer_name": "Alex Morgan",
        "appointment_date": "2026-04-23"
      },
      "evidence": {
        "customer_name": {
          "quote": "My name is Alex Morgan",
          "speaker_role": "caller",
          "turn_index": 4
        },
        "appointment_date": {
          "quote": "April 23 works for me",
          "speaker_role": "caller",
          "turn_index": 7
        }
      },
      "verification": "verified",
      "field_reasons": {},
      "schema_version": "92850758e231a3c95a..."
    },
    "extracted_at": "2026-04-20T18:25:11.002Z",
    "model": "thunderphone-extractor",
    "summary": "Alex Morgan called to book a follow-up visit and confirmed Thursday, April 23."
  },
  "event_id": "4d79ef1d-c2b1-4ed6-85b8-8326bd2895ef",
  "type": "call.data_extracted"
}
فیلڈقسموضاحت
agent_idعدد | nullکال سنبھالنے والا ایجنٹ، جب کوئی ایجنٹ تفویض کیا گیا ہو
agent_nameسٹرنگ | nullکال سنبھالنے والا ایجنٹ، جب کوئی ایجنٹ تفویض کیا گیا ہو
summaryسٹرنگ | nullمکمل شدہ کال کا خلاصہ، جب ایجنٹ میں کال کا خلاصہ بنائیں فعال ہو؛ اس لیے تاخیر سے آنے والا ایکسٹریکشن ایونٹ ایسا خلاصہ بھی فراہم کرتا ہے جو تکمیل کی مدت سے رہ گیا ہو؛ بصورت دیگر null۔ خلاصہ رکھنے لیکن ایکسٹریکشن فیلڈز نہ رکھنے والے ایجنٹس کبھی یہ ایونٹ جاری نہیں کرتے: تاخیر سے آنے والا خلاصہ GET /v1/calls/{call_id} سے پڑھیں
extracted_data.statusسٹرنگاس ایونٹ کے لیے ہمیشہ completed
extracted_data.fieldsآبجیکٹکنفیگر کردہ ایکسٹریکشن فیلڈ کیز کے مطابق ویلیوز؛ غیر دستیاب ویلیوز null ہوتی ہیں
extracted_data.evidenceآبجیکٹایکسٹریکشن فیلڈ کے مطابق شواہد۔ غیر null ویلیو میں عین ساختی طور پر جانچا گیا اقتباس (زیادہ سے زیادہ 1,000 حروف)، speaker_role (caller یا agent)، اور turn_index شامل ہوتے ہیں؛ ماڈل کی جانب سے واپس کیے گئے طویل اقتباسات کو مختصر کرنے کے بجائے مسترد کیا جاتا ہے، اور جب بھی اس کی فیلڈ null ہو، شواہد null ہوتے ہیں
extracted_data.verificationسٹرنگverified صرف اس وقت ہوتا ہے جب آزاد شواہد پاس نے ہر امیدوار فیلڈ کے لیے بالکل ایک درست فیصلہ واپس کیا ہو۔ unavailable کا مطلب ہے کہ پاس ناکام ہوا، وقت ختم ہوا، کافی بجٹ موجود نہیں تھا، یا اس نے خراب یا جزوی آؤٹ پٹ واپس کیا۔ مکمل طور پر غیر دستیاب پاس کسٹمر کے جائزے کے لیے ساختی بنیاد والی ویلیوز محفوظ رکھتا ہے۔ جزوی آؤٹ پٹ کے لیے، درست فیصلے لاگو کیے جاتے ہیں اور ہر وہ امیدوار جس کے لیے بالکل ایک درست فیصلہ نہ ہو اسے null کر دیا جاتا ہے
extracted_data.field_reasonsآبجیکٹساختی بنیاد یا آزاد تصدیق کنندہ کی وجہ سے null کی گئی فیلڈز کے مطابق وجوہات
extracted_data.schema_versionسٹرنگاس ایکسٹریکشن کے لیے استعمال ہونے والے عین فیلڈ اسکیما کا ہیش
extracted_atٹائم اسٹیمپISO 8601 تکمیل کا وقت
modelسٹرنگہمیشہ thunderphone-extractor: ایکسٹریکشن ماڈل کے لیے ThunderPhone کا لیبل، کسی AI ماڈل کا نام نہیں

campaign.completed

کسی کیمپین کے running سے completed میں منتقل ہونے پر ایک مرتبہ بھیجا جاتا ہے، خواہ اس کا شیڈول ختم ہو جائے یا تمام رابطے اختتامی حالتوں تک پہنچ جائیں۔ رنر کی دوبارہ کوششیں دوسرا ایونٹ نہیں بھیجتیں۔ یہ تنظیمی سطح کا لائف سائیکل ایونٹ صرف تنظیم کے دائرہ کار والے اینڈپوائنٹس کو فراہم کیا جاتا ہے، ایجنٹ کے دائرہ کار والے اینڈپوائنٹس کو نہیں۔ نان بلاکنگ۔

{
  "data": {
    "campaign_id": "3f6b2c9e-2a0d-4c63-b6d6-a708dc98f403",
    "name": "May win-back",
    "agent_id": 12,
    "status": "completed",
    "started_at": "2026-04-20T17:00:00Z",
    "completed_at": "2026-04-20T18:25:11Z",
    "counts": {
      "contacts_total": 150,
      "completed": 121,
      "failed": 11,
      "no_answer": 18,
      "skipped": 4,
      "remaining": 0
    }
  },
  "event_id": "8d8f52ce-6b46-423f-9dde-cea0b91ec135",
  "type": "campaign.completed"
}

نتائج کی چاروں گنتیاں ایک دوسرے سے جدا ہیں اور ان کا مجموعہ contacts_total کے برابر ہوتا ہے: completed میں کامیاب رابطے شامل ہوتے ہیں؛ no_answer میں وہ حتمی ناکام یا کوششیں ختم ہونے والے رابطے شامل ہوتے ہیں جن کا آخری نتیجہ جواب نہ ملنا تھا؛ failed میں دیگر تمام حتمی ناکام یا کوششیں ختم ہونے والے رابطے شامل ہوتے ہیں؛ اور remaining میں زیر التوا، شیڈول شدہ، یا اس وقت کال کیے جا رہے رابطے شامل ہوتے ہیں۔ دوبارہ کوشش کے انتظار میں موجود رابطہ remaining ہوتا ہے، چاہے اس کی تازہ ترین کوشش کا نتیجہ جواب نہ ملنا ہو۔ ایک بار کے تکمیل اسنیپ شاٹ سے پہلے جاری کالز کا تطبیق کیا جاتا ہے۔ started_at کنفیگر کردہ مہم کا آغاز ہوتا ہے، یا جب کوئی آغاز کنفیگر نہ کیا گیا ہو تو مہم کی تخلیق کا وقت ہوتا ہے۔ skipped پانچواں زمرہ نہیں ہے: یہ failed کے اندر ان رابطوں کو شمار کرتا ہے جنہیں نمبر کی قسم کے فلٹر نے کال کے بغیر ختم کر دیا۔

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"
}
فیلڈقسمتفصیل
agent_idinteger | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا ہو
agent_namestring | nullکال سنبھالنے والا ایجنٹ، اگر کوئی تفویض کیا گیا ہو
issue_report.severitystringcritical، warning، یا info
issue_report.statusstringopen یا resolved
issue_report.sourcestringuser (ڈیش بورڈ سے درج شدہ) یا system (گریڈنگ کے ذریعے تیار کردہ)

issue.escalated

جب کسی مسئلے کے پیٹرن کو عملے کے جائزے کے لیے ThunderPhone کو بھیجا جاتا ہے تو بھیجا جاتا ہے: ThunderPhone کو رپورٹ کریں کے بعد، یا جب AI سے درست کریں کسٹمر کی جانب سے کی گئی درستگی کی تصدیق نہ کر سکے اور مسئلے کو خودکار طور پر بھیج دے۔ صرف تنظیم کی سطح کے اینڈپوائنٹس کو یہ ایونٹ موصول ہوتا ہے۔

{
  "data": {
    "automatic": false,
    "cluster_id": "7ac2844c-2df0-4fa8-a560-7378da649e19",
    "escalation_id": "ec99f52b-c8c0-41dd-a4f2-dd8a07b10894",
    "status": "open"
  },
  "event_id": "d8f8f420-7a42-45ba-bcf1-b747f9bbecda",
  "type": "issue.escalated"
}
فیلڈقسمتفصیل
automaticbooleanخودکار ایسکلیشن کے لیے true؛ دستی ایسکلیشن کے لیے false
cluster_idUUIDایسکلیٹ کیا گیا مسئلے کا پیٹرن
escalation_idUUIDایسکلیشن ریکارڈ
statusstringایونٹ بھیجے جانے پر open

یہ اطلاع ہے، شواہد کا بنڈل نہیں۔ اسے مسئلے کے پیٹرن سے مربوط کرنے کے لیے cluster_id استعمال کریں۔ ThunderPhone کو رپورٹ کریں دیکھیں۔


ٹیسٹ کال ایونٹس

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"
}
فیلڈقسموضاحت
agent_idinteger | nullوہ ایجنٹ جس نے کال سنبھالی، جب کوئی ایجنٹ مقرر تھا
agent_namestring | nullوہ ایجنٹ جس نے کال سنبھالی، جب کوئی ایجنٹ مقرر تھا
test_call_run.target_typestringagent یا phone_number
test_call_run.target_idintegerوہ ایجنٹ id یا فون نمبر id جسے رن نے ہدف بنایا، جو target_type سے مطابقت رکھتا ہے
test_call_run.statusstringcompleted یا failed
test_call_run.call_idinteger | nullجب رن کال ہونے سے پہلے ناکام ہو جائے تو null
test_call_run.error_messagestringکامیابی پر خالی

الرٹ ایونٹس

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"
}
فیلڈقسموضاحت
event_id (data میں)UUIDالرٹ کے فعال ہونے کی id — اینویلپ کی ترسیلی event_id سے مختلف
rule_id, rule_nameUUID, stringوہ رول جو فعال ہوا
metricstringsuccess_rate، failure_rate، avg_score، call_volume، یا suite_regression
comparatorstringlt، lte، gt، یا gte
metric_valuenumberرول فعال ہونے کے وقت ونڈو میں میٹرک کی قدر
thresholdnumberترتیب دی گئی حد
window_hoursintegerپچھلی جانچ ونڈو
fired_attimestamp

رولز، میٹرکس، کول ڈاؤنز، اور ای میل / Slack چینلز بنانے کے لیے الرٹس گائیڈ دیکھیں۔


فون نمبر ایونٹس

phone_number.spam_risk_changed

اس وقت بھیجا جاتا ہے جب اسپام لیبل کی نگرانی (ایک بامعاوضہ اضافی خصوصیت، جو سپورٹ کے ذریعے درخواست پر دستیاب ہے) کسی زیر نگرانی نمبر کے اسپام خطرے کو medium یا high تک بڑھتا ہوا دیکھے (low سے، ابھی تک کوئی ریڈنگ نہ ہونے سے، یا medium سے high تک)۔ یہ بلاک نہیں کرتا۔ جو نمبر نشان زد رہے اسے دوبارہ نہیں بھیجا جاتا؛ جو low پر واپس آ جائے اور بعد میں دوبارہ نشان زد ہو، اسے بھیجا جاتا ہے۔ اس ایونٹ کے پاس ایجنٹ کا کوئی سیاق نہیں ہوتا، اس لیے یہ صرف تنظیم بھر کے اینڈ پوائنٹس کو موصول ہوتا ہے۔ تنظیم کے مالکان اور ایڈمنز کو بھی ایک ای میل موصول ہوتی ہے۔

{
  "data": {
    "checked_at": "2026-10-21T14:41:07+00:00",
    "phone_number": "+13125550100",
    "phone_number_id": 412,
    "previous_spam_risk": "low",
    "scores": {
      "connection": 31,
      "engagement": 40,
      "maturity": 82,
      "sentiment": 22
    },
    "spam_category": "Telemarketer",
    "spam_risk": "high"
  },
  "event_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
  "type": "phone_number.spam_risk_changed"
}
فیلڈقسمتفصیل
phone_numberاسٹرنگنمبر، E.164 فارمیٹ میں
phone_number_idعدد صحیح | nullفون نمبرز میں اس کا شناختی نمبر
spam_riskاسٹرنگmedium یا high
previous_spam_riskاسٹرنگ | nullگزشتہ ریڈنگ میں خطرہ؛ پہلی ریڈنگ سے پہلے null
spam_categoryاسٹرنگ | nullوہ لیبل جو کیریئرز دکھا سکتے ہیں، مثلاً Telemarketer یا Survey۔ اسے آزاد متن سمجھیں
scoresآبجیکٹہر ایک 0 سے 100 تک، یا کافی کال والیوم ہونے تک null: maturity (نمبر کتنا عرصہ سے رائج ہے)، connection (کیا لوگ جواب دیتے ہیں)، engagement (کیا وہ کال پر رہتے ہیں)، sentiment (کیا وہ اسے بلاک یا رپورٹ کرتے ہیں)
checked_atٹائم اسٹیمپجب ThunderPhone نے نتیجہ پڑھا

مائیگریشن ایونٹس

migration.call.complete

اس وقت بھیجا جاتا ہے جب POST /v1/migrations/{id}/calls کے ذریعے کی گئی کال ختم ہو جائے، خواہ اسے کسی بھی پلیٹ فارم نے وصول کیا ہو۔ یہ بلاک نہیں کرتا۔ کال ختم ہونے کے تقریباً 5 منٹ بعد تک یہ پہنچتا ہے۔ data میں telephony.complete کے تمام فیلڈز کے ساتھ ایک migration بلاک بھی شامل ہوتا ہے۔ ThunderPhone کی کی گئی کال بھی معمول کے مطابق اسی call_id کے ساتھ telephony.complete بھیجتی ہے۔ دوسرے پلیٹ فارم کی وصول کردہ کال کے لیے answered_by، null ہوتا ہے۔ دوسرے پلیٹ فارم پر ایسی کال جو 2 گھنٹے بعد بھی ختم نہ ہوئی ہو، یا جس کی migration پہلے مکمل ہو گئی ہو یا اس کی کلید گم ہو گئی ہو، اسے status: "unknown" اور بغیر ٹرانسکرپٹ کے بھیجا جاتا ہے۔

{
  "data": {
    "agent_id": 42,
    "agent_name": "Front desk",
    "answered_by": null,
    "billable_minutes": null,
    "billing_total_cents": null,
    "call_id": null,
    "direction": "outbound",
    "duration_seconds": 94,
    "end_reason": "user_hangup",
    "end_time": "2026-10-06T17:01:34+00:00",
    "extracted_data": null,
    "from_number": "+15551234567",
    "migration": {
      "arm": "vendor",
      "id": "5f0c2a9e-7b1d-4c3e-8a6f-2d9e1b4c7a30",
      "metadata": {
        "lead_id": "8812"
      },
      "routing_id": "9b2f8c1e-4d3a-4f6b-8e2d-1a7c5b9e0f34",
      "vendor": "retell",
      "vendor_call_id": "call_6a1f0e",
      "vendor_cost_usd": "0.1240"
    },
    "product": "",
    "recording_mode": "vendor",
    "recording_url": "https://…",
    "start_time": "2026-10-06T17:00:00+00:00",
    "status": "completed",
    "summary": "The callee booked a table for two on Thursday.",
    "thunderphone_retained_call_content": true,
    "to_number": "+14155552671",
    "transcripts": [
      {
        "content": "Hi Ada, this is Rosa's calling about your booking.",
        "role": "agent"
      },
      {
        "content": "Yes, Thursday works.",
        "role": "user"
      }
    ],
    "transfer_number": null,
    "unresolved_variables": [],
    "variables": {
      "first_name": "Ada"
    },
    "voice": ""
  },
  "event_id": "7c1e2f3a-4b5c-4d6e-8f7a-9b0c1d2e3f4a",
  "type": "migration.call.complete"
}
فیلڈقسمتفصیل
migration.idUUIDمائیگریشن
migration.routing_idUUIDروٹ کی گئی کال، جیسا کہ کال کرتے وقت واپس ملا تھا
migration.armstringours ‏(ThunderPhone نے کی) یا vendor ‏(دوسرے پلیٹ فارم نے کی)
migration.vendorstringretell، vapi، elevenlabs، یا bland
migration.vendor_call_idstring | nullدوسرے پلیٹ فارم کا کال آئی ڈی؛ ours کے لیے null
migration.metadataobjectکال کرتے وقت بھیجا گیا metadata
migration.vendor_cost_usdstring | nullدوسرے پلیٹ فارم کی رپورٹ کردہ کال کی لاگت، اگر اس نے رپورٹ کی ہو
call_idinteger | nullThunderPhone کال آئی ڈی؛ vendor کے لیے null
statusstringvendor کے لیے: جب وصول کنندہ نے بات کی ہو تو completed، جب نہ کی ہو تو failed، اوپر کے مطابق unknown۔ ours کے لیے: telephony.complete کے مطابق

vendor کال کے لیے ThunderPhone کے پاس بلنگ یا استخراجی ڈیٹا نہیں ہوتا: billable_minutes، billing_total_cents اور extracted_data، null ہوتے ہیں، product اور voice خالی ہوتے ہیں، recording_mode، vendor ہوتا ہے، اور اگر دوسرے پلیٹ فارم نے لنک دیا ہو تو recording_url اسی پلیٹ فارم کا لنک ہوتا ہے۔

migration.rollback

اس وقت بھیجا جاتا ہے جب کسی مائیگریشن کی تدریجی منتقلی خودکار طور پر ہر کال کو دوسری پلیٹ فارم پر واپس منتقل کر دے: 15 منٹ کے اندر 3 کالز ThunderPhone سے منسلک ہونے میں ناکام رہیں، ThunderPhone کو بھیجی گئی 2 کالز ایجنٹ کے جواب دینے سے پہلے ختم ہو گئیں، یا ThunderPhone کی ٹاسک آؤٹ کم ریٹ دوسری پلیٹ فارم کی شرح سے مقررہ فرق سے زیادہ کم ہو گئی۔ ہر رول بیک پر ایک بار، نان بلاکنگ۔ اس کے بعد ThunderPhone کا حصہ 0% ہوتا ہے اور مائیگریشن اس وقت تک موقوف رہتی ہے جب تک کوئی شخص اسے ایجنٹ کے مائیگریشن ٹیب میں دوبارہ شروع نہ کر دے۔ پے لوڈ میں کوئی فون نمبر، ٹرانسکرپٹس یا کال IDs شامل نہیں ہوتے۔

{
  "data": {
    "agent_id": 42,
    "agent_name": "Front desk",
    "dropped": 0,
    "migration_id": "5f0c2a9e-7b1d-4c3e-8a6f-2d9e1b4c7a30",
    "ours": {
      "graded": 20,
      "success_rate": 0.8
    },
    "ours_failed": 3,
    "ours_percent": 0,
    "previous_percent": 25,
    "reason": "ours_failed_burst",
    "rolled_back_at": "2026-10-10T12:05:00+00:00",
    "step": 1,
    "theirs": {
      "graded": 20,
      "success_rate": 0.8
    },
    "vendor": "retell"
  },
  "event_id": "3d1f6b2a-8c4e-5a7b-9d0e-2f1a3b4c5d6e",
  "type": "migration.rollback"
}
فیلڈقسمتفصیل
migration_idUUIDمائیگریشن
vendorstringretell، vapi، elevenlabs، یا bland
reasonstringours_failed_burst (15 منٹ میں 3 ناکام کنکشنز)، dropped_calls (30 منٹ کے اندر ایجنٹ کے جواب دینے سے پہلے ختم ہونے والی 2 کالز)، یا rate_gap (ہر طرف کم از کم rollback_min_calls گریڈ شدہ کالز پر ٹاسک آؤٹ کم ریٹ کا فرق)
previous_percentintegerرول بیک سے پہلے کالز میں ThunderPhone کا حصہ
ours_percentintegerہمیشہ 0
stepinteger | nullشیڈول کا وہ مرحلہ جس پر یہ تھا (0 سے شروع)
ours / theirsobject | nullموجودہ مرحلے میں گریڈ شدہ کالز اور ان کی کامیابی کی شرح؛ اگر مرحلے میں کالز کم ہوں تو theirs گزشتہ 30 دنوں کا ہو سکتا ہے۔ جب کوئی کال نہ ہو تو null
ours_failedintegerگزشتہ 15 منٹ میں شمار کیے گئے ناکام کنکشنز
droppedintegerگزشتہ 30 منٹ میں ڈراپ شمار کی گئی کالز
rolled_back_attimestamp

متعلقہ