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

GetContactInfo#

Test Postman Apidog

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

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

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

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

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

Префикс v3 стал необязательным параметром запроса

Для вашего удобства унифицировали формат запросов методов API для всех мессенджеров.
Подробнее о правилах вызова методов читайте в статье Выполнение запросов.

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

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

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

{
    "chatId": "10000000"
}

Ответ#

Поля ответа#

Поле Тип Описание
avatar string Ссылка на аватар
name string Имя контакта. Возможные значения:
1. Если есть аккаунт, то получаем имя из профиля мессенджера MAX;
2. Если нет аккаунта, то получаем пустую строку.
contactName string Имя контакта . Возможные значения:
1. Если номер сохранён в контактах, то получаем имя из контактной книги;
2. Если номер не добавлен или удалён из контактной книги, то получаем пустую строку.
chatId string Идентификатор индивидуального чата
chatType string Тип чата.
Может принимать значения user, group, channel, bot
lastSeen string Время последнего статуса онлайн
Время последнего статуса онлайн в UNIX-формате
Если аккаунт не создан, то возвращается значение null
phoneNumber integer Номер телефона контакта
Если номер телефона скрыт, принимает значение 0
phoneNumberTimestamp integer Время получения номера телефона от сервера MAX

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

{
    "avatar": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2Not8_NnztwA3vQTnG7UnQg66d1tkit94ОАfZR8Ps9urfic",
    "name": "Ходабрыш Пробешёлов",
    "contactName": "Ходабрыш Пробешёлов",
    "chatId": "10000000",
    "chatType": "user",
    "lastSeen": 1754632014,
    "phoneNumber": 79876543210,
    "phoneNumberTimestamp": 1782133087
}

Ошибки 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

либо метод был использован с chatId
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": "10000000"
}'
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  
    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