CheckWhatsapp#
Метод проверяет наличие аккаунта WhatsApp на номере телефона.
Запрос#
Для проверки наличия аккаунта WhatsApp требуется выполнить запрос по адресу:
POST https://api.green-api.com/waInstance{{idInstance}}/checkWhatsapp/{{apiTokenInstance}}
Для получения параметров запроса idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
phoneNumber | integer | Да | Номер телефона получателя в международном формате: 11 или 12 цифр; Пример: 11001234567 или 380123456789 |
Пример тела запроса#
{
"phoneNumber": 11001234567
}
Ответ#
Поля ответа#
Поле | Тип | Описание |
---|---|---|
existsWhatsapp | boolean | Флаг наличия WhatsApp на номере телефона |
Пример тела ответа#
{
"existsWhatsapp": true
}
Ошибки CheckWhatsapp#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Код HTTP | Идентификатор ошибки | Описание |
---|---|---|
400 | bad phone number, valid 11 or 12 digits | Неверный формат номера телефона, должен быть 11 или 12 цифр |
400 | check phone number timeout limit exceeded | Превышен лимит времени ожидания ответа о проверке номера телефона |
Примеры кода#
import requests
import json
url = "https://api.green-api.com/waInstance{{idInstance}}/checkWhatsapp/{{apiTokenInstance}}"
payload = json.dumps({ "phoneNumber": 79876716790 })
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
curl --location 'https://api.green-api.com/waInstance{{idInstance}}/checkWhatsapp/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data '{
"phoneNumber": 79876716790
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append("https://api.greenapi.com")
.append("/waInstance").append({{idInstance}})
.append("/checkWhatsapp/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"phoneNumber\": 79876716790}";
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("https://api.greenapi.com")
.append("/waInstance").append({{idInstance}})
.append("/checkWhatsapp/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"phoneNumber\": 79876716790}")
.asString();
System.out.println(response);