Status da mensagem
Conceituação#
Esse é o webhook de retorno do status da mensagem
Atenção
O Z-API 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.
Dica
É possível alterar todos os webhooks de uma vez para a mesma URL. Ver endpoint.
API#
/update-webhook-status#
PUT https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-message-status
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Request Body#
Painel Administrativo#
Retornos dos webhooks#
Os possíveis retornos do webhook on-whatsapp-message-status-changes estão cadastrado logo abaixo:
Response#
| Atributos | Tipo | Descrição |
|---|---|---|
| status | string | Status da mensagem (SENT - se foi enviada, RECEIVED - se foi recebida, READ - se foi lida, READ_BY_ME - se foi lida por você (número conectado na sua instância), PLAYED - se foi ouvida ) |
| id | string | Identificador(es) da(s) mensagem(ns). |
| momment | integer | Momento em que a instância foi desconectada do número. |
| phoneDevice | integer | Indica o dispositivo que ocorreu o evento (0 - Celular) |
| phone | string | Número de telefone de destino da mensagem. |
| type | string | Tipo do evento da instância, nesse caso será "MessageStatusCallback". |
| isGroup | boolean | Indica se o chat é um grupo |
200#
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou PUT 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"