> ## 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.

# Avatar de usuario



## OpenAPI

````yaml /es/openapi.yml get /user/avatar
openapi: 3.0.0
info:
  title: Multidispositivo API de WhatsApp
  version: 9.7.0
  description: >
    Esta API se utiliza para enviar whatsapp a través de API.


    El panel web es un proyecto separado (gowa-ui); el servidor descarga su
    último recurso de versión

    y lo sirve en `/` (o devuelve un banner JSON cuando

    APP_UI_ENABLED=false).


    Ámbito del dispositivo:

    - Envía `X-Device-Id` en todas las llamadas REST con ámbito dispositivo.

    - WebSocket: conectar a `/ws?device_id=<id>`.

    - WebSocket auth (cuando la autenticación básica está habilitada): los
    navegadores no pueden establecer un encabezado
      de autorización en conexiones WebSocket, así que también pase
      `&authorization=<base64(user:pass)>` en la cadena de consulta. Usa TLS en producciónformat@@0
      ya que la credencial es visible en la URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Conexión inicial al servidor de Whatsapp
  - name: device
    description: Gestión de dispositivos para soporte multidispositivo
  - name: user
    description: Obteniendo información
  - name: send
    description: Enviar mensaje (Texto/Imágen/Archivo/Video).
  - name: message
    description: Manipulación de mensajes (revocar/react/actualizar).
  - name: call
    description: Gestión de llamadas (rechazar llamadas entrantes)
  - name: chat
    description: Chats de chat y mensajería
  - name: group
    description: Ajuste de grupo
  - name: newsletter
    description: configuración del boletín de noticias
  - name: chatwoot
    description: Integración de Chatwoot para soporte al cliente
paths:
  /user/avatar:
    get:
      tags:
        - user
      summary: Avatar de usuario
      operationId: userAvatar
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: phone
          in: query
          schema:
            type: string
          example: 6289685028129@s.whatsapp.net
          description: Número de teléfono con código de país
        - name: is_preview
          in: query
          schema:
            type: boolean
          example: true
          description: Obtener una vista previa del avatar
        - name: is_community
          in: query
          schema:
            type: boolean
          example: false
          description: Buscar un avatar de la comunidad
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAvatarResponse'
        '400':
          description: Solicitud incorrecta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '403':
          description: >-
            AVATAR_HIDDEN: el contacto oculta la imagen de esta cuenta (no dice
            nada sobre si existe)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
              example:
                code: AVATAR_HIDDEN
                message: the user has hidden their profile picture from you
        '404':
          description: >-
            El contacto no tiene una imagen de perfil (AVATAR_NOT_SET) o el
            dispositivo es desconocido (DEVICE_NOT_FOUND). Comprueba `code`, no
            sólo el estado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
              examples:
                avatarNotSet:
                  summary: El contacto no tiene una foto de perfil
                  value:
                    code: AVATAR_NOT_SET
                    message: that user or group does not have a profile picture
                deviceNotFound:
                  summary: Dispositivo desconocido
                  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: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Identificador de dispositivo para soporte multidispositivo. Requerido
        cuando se registran múltiples dispositivos.

        Si sólo se registra un dispositivo, se utilizará como el valor
        predeterminado.

        También se puede proporcionar como parámetro de consulta `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: Código de estado HTTP
        message:
          type: string
          example: field cannot be blank
          description: Mensaje de error detallado
        results:
          type: object
          example: null
          description: datos adicionales
    ErrorForbidden:
      type: object
      properties:
        code:
          type: string
          example: AVATAR_HIDDEN
          description: Error
        message:
          type: string
          example: the user has hidden their profile picture from you
          description: Mensaje de error detallado
        results:
          type: object
          description: datos adicionales
    ErrorNotFound:
      type: object
      properties:
        code:
          type: string
          example: 404
          description: Código de estado HTTP
        message:
          type: string
          example: Chat not found
          description: Mensaje de error detallado
        results:
          type: object
          example: null
          description: datos adicionales
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: Error
        message:
          type: string
          example: you are not loggin
          description: Mensaje de error detallado
        results:
          type: object
          example: null
          description: datos adicionales
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [Avatar de cambio de usuario](https://gowa-docs.mintlify.site/es/api-reference/user/avatar-de-cambio-de-usuario.md)
- [Grupos de Lista de Usuarios](https://gowa-docs.mintlify.site/es/api-reference/user/grupos-de-lista-de-usuarios.md)
- [Obtener lista de contactos de usuario](https://gowa-docs.mintlify.site/es/api-reference/user/obtener-lista-de-contactos-de-usuario.md)
- [Cambiar nombre de usuario](https://gowa-docs.mintlify.site/es/api-reference/user/cambiar-nombre-de-usuario.md)


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