chats

Получить информацию по чатам

Метод позволяет получить массив всех чатов агентства или только определенного сотрудника с учетом параметров сортировки и пагинации за выбранный период. Максимальный размер окна выборки по дате создания - полгода.

В объекте каждого чата: данные о последнем сообщении, его авторе и объявлении, по которому создан чат.

При активной подписке в вебхуках на системные сообщения systemMessages по этому методу можно получать также данные по системным чатам (Циан и модерация).

Пример:

curl -X GET -H 'Authorization: Bearer <ACCESS TOKEN>' https://public-api.cian.ru/v1/get-chats?page=1&pageSize=100&orderBy=chatId&chatCreatedFrom=2024-10-04+07:56:31&chatCreatedTill=2025-02-24+07:56:31
get/v1/get-chats

Request

  • Base URL: https://public-api.cian.ru
  • URL: https://public-api.cian.ru/v1/get-chats
  • Auth: none declared

Query parameters

chatCreatedFromstring date-time

Дата и время создания чата, с которого выгружать чаты включительно. Если параметр не указан, то по умолчанию используется месяц полгода назад от chatCreatedTill.

chatCreatedTillstring date-time

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

employeeIdinteger

ID кабинета сотрудника в Циане. Список активных сотрудников можно получить по методу или найти в Личном кабинете в разделе Сотрудники. Метод работает только с сотрудниками этого агентства недвижимости, если такого сотрудника нет, вернется пустой ответ.

orderBy'chatId' | 'createdAt' | 'updatedAt'

createdAt: Время создания чата updatedAt: Время обновления чата chatId: Идентификатор чата

Поле, используемое для сортировки чатов в ответе метода. Сортировать можно по ID чата (chatId), дате создания чата (createdAt) или дате последнего сообщения в чате (updatedAt). Если параметр не указан, то по умолчанию используется значение updatedAt.

orderDir'asc' | 'desc'

asc: По возрастанию desc: По убыванию

Направление сортировки: asc - по возрастанию значения поля orderBy, desc - по убыванию значения поля orderBy. Если параметр не указан, то по умолчанию используется значение desc.

pageinteger required

Номер страницы, если количество чатов в ответе метода превышает pageSize. Обязательный параметр. Страницы нумеруются с 1. Если указан несуществующий номер страницы, вернется пустой ответ.

pageSizeinteger required

Количество чатов, возвращаемое методом за один вызов. Обязательный параметр. Минимальное значение 1, максимальное значение 100.

Response

OK

operationIdstring uuid required

ID запроса

Changes

No recorded changes to this operation across all 1 revision of this API.