ساختار ورودی و خروجی وب‌هوک

جهت تبادل داده ساخت‌یافته و دقیق، داده‌های ارسالی از سمت پشتیار و پاسخی که سرور شما برمی‌گرداند از استاندارد JSON Schema پیروی می‌کند.

ساختار درخواست ارسالی به سرور شما (Incoming Webhook Payload)

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

{
  "call_id": "66f10d2a8417d3b5b7654321",
  "caller_number": "09123456789",
  "operator_id": "66f10c3b8417d3b5b1234567",
  "arguments": {
    "order_id": "4920",
    "customer_zip": "1997834521"
  }
}

فرمت پاسخ مورد انتظار (Expected Response Payload)

پاسخ سرور شما باید یک ساختار JSON استاندارد با کد وضعیت 200 OK باشد:

پاسخ موفقیت‌آمیز (200 OK)

{
  "success": true,
  "result": {
    "status_fa": "ارسال شده",
    "tracking_code": "981240123",
    "shipping_company": "تیپاکس",
    "estimated_delivery": "فردا ساعت ۱۴ تا ۱۸"
  },
  "message": "اطلاعات سفارش با موفقیت یافت شد"
}

پاسخ عدم یافتن داده یا خطا

چنانچه رکوردی یافت نشد، مقدار success: false را به همراه پیام توضیحی ارسال نمایید تا هوش مصنوعی پیام مناسب را به مخاطب اعلام کند:

{
  "success": false,
  "error": "شماره سفارش ۴۹۲۰ در سیستم یافت نشد. لطفاً از مشتری بخواهید شماره سفارش را مجدداً بررسی نماید."
}

محدودیت زمان پاسخ‌دهی (Timeout)

• حداکثر زمان پاسخگویی (Timeout): ۳ ثانیه.
• در صورتی که پاسخگویی وب‌هوک بیش از ۳ ثانیه زمان ببرد، هوش مصنوعی بدون قطع تماس به مخاطب اعلام می‌کند که پاسخ از سامانه با تاخیر مواجه شد.
• توصیه: از ایندکس‌گذاری دیتابیس و کشینگ سرور برای تضمین زمان پاسخ زیر ۵۰۰ میلی‌ثانیه استفاده فرمایید.