1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-08-13 20:05:19 +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

@@ -15,19 +15,20 @@ The implemented methods perform specific tasks (such as *SendMessage()* or *Crea
Fast navigation:
<div>
<a href="/docs/Instructions/Telegram/"><img src={require('../../static/img/APIs/Telegram.png').default} width="32"/></a>
<a href="/docs/Instructions/VK/"><img src={require('../../static/img/APIs/VK.png').default} width="32"/></a>
<a href="/docs/Instructions/Viber/"><img src={require('../../static/img/APIs/Viber.png').default} width="32"/></a>
<a href="/docs/Instructions/Twitter/"><img src={require('../../static/img/APIs/Twitter.png').default} width="32"/></a>
<a href="/docs/Instructions/Notion/"><img src={require('../../static/img/APIs/Notion.png').default} width="32"/></a>
<a href="/docs/Instructions/YandexDisk/"><img src={require('../../static/img/APIs/YandexDisk.png').default} width="32"/></a>
<a href="/docs/Instructions/GoogleCalendar/"><img src={require('../../static/img/APIs/GoogleCalendar.png').default} width="32"/></a>
<a href="/docs/Instructions/GoogleDrive/"><img src={require('../../static/img/APIs/GoogleDrive.png').default} width="32"/></a>
<a href="/docs/Instructions/GoogleSheets/"><img src={require('../../static/img/APIs/GoogleSheets.png').default} width="32"/></a>
<a href="/docs/Instructions/Slack/"><img src={require('../../static/img/APIs/Slack.png').default} width="32"/></a>
<a href="/docs/Instructions/Airtable/"><img src={require('../../static/img/APIs/Airtable.png').default} width="32"/></a>
<a href="/docs/Instructions/Dropbox/"><img src={require('../../static/img/APIs/Dropbox.png').default} width="32"/></a>
<a href="/docs/Instructions/Bitrix24/"><img src={require('../../static/img/APIs/Bitrix24.png').default} width="32"/></a>
<a href="/docs/Instructions/Telegram/"><img src={require('../../static/img/APIs/Telegram.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/VK/"><img src={require('../../static/img/APIs/VK.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/VKTeams/"><img src={require('../../static/img/APIs/VKTeams.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Viber/"><img src={require('../../static/img/APIs/Viber.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Twitter/"><img src={require('../../static/img/APIs/Twitter.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Notion/"><img src={require('../../static/img/APIs/Notion.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/YandexDisk/"><img src={require('../../static/img/APIs/YandexDisk.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/GoogleCalendar/"><img src={require('../../static/img/APIs/GoogleCalendar.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/GoogleDrive/"><img src={require('../../static/img/APIs/GoogleDrive.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/GoogleSheets/"><img src={require('../../static/img/APIs/GoogleSheets.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Slack/"><img src={require('../../static/img/APIs/Slack.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Airtable/"><img src={require('../../static/img/APIs/Airtable.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Dropbox/"><img src={require('../../static/img/APIs/Dropbox.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Bitrix24/"><img src={require('../../static/img/APIs/Bitrix24.png').default} width="32" class="wp_logo"/></a>
</div>
<br/>

View File

@@ -12,18 +12,23 @@ This section is dedicated to the library for working with VK Teams API. On this
## Getting started
1. Register, book a tariff and download the VK Teams app [on the home page](https://biz.mail.ru/teams)
![BF](../../static/img/Docs/VKTeams/5.png)
2. Log in to the application using the one-time password that should arrive in the mail. You can view the mail of the required user in the administration panel
![BF](../../static/img/Docs/VKTeams/6.png)
3. Start a dialog with [@metabot](http://teams.vk.com/profile/70001) and follow the procedure to create a new bot
![BF](../../static/img/Docs/VKTeams/1.png)
4. Generate a new **token** and enable the ability to add the bot to a group (if necessary)
![BF](../../static/img/Docs/VKTeams/2.png)
5. Save the bot ID by retrieving it using the "Show My Bots" button
![BF](../../static/img/Docs/VKTeams/4.png)
6. Form a link and click on it in your browser
@@ -38,4 +43,5 @@ https://teams.vk.com/profile/1234567890
7. Start a dialog with the bot
Now you will be able to add a bot to groups and control it with **Token** and **ID of the desired dialog** (group or user)
![BF](../../static/img/Docs/VKTeams/3.png)

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 3
---
# Get information about file
Gets information about a file by ID
`Function GetFileInformation(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| FileID | --fileid | String, Number | File ID |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams
<br/>
:::tip
Method at API documentation: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo)
:::
<br/>
```sh title="CLI command example"
oint vkteams GetFileInformation --token %token% --fileid %fileid%
```
```json title="Result"
{
"filename": "ImportantDocument.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
---
# Delete message
Deletes a message by ID
`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID for message sending |
| MessageID | --messageid | String, Number | Message ID for editing |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams
<br/>
:::tip
Method at API documentation: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages)
:::
<br/>
```sh title="CLI command example"
oint vkteams DeleteMessage --token %token% --chatid %chatid% --messageid %messageid%
```

View File

@@ -0,0 +1,46 @@
---
sidebar_position: 3
---
# Change the message text
Changes the text of an existing message
`Function EditMessageText(Val Token, Val ChatID, Val MessageID, Val Text, Val Markup = "MarkdownV2") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID for message sending |
| MessageID | --messageid | String, Number | Message ID for editing |
| Text | --text | String | New message text |
| Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams
<br/>
:::tip
You can mention a user by appending their userId to the text in the following format @[userId]
Method at API documentation: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText)
:::
<br/>
```sh title="CLI command example"
oint vkteams EditMessageText --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod%
```
```json title="Result"
{
"ok": true
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 6
---
# Forward message
Forwards an existing message to the current dialog box
`Function ForwardMessage(Val Token, Val MessageID, Val FromChatID, Val ChatID, Val Text = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| MessageID | --message | String, Number | Original message ID |
| FromChatID | --fromid | String, Number | Source chat ID |
| ChatID | --chatid | String, Number | Chat ID for message sending |
| Text | --text | String | Additional message text |
Returns: HTTPResponse - Forward message
<br/>
:::tip
Only the chatId from events can be passed to the FromChatID (the code from the chat link is not suitable))
Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText)
:::
<br/>
```sh title="CLI command example"
oint vkteams ForwardMessage --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text%
```
```json title="Result"
{
"msgId": "7401634788940972096",
"ok": true
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 5
---
# Resend file
Sends a previously uploaded file by ID
`Function ResendFile(Val Token, Val ChatID, Val FileID, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID for sending |
| FileID | --fileid | String, Number | File ID to send |
| Text | --text | String | File caption |
| FileName | --filename | String | Displayed file name |
| Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams
<br/>
:::tip
Method at API documentation: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile)
:::
<br/>
```sh title="CLI command example"
oint vkteams ResendFile --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod%
```
```json title="Result"
{
"fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd",
"msgId": "7401634819005743172",
"ok": true
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 2
---
# SendFile
Sends the file to the chat
`Function SendFile(Val Token, Val ChatID, Val File, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID for sending |
| File | --file | BinaryData, String | File for sending |
| Text | --text | String | File caption |
| FileName | --filename | String | Displayed file name |
| Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams
<br/>
:::tip
Method at API documentation: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile)
:::
<br/>
```sh title="CLI command example"
oint vkteams SendFile --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod%
```
```json title="Result"
{
"fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd",
"msgId": "7401634797530906691",
"ok": true
}
```

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
}
```