GetGroupData#
השיטה מקבלת נתוני צ'אט קבוצתי.
בַּקָשָׁה#
כדי לקבל נתוני צ'אט קבוצתי, עליך לבצע בקשה בכתובת:
עבור apiUrl
, idInstance
ו-apiTokenInstance
, עיין ב לפני שמתחילים סָעִיף.
בקש פרמטרים#
פָּרָמֶטֶר | סוּג | הֶכְרֵחִי | תֵאוּר |
---|---|---|---|
groupId | string | כֵּן | זיהוי צ'אט קבוצתי |
בקש דוגמה לגוף#
{
"groupId": "11001234567-1587570015@g.us"
}
בַּקָשָׁה#
בקש פרמטרים#
פָּרָמֶטֶר | סוּג | תֵאוּר |
---|---|---|
groupId | string | זיהוי צ'אט קבוצתי |
owner | string | בעל קבוצה Id |
subject | string | שם הקבוצה |
creation | integer | זמן יצירת קבוצה בפורמט יוניקס |
participants | array | אוסף משתתפי הקבוצה |
subjectTime | integer | זמן יצירת שם קבוצה בפורמט יוניקס |
subjectOwner | string | מִשׁתַמֵשׁ Id מי שיצר את שם הקבוצה |
groupInviteLink | string | קישור להזמנה לקבוצה |
Participants
array subjects parameters
פָּרָמֶטֶר | סוּג | תֵאוּר |
---|---|---|
id | string | משתתף בצ'אט קבוצתי Id |
isAdmin | boolean | סמן אם המשתמש הוא מנהל קבוצה |
isSuperAdmin | boolean | סמן אם המשתמש הוא מנהל-על של הקבוצה |
דוגמה לגוף תגובה#
{
"groupId": "11001234567-1587570015@g.us",
"owner": "11001234567@c.us",
"subject": "Green API Group",
"creation": 1587570015,
"participants": [
{
"id": "11001234567@c.us",
"isAdmin": true,
"isSuperAdmin": true
},
{
"id": "79001234568@c.us",
"isAdmin": true,
"isSuperAdmin": false
},
{
"id": "79001234569@c.us",
"isAdmin": false,
"isSuperAdmin": false
}
],
"subjectTime": 1587737715,
"subjectOwner": "11001234567@c.us",
"groupInviteLink": "https://chat.whatsapp.com/xxxxxxxxxxxxxxxxxxxxxx"
}
GetGroupData שגיאות#
לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות סָעִיף
קוד 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