ArchiveChat#
השיטה מאחסנת צ'אט. אפשר לאחסן צ'אטים שיש בהם לפחות הודעה אחת נכנסת.
בַּקָשָׁה#
כדי להעביר צ'אט לארכיון, עליך לבצע בקשה בכתובת:
For apiUrl
, idInstance
and apiTokenInstance
request parameters, refer to Before you start section.
Note
על מנת שהשיטה תתפקד, על המערכת להיות מסוגלת לראות הודעות נכנסות. כדי לאפשר זאת, הפעל את Receive webhooks on incoming messages and files
אפשרות ב- instance settings או להשתמש ב SetSettings שִׁיטָה.
בקש פרמטרים#
פָּרָמֶטֶר | סוּג | הֶכְרֵחִי | תֵאוּר |
---|---|---|---|
chatId | string | כֵּן | זיהוי משתמש או צ'אט קבוצתי |
טקסט בקשה לדוגמה#
{
"chatId": "120363043968066561@g.us"
}
תְגוּבָה#
פרמטרי תגובה#
גוף התגובה ריק. אם זה מצליח, תגובת השרת היא 200.
שגיאות ArchiveChat#
לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות סָעִיף
HTTP code | Error identifier | Description |
---|---|---|
400 | "ArchiveChatError: cannot archive chat cause last message not found in chat" | chatID is false or there is no message in the chat |
400 | "ArchiveChatError: chat with id 71234567890@c.us already archive=true" | Chat is already in archive |
בקש דוגמאות#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/archiveChat/{{apiTokenInstance}}"
payload = "{\r\n \"chatId\": \"120363043968066561@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}}/archiveChat/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"chatId": "120363043968066561@g.us"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/archiveChat/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"chatId\": \"120363043968066561@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("/archiveChat/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"chatId\": \"120363043968066561@g.us\")
.asString();
System.out.println(response);
Sub ArchiveChat()
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}}/ArchiveChat/{{apiTokenInstance}}"
' ChatId - number to send the chat to the archive (@c.us for private chats, @g.us for group chats)
RequestBody = "{""chatId"":""70123456789@c.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