Перейти к содержанию

GetAvatar#

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

Запрос#

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

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

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

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

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

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

Для получения своего аватара - укажите в chatId свой номер ("{ваш номер}@c.us").

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

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

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

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

Ответ#

Поля ответа#

Поле Тип Описание
urlAvatar string Ссылка на аватар корреспондента или группового чата. Параметр принимает пустое значение в случае, если аватар не установлен
available boolean Флаг, который указывает на доступность аватара корреспондента или группового чата. Параметр принимает значение false, если у корреспондента включены приватность чата

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

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

Ошибки GetAvatar#

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

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

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'))
curl --location 'https://api.green-api.com/waInstance{{idInstance}}/getAvatar/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/getAvatar/")
    .append({{apiTokenInstance}});

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

var jsonBody = "{\"chatId\": \"11001234567@c.us\"}";

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("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/getAvatar/")
    .append({{apiTokenInstance}});

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

System.out.println(response);
Sub GetAvatar()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The idInstance and apiTokenInstance values are available in your account, double brackets must be removed
    url = "https://api.green-api.com/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"":""71234567890@c.us""}"

    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