Recebendo notificações através da HTTP API#

Você pode receber notificações de entrada (mensagens, status) através de solicitações HTTP API, de maneira semelhante a como os outros métodos Green API são implementados. Neste caso, a ordem cronológica das notificações é garantida na sequência em que foram recebidas FIFO. Todas as notificações de entrada são salvas em uma fila e aguardam recebimento por 24 horas.

Para receber notificações de entrada, é necessário executar sequencialmente duas chamadas dos métodos ReceiveNotification e DeleteNotification. O método ReceiveNotification realiza o recebimento da notificação de entrada. O método DeleteNotification confirma o recebimento e processamento bem-sucedidos da notificação. Saiba mais sobre os métodos nas seções correspondentes ReceiveNotification e DeleteNotification.

O período de armazenamento de notificações de entrada é de 24 horas.

Configuração da Conta#

Antes de receber notificações de entrada, é necessário configurar a conta. A configuração da conta pode ser feita programaticamente usando o método SetSettings, ou interativamente na interface do painel de controle pessoal.

Configuração através do método SetSettings#

Para configurar o recebimento de notificações de entrada através da tecnologia HTTP API, o parâmetro webhookUrl deve ser deixado em branco.

Também é necessário indicar quais tipos de notificações devem ser recebidos. Para ativar notificações de entrada por tipos, e também para definir o parâmetro webhookUrl, use o método SetSettings.

Exemplo de corpo de solicitação do método SetSettings#

{
    "webhookUrl": "",
    "outgoingWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes"
}

Recebendo notificações de entrada#

Após configurar a conta, você pode começar a receber notificações usando os métodos ReceiveNotification e DeleteNotification. Um exemplo de código para receber notificações em NodeJS pode ser encontrado no arquivo ReceiveNotifications.

A descrição detalhada do formato das notificações de entrada é apresentada na seção Formato das notificações de entrada.