Pular para o conteúdo principal

Status da instância

Método#

/Status#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/status


Conceituação#

Este método é responsável por lhe passar informações sobre a saúde da sua instância no Z-API, para uma boa qualidade de envio e recebimento é preciso tomar os seguinte cuidados:

  • Configure os webhooks no Z-API para receber notificações sobre mudanças no status da sua instância.

  • Desabilite a otimização de bateria do celular conectado mesmo que seja um emulador (exemplo para Android https://youtu.be/Z1baLLXyvTM).

  • Monitore os atributos deste método.


Atributos#

AtributosTipoDescrição
connectedbooleanIndica se seu número está conectado ao Z-API
sessionbooleanIndica se sua instância tem um token ativo no WhatsApp
errorstringInforma detalhes caso algum dos atributos não esteja true - 'You are already connected.' - 'You need to restore the session.' - 'You are not connected.'
smartphoneConnectedbooleanIndica se o celular está conectado à internet

Code#