Pular para o conteúdo principal

Dados da instância

Conceituação#

Este método te permite obter os dados da sua instância.


Método#

/me#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Response#

200#

AtributosTipoDescrição
idstringId da instância
tokenstringToken da instância
namestringNome da instância
connectedbooleanDefine se a instância está conectada
paymentStatusstringDefine o status de pagamento da instância
createdDateData de criação da instância
connectedCallbackUrlstringUrl do webhook de conexão
deliveryCallbackUrlstringUrl do webhook de envio de mensagem
disconnectedCallbackUrlstringUrl do webhook de desconexão
messageStatusCallbackUrlstringUrl do webhook de status da mensagem
presenceChatCallbackUrlstringUrl do webhook de presença do chat
receivedCallbackUrlstringUrl do webhook de recebimento
receiveCallbackSentByMebooleanDefine se irá receber webhook das mensagens enviadas pela própria instância
callRejectAutobooleanDefine se irá rejeitar uma chamada recebida automaticamente
callRejectMessagestringMensagem a ser enviada quando rejeitar uma chamada
autoReadMessagebooleanDefine se irá marcar as mensagens recebidas como lidas automaticamente
initialDataCallbackUrlstringUrl do webhook de dados iniciais após conexão

Code#