GetAvatar#

O método retorna o avatar do correspondente ou do chat em grupo.

Requisição#

Para obter o avatar, é necessário fazer uma solicitação para o seguinte endereço:

POST https://api.green-api.com/waInstance{{idInstance}}/GetAvatar/{{apiTokenInstance}}

Parâmetros da Requisição#

Parâmetro	Tipo	Obrigatório	Descrição
`chatId`	string	Sim	ID do correspondente ou chat em grupo

Exemplo do Corpo da Requisição#

Para obter o seu próprio avatar - insira o seu número no campo chatId ("{seu número}@c.us").

Obter o avatar do correspondente:

{
    "chatId": "11001234567@c.us"
}

Obter o avatar de um chat em grupo:

{
    "chatId": "120363043968066561@g.us"
}

Resposta#

Campos da resposta#

Campo	Tipo	Descrição
`existsWhatsapp`	boolean	Sinalizador de presença de uma conta do WhatsApp no número de telefone do correspondente
`urlAvatar`	string	URL do avatar do correspondente ou chat em grupo. Este parâmetro é vazio se o avatar não estiver configurado ou se o correspondente não tiver uma conta do WhatsApp (`existsWhatsapp`=`false`)
`reason`	string	Motivo pelo qual o avatar não foi verificado. Presente quando a verificação falha, possíveis valores:
		`bad request data` - Formato inválido de número de telefone. O número de telefone deve conter 11 ou 12 dígitos. Ou identificador de chat
		`get avatar timeout limit exceeded` - Limite de tempo de espera excedido para obter a resposta sobre a presença do avatar

Exemplo de corpo de resposta#

{
    "existsWhatsapp": true,
      "urlAvatar": "https://pps.whatsapp.net/v/link/to/the/image"
}

Erros GetAvatar#

Lista de erros comuns a todos os métodos podem ser encontrados na seção Erros Comuns

Código HTTP	Identificador de erro	Descrição
200	`bad request data`	Formato inválido de número de telefone. O número de telefone deve conter 11 ou 12 dígitos. Ou identificador de chat
200	`get avatar timeout limit exceeded`	Limite de tempo de espera excedido para obter a resposta sobre a presença do avatar

Exemplo de código em Python#

import requests

url = "https://api.green-api.com/waInstance{{idInstance}}/getAvatar/{{apiTokenInstance}}"

payload = "{\r\n    \"chatId\": \"11001234567@c.us\"\r\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))