Pular para o conteúdo principal

Confirmar conexão

Método#

POST on-whatsapp-connected#

Conceituação#

Esse é o webhook de retorno de conexão do Celular com o Z-api

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.

API#

/update-webhook-connected#

PUT https://api.z-api.io/instances/id/{id}/token/{token}/update-webhook-connected

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": "MESSAGE_RECEIVED",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phone": "5544999999999",
"type": "MessageStatusCallback"
}

405#

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início 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"