Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
status
Status da instância
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/status \
  --header 'Client-Token: <api-key>'
{
  "connected": true,
  "error": "<string>",
  "smartphoneConnected": true
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método te permite descobrir se sua instância está ou não conectada a uma conta de WhatsApp.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Response

​
200

​
connected
boolean
Indica se seu número está conectado ao Z-API
​
error
string
Retorna detalhes do status, como “You are already connected”, “You need to restore the session” ou “You are not connected”
​
smartphoneConnected
boolean
Indica se o celular está conectado à internet
{
  "connected": true,
  "error": "You are already connected",
  "smartphoneConnected": true
}

​
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”.