שיחה יוצאת#
התראה מסוג זה נוצרת בעת שיחה יוצאת ומכילה מידע על יוזם השיחה ועל משתתפיה.
הגדרת המופע
כדי לקבל התראות נכנסות על שיחות יוצאות, יש להפעיל את ההגדרות באחת מהדרכים הבאות:
-
דרך הקונסולה יש להפעיל את ההגדרה
קבלת התראות על שיחות יוצאות -
דרך השיטה SetSettings יש להפעיל את ההגדרה
outgoingCallWebhook
התראה#
פורמט ההתראה#
| פרמטר | סוג | תיאור |
|---|---|---|
typeWebhook | string | סוג ההתראה הנכנסת. עבור התראות מסוג זה, השדה מקבל את הערך outgoingCall |
instanceData | object | אובייקט נתונים עם מידע על המופע |
timestamp | integer | זמן התרחשות האירוע בפורמט UNIX |
idMessage | string | מזהה השיחה היוצאת |
from | string | מזהה הצ'אט שבו בוצעה השיחה |
isVideo | boolean | דגל המציין אם זו הייתה שיחת וידאו |
duration | integer | משך השיחה בשניות |
status | string | סטטוס השיחה. יכול לקבל את הערכים הבאים: |
pickUp - לפחות משתתף אחד ענה לשיחה | ||
hungUp - אף אחד מהמשתתפים לא ענה לשיחה, או שלמספר שאליו בוצעה השיחה אין חשבון WhatsApp | ||
invalid - לא ניתן היה להשלים את השיחה או לעבד את הסטטוס. לדוגמה, המספר שאליו בוצעה השיחה אינו קיים | ||
participants | array | סטטוס השיחה עבור כל משתתף. בשיחות פרטיות השדה יכיל אובייקט אחד בלבד |
שדות האובייקט instanceData
| פרמטר | סוג | תיאור |
|---|---|---|
idInstance | integer | מזהה המופע. גודל ה-integer הוא int64. הערכים נעים בין 1 ל-10 ספרות |
wid | string | מזהה החשבון בפורמט WhatsApp |
typeInstance | string | סוג המסנג'ר של המופע |
שדות האובייקט participants
| שדה | סוג | תיאור |
|---|---|---|
id | string | מזהה הצ'אט הפרטי של משתתף השיחה |
status | string | סטטוס השיחה אצל משתתף מסוים. יכול לקבל את הערכים הבאים: |
pickUp - המשתתף ענה לשיחה | ||
hungUp - המשתתף לא ענה לשיחה, או שהמספר שאליו בוצעה השיחה אינו קיים | ||
declined - המשתתף דחה את השיחה | ||
invalid - לא ניתן היה להשלים את השיחה או לעבד את הסטטוס |
דוגמה לגוף ההתראה#
{
"typeWebhook": "outgoingCall",
"instanceData": {
"idInstance": 1101ХХХХХХ,
"wid": "7ХХХХХХХХХХ@c.us",
"typeInstance": "whatsapp"
},
"timestamp": 1768888295,
"idMessage": "AC88AD4AA553FCBB95BEB6BF98F704B1",
"from": "16381924658ХХХ@c.us",
"isVideo": false,
"duration": 0,
"status": "hungUp",
"participants": [
{
"id": "16381924658ХХХ@c.us",
"status": "hungUp"
}
]
}