معرفی قابلیت Web hook و آموزش استفاده از آن

تیم تحرریه

2 سال پیش

راهنمای رویداد‌های ارسال شده :

همه رویداد ها در وب‌هوک ( WEB HOOK ) مرکز تلفن ابری همکاران، با فرمت JSON به URL تنظیمی شما ارسال میگردد. در این مستند رویداد‌‌های ارسالی را به تفصیل توضیح خواهیم داد.

۱-رویداد event_name

این رویداد در وب هوک ( WEB HOOK ) تلفن ابری همکاران، معمولاً در زمان تماس ورودی و خروجی اتفاق میفتد، همچنین زمان پاسخ‌دهی به تماس هم این رویداد نمایش داده می‌شود.

{
  "event_name": "Newstate", 
  "type": "incoming_call",
  "source": "09056466394", 
  "destination": "s",
  "chanel": "SIP/1391010124-00000763", 
  "channel_state": "6",
  "channel_state_desc": "Up",
  "Context": "ivr-78",
  "uniq": "1625071719.3397" 
}

event_name

نام رویداد می‌باشد. Newstate جهت وضعیت تماس، Hangup جهت قطع شدن یک مسیر ارتباطی، CDR جهت دادن اطلاعات تکمیلی یک جریان تماس.

type

نمایانگر نوع تماس می‌باشد. incoming_call برای تماس‌های ورودی و outgoing_call برای تماس‌های خروجی.

source

نمایانگر منبع تماس ورودی و یا خروجی می‌باشد. معمولاً شماره داخلی، نام ivr و یا شماره تماس‌گیرنده را نمایش می‌دهد

destination

نمایانگر مقصد تماس ورودی و یا خروجی می‌باشد. معمولاً شماره داخلی، نام ivr و یا شماره تماس‌گیرنده را نمایش می‌دهد

chanel

نمایانگر کانالی هست که در آن رویداد رخ‌داده است.

channel_state

نمایانگر یک کد عددی برای وضعیت فعلی کانال است

channel_state_desc

نمایانگر نام وضعیت فعلی کانال است و شامل موارد زیر می‌باشد:
Down
Rsrvd
OffHook
Dialing
Ring
Ringing
Up
Busy
Dialing Offhook
Pre-ring
Unknown

Context

نمایانگر زمینه رویداد می‌باشد.

uniq

یک شماره منحصربه‌فرد که به این چرخه تماس داده می‌شود، این شماره برای همه رویدادهای مرتبط با یک تماس ثابت است.

۲- رویداد Hangup

این رویداد در وب هوک ( WEB HOOK ) تلفن ابری همکاران، زمانی که یک جریان تماسی قطع می‌شود، اطلاعات آن را ارسال می‌نماید.

{
  "event_name": "Hangup", 
  "chanel": "SIP/1391010124-00000764",  
  "CallerIDNum": "09056466394",
  "ConnectedLineNum": "136102",
  "Context": "ext-queues",
  "uniq": "1625071789.3398"
}

event_name

chanel

نمایانگر کانالی هست که در آن رویداد رخ‌داده است.

CallerIDNum

نمایانگر کالر ایدی تماس می‌باشد.

ConnectedLineNum

نمایانگر شماره داخلی یا خارجی است که به آن متصل شده‌اید است.

Context

نمایانگر زمینه رویداد می‌باشد.

uniq

یک شماره منحصربه‌فرد که به این چرخه تماس داده می‌شود، این شماره برای همه رویدادهای مرتبط با یک تماس ثابت است.

۳- رویداد CDR

این رویداد در وب هوک ( WEB HOOK ) تلفن ابری همکاران، پس از پایان یک تماس ارسال می‌شود، و اطلاعات تجمیعی تماس از جمله زمان شروع و پایان آن را در اختیار شما می‌گذارد.

{
  "event_name": "Cdr",
  "source": "",
  "destination": "09373608119",
  "chanel": "SIP/135102-00000819",
  "destinationChannel": "SIP/2191010494-0000081a",
  "disposition": "NO ANSWER",
  "LastApplication": "Dial",
  "LastData": "SIP/2191010494/09373608119,300,Tb(func-apply-sipheaders^s^1,(38))U(sub-send-obr",
  "BillableSeconds": "0",
  "duration": "13",
  "type": "outgoing_call",
  "StartTime": "2021-07-01 11:45:24",
  "AnswerTime": "",
  "EndTime": "2021-07-01 11:45:37",
  "Duration": "13",
  "uniq": "1625123724.3765"
}

