# Notification Bot

The Frankencoin API Telegram Bot is a communication tool designed to keep users informed about various activities and updates within the Frankencoin ecosystem.

* Welcome and Help Functions: The bot welcomes new users or groups and provides help information on demand.
* Basic Messages: The bot will inform any user or group about basic updates.
* Subscription Management: Users can subscribe to different types of updates using specific handles like /MintingUpdates.
* Quick Access: The bot provides direct links to the Frankencoin app, blockchain explorer for relevant addresses and transactions, and the GitHub repository.

## How to find it?

Telegram Name: **@FrankencoinApiBot**

<figure><img src="/files/dtVzed8kHYS4ropeaplX" alt=""><figcaption><p>Telegram QR Code</p></figcaption></figure>

You can also find the bot by clicking here: <https://t.me/FrankencoinApiBot>

## Basic Messages

#### Welcome and Environment Information

The bot welcomes new users or groups and provides help information on demand. It shares details about the current API version, blockchain network, and timestamp of messages.

<figure><img src="/files/Di5YXtPJAb9euXn0zLcU" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/jLo9xhFpMBzoNYC3KC2T" alt=""><figcaption></figcaption></figure>

#### Minter Proposals

The bot announces new minter proposals, including application periods and relevant transaction details.

<br>

<figure><img src="/files/RC2GFe1t1qQes1EqjurQ" alt=""><figcaption></figcaption></figure>

#### Minter Proposals Vetoed

The bot notifies if a mint proposal got vetoed through the governance process.

<figure><img src="https://github.com/Frankencoin-ZCHF/gitbook/raw/telegram-bot/.gitbook/assets/Screenshot%202024-09-26%20at%2012.13.41%E2%80%AFPM.png" alt=""><figcaption></figcaption></figure>

#### Position Proposals

The bot notifies users about new position proposals, including details such as minting limits, interest rates, and collateral information.

<figure><img src="https://github.com/Frankencoin-ZCHF/gitbook/raw/telegram-bot/.gitbook/assets/Screenshot%202024-09-26%20at%2012.10.32%E2%80%AFPM.png" alt=""><figcaption></figcaption></figure>

#### Challenges Started

It informs users when new challenges are started, providing information about the challenger, challenge size, and auction details.

<figure><img src="https://github.com/Frankencoin-ZCHF/gitbook/raw/telegram-bot/.gitbook/assets/Screenshot%202024-09-26%20at%2012.16.07%E2%80%AFPM.png" alt=""><figcaption></figcaption></figure>

## Subscription Handels

Use the command `/help` to get your subsctiption state. Use and handle to subscribe or unsubscribe, its a toggle function.

<figure><img src="https://github.com/Frankencoin-ZCHF/gitbook/raw/telegram-bot/.gitbook/assets/Screenshot%202024-09-26%20at%2012.25.01%E2%80%AFPM.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://github.com/Frankencoin-ZCHF/gitbook/raw/telegram-bot/.gitbook/assets/Screenshot%202024-09-26%20at%2012.25.11%E2%80%AFPM.png" alt=""><figcaption></figcaption></figure>

#### Minting Updates

It provides updates on minting activities, including changes in minted amounts, collateral ratios, and fee information.

<figure><img src="https://github.com/Frankencoin-ZCHF/gitbook/raw/telegram-bot/.gitbook/assets/Screenshot%202024-09-26%20at%2012.15.21%E2%80%AFPM.png" alt=""><figcaption></figcaption></figure>


---

# 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.frankencoin.com/telegram-api-bot.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.