GetContacts#

Метод предназначен для получения списка контактов текущего аккаунта.

Обновление информации о контактах может занимать до 5 минут.

При получении пустого массива данных - повторить вызов метода.

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

Запрос#

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

GET

{{apiUrl}}/v3/waInstance{{idInstance}}/getContacts/{{apiTokenInstance}}

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

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

Параметр	Тип	Обязательный	Описание
`count`	integer	Нет	При указании числа `count={{number}}`, отображается указанное количество контактов
			Если контактов меньше, чем указанное число, то отображаются все контакты, соответствующие запросу
			При отсутствии параметра показываются все контакты

Пример запроса с указанным количеством контактов#

GET

{{apiUrl}}/v3/waInstance{{idInstance}}/getContacts/{{apiTokenInstance}}?count=50

Ответ#

Поля ответа#

Поле	Тип	Описание
`chatId`	string	Идентификатор корреспондента или группового чата
`name`	string	Имя контакта. Возможные значения:
		1. Если есть входящая переписка/реакции от аккаунта, то получаем имя из профиля аккаунта
		2. Если нет входящей переписки/реакций от аккаунта, то получаем пустую строку
`contactName`	string	Имя контакта
`type`	string	Тип контакта. Возможные значения:
		`user` - контакт принадлежит корреспонденту
`phoneNumber`	integer	Номер телефона контакта Если номер телефона скрыт, или контакт являестя группой, принимает значение `0`

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

[
    {
        "chatId": "10000000",
        "name": "Ходабрыш Пробешёлов",
        "contactName": "Ходабрыш Пробешёлов", 
        "type": "user",
        "phoneNumber": 79876543210
    },
    {
        "chatId": "10000001",
        "name": "Люся Сидорова",
        "contactName": "Люся Сидорова",
        "type": "user",
        "phoneNumber": 79998887766
    },
    {
        "chatId": "10000002",
        "name": "Вася Петров",
        "contactName": "Вася Петров",
        "type": "user",
        "phoneNumber": 0
    }
]

Ошибки GetContacts#

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

Код HTTP	Описание ошибки	Возможные решения
200	Метод getContacts возвращает пустой массив `[]`	Обратиться в службу техподдержки.

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

PythoncURLJava - SpringJava - UnirestVBA

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getContacts/{{apiTokenInstance}}"

payload = {}
headers= {}

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

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

curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/getContacts/{{apiTokenInstance}}'

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

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

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

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

System.out.println(response);

Sub GetContacts()
    Dim url 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}}/v3/waInstance{{idInstance}}/GetContacts/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False
    http.Send

    response = http.responseText

    Debug.Print response

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

    Set http = Nothing
End Sub