GetChats#
השיטה מיועדת לקבלת רשימה של הקבוצות בחשבון הנוכחי לפי סדר כרונולוגי
בקשה#
כדי לקבל את רשימת הקבוצות, יש לבצע בקשה לכתובת:
GET
{{apiUrl}}/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}
לקבלת פרמטרי הבקשה apiUrl, idInstance ו-apiTokenInstance, עיין/י בסעיף לפני תחילת העבודה.
פרמטרי הבקשה#
| פרמטר | סוג | חובה | תיאור |
|---|---|---|---|
count | integer | לא | מספר הקבוצות, הממוינות לפי זמן הפעילות בקבוצה. העדכון מתרחש לא יותר מפעם אחת בדקה |
תגובה#
שדות התגובה#
| שדה | סוג | תיאור |
|---|---|---|
archive | boolean | דגל המציין האם הקבוצה נמצאת בארכיון או לא |
id | string | מזהה הקבוצה |
79001234567 - מומר אוטומטית לפורמט של מספר טלפון | ||
79001234567@c.us - מספר טלפון | ||
123456789012345@lid - lid- מזהה | ||
ephemeralExpiration | integer | זמן החיים של ההודעות בקבוצה, מתקבל בערכים בשניות: 0, 86400, 604800, 7776000 |
ephemeralSettingTimestamp | integer | זמן התרחשות האירוע בפורמט UNIX |
name | string | שם איש הקשר או הקבוצה |
type | string | סוג איש הקשר. ערכים אפשריים: |
user - איש הקשר משויך לצד השני בשיחה | ||
group - איש הקשר הוא צ'אט קבוצתי |
דוגמה לגוף התגובה#
[
{
"archive": false,
"id": "79876543210@c.us",
"ephemeralExpiration": 86400,
"ephemeralSettingTimestamp": 1777870423,
"name": "John Doe",
"type": "user"
},
{
"archive": false,
"id": "79001234567@c.us",
"ephemeralExpiration": 0,
"ephemeralSettingTimestamp": 0,
"name": "Doe John",
"type": "user"
},
{
"archive": false,
"id": "79001234567-1479621234@g.us",
"ephemeralExpiration": 0,
"ephemeralSettingTimestamp": 0,
"name": "My best group",
"type": "group"
}
]
שגיאות GetChats#
רשימת השגיאות המשותפות לכל השיטות נמצאת בפרק שגיאות סטנדרטיות
| HTTP פתרונות אפשריים | תיאור השגיאה | קוד |
|---|---|---|
| 200 | השיטה GetChats מחזירה מערך ריק [] | יש ליצור קשר עם התמיכה הטכנית. |
דוגמאות הקוד#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}"
payload = {}
headers= {}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getChats/")
.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("/getChats/")
.append({{apiTokenInstance}});
var response = Unirest.get(requestUrl.toString())
.header("Content-Type", "application/json")
.asString();
System.out.println(response);
Sub getChats()
Dim url 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}}/getChats/{{apiTokenInstance}}"
Set http = CreateObject("MSXML2.XMLHTTP")
http.Open "GET", url, False
http.Send
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
Range("A1").Value = response
Set http = Nothing
End Sub