Get Support Info
GET {{URL}}/v1/support
Make a
GET
request to the
/v1/support
endpoint to retrieve information that the Support team can use to help with your issue.
Parameters
socket_conn
The
socket_conn
field provides the current state of the connection to the WhatsApp server.
| Name | Description |
|---|---|
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
| Connection state is unknown. |
shards
-
For High Availability, only one Coreapp owns both the control shard (
-1) and the normal shard (0). Its shards field is[[-1, -1], [0, 0]], while other nodes have a shards field of[]. -
For Multiconnect, the primary Master owns the control shard (
-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
| Name | Description |
|---|---|
role
|
The role of the container in High Availability/Multiconnect setups.
Values: primary master, secondary master, coreapp |
Response
A successful response includes data about your WhatsApp Business API client. The fields in the response may vary based on your specific installation.
HEADERS
| Key | Datatype | Required | Description |
| Authorization | string | | |
RESPONSES
status: OK
"{\n \"support\": {\n \"your-hostname1:your-container-id1\": {\n \"multi_connect\" : true,\n \"role\": \"primary_master | secondary_master | coreapp\",\n \"shards\": [ [your-owned-shard-id, your-owned-shard-id], ...],\n \"context\": \"healthcheck\",\n \"db_engine\": \"MYSQL | PGSQL\",\n \"db_info\": [ ... ],\n \"debug_info\": \"enterprise phone number\",\n \"description\": \"build information\",\n ...\n },\n \"your-hostname2:your-container-id2\": {\n \"multi_connect\" : true,\n \"role\": \"primary_master | secondary_master | coreapp\",\n \"shards\": [ [your-owned-shard-id, your-owned-shard-id], ...],\n \"context\": \"healthcheck\",\n \"db_engine\": \"MYSQL | PGSQL\",\n \"db_info\": [ ... ],\n \"debug_info\": \"enterprise phone number\",\n \"description\": \"build information\",\n ...\n }\n }\n {\n \"support\": {\n \"context\": \"healthcheck\", # context of the API\n \"db_engine\": \"MYSQL\"\n \"db_info\": [ database-driver-version\n ],\n \"debug_info\": \"business-phone-number\", #phone number if registered, otherwise, unregistered\n \"description\": \"whatsapp-build-version\",\n \"device_iso8601\": \"current-timestamp\",\n \"e2e\": { # encryption debug info\n \"identity_timestamp\": \"id-timestamp\",\n \"registration_id\": registration-id\n },\n \"env\": [ client-env-variables\n ],\n \"expire_timestamp\": \"2018-09-27T14:26:07\", # app build version expires timestamp \n \"free_space_data\": 9223372036853727000, # bytes available on the data directory \n \"free_space_logs\": 14269902848, # bytes available on the log directory\n \"free_space_media_incoming\": 9223372036853727000, # bytes available on the media incoming directory\n \"free_space_media_outgoing\": 9223372036853727000, # bytes available on the media outgoing directory\n \"lc\": \"en\", # lowercase, two-letter ISO 639 language code, ZZ if code is unknown\n \"lg\": \"US\", # uppercase, two or three-letter ISO 3166 country code, ZZ if code is unknown\n \"multi_connect\": false, # specifies whether current client is multiconnect enabled \n \"os_name\": \"ubuntu-x86_64\", # operating system name \n \"os_version\": \"16.04\", # operating system version\n\n \"schema\": { # database schema versions\n \"axolotl\": 1,\n \"callback\": 2,\n \"cluster\": 3,\n \"config\": 4,\n \"contact\": 5,\n \"jobqueue\": 6,\n \"message\": 7\n },\n \"socket_conn\": \"UP | DN\" | \"SC\" | \"UP receiving offline\" | \"UNK\", # see options below\n \"version\": \"build-version\"\n }\n },\n \"meta\": {\n \"api_status\": \"stable\",\n \"version\": \"v2.45.1\"\n }\n}"