From 49e522192444d01a102c17cbac9ae356311db0e6 Mon Sep 17 00:00:00 2001 From: Bukxara Date: Thu, 15 Aug 2024 12:06:06 +0500 Subject: [PATCH] README file modified --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 68c98a2..8d2867a 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,34 @@ -Telegram API sending message without rate limit. +# Telegram API sending message without rate limit. -Instructions +## Table of contents +- [Instructions](#instructions) +## Instructions There are 2 endpoints handled by this microservice: -1 -> GET request to {BASE_URL}/bot${botToken}/sendMessage +1 -> GET request to [{BASE_URL}/bot${botToken}/sendMessage]({BASE_URL}/bot${botToken}/sendMessage) – url that you used for sending a message to chat through telegram bot (as GET request) usually looks like this: -https://api.telegram.org/bot/sendMessage?chat_id=&text= +[https://api.telegram.org/bot/sendMessage?chat_id=&text=](https://api.telegram.org/bot/sendMessage?chat_id=&text=) -As you can see, you only have to replace https://api.telegram.org/ part with {BASE_URL}, eventually looking like this: +As you can see, you only have to replace [https://api.telegram.org/](https://api.telegram.org/) part with {BASE_URL}, eventually looking like this: -{BASE_URL}/bot/sendMessage?chat_id=&text= +[{BASE_URL}/bot/sendMessage?chat_id=&text=]({BASE_URL}/bot/sendMessage?chat_id=&text=) 2 -> POST request to {BASE_URL}/sendMessage – url that you used for sending a message to chat through telegram bot (as POST request) usually looks like this: -https://api.telegram.org/bot/sendMessage +[https://api.telegram.org/bot/sendMessage](https://api.telegram.org/bot/sendMessage) -You are expected to do the same thing you did with GET request: replace https://api.telegram.org/ part with {BASE_URL}, eventually looking like this: +You are expected to do the same thing you did with GET request: replace [https://api.telegram.org/](https://api.telegram.org/) part with {BASE_URL}, eventually looking like this: -{BASE_URL}/bot/sendMessage with request body: -{ +[{BASE_URL}/bot/sendMessage]({BASE_URL}/bot/sendMessage) with request body: +```{ "chat_id": , "text": -} +}``` -Requires redis and preffered configuration is host being at 127.0.0.1 and port being at 6379 \ No newline at end of file +p.s. Requires redis and preffered configuration for redis is host being at 127.0.0.1 and port being at 6379 \ No newline at end of file