GetOutgoingStatuses#

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 שעות.

כדי לקבל את יומן ההודעות שנשלחו מהטלפון, עליך להפעיל את ההגדרה 'קבלת חיבורים באינטרנט על סטטוסים של הודעות שנשלחו' בשיטת ה-SetSettings או דרך קונסול (הודעות שהתקבלו לפני הפעלת הגדרה זו לא ייכללו ביומן ההודעות היוצאות).

ייתכן שיחלפו עד 5 דקות עד שההגדרות ייכנסו לתוקף.

ניתן לקבל סטטוסים רק ממספרים ברשימת אנשי הקשר.

רשימת אנשי הקשר מאוחזרת באמצעות השיטה GetContacts המבוססת על השדה contactName. כדי לקבל רשימת אנשי קשר מעודכנת, עליך לשנות את שם איש הקשר ולאשר מחדש על ידי סריקה מחדש של קוד ה-QR.

סטטוסים נשלחים רק ל-1024 אנשי הקשר הראשונים מהשיטה GetContacts עם שדה contactName חוקי.

בקשה#

כדי לקבל סטטוסים יוצאים, עליך לבצע בקשה בכתובת:

GET

{{apiUrl}}/waInstance{{idInstance}}/getOutgoingStatuses/{{apiTokenInstance}}

לפרמטרים של בקשת apiUrl, idInstance ו-apiTokenInstance, עיין בסעיף לפני שתתחיל.

פרמטרים של בקשת כתובת אתר#

פרמטר	הקלד	חובה	תיאור
`דקות`	integer	לא	זמן בדקות שעבורו יש להציג את הודעות המצב (ברירת המחדל היא 1440 דקות)

תגובה#

פרמטרי תגובה#

מערך אובייקטים עם פרמטרים:

פרמטר	הקלד	תיאור
`סוג`	*string	סוג הודעה, `יוצא` - הודעה יוצאת
`idMessage`	*string	מזהה הודעה יוצאת
`חותמת זמן`	integer	זמן הפעולה האחרונה בהודעה בפורמט UNIX
`statusMessage`	*string	מצב הודעה יוצאת, גרסאות אפשריות:
		`בהמתנה` - נשלח
		`שלח` - נשלח
		`נמסר` - נמסר
		`קרא` - קרא/נראה/שמע
`sendByApi`	בוליאנית	האם ההודעה נשלחה דרך API
`typeMessage`	*string	סוג הודעה, גרסאות אפשריות:
		`extendedTextMessage` - הודעת טקסט מורחבת
		`imageMessage` - הודעת תמונה
		`videoMessage` - הודעת וידאו
		`audioMessage` - הודעת שמע
`chatId`	*string	שולח הודעה צ'אט מזהה
`משתתפים`	array	מערך של מחרוזות עם מזהי איש קשר עבורם הסטטוס יהיה זמין. אם ערך השדה ריק, `"משתתפים": []`, הסטטוס יהיה זמין לכל אנשי הקשר. ברירת המחדל היא `[]` אם `"sendByApi"` = `false`
`הודעת טקסט`	*string	הודעת טקסט, if `typeMessage` = `textMessage`
`כתובת אתר להורדה`	*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` - כך ייראה הטקסט שלך
`משתתפים`	array	מערך של מחרוזות עם מזהי איש קשר עבורם הסטטוס יהיה זמין. אם ערך השדה ריק, `"משתתפים": []`, הסטטוס יהיה זמין לכל אנשי הקשר. ברירת המחדל היא `[]` אם `"sendByApi"` = `false`

גוף לדוגמא תגובה#

[
    {
        "type": "outgoing",
        "idMessage": "BAE5018000000000",
        "timestamp": 1710134811,
        "typeMessage": "extendedTextMessage",
        "chatId": "70000000001@c.us",
        "textMessage": "I use Green-API to send this Status!",
        "extendedTextMessage": {
            "text": "I use Green-API to send this Status!",
            "backgroundColor": "#228B22",
            "font": "SERIF",
            "participants": [ 
                "70000000001@c.us",
                "70000000002@c.us" // status will be available only to the specified contacts
            ]
        },
        "statusMessage": "read",
        "sendByApi": true
    },
    {
        "type": "outgoing",
        "idMessage": "BAE5207000000000",
        "timestamp": 1710134814,
        "typeMessage": "imageMessage", // "videoMessage" / "audioMessage"
        "chatId": "70000000001@c.us",
        "participants": [], // status available for everyone
        "downloadUrl": "https://sw-media.storage.greenapi.net/1101000000/dcf81410-bdbc-4aed-bf23-d1845c000000.jpg",
        "caption": "I use Green-API to send this Status!",
        "fileName": "dcf81410-bdbc-4aed-bf23-d1845cd74754.jpg",
        "jpegThumbnail": "/9j/2wCEABALDA4MChAODQ4SERATGCgaGBYWGDEjJ",
        "mimeType": "image/jpeg",
        "statusMessage": "read",
        "sendByApi": true
    }
]

GetOutgoingStatuses שגיאות#

לרשימה של שגיאות משותפות לכל השיטות, עיין בסעיף שגיאות נפוצות

בקש דוגמאות#

PythoncURLJava - SpringJava - Unirest

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/getOutgoingStatuses/{{apiTokenInstance}}"

payload = {}
headers= {}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getOutgoingStatuses/{{apiTokenInstance}}?minutes=3240'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getOutgoingStatuses/")
    .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("/getOutgoingStatuses/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);