GetChats#

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

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

Запрос#

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

GET

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

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

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

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

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

Параметр	Тип	Обязательный	Описание
`count`	integer	Нет	Количество чатов, отсортированных по времени активности в чате. Обновление происходит не чаще чем 1 раз в 1 минуту.

Ответ#

Поля ответа#

Поле	Тип	Описание
`chatId`	string	Идентификатор корреспондента или группового чата
`name`	string	Имя чата
`type`	string	Тип чата. Может принимать значения `user`, `group`, `channel`, `bot`
`phoneNumber`	integer	Номер телефона контакта Если номер телефона скрыт, или контакт являестя группой, принимает значение `0`
`unreadCount`	number	Количество непрочитанных сообщений в чате

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

[
    {
        "chatId": "-10000000000000",
        "name": "Название группы",
        "type": "group",
        "phoneNumber": 0,
        "unreadCount": 1
    },
    {
        "chatId": "10000000",
        "name": "Ходабрыш Пробешёлов",
        "type": "user",
        "phoneNumber": 79876543210,
        "unreadCount": 0
    },
    {
        "chatId": "10000001",
        "name": "Иван Царевич",
        "type": "user",
        "phoneNumber": 0,
        "unreadCount": 3
    },
    {
        "chatId": "10000002",
        "name": "Green-API bot",
        "type": "bot",
        "phoneNumber": 0,
        "unreadCount": 1
    }
]

Ошибки GetChats#

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

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