Assistance

/v1/support

Utilisez le nœud support pour obtenir de l’aide avec votre client de l’API WhatsApp Business. Consultez Contacter l’assistance pour savoir comment ouvrir un ticket auprès de l'assistance directe.

Récupération

Un appel d’API au nœud support renvoie des informations que l’équipe d’assistance peut utiliser pour résoudre votre problème.

Exemple

GET /v1/support

L’utilisation de cURL :

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

Une réponse positive inclut des données concernant votre client de l’API WhatsApp Business. Les champs de la réponse peuvent varier en fonction de votre installation spécifique :

Instance unique

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

Haute disponibilité/Multiconnect

{
    "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",
          ...
        },
    }
}

Paramètres

Le champ socket_conn

Le champ socket_conn fournit l’état actuel de la connexion au serveur WhatsApp.

Le champ shards

• Pour la haute disponibilité, un seul Coreapp possède à la fois la partition de contrôle (-1) et la partition normale (0). Son champ de partitions est [[-1, -1], [0, 0]], tandis que les autres nœuds ont un champ de partitions de [].
• Pour Multiconnect, le maître principal est propriétaire de la partition de contrôle (-1) et son champ de partitions est [[-1, -1]]. Les Coreapps qui possèdent des partitions ont un champ de partitions de [[owned-shard-id,owned shard id]]. Actuellement, un Coreapp ne peut posséder qu’une seule partition en même temps.

Le champ role