Skip to content


The method is aimed for getting the status of the account instance socket connection with WhatsApp.


To get account socket status, you have to execute a request at:

GET {{APIUrl}}/waInstance{{idInstance}}/getStatusInstance/{{apiTokenInstance}}

For APIUrl, idInstance and apiTokenInstance request parameters, refer to Before you start section.


Response parameters#

Parameter Type Description
statusInstance string Account socket connection status. Have variants:
online - Account can get/post messages, socket is open
offline - Account can't get/post messages, socket is closed

Response body example#

    "statusInstance": "online"

Errors GetStatusInstance#

For a list of errors common to all methods, refer to Common errors section

Request examples#

import requests

url = "{{APIUrl}}/waInstance{{idInstance}}/getStatusInstance/{{apiTokenInstance}}"

payload = {}
headers= {}

response = requests.request("GET", url, headers=headers, data = payload)

curl --location '{{APIUrl}}/waInstance{{idInstance}}/getStatusInstance/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();

var response =, HttpMethod.GET, null, String.class);
var requestUrl = new StringBuilder();

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")

Sub GetStatusInstance()
    Dim url As String
    Dim http As Object
    Dim response As String

    ' The idInstance and apiTokenInstance values are available in your account, double brackets must be removed
    url = "{{APIUrl}}/waInstance{{idInstance}}/GetStatusInstance/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    ' Range("A1").Value = response

    Set http = Nothing
End Sub