Чаты
CheckOnline
Чтение.
Проверить, онлайн ли пользователь.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
personId |
int |
да | ID пользователя (personId) |
CreateChat
Запись. Блокируется режимом PILOT_READONLY.
Создать групповой чат.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
name |
string |
да | Название чата | |
description |
string |
нет | "" |
Описание чата (необязательно) |
EditMessage
Запись. Блокируется режимом PILOT_READONLY.
Редактировать ранее отправленное сообщение.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
chatId |
string |
да | GUID чата | |
messageId |
string |
да | GUID сообщения для редактирования | |
newText |
string |
да | Новый текст сообщения |
GetChat
Чтение.
Получить информацию о конкретном чате по его GUID.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
chatId |
string |
да | GUID чата |
GetChatMembers
Чтение.
Получить участников чата.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
chatId |
string |
да | GUID чата |
GetChats
Чтение.
Получить список чатов. Возвращает последние чаты пользователя.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
count |
int |
нет | 20 |
Количество чатов (по умолчанию 20) |
GetMessage
Чтение.
Получить одно сообщение по его GUID.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
messageId |
string |
да | GUID сообщения |
GetMessages
Чтение.
Прочитать сообщения из чата (от старых к новым внутри страницы). Пагинация: skip=0 — самые новые count сообщений, skip=count — предыдущая страница и т.д. Правки сообщений подставляются в текст с пометкой (ред.), реакции и markdown помечаются.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
chatId |
string |
да | GUID чата | |
count |
int |
нет | 30 |
Количество сообщений (по умолчанию 30) |
skip |
int |
нет | 0 |
Пропустить N самых новых сообщений (для пагинации назад по истории) |
maxMessageLength |
int |
нет | 500 |
Макс. длина текста одного сообщения (0 = без лимита) |
GetPersonalChat
Чтение.
Получить личный чат с конкретным пользователем (если он уже существует; сам инструмент чат не создаёт).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
personId |
int |
да | ID пользователя (personId) |
GetRelatedChats
Чтение.
Получить чаты, связанные с объектом (например, обсуждение задачи или документа).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
objectId |
string |
да | GUID объекта | |
relationType |
string |
нет | "Relation" |
Тип связи: Relation или Attach (по умолчанию Relation) |
ReplyMessage
Запись. Блокируется режимом PILOT_READONLY.
Ответить на конкретное сообщение в чате.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
chatId |
string |
да | GUID чата | |
replyToMessageId |
string |
да | GUID сообщения, на которое отвечаем | |
text |
string |
да | Текст ответа |
SearchMessages
Чтение.
Поиск сообщений по тексту в указанных чатах (если chatIds пуст — во всех чатах текущего пользователя).
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
query |
string |
да | Строка поиска | |
chatIds |
string |
нет | "" |
GUID чатов через запятую (если пусто — поиск по всем) |
maxResults |
int |
нет | 50 |
Макс. результатов (по умолчанию 50) |
SendMessage
Запись. Блокируется режимом PILOT_READONLY.
Отправить сообщение в чат.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
chatId |
string |
да | GUID чата | |
text |
string |
да | Текст сообщения |