Skip to main content

Status da mensagem

Método#

POST on-whatsapp-message-status-changes#

Conceituação#

Esse é o webhook de retorno do status da mensagem

Atenção

O PlugZapi não aceita webhooks que não sejam HTTPS


Atualizando Webhook#

Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel administrativo.

API#

/update-webhook-status#

PUT https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-message-status

Request Body#

Body#

{
"value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status"
}

Painel Administrativo#

img


Atributos#

Obrigatórios#

AtributosTipoDescrição
statusstringTipo do status no qual a mensagem se encontra.
idstringIdentificador(es) da(s) mensagem(ns).
phonestringNúmero de telefone de destino da mensagem.
mommentstringMomento em que a instância foi desconectada do número.
typestringTipo do evento da instância, nesse caso será "MessageStatusCallback".

Response#

200#

{
"status": "SENT",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"instanceId": "instance.id"
}
{
"status": "RECEIVED",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"instanceId": "instance.id"
}
{
"status": "READ",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"instanceId": "instance.id"
}
{
"status": "READ-SELF",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"instanceId": "instance.id"
}
{
"status": "PLAYED",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"instanceId": "instance.id"
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.

415#

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"