Ayuda

/v1/support

Usa el nodo support para obtener ayuda con el cliente de la API de WhatsApp Business. Consulta Contactar al equipo de ayuda para obtener más información sobre cómo abrir un ticket de asistencia directa.

Consulta

Una llamada a la API enviada al nodo support devuelve información que el equipo de asistencia puede usar para ayudarte a resolver tu problema.

Ejemplo

GET /v1/support

Si usas una cURL:

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

Una respuesta satisfactoria incluye datos sobre tu cliente de la API de WhatsApp Business. En función de la instalación que tengas, los campos de la respuesta variarán.

Una sola instancia

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

Alta disponibilidad/multiconexión

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

Parámetros

Campo socket_conn

El campo socket_conn indica el estado actual de la conexión al servidor de WhatsApp.

Campo shards

• En el caso de la alta disponibilidad, solo una aplicación principal es propietaria de la partición de control (-1) y la partición normal (0). El campo de estas particiones es [[-1, -1], [0, 0]], mientras que el campo de las particiones de otros nodos es [].
• En el caso de la multiconexión, el objeto maestro principal es el propietario de la partición de control (-1) y el campo de las particiones es [[-1, -1]]. Las aplicaciones principales que sean propietarias de particiones contienen el campo [[owned-shard-id,owned shard id]] para dichas particiones. Por el momento, una aplicación principal puede contener solamente una partición por vez.

Campo role