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

GetChats#

Test Postman Apidog

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

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

Запрос#

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

GET
{{apiUrl}}/v3/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}

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

Ответ#

Поля ответа#

Поле Тип Описание
chatId string Идентификатор корреспондента или группового чата
phoneNumber integer Номер телефона контакта

Если номер телефона скрыт, или контакт являестя группой, принимает значение 0

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

[
    {
        "chatId": "-10000000000000",
        "phoneNumber": 0
    },
    {
        "chatId": "10000000",
        "phoneNumber": 79876543210
    },
    {
        "chatId": "10000001",
        "phoneNumber": 79998887766
    },
    {
        "chatId": "10000002",
        "phoneNumber": 79001234567
    }
]

Ошибки GetContacts#

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

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