DeleteNotification#

Test

השיטה מכוונת למחיקת הודעה נכנסת מתור ההודעות. כדי לציין איזו הודעה למחוק, השתמש בפרמטר receiptId. לאחר קבלת ועיבוד הודעה נכנסת, עליך למחוק את ההודעה מהתור. זה מחייב אותך להפעיל את השיטה הזו. לאחר הקריאה לשיטה, ההודעה תיחשב כמתקבלת ומעובדת ותימחק לצמיתות מהתור. לכן, השיחה הבאה של ReceiveNotification method will return the next notification from the queue in the order in which notifications come to the queue.

הודעות נכנסות נשמרות בתור למשך 24 שעות.

הודעות נשלחות מהתור פנימה FIFO order

בַּקָשָׁה#

כדי למחוק הודעה נכנסת מהתור, עליך לבצע בקשה בכתובת:

DELETE

{{apiUrl}}/waInstance{{idInstance}}/deleteNotification/{{apiTokenInstance}}

TEST

Note that you have to use a request of DELETE type

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

בקש פרמטרים#

פָּרָמֶטֶר	סוּג	הֶכְרֵחִי	תֵאוּר
`receiptId`	integer	כֵּן	מזהה קבלה למחיקת הודעה נכנסת שהתקבלה על ידיReceiveNotification שִׁיטָה

Response#

Response parameters#

פָּרָמֶטֶר	סוּג	תֵאוּר
`result`	boolean	תוצאת מחיקת הודעה נכנסת: `true` - הודעה נכנסת נמחקה בהצלחה מהתור; 'false' - ההודעה לא נמחקה - אפשרי, אם ההודעה נמחקה קודם לכן או 'receiptId' אינו תואם לערך שהתקבל בעבר על ידי ReceiveNotification method

Response body example#

{
    "result": true
}

DeleteNotification errors#

For a list of errors common to all methods, refer to Common errors section

HTTP code	Error Id	Description
400	`Parameter receiptId must be a Number`	`receiptId` parameter is not specified or contains non-digit characters
400	`Parameter idInstance not an integer`	`idInstance` parameter is not specified or contains non-digit characters
400	`Parameter apiTokenInstance not define`	`apiTokenInstance` parameter is not specified

Request examples#

PythoncURLJava - SpringJava - UnirestVBA

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/deleteNotification/{{apiTokenInstance}}/1234567"

payload = {}
headers= {}

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

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

curl --location --request DELETE '{{apiUrl}}/waInstance{{idInstance}}/deleteNotification/{{apiTokenInstance}}/1234567'

var receiptId = 1;
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();

requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/deleteNotification/")
    .append({{apiTokenInstance}})
    .append("/").append(receiptId);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.DELETE, null, String.class);
System.out.println(response);

var receiptId = 1;
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/deleteNotification/")
    .append({{apiTokenInstance}})
    .append("/").append(receiptId);;

var response = Unirest.delete(requestUrl.toString())
    .asString();

System.out.println(response);

Sub DeleteNotification()
    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}}/deleteNotification/{{apiTokenInstance}}/12345"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "DELETE", 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

You can see the example of notifications receipt code on NodeJS in the file ReceiveNotifications