> ## Documentation Index
> Fetch the complete documentation index at: https://chainpatrol-knowledge-update-blockaid-and-hypernative-partn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Telegram Bot

> A Telegram bot that can be used to submit scam reports to ChainPatrol

If you have a **Telegram group**, you can use the ChainPatrol Telegram Bot to let your group members submit scam reports to **ChainPatrol**. The bot will generate new reports that get sent to your admin dashboard for review.

## Setup

### Bot Installation

<Steps>
  <Step title="Add the Bot to Your Group Chat">
    <Warning>
      **Beware of impersonators!** The official ChainPatrol Telegram bot is `@ChainPatrol_Bot`. If you see any other bot claiming to be the ChainPatrol bot, please report it to us.
    </Warning>

    Start by adding the ChainPatrol Telegram Bot to your group chat. You can find the bot by searching for its username in Telegram.

    <Frame>
      <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-bot-add.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=45583566cc396bfebcdd178fba218f2d" alt="Step 1 - Add Bot" width="743" height="694" data-path="images/telegram-bot-add.png" />
    </Frame>
  </Step>

  <Step title="Commands">
    Once the bot is added to your group chat, use the `/help` command to see the available commands.

    <Frame>
      <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-commands.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=49814106b18a1a3227c4ffbcb0d3d6b0" alt="Step 2 - Setup Connect" width="740" height="695" data-path="images/telegram-commands.png" />
    </Frame>
  </Step>
</Steps>

### Bot Configuration

<Frame>
  <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-setupstatus.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=5711f469dd84e3c09d0499cfed25770e" alt="Confirmation Message" width="744" height="695" data-path="images/telegram-setupstatus.png" />
</Frame>

<Steps>
  <Step title="Go to the Bot Settings">
    Visit your [ChainPatrol Dashboard](https://app.chainpatrol.io/admin) and go to the **settings** page.

    <Tip>
      If you don't have a ChainPatrol account and want to protect your community, reach out to us directly!
    </Tip>

    <Frame>
      <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-bot-settings.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=16f78aa99a634e2f30f82e6ca40ed094" alt="Step 1 - Add Bot" width="1552" height="836" data-path="images/telegram-bot-settings.png" />
    </Frame>
  </Step>

  <Step title="Go to Integrations">
    Go to the **Integrations** on the left sidebar.

    <Frame>
      <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-bot-integrations.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=7397a64cecf94bb48d95af1430851a2f" alt="Step 2 - Integrations" width="1552" height="1065" data-path="images/telegram-bot-integrations.png" />
    </Frame>
  </Step>

  <Step title="Add the group details">
    Click on "Add New Telegram Group" and configure the group details.

    <Frame>
      <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-bot-integration-details.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=aaca213f275394d4bfa666ff68f15d31" alt="Step 2 - Add details" width="1557" height="1141" data-path="images/telegram-bot-integration-details.png" />
    </Frame>
  </Step>
</Steps>

## Usage

<Tip>
  Use the `/setupconnect` command to confirm the connection between your group and ChainPatrol.
</Tip>

Once the bot is added to your group and the connection process is complete, you can use the following commands:

### Commands

* `/report <url> <description>` - Submit a scam report for the given URL with a brief description of why it's suspicious
* `/check <url>` - Check if a URL is on the block list
* `/setupstatus` - Find out if this chat group is associated with an organization
* `/setupconnect` - Generates the URL to link Telegram group to organization
* `/help` - Display a list of available commands and their descriptions

## Features

### Auto-Link Monitoring

The ChainPatrol Telegram Bot automatically monitors all links shared in your group chat. This feature provides an additional layer of protection for your community:

* **Real-time Scanning**: Every link posted in the group is instantly checked against ChainPatrol's extensive database of known scams and malicious URLs.
* **Automatic Alerts**: If a potentially harmful link is detected, the bot immediately notifies the group, warning members about the potential risk.
* **Proactive Protection**: This feature helps prevent scams before they can affect your community members, even if no moderators are actively monitoring the group.

<Frame>
  <img src="https://mintcdn.com/chainpatrol-knowledge-update-blockaid-and-hypernative-partn/_tYYcGUrxMX8hzq_/images/telegram-auto-link-monitoring.png?fit=max&auto=format&n=_tYYcGUrxMX8hzq_&q=85&s=12361bfa68ae78b8cb441afc3bdc9acf" alt="Auto-Link Monitoring" width="1846" height="1296" data-path="images/telegram-auto-link-monitoring.png" />
</Frame>

## Privacy

The bot does not collect any personal information. It only collects the URL and the Telegram ID of the user that submitted the report (in case a moderator needs more information about why the URL is a scam). The bot does not store any sensitive information about the group it is added to.

<Tip>
  The ChainPatrol Telegram bot is like any group user. You can adjust permissions
  according to your group's needs.
</Tip>