Asistencia

/v1/support

Usa el nodo support para obtener ayuda con el cliente de la API de WhatsApp Business. Consulta Contactar con el servicio de asistencia para obtener más información sobre cómo abrir una solicitud de Asistencia directa.

Recuperación

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

Ejemplo

GET /v1/support

Mediante cURL:

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

En una respuesta correcta se incluyen datos sobre el cliente de la API de WhatsApp Business. Los campos de la respuesta pueden variar en función de la instalación concreta:

Instancia única

{
    "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 o conexión múltiple

{
    "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 proporciona el estado actual de la conexión al servidor de WhatsApp.

NombreDescripción

DN

Se ha finalizado la conexión al servidor de WhatsApp.

UP

Se ha establecido la conexión al servidor de WhatsApp.

SC

En proceso de conectarse al servidor de WhatsApp.

UP receiving offline

En proceso de conectarse al servidor de WhatsApp y recibir mensajes fuera de internet del servidor.

UNK

Se desconoce el estado de la conexión.

Campo shards

  • En casos de alta disponibilidad, la partición de control (-1) y la partición normal (0) pertenecen a solo una aplicación principal. El campo de particiones correspondiente es [[-1, -1], [0, 0]], mientras que otros nodos tienen un campo de particiones de [].
  • En casos de conexión múltiple, la partición de control (-1) pertenece al maestro principal y el campo de particiones correspondiente es [[-1, -1]]. Las aplicaciones principales propietarias de particiones tienen un campo de particiones de [[owned-shard-id,owned shard id]]. Actualmente, una aplicación principal solo puede poseer una partición a la vez.

Campo role

NombreDescripción

role

Rol del contenedor en las configuraciones de alta disponibilidad o conexión múltiple.


Valores:primary_master, secondary_master o coreapp.