UnbanStatus#

Method under development#

The method is intended to obtain the status of unblocking an account.

Request#

To send a request to unbanStatus, you have to execute a request at:

POST

{{apiUrl}}/waInstance{{idInstance}}/unbanStatus/{{apiTokenInstance}}

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

Request parameters#

Selective specification of parameters is allowed. At least one parameter must be specified.

Parameter	Type	Mandatory	Description
`phoneNumber`	integer	Yes	Phone number in international format without `+` or `00`

Request body example#

{
    "phoneNumber": 441234567890
}

Response#

Response parameters#

Parameter	Type	Description
`status`	string	Account unlock request status
		`NO_APPEAL_OPEN` - No unlock request was received
		`UNBANNED` - Account is unblocked
		`IN_REVIEW` - Request to remove the ban is being processed, a new request to unblock is not required
		`PERMANETLY_BANNED` - Permanent ban, unbanning an account is impossible, you need to request
`reason`	string	Reason for refusal

Response body example#

{
    "status": "UNBANNED",
    "reason": "",
}

UnbanStatus errors#

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

Request examples#

PythoncURLJava - SpringJava - Unirest

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/unbanStatus/{{apiTokenInstance}}"

payload = "{\r\n\t\"phoneNumber\": 441234567890\r\n}"
headers = {
    'Content-Type': 'application/json'
}

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

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/unbanStatus/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data '{
    "phoneNumber": 441234567890
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/unbanStatus/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\"phoneNumber\": 441234567890}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/unbanStatus/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\"phoneNumber\": 441234567890}")
    .asString();

System.out.println(response);