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"
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`existsWhatsapp`	boolean	Флаг наличия учетной записи WhatsApp на номере телефона корреспондента
`urlAvatar`	string	Ссылка на аватар корреспондента или группового чата. Параметр принимает пустое значение в случае, если аватар не установлен или у корреспондента нет учетной записи WhatsApp (`existsWhatsapp`=`false`)
`reason`	string	Причина почему аватар не был проверен. Присутствует когда не удалось выполнить проверку, возможные значения:
		`bad request data` - Неверный формат номера телефона. Номер телефона должен содержать 11 или 12 цифр. Или идентификатора чата
		`get avatar timeout limit exceeded` - Превышен лимит времени ожидания ответа о наличии аватара

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

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

Ошибки GetAvatar#

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

Код HTTP	Идентификатор ошибки	Описание
200	`bad request data`	Неверный формат номера телефона. Номер телефона должен содержать 11 или 12 цифр. Или идентификатора чата
200	`get avatar timeout limit exceeded`	Превышен лимит времени ожидания ответа о наличии аватара

Пример кода на 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'))