1
0
mirror of https://github.com/eternnoir/pyTelegramBotAPI.git synced 2023-08-10 21:12:57 +03:00
pyTelegramBotAPI/telebot/apihelper.py

152 lines
5.0 KiB
Python
Raw Normal View History

2015-06-26 09:55:13 +03:00
# -*- coding: utf-8 -*-
import requests
import telebot
2015-06-30 08:20:44 +03:00
from telebot import types
2015-06-26 17:35:52 +03:00
def _make_request(token, method_name, method='get', params=None, files=None):
2015-07-02 14:43:49 +03:00
"""
Makes a request to the Telegram API.
:param token: The bot's API token. (Created with @BotFather)
:param method_name: Name of the API method to be called. (E.g. 'getUpdates')
:param method: HTTP method to be used. Defaults to 'get'.
:param params: Optional parameters. Should be a dictionary with key-value pairs.
:param files: Optional files.
:return:
"""
request_url = telebot.API_URL + 'bot' + token + '/' + method_name
result = requests.request(method, request_url, params=params, files=files)
if result.status_code != 200:
2015-07-02 14:43:49 +03:00
raise ApiException(method_name, result)
try:
result_json = result.json()
if not result_json['ok']:
2015-07-02 04:38:31 +03:00
raise Exception()
except:
2015-07-02 14:43:49 +03:00
raise ApiException(method_name, result)
return result_json['result']
2015-06-26 10:46:02 +03:00
def get_me(token):
method_url = 'getMe'
return _make_request(token, method_url)
2015-06-26 09:55:13 +03:00
2015-06-26 17:35:52 +03:00
2015-06-26 09:55:13 +03:00
def send_message(token, chat_id, text, disable_web_page_preview=None, reply_to_message_id=None, reply_markup=None):
2015-06-26 10:46:02 +03:00
"""
Use this method to send text messages. On success, the sent Message is returned.
:param token:
:param chat_id:
:param text:
:param disable_web_page_preview:
:param reply_to_message_id:
:param reply_markup:
:return:
"""
2015-06-26 09:55:13 +03:00
method_url = r'sendMessage'
2015-06-26 10:19:05 +03:00
payload = {'chat_id': str(chat_id), 'text': text}
2015-06-26 09:55:13 +03:00
if disable_web_page_preview:
2015-06-26 10:19:05 +03:00
payload['disable_web_page_preview'] = disable_web_page_preview
2015-06-26 09:55:13 +03:00
if reply_to_message_id:
2015-06-26 10:19:05 +03:00
payload['reply_to_message_id'] = reply_to_message_id
2015-06-26 09:55:13 +03:00
if reply_markup:
2015-07-02 14:43:49 +03:00
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2015-06-26 13:02:30 +03:00
2015-06-26 17:35:52 +03:00
def get_updates(token, offset=None, limit=None, timeout=None):
2015-06-26 13:02:30 +03:00
method_url = r'getUpdates'
payload = {}
if offset:
payload['offset'] = offset
if limit:
payload['limit'] = limit
if timeout:
payload['timeout'] = timeout
return _make_request(token, method_url, params=payload)
2015-06-26 17:16:11 +03:00
2015-07-01 23:34:40 +03:00
def get_user_profile_photos(token, user_id, offset=None, limit=None):
method_url = r'getUserProfilePhotos'
payload = {'user_id': user_id}
if offset:
payload['offset'] = offset
if limit:
payload['limit'] = limit
return _make_request(token, method_url, params=payload)
2015-06-26 17:35:52 +03:00
def forward_message(token, chat_id, from_chat_id, message_id):
2015-06-26 17:16:11 +03:00
method_url = r'forwardMessage'
2015-06-26 17:35:52 +03:00
payload = {'chat_id': chat_id, 'from_chat_id': from_chat_id, 'message_id': message_id}
return _make_request(token, method_url, params=payload)
2015-06-26 20:53:07 +03:00
def send_photo(token, chat_id, photo, caption=None, reply_to_message_id=None, reply_markup=None):
method_url = r'sendPhoto'
payload = {'chat_id': chat_id}
files = {'photo': photo}
if caption:
payload['caption'] = caption
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
2015-07-02 14:43:49 +03:00
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload, files=files, method='post')
2015-06-27 16:55:45 +03:00
2015-06-26 20:53:07 +03:00
2015-06-27 17:11:18 +03:00
def send_location(token, chat_id, latitude, longitude, reply_to_message_id=None, reply_markup=None):
method_url = r'sendLocation'
payload = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude}
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
2015-07-02 14:43:49 +03:00
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2015-06-27 17:11:18 +03:00
2015-06-30 06:54:04 +03:00
def send_chat_action(token, chat_id, action):
2015-06-28 12:56:32 +03:00
method_url = r'sendChatAction'
payload = {'chat_id': chat_id, 'action': action}
return _make_request(token, method_url, params=payload)
2015-06-27 17:11:18 +03:00
2015-06-30 06:54:04 +03:00
2015-06-26 21:14:45 +03:00
def send_data(token, chat_id, data, data_type, reply_to_message_id=None, reply_markup=None):
method_url = get_method_by_type(data_type)
2015-06-26 20:53:07 +03:00
payload = {'chat_id': chat_id}
2015-06-26 21:14:45 +03:00
files = {data_type: data}
2015-06-26 20:53:07 +03:00
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
2015-07-02 14:43:49 +03:00
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload, files=files, method='post')
2015-06-27 16:55:45 +03:00
2015-06-26 20:53:07 +03:00
2015-06-26 21:14:45 +03:00
def get_method_by_type(data_type):
if data_type == 'audio':
2015-06-26 20:53:07 +03:00
return 'sendAudio'
2015-06-26 21:14:45 +03:00
if data_type == 'document':
2015-06-26 20:53:07 +03:00
return 'sendDocument'
2015-06-26 21:14:45 +03:00
if data_type == 'sticker':
2015-06-26 20:53:07 +03:00
return 'sendSticker'
2015-06-26 21:14:45 +03:00
if data_type == 'video':
2015-06-26 20:53:07 +03:00
return 'sendVideo'
2015-06-27 16:55:45 +03:00
2015-07-02 14:43:49 +03:00
def _convert_markup(markup):
if isinstance(markup, types.JsonSerializable):
2015-06-30 08:20:44 +03:00
return markup.to_json()
return markup
2015-06-27 16:55:45 +03:00
class ApiException(Exception):
2015-07-02 14:43:49 +03:00
"""
This class represents an Exception thrown when a call to the Telegram API fails.
"""
def __init__(self, function_name, result):
super(ApiException, self).__init__('{0} failed. Returned result: {1}'.format(function_name, result))
self.function_name = function_name
2015-06-27 16:55:45 +03:00
self.result = result