Consultar avatar de um chat
POST /chat/avatar
Retorna a URL temporária da imagem de uma conversa individual ou grupo.
Use preview=true para solicitar a imagem reduzida ou preview=false para
solicitar a imagem completa.
Quando não houver imagem disponível, a resposta continua válida e retorna
url vazio. force=true solicita uma atualização antecipada, respeitando
um intervalo mínimo de 20 segundos por imagem e instância; não use essa
opção em polling contínuo.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Corpo da requisição
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"minLength": 1,
"description": "Identificador do chat. Aceita número com DDI, JID de usuário, LID conhecido pela instância ou JID de grupo.",
"example": "5511999999999"
},
"preview": {
"type": "boolean",
"default": false,
"description": "true solicita preview; false solicita a imagem completa."
},
"force": {
"type": "boolean",
"default": false,
"description": "Solicita uma atualização antecipada, respeitando o intervalo mínimo de 20 segundos por imagem e instância. Não use em polling contínuo."
}
}
},
"example": {
"number": "5511999999999",
"preview": true
}
}
}
}
Respostas
{
"200": {
"description": "URL da foto ou string vazia quando não houver imagem disponível.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "URL temporária; string vazia é válida."
}
}
},
"examples": {
"found": {
"value": {
"url": "https://pps.whatsapp.net/example.jpg"
}
},
"absent": {
"value": {
"url": ""
}
}
}
}
}
},
"400": {
"description": "Payload inválido, number ausente ou identificador inválido.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Token ausente ou inválido.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Falha ao consultar a imagem ou ausência de sessão disponível.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}