Документация API JCat.Работа

Сообщения

Запрос на получение списка диалогов

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

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

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

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

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

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

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

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

{
    "items": [
        {
            "ulid": "01HWWC62ZXTTTNRPQT1MZ9PZ6Q",
            "board_id": 1234,
            "order_id": 123456789,
            "order_title": "Маляр порошковой окраски",
            "author": "Наталья",
            "author_avatar": "https://static.avito.ru/stub_avatars/%D0%9D/1_256x256.png",
            "author_city": "Челябинск",
            "last_message": "жду ответа",
            "last_message_at": "2024-06-10 12:04:19",
            "unread_messages": 10,
            "entity": "response",
            "response_id": 33482811
        },
        {
            "ulid": "01HWWQXXBXJ7BX0CK2EHHHH81R",
            "board_id": 1234,
            "order_id": 123456789,
            "order_title": "Конструктор-проектировщик",
            "author": "Мария",
            "author_avatar": "https://static.avito.ru/stub_avatars/%D0%9C/12_256x256.png",
            "author_city": "Казань",
            "last_message": "Здравствуйте. Еще актуально?",
            "last_message_at": "2024-05-02 16:24:30",
            "unread_messages": 1
            "entity": "response",
            "response_id": 33482812
        }
    ],
    "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-10-14 20:00:04",
            "created_at": "2024-10-14 15:44:47"
        },
        {
            "ulid": "01HXXX8034SQ5RVR3TY67WATSR",
            "message": "Здравствуйте. 2/2",
            "type": "text",
            "type": "outgoing",
            "readed_at": "2024-10-14 21:01:31",
            "created_at": "2024-10-14 20: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 - тема не найдена

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