Skip to content

Commit fa7875a

Browse files
BushlanovDevBushlanovDev
committed
Documentation
1 parent 70c290c commit fa7875a

File tree

2 files changed

+112
-19
lines changed

2 files changed

+112
-19
lines changed

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,17 +153,17 @@ $handler->handle();
153153

154154
#### Upload
155155

156-
- [x] `POST /uploads` (`getUploadUrl`) - *Получение URL для загрузки файла.*
156+
- [x] `POST /uploads` (`getUploadUrl`) - [*Получение URL для загрузки файла.*](./docs/README.md#Получение-URL-для-загрузки-файла)
157157

158158
#### Messages
159159

160-
- [x] `GET /messages` (`getMessages`) - *Получение списка сообщений из чата.*
161-
- [x] `POST /messages` (`sendMessage`) - *Отправка сообщения.*
162-
- [x] `PUT /messages` (`editMessage`) - *Редактирование сообщения.*
163-
- [x] `DELETE /messages` (`deleteMessage`) - *Удаление сообщения.*
164-
- [x] `GET /messages/{messageId}` (`getMessageById`) - *Получение сообщения по ID.*
165-
- [x] `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - *Получение детальной информации о видео.*
166-
- [x] `POST /answers` (`answerOnCallback`) - *Ответ на нажатие callback-кнопки.*
160+
- [x] `GET /messages` (`getMessages`) - [*Получение списка сообщений из чата.*](./docs/README.md#Получение-списка-сообщений-из-чата)
161+
- [x] `POST /messages` (`sendMessage`) - [*Отправка сообщения.*](./docs/README.md#Отправка-сообщения)
162+
- [x] `PUT /messages` (`editMessage`) - [*Редактирование сообщения.*](./docs/README.md#Редактирование-сообщения)
163+
- [x] `DELETE /messages` (`deleteMessage`) - [*Удаление сообщения.*](./docs/README.md#Удаление-сообщения)
164+
- [x] `GET /messages/{messageId}` (`getMessageById`) - [*Получение сообщения по ID.*](./docs/README.md#Получение-сообщения-по-ID)
165+
- [x] `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - [*Получение детальной информации о видео.*](./docs/README.md#Получение-детальной-информации-о-видео)
166+
- [x] `POST /answers` (`answerOnCallback`) - [*Ответ на нажатие callback-кнопки.*](./docs/README.md#Ответ-на-нажатие-callback-кнопки)
167167

168168
## Лицензия
169169

‎docs/README.md‎

Lines changed: 104 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,21 @@
2424
- `GET /chats/{chatId}/members` (`getMembers`) - [*Получение участников чата.*](#Получение-участников-чата)
2525
- `POST /chats/{chatId}/members` (`addMembers`) - [*Добавление участников в чат.*](#Добавление-участников-в-чат)
2626
- `DELETE /chats/{chatId}/members` (`deleteMember`) -[*Удаление участника из чата.*](#Удаление-участника-из-чата)
27-
- Получение обновлений
27+
- [Получение обновлений](#Получение-обновлений)
2828
- `GET /subscriptions` (`getSubscriptions`) - [*Получение списка Webhook-подписок.*](#Получение-списка-Webhook-подписок)
2929
- `POST /subscriptions` (`subscribe`) - [*Создание Webhook-подписки.*](#Создание-Webhook-подписки)
3030
- `DELETE /subscriptions` (`unsubscribe`) - [*Удаление Webhook-подписки.*](#Удаление-Webhook-подписки)
3131
- `GET /updates` (`getUpdates`) - [*Получение обновлений через Long-Polling.*](#Получение-обновлений-через-Long-Polling)
32-
- Загрузка файлов
33-
- `POST /uploads` (`getUploadUrl`) - *Получение URL для загрузки файла.*
34-
- Сообщения
35-
- `GET /messages` (`getMessages`) - *Получение списка сообщений из чата.*
36-
- `POST /messages` (`sendMessage`) - *Отправка сообщения.*
37-
- `PUT /messages` (`editMessage`) - *Редактирование сообщения.*
38-
- `DELETE /messages` (`deleteMessage`) - *Удаление сообщения.*
39-
- `GET /messages/{messageId}` (`getMessageById`) - *Получение сообщения по ID.*
40-
- `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - *Получение детальной информации о видео.*
41-
- `POST /answers` (`answerOnCallback`) - *Ответ на нажатие callback-кнопки.*
32+
- [Загрузка файлов](#Загрузка-файлов)
33+
- `POST /uploads` (`getUploadUrl`) - [*Получение URL для загрузки файла.*](#Получение-URL-для-загрузки-файла)
34+
- [Сообщения](#Сообщения)
35+
- `GET /messages` (`getMessages`) - [*Получение списка сообщений из чата.*](#Получение-списка-сообщений-из-чата)
36+
- `POST /messages` (`sendMessage`) - [*Отправка сообщения.*](#Отправка-сообщения)
37+
- `PUT /messages` (`editMessage`) - [*Редактирование сообщения.*](#Редактирование-сообщения)
38+
- `DELETE /messages` (`deleteMessage`) - [*Удаление сообщения.*](#Удаление-сообщения)
39+
- `GET /messages/{messageId}` (`getMessageById`) - [*Получение сообщения по ID.*](#Получение-сообщения-по-ID)
40+
- `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - [*Получение детальной информации о видео.*](#Получение-детальной-информации-о-видео)
41+
- `POST /answers` (`answerOnCallback`) - [*Ответ на нажатие callback-кнопки.*](#Ответ-на-нажатие-callback-кнопки)
4242

4343
## Быстрый старт
4444

@@ -267,6 +267,8 @@ $api->deleteMember(
267267
);
268268
```
269269

270+
## Получение обновлений
271+
270272
### Получение списка Webhook-подписок
271273

272274
```php
@@ -299,3 +301,94 @@ $updateList = $api->getUpdates(
299301
types: [UpdateType::MessageCreated], // Типы обновлений которые вы хотите получать (необязательно)
300302
);
301303
```
304+
305+
## Загрузка файлов
306+
307+
### Получение URL для загрузки файла
308+
309+
```php
310+
$uploadEndpoint = $api->getUploadUrl(UploadType::Video);
311+
```
312+
313+
## Сообщения
314+
315+
### Получение списка сообщений из чата
316+
317+
```php
318+
$messages = $api->getMessages(
319+
chatId: 12345, // ID чата, чтобы получить сообщения из определённого чата (необязательно)
320+
messageIds: [123, 456], // Список ID сообщений, которые нужно получить (необязательно)
321+
from: 10, // Время начала для запрашиваемых сообщений [Unix timestamp] (необязательно)
322+
to: 20, // Время окончания для запрашиваемых сообщений [Unix timestamp] (необязательно)
323+
count: 10, // Максимальное количество сообщений в ответе [1-100] (необязательно)
324+
);
325+
```
326+
327+
### Отправка сообщения
328+
329+
```php
330+
$message = $api->sendMessage(
331+
userId: 12345, // Если вы отправляете сообщение пользователю, укажите его ID (необязательно)
332+
chatId: 54321, // Если сообщение отправляется в чат, укажите его ID (необязательно)
333+
text: 'Привет мир!', // Текст сообщения (необязательно)
334+
attachments: [ // Прикрепленные элементы (необязательно)
335+
PhotoAttachmentRequest::fromUrl('https://example.com/image.jpg'),
336+
new LocationAttachmentRequest(
337+
latitude: 55.7520233,
338+
longitude: 37.6174994,
339+
),
340+
],
341+
format: MessageFormat::Markdown, // Формат сообщения Markdown или HTML (необязательно)
342+
link: null, // Ссылка на сообщение (необязательно)
343+
notify: true, // Если false, участники чата не будут уведомлены (необязательно)
344+
disableLinkPreview: false, // Если false, сервер не будет генерировать превью для ссылок в тексте сообщения (необязательно)
345+
);
346+
```
347+
348+
### Редактирование сообщения
349+
350+
```php
351+
$api->editMessage(
352+
messageId: 12345,
353+
text: 'Привет мир!',
354+
attachments: null,
355+
format: null,
356+
link: null,
357+
notify: true,
358+
);
359+
```
360+
361+
### Удаление сообщения
362+
363+
```php
364+
$api->deleteMessage(12345);
365+
```
366+
367+
### Получение сообщения по ID
368+
369+
```php
370+
$message = $api->getMessageById(12345);
371+
```
372+
373+
### Получение детальной информации о видео
374+
375+
```php
376+
$videoAttachmentDetails = $api->getVideoAttachmentDetails('some-video-token');
377+
```
378+
379+
### Ответ на нажатие callback-кнопки
380+
381+
Этот метод используется для отправки ответа после того, как пользователь нажал на кнопку.
382+
Ответом может быть обновленное сообщение и/или одноразовое уведомление для пользователя.
383+
384+
```php
385+
$api->answerOnCallback(
386+
callbackId: 'some-callback-id', // Идентификатор кнопки, по которой пользователь кликнул
387+
notification: 'some-notification', // Заполните это, если хотите просто отправить одноразовое уведомление пользователю (необязательно)
388+
text: 'some-text', // Новый текст сообщения (необязательно)
389+
attachments: null, // Вложения сообщения. Если пусто, все вложения будут удалены (необязательно)
390+
link: null, // Ссылка на сообщение (необязательно)
391+
format: null, // Формат сообщения Markdown или HTML (необязательно)
392+
notify: true, // Заполните это, если хотите просто отправить одноразовое уведомление пользователю (необязательно)
393+
);
394+
```

0 commit comments

Comments
 (0)