DeleteNotification#
The method is aimed for deleting an incoming notification from the notification queue. To specify what notification to delete, use receiptId
parameter. After receiving and processing an incoming notification, you need to delete the notification from the queue. This requires you to run this method. After calling the method, the notification will be considered received and processed and will be permanently deleted from the queue. Therefore, the next call of ReceiveNotification method will return the next notification from the queue in the order in which notifications come to the queue.
Incoming notifications are stored in the queue for 24 hours.
Notifications are sent from the queue in FIFO order
Request#
To delete an incoming notification from the queue, you have to execute a request at:
DELETE https://api.greenapi.com/waInstance{{idInstance}}/deleteNotification/{{apiTokenInstance}}/{{receiptId}}
Note that you have to use a request of
DELETE
type
For idInstance
and apiTokenInstance
request parameters, refer to Before you start section.
Request parameters#
Parameter | Type | Mandatory | Description |
---|---|---|---|
receiptId | integer | Yes | Receipt Id for deleting an incoming notification received by ReceiveNotification method |
Response#
Response parameters#
Parameter | Type | Description |
---|---|---|
result | boolean | Incoming notification deleting result: true - incoming notification successfully deleted from the queue; false - notification is not deleted - possible, if the notification was deleted earlier or receiptId doesn't correspond to the value previously received by 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#
import requests
url = "https://api.greenapi.com/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 'https://api.green-api.com/waInstance{{idInstance}}/deleteNotification/{{apiTokenInstance}}/1234567'
var receiptId = 1;
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append("https://api.greenapi.com")
.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("https://api.greenapi.com")
.append("/waInstance").append({{idInstance}})
.append("/deleteNotification/")
.append({{apiTokenInstance}})
.append("/").append(receiptId);;
var response = Unirest.delete(requestUrl.toString())
.asString();
System.out.println(response);
You can see the example of notifications receipt code on NodeJS in the file ReceiveNotifications