We are sunsetting On-Premises API. Refer to our On-Premises API Sunset document for details, and to learn how to migrate to our next-generation Cloud API.
/v1/support
Use the support
node to get help with your WhatsApp Business API client. See Contact Support for more information on opening a Direct Support ticket.
An API call to the support
node returns information the Support team can use to help with your issue.
GET /v1/support
Using cURL
:
curl https://your-webapp-hostname:your-webapp-port/v1/support \ -H 'Authorization: Bearer your-auth-token'
A successful response includes data about your WhatsApp Business API client. The fields in the response may vary based on your specific installation:
{ "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" } }
{ "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", ... }, } }
socket_conn
FieldThe socket_conn
field provides the current state of the connection to the WhatsApp server.
Name | Description |
---|---|
| Disconnected from WhatsApp server. |
| Connected to WhatsApp server. |
| In the process of connecting to WhatsApp server. |
| In the process of connecting to WhatsApp server and receiving offline messages from server. |
| Connection state is unknown. |
shards
Field-1
) and the normal shard (0
). Its shards field is [[-1, -1], [0, 0]]
, while other nodes have a shards field of []
.-1
), and its shards field are [[-1, -1]]
. Coreapps that own shards have a shards field of [[
owned-shard-id
,
owned shard id
]]
. Currently, one Coreapp can only own 1 shard at the same time. role
FieldName | Description |
---|---|
| Role of the container in High Availability/Multiconnect setups. Values: |