## Why is simple? Add your API tokens (`Authorization` header) and your bot usernames in the `config.toml` file, and you're ready to go. > [!NOTE] > Check out the `config.toml.example` file to see how to fill the `config.toml` file. > [!WARNING] > Remember to keep the `config.toml` file safe, because anyone can use it to ping your bots. ## CLI Arguments - `--config`: The path to the config file. (default: `config.toml`) ## Requirements - Rust (MSRV 1.75.0) - Cargo ## Build ```bash cargo build --release ``` ## Run ```bash cargo run --release ``` Or just run the binary file in `target/release/telepingbot` ## Endpoints ### `/ping/@` This endpoint is to ping the bot and returns if it's online or not. #### Url querys - "cmd": One word base64Url encoded, will use it as a command, default is `start` - "args": Base64Url encoded, will use it as arguments for the command, default is `""` #### Headers - `Authorization`: The API access token. e.g: `Authorization: FirstToken` #### Response - `200`: The bot is online. - `404`: The bot is offline. - `401`: The API access token is invalid. - `500`: Internal server error. e.g: The bot username is invalid or the superbot can't send message to the bot. #### Example > [!NOTE] > > Replace `FirstToken` with your API access token and `@testbot` with your bot username > and the host and port with your host and port. ```bash curl -v 0.0.0.0:3939/ping/@testbot -H "Authorization: FirstToken" ```