itd-api / ChatsApi
Interface: ChatsApi
Defined in: chats-api.ts:7
Чаты полного клиента: REST-операции и канал событий.
Extends
Properties
events
readonly events: ChatEvents;Defined in: chats-api.ts:8
Methods
acceptRequest()
acceptRequest(chatId, options?): Promise<void>;Defined in: resources/chats.ts:565
Принимает запрос на переписку.
Parameters
chatId
string
options?
RequestOptions = {}
Returns
Promise<void>
Inherited from
clearHistory()
clearHistory(
chatId,
forEveryone?,
options?
): Promise<ChatChange | undefined>;Defined in: resources/chats.ts:596
Очищает историю у текущего пользователя или у всех участников.
Parameters
chatId
string
forEveryone?
boolean = false
options?
RequestOptions = {}
Returns
Promise<ChatChange | undefined>
Inherited from
createDirect()
createDirect(userId, options?): Promise<ChatDirectResult>;Defined in: resources/chats.ts:410
Возвращает ID личного чата по ID собеседника. created показывает, создан ли новый чат.
Parameters
userId
string
options?
RequestOptions = {}
Returns
Promise<ChatDirectResult>
Inherited from
delete()
delete(
chatId,
forEveryone?,
options?
): Promise<ChatChange | undefined>;Defined in: resources/chats.ts:608
Удаляет чат у текущего пользователя или у всех участников.
Parameters
chatId
string
forEveryone?
boolean = false
options?
RequestOptions = {}
Returns
Promise<ChatChange | undefined>
Inherited from
deleteMessagesForAll()
deleteMessagesForAll(
chatId,
messageIds,
options?
): Promise<ChatDeletedMessages>;Defined in: resources/chats.ts:512
Удаляет сообщения из истории всех участников.
Parameters
chatId
string
messageIds
readonly string[]
options?
RequestOptions = {}
Returns
Promise<ChatDeletedMessages>
Inherited from
ChatsResource.deleteMessagesForAll
deleteMessagesForMe()
deleteMessagesForMe(
chatId,
messageIds,
options?
): Promise<ChatDeletedMessages>;Defined in: resources/chats.ts:499
Удаляет сообщения из истории текущего пользователя.
Parameters
chatId
string
messageIds
readonly string[]
options?
RequestOptions = {}
Returns
Promise<ChatDeletedMessages>
Inherited from
ChatsResource.deleteMessagesForMe
editMessage()
editMessage(
chatId,
messageId,
input,
options?
): Promise<ChatEditedMessage>;Defined in: resources/chats.ts:464
Меняет содержимое сообщения. Пустой массив entities сбрасывает форматирование.
Parameters
chatId
string
messageId
string
input
options?
RequestOptions = {}
Returns
Promise<ChatEditedMessage>
Inherited from
fileLinks()
fileLinks(
chatId,
fileIds,
options?
): Promise<ChatFileLink[]>;Defined in: resources/chats.ts:332
Получает временные ссылки на файлы чата. Срок действия каждой ссылки указан в expiresIn.
Parameters
chatId
string
fileIds
readonly string[]
options?
RequestOptions = {}
Returns
Promise<ChatFileLink[]>
Inherited from
forwardMessages()
forwardMessages(
chatId,
input,
options?
): Promise<ChatForwardedMessages>;Defined in: resources/chats.ts:482
Пересылает сообщения из другого чата. Результат содержит успешные и отклонённые элементы.
Parameters
chatId
string
input
options?
RequestOptions = {}
Returns
Promise<ChatForwardedMessages>
Inherited from
get()
get(chatId, options?): Promise<ChatSummary>;Defined in: resources/chats.ts:218
Возвращает сводку чата по его идентификатору.
Parameters
chatId
string
options?
RequestOptions = {}
Returns
Promise<ChatSummary>
Inherited from
heardMessages()
heardMessages(
chatId,
messageIds,
options?
): Promise<string[]>;Defined in: resources/chats.ts:385
Возвращает ID прослушанных сообщений из переданного списка.
Parameters
chatId
string
messageIds
readonly string[]
options?
RequestOptions = {}
Returns
Promise<string[]>
Inherited from
iterate()
iterate(params?, options?): Paginator<ChatSummary>;Defined in: resources/chats.ts:201
Перебирает чаты текущего пользователя по курсору списка.
Parameters
params?
ChatListParams = {}
options?
PaginationOptions = {}
Returns
Example
for await (const chat of itd.chats.iterate({ limit: 20 })) {
console.log(chat.chatId, chat.unreadCount);
}Inherited from
iterateMessages()
iterateMessages(
chatId,
params?,
options?
): Paginator<ChatMessage>;Defined in: resources/chats.ts:263
Перебирает сообщения от новых к старым, подставляя ID последнего сообщения как курсор.
Parameters
chatId
string
params?
ChatListParams = {}
options?
PaginationOptions = {}
Returns
Example
for await (const message of itd.chats.iterateMessages(chatId)) {
console.log(message.text);
}Inherited from
list()
list(params?, options?): Promise<ChatListPage>;Defined in: resources/chats.ts:183
Возвращает страницу чатов текущего пользователя.
Parameters
params?
ChatListParams = {}
options?
RequestOptions = {}
Returns
Promise<ChatListPage>
Example
const page = await itd.chats.list({ limit: 20 });
if (page.nextBefore) await itd.chats.list({ before: page.nextBefore, limit: 20 });Inherited from
markHeard()
markHeard(
chatId,
messageId,
options?
): Promise<void>;Defined in: resources/chats.ts:570
Отмечает голосовое сообщение прослушанным.
Parameters
chatId
string
messageId
string
options?
RequestOptions = {}
Returns
Promise<void>
Inherited from
markRead()
markRead(
chatId,
lastReadMessage,
options?
): Promise<ChatReadResult>;Defined in: resources/chats.ts:552
Отмечает историю прочитанной до указанного сообщения включительно.
Parameters
chatId
string
lastReadMessage
string
options?
RequestOptions = {}
Returns
Promise<ChatReadResult>
Inherited from
media()
media(
chatId,
category,
params?,
options?
): Promise<ChatMediaPage>;Defined in: resources/chats.ts:300
Загружает вложения выбранной категории. Для следующей страницы передайте nextBefore.
Parameters
chatId
string
category
params?
ChatListParams = {}
options?
RequestOptions = {}
Returns
Promise<ChatMediaPage>
Inherited from
messages()
messages(
chatId,
params?,
options?
): Promise<ChatHistoryPage>;Defined in: resources/chats.ts:241
Загружает историю, начиная с последних сообщений.
Для следующей страницы передайте ID последнего сообщения страницы в before. Для последовательного чтения используйте iterateMessages.
Parameters
chatId
string
params?
ChatListParams = {}
options?
RequestOptions = {}
Returns
Promise<ChatHistoryPage>
Inherited from
messagesAround()
messagesAround(
chatId,
messageId,
limit?,
options?
): Promise<ChatHistoryPage>;Defined in: resources/chats.ts:286
Загружает часть истории вокруг сообщения. По умолчанию запрашивает до 40 сообщений.
Parameters
chatId
string
messageId
string
limit?
number = DEFAULT_AROUND_LIMIT
options?
RequestOptions = {}
Returns
Promise<ChatHistoryPage>
Inherited from
presence()
presence(userId, options?): Promise<ChatPresence>;Defined in: resources/chats.ts:345
Возвращает статус присутствия одного пользователя.
Parameters
userId
string
options?
RequestOptions = {}
Returns
Promise<ChatPresence>
Inherited from
presenceMany()
presenceMany(userIds, options?): Promise<Record<string, boolean>>;Defined in: resources/chats.ts:353
Возвращает карту ID → онлайн одним запросом.
Parameters
userIds
readonly string[]
options?
RequestOptions = {}
Returns
Promise<Record<string, boolean>>
Inherited from
reactionCatalog()
reactionCatalog(options?): Promise<ChatReactionCatalog>;Defined in: resources/chats.ts:365
Загружает список доступных реакций.
Parameters
options?
RequestOptions = {}
Returns
Promise<ChatReactionCatalog>
Inherited from
reactions()
reactions(
chatId,
messageId,
options?
): Promise<ChatMessageReactions>;Defined in: resources/chats.ts:373
Возвращает суммарные реакции на сообщение и версию их состояния.
Parameters
chatId
string
messageId
string
options?
RequestOptions = {}
Returns
Promise<ChatMessageReactions>
Inherited from
sendAction()
sendAction(
chatId,
type,
progress?,
options?
): Promise<void>;Defined in: resources/chats.ts:578
Показывает собеседнику действие. Для загрузки progress задаётся долей от 0 до 1.
Parameters
chatId
string
type
progress?
number
options?
RequestOptions = {}
Returns
Promise<void>
Inherited from
sendMessage()
sendMessage(
chatId,
input,
options?
): Promise<ChatSentMessage>;Defined in: resources/chats.ts:427
Отправляет сообщение в существующий чат.
Parameters
chatId
string
input
options?
RequestOptions = {}
Returns
Promise<ChatSentMessage>
Example
const sent = await itd.chats.sendMessage(chatId, { text: 'Привет!' });
console.log(sent.messageId);Inherited from
sendMessageToUser()
sendMessageToUser(
userId,
input,
options?
): Promise<ChatFirstMessage>;Defined in: resources/chats.ts:446
Отправляет сообщение по ID собеседника. Если диалога ещё нет, сервер создаёт его.
Parameters
userId
string
input
Omit<SendChatMessageInput, "replyToId">
options?
RequestOptions = {}
Returns
Promise<ChatFirstMessage>
Inherited from
ChatsResource.sendMessageToUser
setMuted()
setMuted(
chatId,
muted,
options?
): Promise<void>;Defined in: resources/chats.ts:534
Отключает или включает уведомления чата.
Parameters
chatId
string
muted
boolean
options?
RequestOptions = {}
Returns
Promise<void>
Inherited from
setPinned()
setPinned(
chatId,
pinned,
options?
): Promise<void>;Defined in: resources/chats.ts:525
Закрепляет или открепляет чат в списке.
Parameters
chatId
string
pinned
boolean
options?
RequestOptions = {}
Returns
Promise<void>
Inherited from
setReactions()
setReactions(
chatId,
messageId,
input,
options?
): Promise<ChatMessageReactions>;Defined in: resources/chats.ts:626
Заменяет реакции текущего пользователя. Пустой список снимает его реакции.
В expectedVersion передайте reactionVersion из reactions. При конфликте перечитайте состояние перед повторной записью.
Parameters
chatId
string
messageId
string
input
options?
RequestOptions = {}
Returns
Promise<ChatMessageReactions>
Inherited from
setUnread()
setUnread(
chatId,
unread,
options?
): Promise<void>;Defined in: resources/chats.ts:543
Выставляет или снимает ручную отметку непрочитанного.
Parameters
chatId
string
unread
boolean
options?
RequestOptions = {}
Returns
Promise<void>
Inherited from
unread()
unread(options?): Promise<ChatUnreadState>;Defined in: resources/chats.ts:227
Возвращает число непрочитанных и число чатов с непрочитанным.
Parameters
options?
RequestOptions = {}
Returns
Promise<ChatUnreadState>
Inherited from
updates()
updates(
since,
limit?,
options?
): Promise<ChatUpdatesPage>;Defined in: resources/chats.ts:401
Загружает изменения после eventSeq из списка чатов или nextEventSeq предыдущей страницы. Передайте возвращённый nextEventSeq в следующий вызов. При resetRequired перечитайте список чатов.
Parameters
since
number
limit?
number
options?
RequestOptions = {}
Returns
Promise<ChatUpdatesPage>
Inherited from
uploadFile()
uploadFile(
file,
uploadOptions?,
options?
): Promise<ChatUploadedFile>;Defined in: resources/chats.ts:323
Загружает файл в мессенджер. Потоковый источник должен сообщить размер заранее. deadline охватывает чтение файла, отправку частей и завершение загрузки.
Parameters
file
uploadOptions?
ChatUploadOptions = {}
options?
RequestOptions = {}
Returns
Promise<ChatUploadedFile>
Example
const { fileId } = await itd.chats.uploadFile(file);
await itd.chats.sendMessage(chatId, { text: '', attachmentIds: [fileId] });