Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
device
Dados do celular
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/device \
  --header 'Client-Token: <api-key>'
{
  "phone": "<string>",
  "imgUrl": "<string>",
  "about": "<string>",
  "name": "<string>",
  "device": {
    "sessionName": "<string>",
    "device_model": "<string>"
  },
  "originalDevice": "<string>",
  "sessionId": 123,
  "isBusiness": 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 é responsável por retornar informações sobre o device/celular conectado.

​
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

​
phone
string
Número telefônico do dispositivo conectado
​
imgUrl
string
URL da imagem/foto de perfil do usuário
​
about
string
Recado do perfil do contato
​
name
string
Nome do proprietário da conta
​
device
object
Informações do dispositivo
​
originalDevice
string
Tipo original do aparelho: “iphone”, “android”, “smbi” ou “smba”
​
sessionId
number
Identificador numérico único da sessão
​
isBusiness
boolean
Indica se é conta comercial
{
  "phone": "5511999999999",
  "imgUrl": "https://...",
  "about": "Recado do perfil do contato",
  "name": "Nome do usuário",
  "device": {
    "sessionName": "Z-API",
    "device_model": "Z-API"
  },
  "originalDevice": "iphone",
  "sessionId": 175,
  "isBusiness": false
}

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