maxbot-api-client-ts 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +158 -0
- package/dist/api.d.mts +723 -0
- package/dist/api.d.ts +723 -0
- package/dist/api.js +884 -0
- package/dist/api.mjs +860 -0
- package/package.json +39 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 GREEN-API
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# MaxBot API Client (TypeScript)
|
|
2
|
+
|
|
3
|
+
`maxbot-api-client-ts` — это современный TypeScript SDK для интеграции с API MAX Bot. Библиотека предоставляет строго типизированный интерфейс для управления ботами, сообщениями, чатами и медиафайлами, а также поддерживает работу через long-polling и вебхуки.
|
|
4
|
+
|
|
5
|
+
## API
|
|
6
|
+
|
|
7
|
+
Документацию по REST API MAX можно найти по ссылке https://dev.max.ru/docs-api. Библиотека является оберткой для REST API, поэтому документация по указанной выше ссылке также применима к используемым здесь моделям и параметрам запроса.
|
|
8
|
+
|
|
9
|
+
## Поддержка
|
|
10
|
+
|
|
11
|
+
[](mailto:support@green-api.com)
|
|
12
|
+
[](https://t.me/greenapi_support_ru_bot)
|
|
13
|
+
[](https://wa.me/77780739095)
|
|
14
|
+
|
|
15
|
+
## Руководства и новости
|
|
16
|
+
|
|
17
|
+
[](https://www.youtube.com/@green-api)
|
|
18
|
+
[](https://t.me/green_api)
|
|
19
|
+
[](https://whatsapp.com/channel/0029VaHUM5TBA1f7cG29nO1C)
|
|
20
|
+
|
|
21
|
+
-----
|
|
22
|
+
|
|
23
|
+
## Установка
|
|
24
|
+
|
|
25
|
+
**Убедитесь, что у вас установлена версия Node.js версии не ниже 18**
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
node -v
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm -v
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Установите библиотеку:**
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install maxbot-api-client-ts
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
-----
|
|
42
|
+
|
|
43
|
+
## Использование и примеры
|
|
44
|
+
|
|
45
|
+
**Как инициализировать клиент:**
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
import { MaxBotAPI } from 'maxbot-api-client-ts';
|
|
49
|
+
|
|
50
|
+
const response = new MaxBotAPI({
|
|
51
|
+
base_url: "https://platform-api.max.ru",
|
|
52
|
+
token: "YOUR_BOT_TOKEN",
|
|
53
|
+
});
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Как получить информацию о боте:**
|
|
57
|
+
|
|
58
|
+
Ссылка на пример: [GetBot/main.ts](./examples/GetBot/main.ts)
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
const response = await bot.bots.getBot();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Как отправить сообщение:**
|
|
65
|
+
|
|
66
|
+
Ссылка на пример: [SendMessage/main.ts](./examples/SendMessage/main.ts)
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
await bot.messages.sendMessage({
|
|
70
|
+
user_id: 123456789,
|
|
71
|
+
text: "Hello world!",
|
|
72
|
+
});
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**Как легко отправить файл (по ссылке или локальный):**
|
|
76
|
+
|
|
77
|
+
Метод `helpers.sendFile` сам определит тип источника и загрузит файл на сервер, если это необходимо.
|
|
78
|
+
|
|
79
|
+
Ссылка на пример: [SendFile/main.ts](./examples/SendFile/main.ts)
|
|
80
|
+
|
|
81
|
+
```typescript
|
|
82
|
+
await bot.helpers.sendFile({
|
|
83
|
+
chat_id: 123456789,
|
|
84
|
+
file_source: "./documents/report.pdf",
|
|
85
|
+
});
|
|
86
|
+
```
|
|
87
|
+
```typescript
|
|
88
|
+
await bot.helpers.sendFile({
|
|
89
|
+
chat_id: 123456789,
|
|
90
|
+
file_source: "https://example.com/image.png",
|
|
91
|
+
});
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Как получить входящее уведомление:**
|
|
95
|
+
|
|
96
|
+
Ссылка на пример: [GetUpdates/main.ts](./examples/GetUpdates/main.ts)
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
const response = await bot.subscriptions.getUpdates({
|
|
100
|
+
timeout: 25,
|
|
101
|
+
marker: marker,
|
|
102
|
+
types: [UpdateType.TypeMessageCreated]
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
-----
|
|
107
|
+
|
|
108
|
+
## Список примеров
|
|
109
|
+
|
|
110
|
+
| Описание | Ссылка на пример |
|
|
111
|
+
|--------------------------------------|----------------------------------------------------------|
|
|
112
|
+
| Как отправить сообщение | [SendMessage/main.ts](./examples/SendMessage/main.ts) |
|
|
113
|
+
| Как получить информацию о боте | [GetBot/main.ts](./examples/GetBot/main.ts) |
|
|
114
|
+
| Как отправить файл | [SendFile/main.ts](./examples/SendFile/main.ts) |
|
|
115
|
+
| Как загрузить файл | [UploadFile/main.ts](./examples/UploadFile/main.ts) |
|
|
116
|
+
| Как получить входящее уведомление | [GetUpdates/main.ts](./examples/GetUpdates/main.ts) |
|
|
117
|
+
|
|
118
|
+
## Список всех методов библиотеки
|
|
119
|
+
|
|
120
|
+
| Метод API | Описание | Ссылка на документацию MAX | Ссылка на документацию библиотеки |
|
|
121
|
+
|-----------------|-------------------------|------------------------------------------------|----------------------------------------------|
|
|
122
|
+
| `Bots.GetBot` | Получает информацию о боте | [GetBot](https://dev.max.ru/docs-api/methods/GET/me) | [GetBot](./docs/bots/GetBot.md) |
|
|
123
|
+
| `Bots.PatchBot` | Изменяет информацию о боте | | [PatchBot](./docs/bots/PatchBot.md) |
|
|
124
|
+
| `Chats.GetChats` | Возвращает список групповых чатов, в которых участвовал бот | [GetChats](https://dev.max.ru/docs-api/methods/GET/chats) | [GetChats](./docs/chats/GetChats.md) |
|
|
125
|
+
| `Chats.GetChat` | Возвращает информацию о групповом чате по его ID | [GetChat](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-) | [GetChat](./docs/chats/GetChat.md) |
|
|
126
|
+
| `Chats.EditChat` | Позволяет редактировать информацию о групповом чате | [EditChat](https://dev.max.ru/docs-api/methods/PATCH/chats/-chatId-) | [EditChat](./docs/chats/EditChat.md) |
|
|
127
|
+
| `Chats.DeleteChat` | Удаляет групповой чат для всех участников | [DeleteChat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-) | [DeleteChat](./docs/chats/DeleteChat.md) |
|
|
128
|
+
| `Chats.SendAction` | Позволяет отправлять следующие действия бота в групповой чат | [SendAction](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/actions) | [SendAction](./docs/chats/SendAction.md) |
|
|
129
|
+
| `Chats.GetPinnedMessage` | Возвращает закрепленное сообщение в чате | [GetPinnedMessage](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/pin) | [GetPinnedMessage](./docs/chats/GetPinnedMessage.md) |
|
|
130
|
+
| `Chats.PinMessage` | Закрепляет сообщение в групповом чате | [PinMessage](https://dev.max.ru/docs-api/methods/PUT/chats/-chatId-/pin) | [PinMessage](./docs/chats/PinMessage.md) |
|
|
131
|
+
| `Chats.UnpinMessage` | Удаляет закрепленное сообщение в групповом чате | [UnpinMessage](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/pin) | [UnpinMessage](./docs/chats/UnpinMessage.md) |
|
|
132
|
+
| `Chats.GetChatMembership` | Возвращает членство бота в групповом чате | [GetChatMembership](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/me) | [GetChatMembership](./docs/chats/GetChatMembership.md) |
|
|
133
|
+
| `Chats.LeaveChat` | Удаляет бота из группового чата | [LeaveChat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/me) | [LeaveChat](./docs/chats/LeaveChat.md) |
|
|
134
|
+
| `Chats.GetChatAdmins` | Возвращает список всех администраторов группового чата | [GetChatAdmins](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/admins) | [GetChatAdmins](./docs/chats/GetChatAdmins.md) |
|
|
135
|
+
| `Chats.SetChatAdmins` | Назначает участника группы администратором | [SetChatAdmins](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members/admins) | [SetChatAdmins](./docs/chats/SetChatAdmins.md) |
|
|
136
|
+
| `Chats.DeleteAdmin` | Отменяет права администратора пользователя в групповом чате | [DeleteAdmin](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/admins/-userId-) | [DeleteAdmin](./docs/chats/DeleteAdmin.md) |
|
|
137
|
+
| `Chats.GetChatMembers` | Возвращает список участников группового чата | [GetChatMembers](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members) | [GetChatMembers](./docs/chats/GetChatMembers.md) |
|
|
138
|
+
| `Chats.AddMembers` | Добавляет участников в групповой чат | [AddMembers](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members) | [AddMembers](./docs/chats/AddMembers.md) |
|
|
139
|
+
| `Chats.DeleteMember` | Удаляет участника из группового чата | [DeleteMember](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members) | [DeleteMember](./docs/chats/DeleteMember.md) |
|
|
140
|
+
| `Subscriptions.GetSubscriptions` | Возвращает список подписок на уведомления веб-хуков | [GetSubscriptions](https://dev.max.ru/docs-api/methods/GET/subscriptions) | [GetSubscriptions](./docs/subscriptions/GetSubscriptions.md) |
|
|
141
|
+
| `Subscriptions.Subscribe` | Настраивает доставку событий бота через веб-хук | [Subscribe](https://dev.max.ru/docs-api/methods/POST/subscriptions) | [Subscribe](./docs/subscriptions/Subscribe.md) |
|
|
142
|
+
| `Subscriptions.Unsubscribe` | Отменяет подписку бота на получение обновлений через веб-хук | [Unsubscribe](https://dev.max.ru/docs-api/methods/DELETE/subscriptions) | [Unsubscribe](./docs/subscriptions/Unsubscribe.md)|
|
|
143
|
+
| `Subscriptions.GetUpdates` | Получает входящие обновления | [GetUpdates](https://dev.max.ru/docs-api/methods/GET/updates) | [GetUpdates](./docs/subscriptions/GetUpdates.md) |
|
|
144
|
+
| `Upload.UploadFile` | Загружает файл на серверы MAX для последующей передачи | [UploadFile](https://dev.max.ru/docs-api/methods/POST/uploads) | [UploadFile](./docs/upload/UploadFile.md) |
|
|
145
|
+
| `Helpers.SendFile` | Упрощает отправку файлов, автоматически определяя URL или путь | | [SendFile](./docs/helpers/SendFile.md) |
|
|
146
|
+
| `Messages.GetMessages` | Возвращает информацию о сообщении или массив сообщений из чата | [GetMessages](https://dev.max.ru/docs-api/methods/GET/messages) | [GetMessages](./docs/messages/GetMessages.md) |
|
|
147
|
+
| `Messages.SendMessage` | Отправляет текстовое или медиа-сообщение указанному пользователю или в чат | [SendMessage](https://dev.max.ru/docs-api/methods/POST/messages) | [SendMessage](./docs/messages/SendMessage.md) |
|
|
148
|
+
| `Messages.EditMessage` | Редактирует текст или медиафайл ранее отправленного сообщения | [EditMessage](https://dev.max.ru/docs-api/methods/PUT/messages) | [EditMessage](./docs/messages/EditMessage.md) |
|
|
149
|
+
| `Messages.DeleteMessage` | Удаляет сообщение из чата | [DeleteMessage](https://dev.max.ru/docs-api/methods/DELETE/messages) | [DeleteMessage](./docs/messages/DeleteMessage.md) |
|
|
150
|
+
| `Messages.GetMessage` | Извлекает содержимое и метаданные конкретного сообщения по его ID | [GetMessage](https://dev.max.ru/docs-api/methods/GET/messages/-messageId-) | [GetMessage](./docs/messages/GetMessage.md) |
|
|
151
|
+
| `Messages.GetVideoInfo` | Возвращает подробную информацию о прикрепленном видео | [GetVideoInfo](https://dev.max.ru/docs-api/methods/GET/videos/-videoToken-) | [GetVideoInfo](./docs/messages/GetVideoInfo.md) |
|
|
152
|
+
| `Messages.AnswerCallback` | Отправляет ответ после того, как пользователь нажмет кнопку | [AnswerCallback](https://dev.max.ru/docs-api/methods/POST/answers) | [AnswerCallback](./docs/messages/AnswerCallback.md)|
|
|
153
|
+
|
|
154
|
+
-----
|
|
155
|
+
|
|
156
|
+
## Лицензия
|
|
157
|
+
|
|
158
|
+
MIT
|