Suporte

/v1/support

Use o nó support para obter ajuda com o seu cliente da WhatsApp Business API. Consulte Suporte Direto para saber como abrir um tíquete.

Recuperação

Com uma chamada de API ao nó support, é possível obter informações úteis para que a equipe de suporte ajude a resolver o problema.

Exemplo

GET /v1/support

Com uso de cURL:

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

Se for bem-sucedida, a resposta incluirá dados sobre o seu cliente da WhatsApp Business API. Os campos incluídos na resposta podem variar de acordo com a configuração:

Instância ú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 disponibilidade/multiconexão

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

O campo socket_conn informa o status atual da conexão com o servidor do WhatsApp.

Campo shards

• Na alta disponibilidade, apenas um Coreapp terá o fragmento de controle (-1) e o fragmento normal (0). O campo shards será [[-1, -1], [0, 0]] nesse caso. Para outros nós, o campo será [].
• Na multiconexão, o mestre primário terá o fragmento de controle (-1), e o campo shards será [[-1, -1]]. O campo dos Coreapps com fragmentos próprios será [[owned-shard-id,owned shard id]]. Atualmente, cada Coreapp só pode ter um fragmento ao mesmo tempo.

Campo role