Skip to content
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,10 +187,10 @@ $handler->handle();
#### Chats

- [x] ~~`GET /chats` (`getChats`) - [*Получение списка всех чатов бота.*](./docs/README.md#Получение-списка-всех-чатов-бота-deprecated)~~ (deprecated)
- [x] `GET /chats/{chatLink}` (`getChatByLink`) - [*Получение информации о чате по ссылке.*](./docs/README.md#Получение-информации-о-чате-по-ссылке)
- [x] ~~`GET /chats/{chatLink}` (`getChatByLink`) - [*Получение информации о чате по ссылке.*](./docs/README.md#Получение-информации-о-чате-по-ссылке-deprecated)~~ (deprecated)
- [x] `GET /chats/{chatId}` (`getChat`) - [*Получение информации о чате по ID.*](./docs/README.md#Получение-информации-о-чате-по-ID)
- [x] `PATCH /chats/{chatId}` (`editChat`) - [*Редактирование информации о чате.*](./docs/README.md#Редактирование-информации-о-чате)
- [x] `DELETE /chats/{chatId}` (`deleteChat`) - [*Удаление чата.*](./docs/README.md#Удаление-чата)
- [x] ~~`DELETE /chats/{chatId}` (`deleteChat`) - [*Удаление чата.*](./docs/README.md#Удаление-чата-deprecated)~~ (deprecated)
- [x] `POST /chats/{chatId}/actions` (`sendAction`) - [*Отправка действия в чат (например, "печатает...").*](./docs/README.md#Отправка-действия-в-чат)
- [x] `GET /chats/{chatId}/pin` (`getPinnedMessage`) - [*Получение закрепленного сообщения.*](./docs/README.md#Получение-закрепленного-сообщения)
- [x] `PUT /chats/{chatId}/pin` (`pinMessage`) - [*Закрепление сообщения.*](./docs/README.md#Закрепление-сообщения)
Expand All @@ -201,7 +201,7 @@ $handler->handle();
- [x] `POST /chats/{chatId}/members/admins` (`addAdmins`) - [*Назначение администраторов чата.*](./docs/README.md#Назначение-администраторов-чата)
- [x] `DELETE /chats/{chatId}/members/admins/{userId}` (`deleteAdmin`) - [*Снятие прав администратора.*](./docs/README.md#Снятие-прав-администратора)
- [x] `GET /chats/{chatId}/members` (`getMembers`) - [*Получение участников чата.*](./docs/README.md#Получение-участников-чата)
- [x] `POST /chats/{chatId}/members` (`addMembers`) - [*Добавление участников в чат.*](./docs/README.md#Добавление-участников-в-чат)
- [x] ~~`POST /chats/{chatId}/members` (`addMembers`) - [*Добавление участников в чат.*](./docs/README.md#Добавление-участников-в-чат-deprecated)~~ (deprecated, удаляется 30.09.2026)
- [x] `DELETE /chats/{chatId}/members` (`deleteMember`) - [*Удаление участника из чата.*](./docs/README.md#Удаление-участника-из-чата)

#### Subscriptions
Expand All @@ -225,6 +225,14 @@ $handler->handle();
- [x] `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - [*Получение детальной информации о видео.*](./docs/README.md#Получение-детальной-информации-о-видео)
- [x] `POST /answers` (`answerOnCallback`) - [*Ответ на нажатие callback-кнопки.*](./docs/README.md#Ответ-на-нажатие-callback-кнопки)

#### Comments

- [x] `GET /messages/{messageId}/comments` (`getComments`) - [*Получение комментариев к посту.*](./docs/README.md#Получение-комментариев-к-посту)
- [x] `GET /messages/{messageId}/comments/{commentId}` (`getCommentById`) - [*Получение комментария по ID.*](./docs/README.md#Получение-комментария-по-ID)
- [x] `POST /messages/{messageId}/comments` (`sendComment`) - [*Отправка комментария.*](./docs/README.md#Отправка-комментария)
- [x] `PUT /messages/{messageId}/comments` (`editComment`) - [*Редактирование комментария.*](./docs/README.md#Редактирование-комментария)
- [x] `DELETE /messages/{messageId}/comments` (`deleteComment`) - [*Удаление комментария.*](./docs/README.md#Удаление-комментария)

## Лицензия

Данная библиотека распространяется под лицензией MIT - подробности см. в файле [LICENSE](LICENSE).
82 changes: 76 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
- ~~`PATCH /me` (`editBotInfo`)~~ - [*Редактирование информации о боте.*](#Редактирование-информации-о-боте-deprecated) (deprecated)
- [Чаты](#Чаты)
- ~~`GET /chats` (`getChats`)~~ - [*Получение списка всех чатов бота.*](#Получение-списка-всех-чатов-бота-deprecated) (deprecated)
- `GET /chats/{chatLink}` (`getChatByLink`) - [*Получение информации о чате по ссылке.*](#Получение-информации-о-чате-по-ссылке)
- ~~`GET /chats/{chatLink}` (`getChatByLink`)~~ - [*Получение информации о чате по ссылке.*](#Получение-информации-о-чате-по-ссылке-deprecated) (deprecated)
- `GET /chats/{chatId}` (`getChat`) - [*Получение информации о чате по ID.*](#Получение-информации-о-чате-по-ID)
- `PATCH /chats/{chatId}` (`editChat`) - [*Редактирование информации о чате.*](#Редактирование-информации-о-чате)
- `DELETE /chats/{chatId}` (`deleteChat`) - [*Удаление чата.*](#Удаление-чата)
- ~~`DELETE /chats/{chatId}` (`deleteChat`)~~ - [*Удаление чата.*](#Удаление-чата-deprecated) (deprecated)
- `POST /chats/{chatId}/actions` (`sendAction`) - [*Отправка действия в чат (например, "печатает...").*](#Отправка-действия-в-чат)
- `GET /chats/{chatId}/pin` (`getPinnedMessage`) - [*Получение закрепленного сообщения.*](#Получение-закрепленного-сообщения)
- `PUT /chats/{chatId}/pin` (`pinMessage`) - [*Закрепление сообщения.*](#Закрепление-сообщения)
Expand All @@ -22,7 +22,7 @@
- `POST /chats/{chatId}/members/admins` (`addAdmin`) - [*Назначение администраторов чата.*](#Назначение-администраторов-чата)
- `DELETE /chats/{chatId}/members/admins/{userId}` (`deleteAdmins`) - [*Снятие прав администратора.*](#Снятие-прав-администратора)
- `GET /chats/{chatId}/members` (`getMembers`) - [*Получение участников чата.*](#Получение-участников-чата)
- `POST /chats/{chatId}/members` (`addMembers`) - [*Добавление участников в чат.*](#Добавление-участников-в-чат)
- ~~`POST /chats/{chatId}/members` (`addMembers`)~~ - [*Добавление участников в чат.*](#Добавление-участников-в-чат-deprecated) (deprecated)
- `DELETE /chats/{chatId}/members` (`deleteMember`) -[*Удаление участника из чата.*](#Удаление-участника-из-чата)
- [Получение обновлений](#Получение-обновлений)
- `GET /subscriptions` (`getSubscriptions`) - [*Получение списка Webhook-подписок.*](#Получение-списка-Webhook-подписок)
Expand All @@ -40,6 +40,12 @@
- `GET /messages/{messageId}` (`getMessageById`) - [*Получение сообщения по ID.*](#Получение-сообщения-по-ID)
- `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - [*Получение детальной информации о видео.*](#Получение-детальной-информации-о-видео)
- `POST /answers` (`answerOnCallback`) - [*Ответ на нажатие callback-кнопки.*](#Ответ-на-нажатие-callback-кнопки)
- [Комментарии](#Комментарии)
- `GET /messages/{messageId}/comments` (`getComments`) - [*Получение комментариев к посту.*](#Получение-комментариев-к-посту)
- `GET /messages/{messageId}/comments/{commentId}` (`getCommentById`) - [*Получение комментария по ID.*](#Получение-комментария-по-ID)
- `POST /messages/{messageId}/comments` (`sendComment`) - [*Отправка комментария.*](#Отправка-комментария)
- `PUT /messages/{messageId}/comments` (`editComment`) - [*Редактирование комментария.*](#Редактирование-комментария)
- `DELETE /messages/{messageId}/comments` (`deleteComment`) - [*Удаление комментария.*](#Удаление-комментария)
- [Laravel](#Laravel)
- [Регистрация пакета](#Регистрация-пакета)
- [Настройка](#Настройка)
Expand Down Expand Up @@ -154,6 +160,8 @@ $botInfo = $api->editBotInfo(

### Получение списка всех чатов бота (deprecated)

С июня 2026 API не поддерживает `GET /chats`. Идентификаторы чатов собирайте из событий `bot_added` и `bot_started`.

Возвращает информацию о чатах, в которых участвовал бот.
Результат включает список чатов и маркер для перехода к следующей странице.

Expand All @@ -164,7 +172,9 @@ $chats = $api->getChats(
);
```

### Получение информации о чате по ссылке
### Получение информации о чате по ссылке (deprecated)

Метода `GET /chats/{chatLink}` нет в документации и схеме Bot API с версии 0.0.33.

Возвращает информацию о чате по его публичной ссылке, либо информацию о диалоге с пользователем по его username.

Expand All @@ -191,7 +201,9 @@ $chat = $api->editChat(
);
```

### Удаление чата
### Удаление чата (deprecated)

Метода `DELETE /chats/{chatId}` нет в документации и схеме Bot API с версии 0.0.33.

```php
$api->deleteChat(12345);
Expand Down Expand Up @@ -277,7 +289,10 @@ $api->deleteAdmin(
$chatMemberList = $api->getMembers(12345);
```

### Добавление участников в чат
### Добавление участников в чат (deprecated)

С 9 сентября 2026 метод `POST /chats/{chatId}/members` ограничен, 30 сентября 2026 его удаляют. Готовой замены в API
нет.

```php
$api->addMembers(
Expand Down Expand Up @@ -456,9 +471,64 @@ $api->answerOnCallback(
link: null, // Ссылка на сообщение (необязательно)
format: null, // Формат сообщения Markdown или HTML (необязательно)
notify: true, // Заполните это, если хотите просто отправить одноразовое уведомление пользователю (необязательно)
disableLinkPreview: false, // Не генерировать превью ссылок в новом тексте (необязательно)
);
```

## Комментарии

Комментарии оставляют к постам в каналах. В отличие от сообщений, у комментария нет вложений и публичной ссылки.
Для некоторых методов бот должен быть администратором канала с нужными правами. События `comment_created`,
`comment_edited` и `comment_removed` приходят, только если у бота есть право `read_all_messages`.

### Получение комментариев к посту

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

```php
$comments = $api->getComments(
messageId: 'mid.post', // Идентификатор поста
commentIds: ['mid.1', 'mid.2'], // Идентификаторы нужных комментариев (необязательно)
before: 1678886400000, // Комментарии до этого времени (необязательно)
after: 1678880000000, // Комментарии после этого времени (необязательно)
count: 50, // Максимальное количество комментариев в ответе, 1-100 (необязательно)
);
```

### Получение комментария по ID

```php
$comment = $api->getCommentById('mid.post', 'mid.comment');
```

### Отправка комментария

```php
$comment = $api->sendComment(
messageId: 'mid.post', // Идентификатор поста
text: 'Спасибо за пост!', // Текст комментария
format: MessageFormat::Markdown, // Формат текста Markdown или HTML (необязательно)
link: new MessageLink(MessageLinkType::Reply, 'mid.comment'), // Ответ на другой комментарий (необязательно)
disableLinkPreview: false, // Не генерировать превью ссылок (необязательно)
);
```

### Редактирование комментария

```php
$result = $api->editComment(
messageId: 'mid.post',
commentId: 'mid.comment',
text: 'Исправленный текст',
);
```

### Удаление комментария

```php
$result = $api->deleteComment('mid.post', 'mid.comment');
```

## Laravel

### Регистрация пакета
Expand Down
Loading
Loading