Документация API JCat.Недвижимость

Сообщения

Запрос на получение списка тем

GET https://chats.jcat.ru/v1/threads

Параметры пагинации:

Имя параметра	Тип	Описание	Пример значения	Обязательное
page	integer	Номер страницы	1	Нет
limit	integer	Кол-во записей на страницу	20	Нет

Принимаемые параметры:

Имя параметра	Тип	Описание	Пример значения	Обязательное
entity	string	Тип сущности При работе с API JCat.Недвижимость всегда равен "order"	order	Да
only_uread	bool \| int	Получить только темы, в которых есть непрочитанные сообщения	true \| 1	Нет
search	string \| int	Поиск по идентификатору объявления, автору или названию объявления При типе строка - минимальное количество символов - 3.	Сергей \| 301008556	Нет

Результат запроса:

200 OK - успешное выполнение
401 Unauthorized - пользователь не авторизован или не верный ключ
403 Forbidden - доступ для данного пользователя запрещен

Пример ответа:

{
    "items": [
        {
            "ulid": "01HWWC62ZXTTTNRPQT1MZ9PZ6Q",
            "board_id": 1234,
            "order_id": 123456789,
            "order_title": "3-к. квартира, 64,8 м², 7/22 эт.",
            "author": "Gogi",
            "author_avatar": "https://static.avito.ru/stub_avatars/G/12_256x256.png",
            "last_message": "еще продается?",
            "last_message_at": "2024-06-10 12:04:19",
            "unread_messages": 10,
            "entity": "order"
        },
        {
            "ulid": "01HWWQXXBXJ7BX0CK2EHHHH81R",
            "board_id": 1234,
            "order_id": 123456789,
            "order_title": "2-к. квартира, 2/9 эт",
            "author": "Мария",
            "author_avatar": "https://static.avito.ru/stub_avatars/%D0%9C/12_256x256.png",
            "last_message": "Здравствуйте. Скажите, пожалуйста, а вы готовы продать с ипотекой?",
            "last_message_at": "2024-05-02 16:24:30",
            "unread_messages": 1,
            "entity": "order"
        }
    ],
    "total": 2,
    "pages": {
        "page": 1,
        "total": 1
    }
}

Запрос на получение списка сообщений по выбранной теме

GET https://chats.jcat.ru/v1/threads/{ulid}/messages

Параметры пагинации:

Имя параметра	Тип	Описание	Пример значения	Обязательное
page	integer	Номер страницы	1	Нет
limit	integer	Кол-во записей на страницу	20	Нет

Принимаемые параметры:

Имя параметра	Тип	Описание	Пример значения	Обязательное
{ulid}	ulid	Уникальный идентификатор темы	01XXVJ4K3W89Z6XJNB88WTCTM7	Да
search	string	Поиск по содержимому сообщения Минимальное количество символов - 3.	Добрый день	Нет

Результат запроса:

200 OK - успешное выполнение
401 Unauthorized - пользователь не авторизован или не верный ключ
403 Forbidden - доступ для данного пользователя запрещен
404 Not Found - тема не найдена

Пример ответа:

{
    "items": [
        {
            "ulid": "01HXXJ4K3W89Z6XJNB99WTCMM7",
            "message": "Добрый день! Подскажите, сколько добираться до метро пешком?",
            "type": "text",
            "direction": "incoming",
            "readed_at": "2024-06-10 20:00:04",
            "created_at": "2024-05-14 15:44:47"
        },
        {
            "ulid": "01HXXX8034SQ5RVR3TY67WATSR",
            "message": "Здравствуйте, недолго, минут 5",
            "type": "text",
            "direction": "outgoing",
            "readed_at": "2024-05-31 15:01:31",
            "created_at": "2024-05-15 13:54:50"
        },
    ],
    "total": 2,
    "pages": {
        "page": 1,
        "total": 1
    }
}

Запрос на отправку сообщения для выбранной темы

POST https://chats.jcat.ru/v1/threads/{ulid}/message

Принимаемые параметры:

Имя параметра	Тип	Описание	Пример значения	Обязательное
{ulid}	ulid	Уникальный идентификатор темы	01XXVJ4K3W89Z6XJNB88WTCTM7	Да
message	string	Текст сообщения Максимальное количество символов - 4000.	Здравствуйте, берете?	Да

Результат запроса:

200 OK - успешное выполнение
400 Bad Request - сообщение пустое или слишком длинное
401 Unauthorized - пользователь не авторизован или не верный ключ
403 Forbidden - доступ для данного пользователя запрещен
404 Not Found - тема не найдена

При успехе возвращает пустой массив.

Запрос на удаление темы

DELETE https://chats.jcat.ru/v1/threads/{ulid}

Обязательные параметры:

Имя параметра	Тип	Описание	Пример значения	Обязательное
{ulid}	ulid	Уникальный идентификатор темы	01XXVJ4K3W89Z6XJNB88WTCTM7	Да

Результат запроса:

200 OK - успешное выполнение
401 Unauthorized - пользователь не авторизован или не верный ключ
403 Forbidden - доступ для данного пользователя запрещен
404 Not Found - тема не найдена

При успехе возвращает пустой массив.