پرش به مطلب اصلی

IVR API

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

پارامترها کامپوننت

  • API Address: آدرس وب‌‌سرویس برای اطلاع از شماره داخلی مقصد.

  • Announcement: فایل صوتی که در ورود به IVR پخش می‌گردد.

  • Timeout Announcement: پیامی که هنگام Timeout شدن پخش‌ می‌شود.

  • Invalid Announcement: پیامی که هنگام واردکردن شماره اشتباه از سوی تماس‌‌گیرنده پخش‌ می‌شود.

  • Enable Direct Dial: درصورت فعال‌‌بودن، تماس‌‌گیرنده‌ می‌تواند شماره داخلی یکی از کاربران تعریف‌شده در سیستم را بگیرد.

  • Repeat Loop: تعداد تکرار IVR‌ است (درصورت واردنشدن عدد از طرف تماس‌‌گیرنده).

  • Timeout (Sec): مدت زمانی که فرصت داده‌ می‌شود تا پس از واردشدن عدد اول، عدد دوم (برحسب ثانیه) وارد گردد. مقدار صفر قابليت timeout را غيرفعال مي‌كند.

  • Max Digits: حداکثر رقم‌‌هایی که تماس‌‌گیرنده‌ می‌تواند وارد کند.

  • Case: عددی است که اگر کاربر وارد کند خروجی مربوطه اجرا‌ می‌گردد.

  • Text: نامی است که تنها برای نمایش در ظاهر کامپوننت استفاده‌ می‌شود و‌ می‌توان برای سهولت در دسترسی از آن استفاده کرد.

قالب وب‌‌سرویس

با‌توجه به مقادیر منوی تنظیمات مربوط به API Method & API Version، آدرس وب‌سرویس فراخوانی شده و داده‌های زیر همراه با آن ارسال می‌گردند.

  • src: شماره تماس‌‌گیرنده (Caller یا CID).
  • dst: شماره واردشده (Callee یا DID یا Exten).
  • data: داده‌‌ای که تماس‌‌گیرنده در مسیر تماس وارد کرده است (مثلاً داده‌‌ای که در IVR وارد کرده است).
  • unique_id: شناسه یکتای تماس.
  • app_name: نام کامپوننت جاری.

و در جواب، خروجی زیر را به‌صورت json دریافت‌ می‌کند.

{
"ok": "1",
"case": "3"
}

در نهایت تماس از خروجی مورد نظر (در اینجا 3) خارج‌ می‌شود.