Ir para o conteúdo

Excluir notificações#

/v1/notifications

Use o methodo notifications para receber notificações de entrada. Após receber e processar uma notificação, ela deve ser removida a fim de receber a próxima notificação da fila.

Request#

Para excluir uma notificação, você precisa realizar um request no endereço, utilizando o método DELETE

DELETE https://api.green-api.com/v1/notifications/{{receipt}}

Parâmetros de solicitação#

Parâmetro Tipo Obrigatório Descrição
receipt integer Sim ID de entrega de notificação; gerado quando notificação é recebida

Resposta#

Se a resposta for bem-sucedida, o código HTTP 200 será retornado independentemente de a notificação ter sido removida ou não.

Parâmetros de Resposta#

Parâmetro Тipo Descrição
result boolean o resultado da exclusão da notificação: true - a notificação foi encontrada e excluída; false - notificação não foi encontrada para o valor fornecidorecibo

Resposta de Exemplo#

Se a notificação foi encontrada e removida, o código HTTP 200 é retornado. O corpo da resposta contém o parâmetro result com o valortrue:

200
{
    "result": true
}

Se a notificação não for encontrada, o código HTTP 200 também será retornado. Nesse caso, o corpo da resposta contém o parâmetro result com o valorfalse:

200
{
    "result": false
}

Erros#

Para obter uma lista de erros comuns a todos os métodos, consulte a seção Erros padrão.

Em caso de erro, o código HTTP 400 é retornado com uma descrição detalhada do erro no corpo da resposta.

Exemplo de código Python#

import requests

url = "https://api.green-api.com/v1/notifications/1234567"

payload = {}
headers = {
  'Authorization': 'Bearer {{AuthToken}}'
}

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

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