DeleteNotification#
Метод предназначен для удаления входящего уведомления из очереди уведомлений. Чтобы указать, какое уведомление следует удалить, используйте параметр receiptId
. После получения и обработки входящего уведомления требуется удалить уведомление из очереди. Для этого требуется выполнить данный метод. После вызова метода уведомление будет считаться принятым и обработанным и будет безвозвратно удалено из очереди. Таким образом следующий вызов метода ReceiveNotification вернет следующее уведомление из очереди в порядке поступления уведомлений в очередь.
Срок хранения входящих уведомлений в очереди составляет 24 часа.
Уведомления отдаются из очереди в порядке FIFO
Запрос#
Для удаления входящего уведомления из очереди требуется выполнить запрос по адресу:
DELETE https://api.green-api.com/waInstance{{idInstance}}/DeleteNotification/{{apiTokenInstance}}/{{receiptId}}
Обратите внимание, что требуется использовать запрос вида
DELETE
Для получения параметров запроса idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
receiptId | integer | Да | Идентификатор доставки для удаления входящего уведомления, полученный методом ReceiveNotification |
Ответ#
Поля ответа#
Поле | Тип | Описание |
---|---|---|
result | boolean | Результат удаления входящего уведомления: true - входящее уведомление успешно удалено из очереди; false - уведомление не удалено - возможно, когда уведомление было удалено ранее, или receiptId не соответствует ранее полученному значению методом ReceiveNotification |
Пример тела ответа#
{
"result": true
}
Ошибки DeleteNotification#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Код HTTP | Идентификатор ошибки | Описание |
---|---|---|
400 | Parameter receiptId must be a Number | Не задан параметр receiptId или содержит нецифровые символы |
400 | Parameter idInstance not an integer | Не задан параметр idInstance или содержит нецифровые символы |
400 | Parameter apiTokenInstance not define | Не задан параметр apiTokenInstance |
Пример кода на Python#
import requests
url = "https://api.green-api.com/waInstance{{idInstance}}/DeleteNotification/{{apiTokenInstance}}/1234567"
payload = {}
headers= {}
response = requests.request("DELETE", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
Пример кода получения уведомлений на NodeJS можно посмотреть в файле ReceiveNotifications