Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
chats
/
{phone}
Metadados da conversa
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/chats/{phone} \
  --header 'Client-Token: <api-key>'
{
  "phone": "5511999999999",
  "name": "Maria Silva",
  "short": "Maria",
  "notify": "Maria Silva",
  "vname": "Maria Silva",
  "imgUrl": "https://cdn.example.com/profile.jpg",
  "about": "Atendimento",
  "exists": true,
  "lid": null
}
Retorna metadados da conversa ou grupo informado.
Aliases consolidados da collection: Pegar metadata do Chat.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

​
phone
string
required

Número no formato internacional, sem +, espaços ou pontuação.

Example:

"5511999999999"

Response

Resposta de sucesso.

​
phone
string
required
Example:

"5511999999999"

​
name
string
required
Example:

"Maria Silva"

​
short
string
required
Example:

"Maria"

​
notify
string
required
Example:

"Maria Silva"

​
vname
string
required
Example:

"Maria Silva"

​
imgUrl
string
required
Example:

"https://cdn.example.com/profile.jpg"

​
about
string
required
Example:

"Atendimento"

​
exists
boolean
required
Example:

true

​
lid
unknown
required