Outgoing message status#
Webhook נכנס מסוג זה מכיל את הסטטוס של הודעה שנשלחה בעבר: נשלחה, נמסרה, קראה וכו'.
כדי לקבל הודעות לגבי סטטוסים של שליחה/מסירה/קבלות קריאה של הודעות שנשלחו מטלפון נייד, יש צורך להפעיל את ההגדרות הבאות:
outgoingMessageWebhookoutgoingWebhook
Webhook#
Webhook פרמטרים#
| פָּרָמֶטֶר | סוּג | תֵאוּר |
|---|---|---|
typeWebhook | string | Incoming webhook type. עבור webhooks מסוג זה הפרמטר מקבל את הערך outgoingMessageStatus |
chatId | string | Chat Id. צ'אט עם הודעה שעבורה קיבלת את הסטטוס. |
instanceData | object | נתוני מופע |
timestamp | integer | חותמת זמן לאירוע בפורמט UNIX |
idMessage | string | מזהה הודעה יוצאת או קובץ. מזהה הודעה יוצאת מוחזר לפי שיטות: SendMessage, SendFileByUrl, SendFileByUpload, SendLocation, SendContact, SendPoll |
status | string | מצב הודעה יוצאת או קובץ. המצב מקבל את הערכים: |
sent - הודעה נשלחה | ||
delivered - הודעה שנמסרה לנמען | ||
read - הודעה שנקראה/נצפה/נשמעה על ידי הנמען | ||
failed - אירעה שגיאה בעת שליחת הודעה לשרת WhatsApp (לא ניתן לבטל מצב זה בהגדרות SetSettings, יש צורך ליישם את העיבוד של הודעה זו) | ||
noAccount - למספר הטלפון של הנמען אין חשבון WhatsApp (לא ניתן לבטל את הסטטוס הזה בהגדרות SetSettings, יש צורך ליישם את העיבוד של הודעה זו) | ||
notInGroup - השולח אינו משתתף בצ'אט קבוצתי שאליו נשלחת ההודעה | ||
yellowCard - השעיית שליחת הודעות עקב פעילות ספאם. הודעות שנשלחות לאחר קבלת הסטטוס נשמרות בתור לשליחה למשך 24 שעות. כדי להמשיך להפעיל את המופע, עליך לבצע א reboot of the instance. | ||
description | string | תיאור שגיאה (מומלץ ליידע את המפעיל על שגיאות מערכת) |
sendByApi | boolean | האם ההודעה נשלחת דרך API: true , false |
instanceData פרמטרים של אובייקט
| פָּרָמֶטֶר | סוּג | תֵאוּר |
|---|---|---|
idInstance | integer | זיהוי מופע גודל המספר השלם הוא int64. טווח הערכים כולל בין 1 ל-10 ספרות |
wid | string | זיהוי חשבון בפורמט WhatsApp |
typeInstance | string | סוג שליח מופע |
Webhook body example#
{
"typeWebhook": "outgoingMessageStatus",
"chatId": "71234567890@c.us",
"instanceData": {
"idInstance": 1234,
"wid": "11001234567@c.us",
"typeInstance": "whatsapp"
},
"timestamp": 1586700802,
"idMessage": "3EB0608D6A2901063D63",
"status": "noAccount",
"description":"SWE004: the number of participants in the group has been exceeded - 706", // 706 - the number of participants in the group
"sendByApi": true
}