Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
me
Dados da instância
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/me \
  --header 'Client-Token: <api-key>'
{
  "id": "<string>",
  "token": "<string>",
  "name": "<string>",
  "due": 123,
  "connected": true,
  "paymentStatus": "<string>",
  "created": "<string>",
  "connectedCallbackUrl": "<string>",
  "deliveryCallbackUrl": "<string>",
  "disconnectedCallbackUrl": "<string>",
  "messageStatusCallbackUrl": "<string>",
  "presenceChatCallbackUrl": "<string>",
  "receivedCallbackUrl": "<string>",
  "receiveCallbackSentByMe": true,
  "callRejectAuto": true,
  "callRejectMessage": "<string>",
  "autoReadMessage": true,
  "initialDataCallbackUrl": "<string>"
}

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 retorna os dados e configurações da sua instância.

​
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

​
id
string
Id da instância
​
token
string
Token da instância
​
name
string
Nome da instância
​
due
number
Timestamp com a data de vencimento da instância (unix timestamp)
​
connected
boolean
Define se a instância está conectada
​
paymentStatus
string
Define o status de pagamento da instância
​
created
string
Data de criação da instância
​
connectedCallbackUrl
string
URL do webhook de conexão
​
deliveryCallbackUrl
string
URL do webhook de envio de mensagem
​
disconnectedCallbackUrl
string
URL do webhook de desconexão
​
messageStatusCallbackUrl
string
URL do webhook de status da mensagem
​
presenceChatCallbackUrl
string
URL do webhook de presença do chat
​
receivedCallbackUrl
string
URL do webhook de recebimento
​
receiveCallbackSentByMe
boolean
Define se irá receber webhook das mensagens enviadas pela própria instância
​
callRejectAuto
boolean
Define se irá rejeitar uma chamada recebida automaticamente
​
callRejectMessage
string
Mensagem a ser enviada quando rejeitar uma chamada
​
autoReadMessage
boolean
Define se irá marcar as mensagens recebidas como lidas automaticamente
​
initialDataCallbackUrl
string
URL do webhook de dados iniciais após conexão
{
  "id": "123456",
  "token": "abcdef-ghij-klmn-opqr",
  "name": "Minha instância",
  "due": 1700000000,
  "connected": true,
  "paymentStatus": "ACTIVE",
  "created": "2024-01-01T00:00:00.000Z",
  "connectedCallbackUrl": "https://meusite.com/webhook/connected",
  "deliveryCallbackUrl": "https://meusite.com/webhook/delivery",
  "disconnectedCallbackUrl": "https://meusite.com/webhook/disconnected",
  "messageStatusCallbackUrl": "https://meusite.com/webhook/message-status",
  "presenceChatCallbackUrl": "https://meusite.com/webhook/presence",
  "receivedCallbackUrl": "https://meusite.com/webhook/received",
  "receiveCallbackSentByMe": false,
  "callRejectAuto": false,
  "callRejectMessage": "",
  "autoReadMessage": false,
  "initialDataCallbackUrl": ""
}

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