Правка доков

2025-11-06 08:49:29 +02:00 · 2024-08-11 13:02:11 +03:00
parent caaf5aac6f
commit bd60aff608
46 changed files with 4915 additions and 4356 deletions
--- a/docs/en/md/Instructions/Start.md
+++ b/docs/en/md/Instructions/Start.md
@@ -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/>
--- a/docs/en/md/Instructions/VKTeams.md
+++ b/docs/en/md/Instructions/VKTeams.md
@@ -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)
--- a/docs/en/md/VKTeams/Common-methods/Get-file-information.md
+++ b/docs/en/md/VKTeams/Common-methods/Get-file-information.md
@@ -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
+}
+```
--- a/docs/en/md/VKTeams/Message-sending/Delete-message.md
+++ b/docs/en/md/VKTeams/Message-sending/Delete-message.md
@@ -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%
+
+```
+
+
--- a/docs/en/md/VKTeams/Message-sending/Edit-message-text.md
+++ b/docs/en/md/VKTeams/Message-sending/Edit-message-text.md
@@ -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
+}
+```
--- a/docs/en/md/VKTeams/Message-sending/Forward-message.md
+++ b/docs/en/md/VKTeams/Message-sending/Forward-message.md
@@ -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
+}
+```
--- a/docs/en/md/VKTeams/Message-sending/Resend-file.md
+++ b/docs/en/md/VKTeams/Message-sending/Resend-file.md
@@ -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
+}
+```
--- a/docs/en/md/VKTeams/Message-sending/Send-file.md
+++ b/docs/en/md/VKTeams/Message-sending/Send-file.md
@@ -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
+}
+```