mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2024-12-16 11:38:11 +02:00
95 lines
2.8 KiB
Markdown
95 lines
2.8 KiB
Markdown
---
|
|
sidebar_position: 5
|
|
---
|
|
|
|
# Send document
|
|
Sends a document to a chat or channel
|
|
|
|
|
|
|
|
`Function SendDocument(Val Token, Val ChatID, Val Text, Val Document, Val Keyboard = "", Val Markup = "Markdown", Val FileName = "") Export`
|
|
|
|
| Parameter | CLI option | Type | Description |
|
|
|-|-|-|-|
|
|
| Token | --token | String | Bot token |
|
|
| ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID |
|
|
| Text | --text | String | Message text |
|
|
| Document | --doc | BinaryData,String | Document file |
|
|
| Keyboard | --keyboard | String | Keyboard JSON or path to .json |
|
|
| Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) |
|
|
| FileName | --filename | String | Custom displayed file name with extension, if necessary |
|
|
|
|
|
|
Returns: Map Of KeyAndValue - Serialized JSON response from Telegram
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
```bsl title="Code example"
|
|
Token = FunctionParameters["Telegram_Token"];
|
|
ChatID = FunctionParameters["Telegram_ChatID"];
|
|
ChannelID = FunctionParameters["Telegram_ChannelID"];
|
|
Text = FunctionParameters["String"];
|
|
Document = FunctionParameters["Document"];
|
|
|
|
DocumentPath = GetTempFileName("docx");
|
|
CopyFile(Document, DocumentPath);
|
|
|
|
DocumentDD = New BinaryData(DocumentPath);
|
|
|
|
Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document);
|
|
|
|
OPI_TestDataRetrieval.WriteLog(Result, "SendDocument", "Telegram");
|
|
|
|
Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document, , , "customname.docx");
|
|
|
|
OPI_TestDataRetrieval.WriteLog(Result, "SendDocument (with name)", "Telegram");
|
|
|
|
Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentPath);
|
|
|
|
OPI_TestDataRetrieval.WriteLog(Result, "SendDocument (Path)");
|
|
|
|
Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentDD, , , "customname.docx");
|
|
```
|
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
oint telegram SendDocument --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --doc "https://openintegrations.dev/test_data/document.docx" --keyboard %keyboard% --parsemode %parsemode% --filename %filename%
|
|
|
|
```
|
|
|
|
```json title="Result"
|
|
{
|
|
"ok": true,
|
|
"result": {
|
|
"message_id": 4642,
|
|
"from": {
|
|
"id": 6129457865,
|
|
"is_bot": true,
|
|
"first_name": "Vitaly The Bot",
|
|
"username": "sicheebot"
|
|
},
|
|
"chat": {
|
|
"id": 461699897,
|
|
"first_name": "Anton",
|
|
"last_name": "Titowets",
|
|
"username": "JKIee",
|
|
"type": "private"
|
|
},
|
|
"date": 1717072414,
|
|
"document": {
|
|
"file_name": "document.docx",
|
|
"mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
|
|
"file_id": "BQACAgIAAxkDAAISImZYch5MDU2ibeJ0S46yZfw6Dmb2AAKtUAACYCjISp3o6gzXeDCVNQQ",
|
|
"file_unique_id": "AgADrVAAAmAoyEo",
|
|
"file_size": 24069
|
|
},
|
|
"caption": "String value"
|
|
}
|
|
}
|
|
```
|