Pular para o conteúdo principal

Ao conectar

Conceituação#

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

Esse é webhook é disparado quando o Z-API se conectada ao WhatsApp, isso pode acontecer quando le o qr-code, quando reiniciar a instancia e etc

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}/token/{token}/update-webhook-connected

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Request Body#

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


Retornos dos webhooks#

Os possíveis retornos do webhook on-webhook-connected estão cadastrado logo abaixo:

Response#

AtributosTipoDescrição
connectedbooleanstatus da instância.
phonestringNúmero conectado.
mommentstringMomento em que a instância foi desconectada do número.
typestringTipo do evento da instância, nesse caso será "ConnectedCallback" .

200#

{
"type": 'ConnectedCallback',
"connected": true,
"momment": 26151515154,
"instanceId": instance.id,
"phone": "número",,
"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 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"