> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Аватар пользователя



## OpenAPI

````yaml /ru/openapi.yml get /user/avatar
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: >
    Этот API используется для отправки whatsapp через API.


    Веб-панель инструментов это отдельный проект (gowa-ui); сервер загружает
    свой последний релиз

    и служит в `/` (или возвращает баннер JSON, когда

    APP_UI_ENABLED=false).


    Привязка устройства:

    - Отправляйте `X-Device-Id` при всех вызовах с прикрепленными устройствами.

    - WebSocket: подключиться к `/ws?device_id=<id>`.

    - Аутентификация WebSocket (когда включена основная аутентификация):
    браузеры не могут установить
      Заголовок авторизации при соединениях WebSocket, так же передает
      `&authorization=<base64(user:pass)>` в строке запроса. Использовать TLS в производстве
      так как учетные данные видны на URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Первоначальное подключение к серверу Whatsapp
  - name: device
    description: Управление устройством для поддержки нескольких устройств
  - name: user
    description: Получение информации
  - name: send
    description: Отправить сообщение (Text/Image/Файл/Видео).
  - name: message
    description: Управление сообщениями (отозвать/изменить/обновить).
  - name: call
    description: Управление звонками (отклонить входящие вызовы)
  - name: chat
    description: Общение и обмен сообщениями
  - name: group
    description: Настройки группы
  - name: newsletter
    description: настройка рассылки
  - name: chatwoot
    description: Интеграция с Chatwoot для поддержки клиентов
paths:
  /user/avatar:
    get:
      tags:
        - user
      summary: Аватар пользователя
      operationId: userAvatar
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: phone
          in: query
          schema:
            type: string
          example: 6289685028129@s.whatsapp.net
          description: Номер телефона с кодом страны
        - name: is_preview
          in: query
          schema:
            type: boolean
          example: true
          description: Получать ли предварительный просмотр аватара
        - name: is_community
          in: query
          schema:
            type: boolean
          example: false
          description: Получать ли аватар сообщества
      responses:
        '200':
          description: ОК
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAvatarResponse'
        '400':
          description: Плохой запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '403':
          description: >-
            AVATAR_HIDDEN: контакт скрывает картинку с этой учетной записи
            (ничего не говорит о том, существует ли она)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
              example:
                code: AVATAR_HIDDEN
                message: the user has hidden their profile picture from you
        '404':
          description: >-
            Контакт не имеет фото профиля (AVATAR_NOT_SET) или устройство
            неизвестно (DEVICE_NOT_FOUND). Проверьте `code`, а не только статус.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
              examples:
                avatarNotSet:
                  summary: У контакта нет фото профиля
                  value:
                    code: AVATAR_NOT_SET
                    message: that user or group does not have a profile picture
                deviceNotFound:
                  summary: Неизвестное устройство
                  value:
                    code: DEVICE_NOT_FOUND
                    message: >-
                      device not found; create a device first from /api/devices
                      or provide a valid X-Device-Id
                    results:
                      device_id: my-device
        '500':
          description: Внутренняя ошибка сервера
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Идентификатор устройства для поддержки нескольких устройств. Требуется
        при регистрации нескольких устройств.

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

        Можно также задать параметр `device_id` запроса.
      schema:
        type: string
        example: my-device-id
  schemas:
    UserAvatarResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Success
        results:
          type: object
          properties:
            url:
              type: string
              example: >-
                https://pps.whatsapp.net/v/t61.24694-24/181358562_385581386633509_6230178822944778044_n.jpg?ccb=11-4&oh=df36c5b990497b8a5758a0f1ad8118a8&oe=620AA726
            id:
              type: string
              example: '1635239861'
            type:
              type: string
              example: image
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: Код состояния HTTP
        message:
          type: string
          example: field cannot be blank
          description: Подробное сообщение об ошибке
        results:
          type: object
          example: null
          description: дополнительные данные
    ErrorForbidden:
      type: object
      properties:
        code:
          type: string
          example: AVATAR_HIDDEN
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: the user has hidden their profile picture from you
          description: Подробное сообщение об ошибке
        results:
          type: object
          description: дополнительные данные
    ErrorNotFound:
      type: object
      properties:
        code:
          type: string
          example: 404
          description: Код состояния HTTP
        message:
          type: string
          example: Chat not found
          description: Подробное сообщение об ошибке
        results:
          type: object
          example: null
          description: дополнительные данные
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Подробное сообщение об ошибке
        results:
          type: object
          example: null
          description: дополнительные данные
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [Изменить аватар](https://gowa-docs.mintlify.site/ru/api-reference/user/изменить-аватар.md)
- [Получить список контактов пользователя](https://gowa-docs.mintlify.site/ru/api-reference/user/получить-список-контактов-пользователя.md)
- [Имя изменения Push-имени пользователя](https://gowa-docs.mintlify.site/ru/api-reference/user/имя-изменения-push-имени-пользователя.md)
- [Получить список контактов пользователя с каждым именем контакта отдельно](https://gowa-docs.mintlify.site/ru/api-reference/user/получить-список-контактов-пользователя-с-каждым-именем-контакта-отдельно.md)
- [Интеграция с Chatwoot](https://gowa-docs.mintlify.site/ru/integrations/chatwoot.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.