# Telegram

{% hint style="info" %}
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
{% endhint %}

**Telegram** sends messages acting as a Telegram Bot API.

## **Parameters**

Take a look at the configuration options for the component. Parameters supported by [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>When active, the connector will use the account dynamically. Otherwise, it will use the account statically.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>The name of the dynamic account used by the connector. This account must have been previously configured in a <a href="/pages/0kxlZ011XP4A2T43v9kh"><strong>Store Account</strong></a> connector in the pipeline for this process to take effect. It is only available if the <strong>Dynamic Account</strong> parameter is active.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>The account used by the connector. It is only available if the <strong>Dynamic Account</strong> parameter is inactive.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Type</strong></td><td>The endpoint type. Currently, only the “bots” type is supported.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Chat Id</strong> <code>(DB)</code></td><td>The ID of the chat that is to receive the generated messages. Chat IDs can be first obtained from incoming messages (e.g. when a Telegram user starts a conversation with a bot, their client automatically sends a ‘/start’ message containing the chat ID). This is an optional parameter as the chat ID can be set dynamically for each outgoing message (using body or headers).</td><td>N/A</td><td>String</td></tr><tr><td><strong>Base Uri</strong> <code>(DB)</code></td><td>Can be used to set an alternative base URI, for example when you want to test the component against a mock Telegram API.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Buffer Size</strong></td><td>The initial in-memory buffer size used when transferring data between Camel and AHC Client.</td><td>1048576</td><td>Integer</td></tr><tr><td><strong>Proxy Type</strong></td><td>HTTP proxy type which could be used when sending out the message.</td><td>HTTP</td><td>String</td></tr><tr><td><strong>Body</strong> <code>(DB)</code></td><td>The content of the message.</td><td><code>{}</code></td><td>JSON</td></tr></tbody></table>

### **Headers tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Chat Id</strong> <code>(DB)</code></td><td>This header is used by the producer endpoint in order to resolve the chat ID that will receive the message. The recipient chat ID can be placed (in order of priority) in the message body, in the CamelTelegramChatId header or in the endpoint configuration (chatId option). This header is also present in all incoming messages.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Media Title Caption</strong> <code>(DB)</code></td><td>This header is used to provide a caption or title for outgoing binary messages.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Parse Mode</strong></td><td>This header is used to format text messages using HTML or Markdown.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Message Timestamp</strong></td><td>The message timestamp.</td><td>N/A</td><td>Integer</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/enterprise-applications/telegram.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
