mirror of
https://github.com/nikdoof/smsbot.git
synced 2025-12-22 06:09:28 +00:00
Add usage instructions
This commit is contained in:
34
README.md
34
README.md
@@ -1,3 +1,35 @@
|
||||
# Twilio2Telegram
|
||||
|
||||
Forward SMS from your Twilio number to Telegram
|
||||
Forward SMS and Calls from your Twilio number to Telegram
|
||||
|
||||
## Usage
|
||||
|
||||
### Clone the repository
|
||||
|
||||
`git clone git@github.com:FiveBoroughs/Twilio2Telegram.git`
|
||||
|
||||
### Set the envirronement variables
|
||||
|
||||
`cp sample.env .env && vim .env`
|
||||
|
||||
Create your bot and obtain the BotToken by following the BotFather instructions : t.me/botfather
|
||||
|
||||
Get the telegram owner and subscribers chat id by talking to the bot in telegram, and watching this url `https://api.telegram.org/bot<BotToken>/getUpdates`
|
||||
|
||||
And the Twilio Token from twilio.com/console : hidden behind the "View" button, next to auth token
|
||||
|
||||
### Launch the docker container
|
||||
|
||||
`docker-compose up -d`
|
||||
|
||||
### Set the Twilio webhooks destination
|
||||
|
||||
Click on the desired number twilio.com/console/phone-numbers/incoming
|
||||
|
||||
And add the domain or ip of the server hosting Twilio2Telgram, `/call` for calls and `/message` for messages
|
||||
|
||||

|
||||
|
||||
Optional :
|
||||
Twilio2Telegram listens for webhook calls on the 8080 port.
|
||||
If you want to add https and user the port 80, set up a reverse proxy on the machine
|
||||
|
||||
@@ -51,15 +51,13 @@ def tg_error_handler(update, context):
|
||||
|
||||
def tg_bot_start():
|
||||
"""Start the telegram bot."""
|
||||
# Create the Updater and pass it your bot's token.
|
||||
# Make sure to set use_context=True to use the new context based callbacks
|
||||
# Post version 12 this will no longer be necessary
|
||||
# Create the Updater
|
||||
updater = Updater(os.environ.get('TELEGRAM_BOT_TOKEN'))
|
||||
|
||||
# Get the dispatcher to register handlers
|
||||
dp = updater.dispatcher
|
||||
|
||||
# on different commands - answer in Telegram
|
||||
# on /help command
|
||||
dp.add_handler(CommandHandler("help", tg_help_handler))
|
||||
|
||||
# log all errors
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
flask
|
||||
requests
|
||||
pyOpenSSL
|
||||
waitress
|
||||
twilio
|
||||
python-telegram-bot
|
||||
BIN
static/Screenshot_twilio_webhook_settings.png
Normal file
BIN
static/Screenshot_twilio_webhook_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
Reference in New Issue
Block a user