incomingCall#
הודעה מסוג זה נוצרת בעת שיחה נכנסת ומכילה מידע על יוזם השיחה ועל הנמען.
הגדרת מופע
כדי לקבל התראות על שיחות נכנסות, יש להפעיל את ההגדרות באחת מהדרכים הבאות:
-
דרך האזור האישי הפעל את ההגדרות
קבל התראות על הודעות וקבצים נכנסיםוקבל התראות על שיחות -
דרך המתודה SetSettings הפעל את ההגדרות
incomingWebhookו-incomingCallWebhook
התראה#
פורמט ההתראה#
| תיאור | סוג | פרמטר |
|---|---|---|
from | string | מזהה יוזם השיחה |
typeWebhook | string | סוג ההתראה הנכנסת. incomingCall עבור הודעות מסוג זה, השדה מקבל את הערך |
instanceData | object | אובייקט נתונים עם מידע על המופע |
status | string | סטטוס השיחה הנכנסת, יכול לקבל את הערכים: |
offer - שיחה נכנסת | ||
pickUp - שיחה נכנסת שנענתה | ||
hungUp - הנמען של השיחה הנכנסת ניתק את השיחה, או שבטלפון הופעלה פונקציית "לא להפריע" | ||
missed - declined יוזם השיחה ביטל את השיחה. סטטוס זה מיושן, ובמקומו יגיע | ||
declined - שיחה שלא נענתה או שיחה שיוזמה בוטלה על ידי המתקשר | ||
timestamp | integer | זמן התרחשות האירוע בפורמט UNIX |
idMessage | string | מזהה השיחה הנכנסת |
instanceData שדות אובייקט
| פרמטר | סוג | תיאור |
|---|---|---|
idInstance | integer | מזהה המופע. גודל integer הוא int64. הערכים נעים בין 1 ל-10 ספרות |
wid | string | מזהה החשבון בפורמט |
typeInstance | string | סוג המסנג'ר עבור המופע |
סטטוסי שיחה
:בשיחה נכנסת, המערכת יוצרת ברצף שתי התראות
- ההתראה הראשונה עם סטטוס
offer, המציינת התקבלה של שיחה נכנסת חדשה. - ההתראה השנייה עם סטטוס
pickUp,hungUpאוdeclined, בהתאם לתוצאת השיחה.
תרחיש קבלת ההתראות:
offer+pickUp- שיחה נכנסת מוצלחת, הנמען ענה לשיחהoffer+hungUp- שיחה נכנסת שלא נענתה, הנמען ניתק את השיחה או שבטלפון הופעלה פונקציית "לא להפריע" (הניחו את הטלפון)offer+declined- שיחה נכנסת שלא נענתה, היוזם ניתק את השיחה (המתקשר סיים את השיחה)offer+declined- שיחה נכנסת שלא נענתה, האפליקציה סיימה את השיחה עקב חריגה מזמן קצוב (WhatsApp סיים את השיחה)
דוגמה לגוף התראה#
{
"from": "79001234500@c.us",
"typeWebhook": "incomingCall",
"instanceData": {
"idInstance": 1101123456,
"wid": "79876543210@c.us",
"typeInstance": "whatsapp"
},
"status": "pickUp",
"timestamp": 1617691757,
"idMessage": "104179EDB7F5328988D8834107EEBE50"
}