الدعم

/v1/support

استخدم العقدة support للحصول على المساعدة فيما يتعلق بعميل واجهة API الخاصة بتطبيق WhatsApp للأعمال. ولمزيد من المعلومات حول كيفية فتح تذكرة دعم مباشر، يمكنك الرجوع إلى القسم الاتصال بالدعم.

الاستعادة

سيؤدي استدعاء واجهة API للعقدة support إلى إرجاع معلومات يمكن لفريق الدعم استخدامها للمساعدة في حل مشكلتك.

المثال

GET /v1/support

استخدام cURL:

curl  https://your-webapp-hostname:your-webapp-port/v1/support \
  -H 'Authorization: Bearer your-auth-token' 

تتضمن الاستجابة الناجحة بيانات حول عميل API الخاصة بواتساب للأعمال. وقد تختلف الحقول الموجودة في الاستجابة استنادًا إلى عملية التثبيت المحددة لديك:

المثيل المنفرد

{
    "support": {   
        "context": "healthcheck", # context of the API
        "db_engine": "MYSQL"
        "db_info": [ database-driver-version ],
        "debug_info": "business-phone-number", #phone number if registered, otherwise, unregistered
        "description": "whatsapp-build-version",
        "device_iso8601": "current-timestamp",
  
        "e2e": { # encryption debug info
            "identity_timestamp": "id-timestamp",
            "registration_id": registration-id
        },
  
        "env": [ client-env-variables ],
        "expire_timestamp": "2018-09-27T14:26:07", # app build version expires timestamp 
        "free_space_data": 9223372036853727000, # bytes available on the data directory  
        "free_space_logs": 14269902848, # bytes available on the log directory
        "free_space_media_incoming": 9223372036853727000, # bytes available on the media incoming directory
        "free_space_media_outgoing": 9223372036853727000, # bytes available on the media outgoing directory
        "lc": "en", # lowercase, two-letter ISO 639 language code, ZZ if code is unknown
        "lg": "US", # uppercase, two or three-letter ISO 3166 country code, ZZ if code is unknown
        "multi_connect": false, # specifies whether current client is multiconnect enabled 
        "os_name": "ubuntu-x86_64", # operating system name 
        "os_version": "16.04", # operating system version

        "schema": { # database schema versions
            "axolotl": 1,
            "callback": 2,
            "cluster": 3,
            "config": 4,
            "contact": 5,
            "jobqueue": 6,
            "message": 7
        },
        "socket_conn": "UP | DN" | "SC" | "UP receiving offline" | "UNK", # see options below
        "version": "build-version"    
    }
}

التوفّر العالي/الاتصال المتعدد

{
    "support": {
        "your-hostname1:your-container-id1": {
          "multi_connect" : true,
          "role": "primary_master | secondary_master | coreapp",
          "shards": [ [your-owned-shard-id, your-owned-shard-id], ...],
          "context": "healthcheck",
          "db_engine": "MYSQL | PGSQL",
          "db_info": [ ... ],
          "debug_info": "enterprise phone number",
          "description": "build information",
          ...
        },
        "your-hostname2:your-container-id2": {
          "multi_connect" : true,
          "role": "primary_master | secondary_master | coreapp",
          "shards": [ [your-owned-shard-id, your-owned-shard-id], ...],
          "context": "healthcheck",
          "db_engine": "MYSQL | PGSQL",
          "db_info": [ ... ],
          "debug_info": "enterprise phone number",
          "description": "build information",
          ...
        },
    }
}

المعلمات

الحقل socket_conn

يوفر الحقل socket_conn حالة الاتصال الحالية بخادم WhatsApp.

الحقل shards

• بالنسبة للتوفّر العالي، ستحصل عقدة Coreapp واحدة فقط على مقطع التحكم (-1) والمقطع العادي (0). وسيكون حقل المقاطع هو [[-1, -1], [0, 0]]، بينما تتضمن العُقد الأخرى حقل المقاطع [].
• بالنسبة للاتصال المتعدد، ستحصل عقدة Master الأساسية على مقطع التحكم (-1) وسيكون حقل المقاطع هو [[-1, -1]]. وتحصل عُقد Coreapps التي تمتلك المقاطع على حقل مقاطع [[owned-shard-id,owned shard id]]. ويمكن حاليًا أن تتضمن كل عقدة Coreapp مقطعًا واحدًا فقط في الوقت نفسه.

الحقل role