├── .gitignore ├── LICENSE ├── README.md ├── app.yaml ├── favicon.ico ├── index.yaml ├── main.py └── multipart.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # telebot 2 | Telegram Bot starter kit. Very easy to install with Google App Engine. 3 | 4 | Reddit post: http://www.reddit.com/r/Telegram/comments/3b1pwl/create_your_own_telegram_bot_stepbystep/ 5 | 6 | Instructions 7 | ============ 8 | 9 | 1. Message @botfather https://telegram.me/botfather with the following text: `/newbot` 10 | If you don't know how to message by username, click the search field on your Telegram app and type `@botfather`, you should be able to initiate a conversation. Be careful not to send it to the wrong contact, because some users has similar usernames to `botfather`. 11 | 12 | ![botfather initial conversation](http://i.imgur.com/pGOtOcj.png) 13 | 14 | 2. @botfather replies with `Alright, a new bot. How are we going to call it? Please choose a name for your bot.` 15 | 16 | 3. Type whatever name you want for your bot. 17 | 18 | 4. @botfather replies with `Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot.` 19 | 20 | 5. Type whatever username you want for your bot, minimum 5 characters, and must end with `bot`. For example: `whateversamplebot` 21 | 22 | 6. @botfather replies with: 23 | 24 | Done! Congratulations on your new bot. You will find it at telegram.me/whateversamplebot. You can now add a description, about section and profile picture for your bot, see /help for a list of commands. 25 | 26 | Use this token to access the HTTP API: 27 | 123456789:AAG90e14-0f8-40183D-18491dDE 28 | 29 | For a description of the Bot API, see this page: https://core.telegram.org/bots/api 30 | 31 | 7. Note down the 'token' mentioned above. 32 | 33 | 8. Type `/setprivacy` to @botfather. 34 | 35 | ![botfather later conversation](http://i.imgur.com/ZrRdaa0.png) 36 | 37 | 9. @botfather replies with `Choose a bot to change group messages settings.` 38 | 39 | 10. Type `@whateversamplebot` (change to the username you set at step 5 above, but start it with `@`) 40 | 41 | 11. @botfather replies with 42 | 43 | 'Enable' - your bot will only receive messages that either start with the '/' symbol or mention the bot by username. 44 | 'Disable' - your bot will receive all messages that people send to groups. 45 | Current status is: ENABLED 46 | 47 | 12. Type `Disable` to let your bot receive all messages sent to a group. This step is up to you actually. 48 | 49 | 13. @botfather replies with `Success! The new status is: DISABLED. /help` 50 | 51 | 14. Go to https://console.cloud.google.com/project 52 | 53 | 15. Click `Create Project` 54 | 55 | 16. Type the project name, whatever you want. For example: `octopus-gorilla-123`. Make sure the Project ID is also the same. 56 | 57 | ![App Engine registration](http://i.imgur.com/mxw8owO.png) 58 | 59 | 17. Clone this repository. If you don't understand what I said, click the green `Clone or download` button on this page, click `Download ZIP`, and extract the ZIP file. 60 | 61 | 18. Open `app.yaml` file using a good text editor like Sublime Text. Change the `YOUR_APP_ID_HERE` to the Project ID you set on step 16, and save the file. 62 | 63 | ![app.yaml](http://i.imgur.com/m9yRwNw.png) 64 | 65 | 19. Open `main.py` file using a good text editor. Change the `YOUR_BOT_TOKEN_HERE` to the token you get from @botfather at step 6, and save the file. 66 | 67 | ![main.py](http://i.imgur.com/oNFEdsp.png) 68 | 69 | 20. Download Google App Engine SDK for Python from https://cloud.google.com/appengine/downloads and install it. 70 | 71 | 21. Run the GoogleAppEngineLauncher application. 72 | 73 | 22. Click the `File` menu, choose `Add Existing Application...` and browse to the folder with the `app.yaml` and `main.py` file. 74 | 75 | 23. The project ID should appear as a row at the `Name` column. 76 | 77 | ![app engine launcher](http://i.imgur.com/SXr2Tz2.png) 78 | 79 | 24. Click `Deploy`, enter your Google credentials, and your app should be installed to Google's servers. 80 | 81 | 25. Open your browser and go to https://`project-id`.appspot.com/me (replace `project-id` with the Project ID you set on step 16). 82 | 83 | 26. Wait until you see a long text with `"ok": true` and your bot's name. This could take a minute or so, please reload if it does not succeed. 84 | 85 | 27. Now, go to https://`project-id`.appspot.com/set_webhook?url=https://`project-id`.appspot.com/webhook (replace both `project-id`s with the Project ID you set on step 16). 86 | 87 | 28. You should see `Webhook was set`. 88 | 89 | 29. Open your Telegram client and send the message `/start` to your bot. (type @`your-bot-username` at the search field to initiate the conversation) 90 | 91 | 30. You can, for example, send `what time` to the bot and the bot will reply you. Try sending `/image` as well. Mission completed! 92 | 93 | To customize the bot, edit the `main.py` starting from the `CUSTOMIZE FROM HERE` line. They are simple if-else statements. 94 | 95 | -------------------------------------------------------------------------------- /app.yaml: -------------------------------------------------------------------------------- 1 | application: YOUR_APP_ID_HERE 2 | version: 1 3 | runtime: python27 4 | api_version: 1 5 | threadsafe: yes 6 | 7 | handlers: 8 | - url: /favicon\.ico 9 | static_files: favicon.ico 10 | upload: favicon\.ico 11 | 12 | - url: /set_webhook 13 | login: admin 14 | script: main.app 15 | 16 | - url: .* 17 | script: main.app 18 | 19 | libraries: 20 | - name: webapp2 21 | version: "2.5.2" 22 | - name: PIL 23 | version: latest 24 | -------------------------------------------------------------------------------- /favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yukuku/telebot/7579a97f59698569bb176be35fa27b1ce5767cc0/favicon.ico -------------------------------------------------------------------------------- /index.yaml: -------------------------------------------------------------------------------- 1 | indexes: 2 | 3 | # AUTOGENERATED 4 | 5 | # This index.yaml is automatically updated whenever the dev_appserver 6 | # detects that a new type of query is run. If you want to manage the 7 | # index.yaml file manually, remove the above marker line (the line 8 | # saying "# AUTOGENERATED"). If you want to manage some indexes 9 | # manually, move them above the marker line. The index.yaml file is 10 | # automatically uploaded to the admin console when you next deploy 11 | # your application using appcfg.py. 12 | 13 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import StringIO 2 | import json 3 | import logging 4 | import random 5 | import urllib 6 | import urllib2 7 | 8 | # for sending images 9 | from PIL import Image 10 | import multipart 11 | 12 | # standard app engine imports 13 | from google.appengine.api import urlfetch 14 | from google.appengine.ext import ndb 15 | import webapp2 16 | 17 | TOKEN = 'YOUR_BOT_TOKEN_HERE' 18 | 19 | BASE_URL = 'https://api.telegram.org/bot' + TOKEN + '/' 20 | 21 | 22 | # ================================ 23 | 24 | class EnableStatus(ndb.Model): 25 | # key name: str(chat_id) 26 | enabled = ndb.BooleanProperty(indexed=False, default=False) 27 | 28 | 29 | # ================================ 30 | 31 | def setEnabled(chat_id, yes): 32 | es = EnableStatus.get_or_insert(str(chat_id)) 33 | es.enabled = yes 34 | es.put() 35 | 36 | def getEnabled(chat_id): 37 | es = EnableStatus.get_by_id(str(chat_id)) 38 | if es: 39 | return es.enabled 40 | return False 41 | 42 | 43 | # ================================ 44 | 45 | class MeHandler(webapp2.RequestHandler): 46 | def get(self): 47 | urlfetch.set_default_fetch_deadline(60) 48 | self.response.write(json.dumps(json.load(urllib2.urlopen(BASE_URL + 'getMe')))) 49 | 50 | 51 | class GetUpdatesHandler(webapp2.RequestHandler): 52 | def get(self): 53 | urlfetch.set_default_fetch_deadline(60) 54 | self.response.write(json.dumps(json.load(urllib2.urlopen(BASE_URL + 'getUpdates')))) 55 | 56 | 57 | class SetWebhookHandler(webapp2.RequestHandler): 58 | def get(self): 59 | urlfetch.set_default_fetch_deadline(60) 60 | url = self.request.get('url') 61 | if url: 62 | self.response.write(json.dumps(json.load(urllib2.urlopen(BASE_URL + 'setWebhook', urllib.urlencode({'url': url}))))) 63 | 64 | 65 | class WebhookHandler(webapp2.RequestHandler): 66 | def post(self): 67 | urlfetch.set_default_fetch_deadline(60) 68 | body = json.loads(self.request.body) 69 | logging.info('request body:') 70 | logging.info(body) 71 | self.response.write(json.dumps(body)) 72 | 73 | update_id = body['update_id'] 74 | try: 75 | message = body['message'] 76 | except: 77 | message = body['edited_message'] 78 | message_id = message.get('message_id') 79 | date = message.get('date') 80 | text = message.get('text') 81 | fr = message.get('from') 82 | chat = message['chat'] 83 | chat_id = chat['id'] 84 | 85 | if not text: 86 | logging.info('no text') 87 | return 88 | 89 | def reply(msg=None, img=None): 90 | if msg: 91 | resp = urllib2.urlopen(BASE_URL + 'sendMessage', urllib.urlencode({ 92 | 'chat_id': str(chat_id), 93 | 'text': msg.encode('utf-8'), 94 | 'disable_web_page_preview': 'true', 95 | 'reply_to_message_id': str(message_id), 96 | })).read() 97 | elif img: 98 | resp = multipart.post_multipart(BASE_URL + 'sendPhoto', [ 99 | ('chat_id', str(chat_id)), 100 | ('reply_to_message_id', str(message_id)), 101 | ], [ 102 | ('photo', 'image.jpg', img), 103 | ]) 104 | else: 105 | logging.error('no msg or img specified') 106 | resp = None 107 | 108 | logging.info('send response:') 109 | logging.info(resp) 110 | 111 | if text.startswith('/'): 112 | if text == '/start': 113 | reply('Bot enabled') 114 | setEnabled(chat_id, True) 115 | elif text == '/stop': 116 | reply('Bot disabled') 117 | setEnabled(chat_id, False) 118 | elif text == '/image': 119 | img = Image.new('RGB', (512, 512)) 120 | base = random.randint(0, 16777216) 121 | pixels = [base+i*j for i in range(512) for j in range(512)] # generate sample image 122 | img.putdata(pixels) 123 | output = StringIO.StringIO() 124 | img.save(output, 'JPEG') 125 | reply(img=output.getvalue()) 126 | else: 127 | reply('What command?') 128 | 129 | # CUSTOMIZE FROM HERE 130 | 131 | elif 'who are you' in text: 132 | reply('telebot starter kit, created by yukuku: https://github.com/yukuku/telebot') 133 | elif 'what time' in text: 134 | reply('look at the corner of your screen!') 135 | else: 136 | if getEnabled(chat_id): 137 | reply('I got your message! (but I do not know how to answer)') 138 | else: 139 | logging.info('not enabled for chat_id {}'.format(chat_id)) 140 | 141 | 142 | app = webapp2.WSGIApplication([ 143 | ('/me', MeHandler), 144 | ('/updates', GetUpdatesHandler), 145 | ('/set_webhook', SetWebhookHandler), 146 | ('/webhook', WebhookHandler), 147 | ], debug=True) 148 | -------------------------------------------------------------------------------- /multipart.py: -------------------------------------------------------------------------------- 1 | import httplib 2 | import mimetypes 3 | import urlparse 4 | import uuid 5 | 6 | def post_multipart(url, fields, files): 7 | parts = urlparse.urlparse(url) 8 | scheme = parts[0] 9 | host = parts[1] 10 | selector = parts[2] 11 | content_type, body = encode_multipart_formdata(fields, files) 12 | if scheme == 'http': 13 | h = httplib.HTTP(host) 14 | elif scheme == 'https': 15 | h = httplib.HTTPS(host) 16 | else: 17 | raise ValueError('unknown scheme: ' + scheme) 18 | h.putrequest('POST', selector) 19 | h.putheader('content-type', content_type) 20 | h.putheader('content-length', str(len(body))) 21 | h.endheaders() 22 | h.send(body) 23 | errcode, errmsg, headers = h.getreply() 24 | return h.file.read() 25 | 26 | 27 | def encode_multipart_formdata(fields, files): 28 | def get_content_type(filename): 29 | return mimetypes.guess_type(filename)[0] or 'application/octet-stream' 30 | 31 | LIMIT = '----------' + uuid.uuid4().hex 32 | CRLF = '\r\n' 33 | L = [] 34 | for (key, value) in fields: 35 | L.append('--' + LIMIT) 36 | L.append('Content-Disposition: form-data; name="%s"' % key) 37 | L.append('') 38 | L.append(value) 39 | for (key, filename, value) in files: 40 | L.append('--' + LIMIT) 41 | L.append('Content-Disposition: form-data; name="%s"; filename="%s"' % (key, filename)) 42 | L.append('Content-Type: %s' % get_content_type(filename)) 43 | L.append('') 44 | L.append(value) 45 | L.append('--' + LIMIT + '--') 46 | L.append('') 47 | body = CRLF.join(L) 48 | content_type = 'multipart/form-data; boundary=%s' % LIMIT 49 | return content_type, body 50 | --------------------------------------------------------------------------------