Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
contacts
/
{phone}
Metadata do contato
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/contacts/{phone} \
  --header 'Client-Token: <api-key>'
{
  "name": "<string>",
  "phone": "<string>",
  "notify": "<string>",
  "short": "<string>",
  "imgUrl": "<string>",
  "about": "<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 é responsável por retornar as informações do metadata do contato.
Se você pretende armazenar a imagem do seu contato observe que sempre retornamos no get-contacts o atributo imgUrl com ela para você, porém é importante lembrar que esta fica disponível por apenas 48 horas conforme política do 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.

​
Path

​
phone
string
obrigatório
Telefone do contato no formato DDI DDD NÚMERO. Ex: 551199999999

​
Response

​
200

​
name
string
Nome e sobrenome do contato
​
phone
string
Número do contato
​
notify
string
Nome do contato no WhatsApp
​
short
string
Nome do contato
​
imgUrl
string
URL da foto do contato (expira em 48 horas)
​
about
string
Recado do perfil do contato
{
  "name": "Nome e sobrenome do contato",
  "phone": "551199999999",
  "notify": "Nome do contato no WhatsApp",
  "short": "Nome do contato",
  "imgUrl": "https://...",
  "about": "Recado do perfil do contato"
}

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