Support

/v1/support

Use the support node to get help with your WhatsApp Business API client.

This document covers:

See Contact Support for more information on opening a Direct Support ticket.

Retrieving Support Information

An API call to the support node will return information the Support team can use to help with your issue.

Request

GET /v1/support

Using cURL:

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

Response

A successful response will include data about your WhatsApp Business API client. The fields in the response may vary based on your specific installation.

Single instance

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

High Availability/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",
          ...
        },
    }
}

The socket_conn field

The socket_conn field provides the current state of the connection to the WhatsApp server.

NameDescription

DN

Disconnected from WhatsApp server

UP

Connected to WhatsApp server

SC

In the process of connecting to WhatsApp server

UP receiving offline

In the process of connecting to WhatsApp server and receiving offline messages from server

UNK

onnection state is unknown

The shards field

  • For High Availability, only one Coreapp will own both the control shard (-1) and the normal shard (0). Its shards field will be [[-1, -1], [0, 0]], while other nodes have a shards field of [].
  • For Multiconnect, the primary Master will own the control shard (-1), and its shards field will be [[-1, -1]]. Coreapps that own shards will have a shards field of [[owned-shard-id, owned shard id]]. Currently, one Coreapp can only own 1 shard at the same time.

The role field

NameDescription

role

Role of the container in High Availability/Multiconnect setups
Values: primary_master, secondary_master, coreapp