event_name

source

نمایانگر منبع تماس ورودی و یا خروجی می‌باشد. معمولا شماره داخلی، نام IVR و یا شماره تماس گیرنده را نمایش می‌دهد

destination

نمایانگر مقصد تماس ورودی و یا خروجی می‌باشد. معمولاً شماره داخلی، نام IVR و یا شماره تماس‌گیرنده را نمایش می‌دهد

chanel

نمایانگر کانالی هست که در آن رویداد رخ‌داده است.

destinationChannel

نمایانگر کانال مقصد می‌باشد.

disposition

آخرین وضعیت شناسایی‌شده جریان تماس که شامل این موارد است:
NO ANSWER : کانال پاسخ داده نشده است. این حالت پیش فرض است.
FAILED : کانال سعی کرده شماره گیری کند اما تماس ناموفق بود.
BUSY : کانال سعی کرده شماره گیری کند اما مقصد مشغول بود.
ANSWERED : کانال پاسخ داده شده است. علت قطع کردن دیگر بر وضع CDR تأثیر نخواهد گذاشت.
CONGESTION :کانال سعی کرد شماره گیری کند اما خطوط شبکه شلوغ بودن.

LastApplication

آخرین برنامه‌ای که اجراشده است.

LastData

آخرین پارامترهای که به برنامه اجرای تماس داده‌شده است.

BillableSeconds

زمان زنگ خوردن به ثانیه، از زمانی که جریان پاسخ‌داده‌شده است تا زمانی که جریان قطع‌شده است.

duration

مدت‌زمان به ثانیه از زمانی که جریان شروع‌شده تا زمانی که جریان قطع‌شده است.

type

نمایانگر نوع تماس می‌باشد. incoming_call برای تماس‌های ورودی و outgoing_call برای تماس‌های خروجی.

StartTime

تاریخ و زمان شروع جریان تماس.

AnswerTime

تاریخ و زمان شروع پاسخ دادن به جریان تماس.

EndTime

تاریخ و زمان پایان جریان تماس.

uniq

یک شماره منحصربه‌فرد که به این چرخه تماس داده می‌شود، این شماره برای همه رویدادهای مرتبط با یک تماس ثابت است.

جهت راه‌اندازی Web Hook در تلفن ابری همکاران از طریق فرم‌های زیر با ما ارتباط بگیرید.

ارسال درخواست راه‌اندازی

اگر شما درخواست ست شدن WEB HOOK را دارید، از طریق فرم زیر درخواست خود را برای ما ارسال نمایید.

برای مشاهده و ارسال فرم به برگه کامل بروید.

ارسال درخواست مشاوره

اگر سایت و یا CRM شما این قابلیت را در اختیار شما قرار نمیدهد، نگران نباشد. مشاورین ما بهترین راه برای استفاده از این امکان را در اختیار شما قرار میدهند. پس از طرق فرم زیر درخواست مشاوره برای ما ارسال کندی.

برای مشاهده و ارسال فرم به برگه کامل بروید.

سوالات متداول

قابلیت استفاده از وب‌هوک ( WEB HOOK ) در کدام یک از اشتراک‌ها موجود است ؟

این قابلیت از اشتراک طرح دو به بالا قابل ارائه می‌باشد.

آیا خدمات پشتیبانی راه‌اندازی این قابلیت در نرم‌افزار‌های شخص ثالث امکان پذیر است ؟

بله، جهت این امکان با همکاران واحد فروش ما ارتباط بگیرید.

از زمان ارسال درخواست تا راه‌اندازی چقدر زمان می‌برد ؟

انجام این درخواست حداکثر دو روز کاری زمان‌بر خواهد بود.

راجع به وب‌هوک اطلاعات بیشتری را نیاز دارم.

جهت کسب اطلاعات بیشتر راجع به به وب هوک به اینجا مراجعه کنید.