> ## 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 /ar/openapi.yml get /user/avatar
openapi: 3.0.0
info:
  title: واتسآب API متعدد الأجهزة
  version: 9.7.0
  description: >
    يتم استخدام هذا API لإرسال أي تطبيق عبر API.


    لوحة المعلومات هي مشروع منفصل (gowa-ui)؛ يقوم الخادم بتنزيل أحدث أصول
    الإصدار

    ويخدمه في `/` (أو يرجع لافتة JSON عندما

    APP_UI_ENABLED=false).


    تحديد الجهاز:

    - إرسال `X-Device-Id` على جميع مكالمات REST على نطاق الجهاز.

    - WebSocket: الاتصال بـ `/w?جهاز_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: إرسال رسالة (نص/صورة/ملف/فيديو).
  - name: message
    description: التلاعب بالرسالة (إلغائ/react/update).
  - 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/ar/api-reference/send/إرسال-صورة.md)
- [معلومات المستخدم](https://gowa-docs.mintlify.site/ar/api-reference/user/معلومات-المستخدم.md)
- [تعيين صورة المجموعة](https://gowa-docs.mintlify.site/ar/api-reference/group/تعيين-صورة-المجموعة.md)
- [تغيير الصورة الرمزية](https://gowa-docs.mintlify.site/ar/api-reference/user/تغيير-الصورة-الرمزية.md)
- [تغيير اسم المستخدم](https://gowa-docs.mintlify.site/ar/api-reference/user/تغيير-اسم-المستخدم.md)


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