Difference between revisions of "Telegram message processor"

Jump to: navigation, search
Line 15: Line 15:
 
Open the link in the Telegram app (you need that), or alternatively in the Telegram Web (if your browser allows it). In Telegram, you should see this:
 
Open the link in the Telegram app (you need that), or alternatively in the Telegram Web (if your browser allows it). In Telegram, you should see this:
  
[[File:telegramstartscreen.png]]
+
[[File:telegramstartscreen.png|center|600px]]
  
 
Click the "Start" button at the bottom to begin the conversation with Botfather. Once you have, you will see:
 
Click the "Start" button at the bottom to begin the conversation with Botfather. Once you have, you will see:
  
[[File:botfatherstart.png]]
+
[[File:botfatherstart.png|center|600px]]
  
 
Enter the command "/newbot" in the conversation, and Botfather will ask you for all of the information you need. You will need to enter both a name and a unique username for your Bot. The Telegram settings screen provided some suggestions, but you can choose what you want. Since it should be unique, it is recommended you use your organization or sitename as part of these.
 
Enter the command "/newbot" in the conversation, and Botfather will ask you for all of the information you need. You will need to enter both a name and a unique username for your Bot. The Telegram settings screen provided some suggestions, but you can choose what you want. Since it should be unique, it is recommended you use your organization or sitename as part of these.
  
[[File:newbot.png]]
+
[[File:newbot.png|center|600px]]
  
 
Once you have given Botfather everything it needs, you will gave the bot token displayed in the conversation:
 
Once you have given Botfather everything it needs, you will gave the bot token displayed in the conversation:
  
[[File:bottoken.png]]
+
[[File:bottoken.png|center|600px]]
  
 
Transfer the bot token information to the settings screen and hit "Save changes":
 
Transfer the bot token information to the settings screen and hit "Save changes":
  
[[File:savechanges.png]]
+
[[File:savechanges.png|center|600px]]
  
 
The name and username you chose will be filled in for you. Telegram is now ready for your users to configure their message preferences.
 
The name and username you chose will be filled in for you. Telegram is now ready for your users to configure their message preferences.
  
[[File:finalsettings.png]]
+
[[File:finalsettings.png|center|600px]]
  
 
NOTE: The "Setup Telegram webhook" option is still a work in progress.
 
NOTE: The "Setup Telegram webhook" option is still a work in progress.

Revision as of 19:55, 25 May 2017

This plugin provides a message processor for Telegram, allowing sites to configure a Telegram bot that their users can configure to forward Moodle notifications and messages to their Telegram account.

Configuring the plugin settings

At the Telegram main settings page (Plugins / Message outputs / Telegram), you will need to configure a bot token to be used by the site. To get this token, you will need to create a new Telegram bot using the Telegram bot "Botfather".

After you have installed the plugin, at the settings screen, you will see this:

Settingscreen.png

The only thing you really need to enter here is the "bot token for the site". The other two fields will be automatically filled in once you save the token. To get the token, you need to open the Botfather in Telegram, which you can do by clicking the provided link below the instructions. When you click it, you will see something like this:

opentelegram.png

Open the link in the Telegram app (you need that), or alternatively in the Telegram Web (if your browser allows it). In Telegram, you should see this:

telegramstartscreen.png

Click the "Start" button at the bottom to begin the conversation with Botfather. Once you have, you will see:

botfatherstart.png

Enter the command "/newbot" in the conversation, and Botfather will ask you for all of the information you need. You will need to enter both a name and a unique username for your Bot. The Telegram settings screen provided some suggestions, but you can choose what you want. Since it should be unique, it is recommended you use your organization or sitename as part of these.

newbot.png

Once you have given Botfather everything it needs, you will gave the bot token displayed in the conversation:

bottoken.png

Transfer the bot token information to the settings screen and hit "Save changes":

savechanges.png

The name and username you chose will be filled in for you. Telegram is now ready for your users to configure their message preferences.

finalsettings.png

NOTE: The "Setup Telegram webhook" option is still a work in progress.