GetChats#

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

Запрос#

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

GET

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

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

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

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

Ответ#

Поля ответа#

Поле	Тип	Описание
`archive`	boolean	Флаг указывает на то, находится ли чат в архиве или нет
`id`	string	Идентификатор чата
		`79001234567` - автоматически приводится к виду номера
		`79001234567@c.us` - номер телефона
		`123456789012345@lid` - `lid`- идентификатор
`ephemeralExpiration`	integer	Время жизни сообщений в чате, принимает значения в секундах: 0, 86400, 604800, 7776000
`ephemeralSettingTimestamp`	integer	Время наступления события в UNIX-формате
`name`	string	Имя контакта или группы
`type`	string	Тип контакта. Возможные значения:
		`user` - контакт принадлежит корреспонденту
		`group` - контакт является групповым чатом

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

[
    {
        "archive": false,
        "id": "79876543210@c.us",
        "ephemeralExpiration": 86400,
        "ephemeralSettingTimestamp": 1777870423,
        "name": "Иван Царевич",
        "type": "user"
    },
    {
        "archive": false,
        "id": "79001234567@c.us",
        "ephemeralExpiration": 0,
        "ephemeralSettingTimestamp": 0,
        "name": "Василиса Прекрасная",
        "type": "user"
    },
    {
        "archive": false,
        "id": "79001234567-1479621234@g.us",
        "ephemeralExpiration": 0,
        "ephemeralSettingTimestamp": 0,
        "name": "Моя группа",
        "type": "group"
    }
]

Ошибки GetChats#

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

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

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

PythoncURLJava - SpringJava - UnirestVBA

import requests

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

payload = {}
headers= {}

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

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getChats/")
    .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("/waInstance").append({{idInstance}})
    .append("/getChats/")
    .append({{apiTokenInstance}});

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

System.out.println(response);

Sub getChats()
    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}}/waInstance{{idInstance}}/getChats/{{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