GetAvatar#

Метод возвращает аватар корреспондента или группового чата.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

Для получения аватара требуется выполнить запрос по адресу:

POST

{{apiUrl}}/v3/waInstance{{idInstance}}/getAvatar/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор корреспондента или группового чата

Пример тела запроса#

Для получения своего аватара в поле chatId укажите свой user_id указанный в методе getAccountSettings.

Получить аватар корреспондента:

{
    "chatId": "10000000"
}

Получить аватар группового чата:

{
    "chatId": "-10000000000000"
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`urlAvatar`	string	Ссылка на аватар корреспондента или группового чата. Параметр принимает пустое значение в случае, если аватар не установлен или установлены настройки конфиденциальности, ограничивающие доступ к аватару
`available`	boolean	Флаг, который указывает на доступность аватара корреспондента или группового чата. 1. Параметр принимает значение `true` , если аватар доступен для просмотра. При этом, если у корреспондента аватар не установлен, то поле `urlAvatar` будет пустым. 2. Параметр принимает значение `false`, если у корреспондента включены настройки приватности чата и аватар не доступен.

Пример тела ответа#

Успешное выполнение метода#

{
    "urlAvatar": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotBPGJiDHPpKQP3fE_vh2BE1holGE_adbUwUqCIPQgiOI",
    "available": true
}

Выполнение метода с ошибкой#

{
    "statusCode": 400,
    "timestamp": "2025-08-21T13:02:16.247Z",
    "path": "/waInstance3100000001/getAvatar/9ece01c05bbe44768fb674840138bbe6af876fe49b69418fbf",
    "message": "Validation failed. Details: 'chatId' must be one of the next formats: 'user_id' or 'group_id'"
}

Ошибки GetAvatar#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP	Идентификатор ошибки	Описание
200	`{` `"urlAvatar": "",` `"available": false` `}`	На номере установлены настройки конфиденциальности, ограничивающие доступ к аватару
200	`{` `"urlAvatar": "",` `"available": true` `}`	Аватар не установлен либо на номере нет аккаунта WhatsApp
400	`Bad Request` `Validation failed`	Ошибка валидации

Примеры кода#

PythoncURLJava - SpringJava - UnirestVBA

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getAvatar/{{apiTokenInstance}}"

payload = "{\r\n    \"chatId\": \"10000000\"\r\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.post(url, json=payload)

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

curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/getAvatar/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "10000000"
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/getAvatar/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\"chatId\": \"10000000\"}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/getAvatar/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\"chatId\": \"10000000\"}")
    .asString();

System.out.println(response);

Sub GetAvatar()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/v3/waInstance{{idInstance}}/GetAvatar/{{apiTokenInstance}}"

    ' chatId - is the number to send the message to (@c.us for private chats, @g.us for group chats)
    RequestBody = "{""chatId"":""10000000""}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    With http
        .Open "POST", url, False
        .setRequestHeader "Content-Type", "application/json"
        .Send RequestBody
    End With

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    Range("A1").Value = response

    Set http = Nothing
End Sub