https://github.com/pkarpovich/tg-contacts-search

Telegram bot that helps you to find telegram username based on provided phone number
https://github.com/pkarpovich/tg-contacts-search

contacts telegram-bot

Last synced: about 21 hours ago
JSON representation

Telegram bot that helps you to find telegram username based on provided phone number

• Host: GitHub
• URL: https://github.com/pkarpovich/tg-contacts-search
• Owner: pkarpovich
• License: mit
• Created: 2024-02-21T07:53:31.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-04-19T13:21:12.000Z (7 months ago)
• Last Synced: 2024-06-19T16:44:35.574Z (5 months ago)
• Topics: contacts, telegram-bot
• Language: Go
• Homepage:
• Size: 43 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Telegram Contacts Search

## Description

This project implements a Telegram bot designed to retrieve telegram username based on provided phone number.

## Pre-requisites

- Docker and Docker Compose

- Telegram Bot API token

- Go 1.22

## Installation

1. Clone the repository

2. Ensure that you already have an active session file in the `sessions` folder. If not, you can create a new session file by running the application locally.

3. Build and start the container using Docker Compose

```bash

docker compose up --build

```

## Usage

The bot is designed to be interacted with through Telegram messages. Once deployed, it can:

- Validate phone numbers and retrieve associated Telegram usernames based on message content.

- Respond to /ping with "pong".

## Configuration

Configure the bot using environment variables specified in the .env file or directly in the compose.yaml:

- `BOT_TOKEN`: Your Telegram Bot Token.

- `APP_HASH`: Your Telegram Application Hash.

- `APP_ID`: Your Telegram Application ID.

- `PHONE`: The phone number associated with the bot account.

- `PASSWORD`: The password for the Telegram account (if applicable).

- `SESSION_FOLDER`: The local directory for storing session data. Default is ./sessions.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.