Перейти к содержанию

GetContactInfo#

Test Postman

Метод предназначен для получения информации о контакте.

Запрос#

Для получения информации о контакте требуется выполнить запрос по адресу:

POST 
{{apiUrl}}/waInstance{{idInstance}}/getContactInfo/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр Тип Обязательный Описание
chatId string Да Идентификатор корреспондента

Пример тела запроса#

{
    "chatId": "10000000"
}

Ответ#

Поля ответа#

Поле Тип Описание
avatar string Ссылка на аватар
name string Имя контакта
contactName string Имя контакта из телефонной книги
chatId string Идентификатор корреспондента
lastSeen integer Время последнего статуса онлайн
phoneNumber integer Номер телефона контакта

Пример тела ответа#

{
    "avatar": "https://4100.api.green-api.com/download/4100/BTZ4NuB7eCzxAQozwDKYmcUEvgSXr.jpg",
    "name": "Василиса",
    "contactName": "Василиса Прекрасная",
    "chatId": "100000000",
    "lastSeen": 1769681957,
    "phoneNumber": 79876543210
}

Ошибки GetContactInfo#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP Идентификатор ошибки Описание
400 Bad Request
Validation failed		 Ошибка валидации
400 Bad Request
Validation failed.
Details: The method GetContactInfo does not support group chats, to work with groups, use the GetGroupData method		 Пустое тело запроса

либо неверное chatId

либо метод был использован с groupId
500 Internal Server Error
interface conversion: interface {} is bool, not string		 Неверно указан тип данных поля chatId

Примеры кода#

import requests

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

payload = {
    "chatId": "10000000"
}

response = requests.post(url, json=payload)

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getContactInfo/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "71234567890@c.us"
}'

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

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

var jsonBody = "{\"chatId\": \"10000000\"}";

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("/getContactInfo/")
    .append({{apiTokenInstance}});

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

System.out.println(response);

Sub GetContactInfo()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/GetContactInfo/{{apiTokenInstance}}"

    ' chatId - is the number to send the message to (@c.us for private chats, @g.us for group chats)
    RequestBody = "{""chatId"":""10000000""}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    With http
        .Open "POST", url, False
        .setRequestHeader "Content-Type", "application/json"
        .Send RequestBody
    End With

    response = http.responseText

    Debug.Print response

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

    Set http = Nothing
End Sub