GetGroupData#
השיטה מקבלת נתוני צ'אט קבוצתי.
בַּקָשָׁה#
כדי לקבל נתוני צ'אט קבוצתי, עליך לבצע בקשה בכתובת:
POST
{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}
עבור apiUrl, idInstance ו-apiTokenInstance, עיין ב לפני שמתחילים סָעִיף.
בקש פרמטרים#
| פָּרָמֶטֶר | סוּג | הֶכְרֵחִי | תֵאוּר |
|---|---|---|---|
groupId | string | כֵּן | זיהוי צ'אט קבוצתי |
בקש דוגמה לגוף#
{
"groupId": "11001234567-1587570015@g.us"
}
בַּקָשָׁה#
בקש פרמטרים#
| פָּרָמֶטֶר | סוּג | תֵאוּר |
|---|---|---|
groupId | string | |
owner | string | בעל קבוצה Id |
subject | string | שם הקבוצה |
creation | number | זמן יצירת קבוצה בפורמט יוניקס |
subjectTime | number | זמן יצירת שם קבוצה בפורמט יוניקס |
subjectOwner | string | מִשׁתַמֵשׁ Id מי שיצר את שם הקבוצה |
groupInviteLink | string | קישור להזמנה לקבוצה |
ephemeralExpiration | number | חיים שלמים של הודעות שנעלמות |
allowParticipantsEditGroupSettings | boolean | הרשאה לשנות הגדרות קבוצה, נכון/לא נכון |
allowParticipantsSendMessages | boolean | הרשאה לשליחת הודעה לקבוצה, נכון/לא נכון |
allowParticipantsAddMembers | boolean | הרשאה להוסיף חברים נוספים לקבוצה, נכון/לא נכון |
isCommunity | boolean | קבוצה זו היא קהילה (זמינה רק למנהלי קהילה), נכון/לא נכון |
isCommunityAnnounce | boolean | קבוצה זו היא קבוצת מודעות קהילתית (זמינה רק למנהלי קהילה), נכון/לא נכון |
size | number | מספר המשתתפים בקבוצה |
participants | array | אוסף משתתפי הקבוצה |
| פָּרָמֶטֶר | סוּג | תֵאוּר |
|---|---|---|
id | string | משתתף בצ'אט קבוצתי Id |
lid | string | משתתף בצ'אט קבוצתי Id |
isAdmin | boolean | סמן אם המשתמש הוא מנהל קבוצה |
isSuperAdmin | boolean | סמן אם המשתמש הוא מנהל-על של הקבוצה |
דוגמה לגוף תגובה#
{
"groupId": "79876543210-1587570015@g.us",
"owner": "79876543210@c.us",
"subject": "GREEN-API Group",
"creation": 1587570015,
"subjectTime": 1587737715,
"subjectOwner": "79876543210@c.us",
"groupInviteLink": "https://chat.whatsapp.com/xxxxxxxxxxxxxxxxxxxxxx",
"ephemeralExpiration": 0,
"allowParticipantsEditGroupSettings": true,
"allowParticipantsSendMessages": true,
"allowParticipantsAddMembers": false,
"isCommunity": false,
"isCommunityAnnounce": false,
"size": 3,
"participants": [
{
"id": "79876543210@c.us",
"lid": "123456789098765@lid",
"isAdmin": true,
"isSuperAdmin": true
},
{
"id": "79001234567@c.us",
"lid": "123456789012345@lid",
"isAdmin": true,
"isSuperAdmin": false
},
{
"id": "79001234567@c.us",
"lid": "123456789000000@lid",
"isAdmin": false,
"isSuperAdmin": false
}
]
}
GetGroupData שגיאות#
מגבלות WhatsApp בעת קריאה תכופה לשיטה
בעת בקשות תכופות, WhatsApp עשויה להגביל את הגישה לקבלת קישור הקבוצה. במקרה זה, לתגובת GetGroupData יהיה שדה ריק של groupInviteLink.
לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות סָעִיף
| קוד HTTP | מזהה שגיאה | תֵאוּר | פתרונות אפשריים |
|---|---|---|---|
| 200 | Error: forbidden | המספר אינו כלול בקבוצה זו. | ----- |
| 200 | השדה groupInviteLink אינו מכיל קישור | המשתמש אינו מנהל/בעלים של הקבוצה. | 1. הקצה למשתמש את המופע כזכויות מנהל. 2. בצע בקשות מבעל הקבוצה. |
טקסט תגובה לדוגמה#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"
payload = "{\r\n\t\"groupId\": \"11001234567-1587570015@g.us\"\r\n}"
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"groupId": "11111111111111111@g.us"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getGroupData/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"groupId\": \"11111111111111111@g.us\"}";
var requestEntity = new HttpEntity<>(jsonBody, headers);
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getGroupData/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"groupId\": \"11111111111111111@g.us\"}")
.asString();
System.out.println(response);
Sub GetGroupData()
Dim url As String
Dim RequestBody As String
Dim http As Object
Dim response As String
' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
url = "{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"
' groupId - group chat identifier
RequestBody = "{""groupId"":""120123400367448864@g.us""}"
Set http = CreateObject("MSXML2.XMLHTTP")
With http
.Open "POST", url, False
.setRequestHeader "Content-Type", "application/json"
.Send RequestBody
End With
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
Range("A1").Value = response
Set http = Nothing
End Sub