GetIncomingStatuses#
Beta version
The functionality is in beta mode. Features are subject to change and may also work unstably. There may be additional charges for functionality in the future.
השיטה מחזירה את הודעות המצב הנכנסות של המופע. במצב ברירת המחדל מוחזרות הודעות המצב הנכנסות למשך 24 שעות.
ניתן לקבל סטטוסים רק ממספרים ברשימת אנשי הקשר.
רשימת אנשי הקשר מאוחזרת באמצעות השיטה GetContacts המבוססת על השדה
contactName
. כדי לקבל רשימת אנשי קשר מעודכנת, עליך לשנות את שם איש הקשר ולאשר מחדש על ידי סריקה מחדש של קוד ה-QR.
בקשה#
כדי לקבל סטטוסים נכנסים, עליך לבצע בקשה בכתובת:
{{apiUrl}}/waInstance{{idInstance}}/getIncomingStatuses/{{apiTokenInstance}}
For apiUrl
, idInstance
and apiTokenInstance
request parameters, refer to Before you start section.
פרמטרים של בקשת כתובת אתר#
פרמטר | הקלד | חובה | תיאור |
---|---|---|---|
דקות | integer | לא | זמן בדקות שעבורו יש להציג את הודעות המצב (ברירת המחדל היא 1440 דקות) |
תגובה#
פרמטרי תגובה#
מערך אובייקטים עם פרמטרים:
פרמטר | הקלד | תיאור |
---|---|---|
סוג | **string* | סוג הודעה, נכנסת - הודעה נכנסת |
idMessage | **string* | מזהה הודעה נכנסת |
חותמת זמן | integer | זמן קבלת הודעה בפורמט UNIX |
typeMessage | **string* | סוג הודעה, גרסאות אפשריות: |
extendedTextMessage - הודעת טקסט מורחבת | ||
imageMessage - הודעת תמונה | ||
videoMessage - הודעת וידאו | ||
audioMessage - הודעת שמע | ||
chatId | **string* | שולח הודעה צ'אט מזהה |
senderId | **string* | שולח ההודעה Id |
SenderName | **string* | שם שולח ההודעה |
senderContactName | **string* | שם שולח ההודעה לפי רשימת אנשי הקשר של החשבון הנוכחי |
הודעת טקסט | **string* | הודעת טקסט, if typeMessage = extendedTextMessage |
כתובת אתר להורדה | **string* | קישור להורדת קובץ, אם typeMessage = imageMessage /videoMessage /audioMessage |
כיתוב | **string* | כיתוב קובץ, אם typeMessage = imageMessage /videoMessage |
שם קובץ | **string* | שם הקובץ, אם typeMessage = imageMessage /videoMessage /audioMessage . השדה נוצר אוטומטית |
jpeg Thumbnail | **string* | תצוגה מקדימה של תמונה מקודדת base64 , אם typeMessage = imageMessage /videoMessage |
mimeType | **string* | סוג הקובץ לפי סוגי מדיה, אם typeMessage = imageMessage / videoMessage /audioMessage |
extendedTextMessage | object | אובייקט הודעת טקסט (מורחב), אם typeMessage = extendedTextMessage |
פרמטרים של אובייקט extendedTextMessage
:
פרמטר | הקלד | תיאור |
---|---|---|
טקסט | **string* | טקסט הודעה |
צבע רקע | **string* | צבע רקע. ערך ברירת מחדל: #FFFFFF . אתר לדוגמא לקבלת ערך צבע הרקע |
גופן | **string* | גופן טקסט. מקבל ערכים: |
SERIF - כך ייראה הטקסט שלך | ||
SANS_SERIF - כך ייראה הטקסט שלך | ||
NORICAN_REGULAR - כך ייראה הטקסט שלך | ||
BRYNDAN_WRITE - כך ייראה הטקסט שלך | ||
OSWALD_HEAVY - כך ייראה הטקסט שלך |
גוף לדוגמא תגובה{#response-example-body}#
[
{
"type": "incoming",
"idMessage": "1E1A12D337F2BFA5FC0000000000000",
"timestamp": 1710232595,
"typeMessage": "extendedTextMessage",
"chatId": "70000000001@c.us",
"textMessage": "Good day!",
"extendedTextMessage": {
"text": "Good day!",
"backgroundColor": "#228B22",
"font": "SANS_SERIF"
},
"senderId": "70000000001@c.us",
"senderName": "Reachel",
"senderContactName": "Reachel's whatsapp",
},
{
"type": "incoming",
"idMessage": "38E322274FDEBA56047000000000000",
"timestamp": 1710232636,
"typeMessage": "imageMessage", // "videoMessage" / "audioMessage"
"chatId": "70000000001@c.us",
"downloadUrl": "https://sw-media.storage.greenapi.net/1101000000/dcf81410-bdbc-4aed-bf23-d1845c000000.jpg",
"caption": "Good day!",
"fileName": "dcf81410-bdbc-4aed-bf23-d1845cd74754.jpg",
"jpegThumbnail": "/9j/2wCEABALDA4MChAODQ4SERATGCgaGBYWGDEjJ",
"mimeType": "image/jpeg",
"senderId": "70000000001@c.us",
"senderName": "Reachel",
"senderContactName": "Reachel's whatsapp",
}
]
GetIncomingStatuses שגיאות#
לרשימה של שגיאות משותפות לכל השיטות, עיין בסעיף שגיאות נפוצות
דוגמאות לבקשות#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/getIncomingStatuses/{{apiTokenInstance}}"
payload = {}
headers= {}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getIncomingStatuses/{{apiTokenInstance}}?minutes=3240'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getIncomingStatuses/")
.append({{apiTokenInstance}});
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getIncomingStatuses/")
.append({{apiTokenInstance}});
var response = Unirest.get(requestUrl.toString())
.header("Content-Type", "application/json")
.asString();
System.out.println(response);