1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-06 08:49:29 +02:00

Правка доков

This commit is contained in:
Anton
2024-08-11 13:02:11 +03:00
parent caaf5aac6f
commit bd60aff608
46 changed files with 4915 additions and 4356 deletions

View File

@@ -0,0 +1 @@
oint vkteams ИзменитьТекстСообщения --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod%

View File

@@ -0,0 +1 @@
oint vkteams ОтправитьФайл --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod%

View File

@@ -0,0 +1 @@
oint vkteams ПереслатьСообщение --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text%

View File

@@ -0,0 +1 @@
oint vkteams ПереслатьФайл --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod%

View File

@@ -0,0 +1 @@
oint vkteams ПолучитьИнформациюОФайле --token %token% --fileid %fileid%

View File

@@ -0,0 +1 @@
oint vkteams УдалитьСообщение --token %token% --chatid %chatid% --messageid %messageid%

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 3
---
# Получить информацию о файле
Получает информацию о файле по его ID
`Функция ПолучитьИнформациюОФайле(Знач Токен, Знач IDФайла) Экспорт`
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен бота |
| IDФайла | --fileid | Строка, Число | ID Файла |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams
<br/>
:::tip
Метод в документации API: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo)
:::
<br/>
```sh title="Пример команды CLI"
oint vkteams ПолучитьИнформациюОФайле --token %token% --fileid %fileid%
```
```json title="Результат"
{
"filename": "ВажныйДокумент.docx",
"size": 24071,
"type": "application",
"url": "https://ub.icq.net/files/get/XrJ30TgJvcpZoiAEu1MC46e1MCbBs3NXwqSkBiZgCEkXOsNmPmAnw2XXpEM4WXMcylct3N2s3XwyMI5Cj7GDKtY6FmpmOHLgYC2xUanmVRf4gtn0zVatipXHgtriTJACrKfemXbqJuLCNOYZJieYS72mwqu1MC/%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"ok": true
}
```

View File

@@ -0,0 +1,38 @@
---
sidebar_position: 4
---
# Удалить сообщение
Удаляет сообщение по ID
`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт`
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен бота |
| IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения |
| IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams
<br/>
:::tip
Метод в документации API: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages)
:::
<br/>
```sh title="Пример команды CLI"
oint vkteams УдалитьСообщение --token %token% --chatid %chatid% --messageid %messageid%
```

View File

@@ -0,0 +1,46 @@
---
sidebar_position: 3
---
# Изменить текст сообщения
Изменяет текст сущесствующего сообщения
`Функция ИзменитьТекстСообщения(Знач Токен, Знач IDЧата, Знач IDСообщения, Знач Текст, Знач Разметка = "MarkdownV2") Экспорт`
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен бота |
| IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения |
| IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования |
| Текст | --text | Строка | Новый текст сообщения |
| Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams
<br/>
:::tip
Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId]
Метод в документации API: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText)
:::
<br/>
```sh title="Пример команды CLI"
oint vkteams ИзменитьТекстСообщения --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod%
```
```json title="Результат"
{
"ok": true
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 6
---
# Переслать сообщение
Переслыает существующее сообщение в текущий диалог
`Функция ПереслатьСообщение(Знач Токен, Знач IDСообщения, Знач IDЧатаИсточника, Знач IDЧата, Знач Текст = "") Экспорт`
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен бота |
| IDСообщения | --message | Строка, Число | ID оригинального сообщения |
| IDЧатаИсточника | --fromid | Строка, Число | ID чата источника оригинального сообщения |
| IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения |
| Текст | --text | Строка | Дополнительный текст сообщения |
Возвращаемое значение: HTTPОтвет - Переслать сообщение
<br/>
:::tip
В IDЧатаИсточника можно передавать только chatId из событий (код из ссылки на чат не подходит)
Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText)
:::
<br/>
```sh title="Пример команды CLI"
oint vkteams ПереслатьСообщение --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text%
```
```json title="Результат"
{
"msgId": "7401634788940972096",
"ok": true
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 5
---
# Переслать файл
Отправляет ранее загруженный файл по его ID
`Функция ПереслатьФайл(Знач Токен, Знач IDЧата, Знач IDФайла, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт`
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен бота |
| IDЧата | --chatid | Строка, Число | ID чата для отправки файла |
| IDФайла | --fileid | Строка, Число | ID Файла для отправки |
| Текст | --text | Строка | Подпись к файлу |
| ИмяФайла | --filename | Строка | Отображаемое имя файла |
| Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams
<br/>
:::tip
Метод в документации API: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile)
:::
<br/>
```sh title="Пример команды CLI"
oint vkteams ПереслатьФайл --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod%
```
```json title="Результат"
{
"fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd",
"msgId": "7401634819005743172",
"ok": true
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 2
---
# Отправить файл
Отправляет файл в чат
`Функция ОтправитьФайл(Знач Токен, Знач IDЧата, Знач Файл, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт`
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен бота |
| IDЧата | --chatid | Строка, Число | ID чата для отправки файла |
| Файл | --file | ДвоичныеДанные, Строка | Файл для отправки |
| Текст | --text | Строка | Подпись к файлу |
| ИмяФайла | --filename | Строка | Отображаемое имя файла |
| Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams
<br/>
:::tip
Метод в документации API: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile)
:::
<br/>
```sh title="Пример команды CLI"
oint vkteams ОтправитьФайл --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod%
```
```json title="Результат"
{
"fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd",
"msgId": "7401634797530906691",
"ok": true
}
```