Incoming call#
Webhook מסוג זה מופיע כאשר יש שיחה נכנסת ומכיל מידע על יוזם ונמען השיחה.
Webhook#
פרמטרים של Webhook#
| פרמטר | הקלד | תֵאוּר | 
|---|---|---|
| מ | **string* | יוזם השיחה Id | 
| typeWebhook | **string* | סוג webhook נכנס. עבור webhooks מסוג זה הפרמטר מקבל את הערך incomingCall | 
| instanceData | object | נתוני מופע | 
| סטטוס | **string* | הסטטוס של שיחה נכנסת, הוא מקבל את הערכים הבאים: | 
| הצעה- שיחה נכנסת | ||
| איסוף- ענה לשיחה נכנסת | ||
| ניתוק- מקבל השיחה הנכנסת לא הרים את הטלפון וניתק, פונקציית "נא לא להפריע" מופעלת בטלפון | ||
| חסר- יוזם השיחה ביטל את השיחה | ||
| נדחה- שיחה נכנסת שלא נענתה | ||
| חותמת זמן | integer | חותמת זמן לאירוע בפורמט UNIX | 
| idMessage | **string* | זיהוי שיחה נכנסת | 
פרמטרי אובייקט 'instanceData'
| פרמטר | הקלד | תיאור | 
|---|---|---|
| idInstance | integer | מזהה מופע גודל המספר השלם הוא int64. טווח הערכים כולל בין 1 ל-10 ספרות | 
| wid | **string* | זיהוי חשבון בפורמט WhatsApp | 
| typeInstance | **string* | סוג שליח מופע | 
סטטוסי שיחה
כאשר מתקבלת שיחה נכנסת, המערכת מייצרת שתי התראות ברצף:
- ההתראה הראשונה עם הסטטוס הצעה, המציינת שהתקבלה שיחה נכנסת חדשה.
- התראה שנייה עם סטטוס 'איסוף', 'ניתוק', 'פספס' או 'נדחה', בהתאם לתוצאות השיחה.
תרחיש לקבלת הודעות:
- הצעה+- איסוף- שיחה נכנסת מוצלחת, הנמען ענה לשיחה
- הצעה+- ניתוק- שיחה נכנסת לא נענתה, הנמען קטע את החיבור או שהפונקציה "נא לא להפריע" הופעלה בטלפון (ניתק)
- הצעה+- חסרה- שיחה נכנסת שלא נענתה, היוזם קטע את החיבור (המתקשר סיים את השיחה)
- הצעה+- נדחה- שיחה נכנסת שלא נענתה, האפליקציה ניתקה את החיבור עקב פסק זמן (Whatsapp סיימה את השיחה)
Webhook body example#
{
  "from": "79001234500@c.us",
  "typeWebhook": "incomingCall",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "status": "pickUp",
  "timestamp": 1617691757,
  "idMessage": "104179EDB7F5328988D8834107EEBE50"
}