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

448 lines
16 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
from telebot import util
2015-07-20 04:56:17 +03:00
logger = telebot.logger
2015-09-18 21:53:10 +03:00
API_URL = "https://api.telegram.org/bot{0}/{1}"
FILE_URL = "https://api.telegram.org/file/bot{0}/{1}"
2015-06-26 17:35:52 +03:00
2016-04-14 09:34:37 +03:00
CONNECT_TIMEOUT = 3.5
READ_TIMEOUT = 9999
2015-09-18 21:53:10 +03:00
def _make_request(token, method_name, method='get', params=None, files=None, base_url=API_URL):
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: The result parsed to a JSON dictionary.
2015-07-02 14:43:49 +03:00
"""
2015-09-18 21:53:10 +03:00
request_url = base_url.format(token, method_name)
logger.debug("Request: method={0} url={1} params={2} files={3}".format(method, request_url, params, files))
2016-04-14 09:34:37 +03:00
read_timeout = READ_TIMEOUT
connect_timeout = CONNECT_TIMEOUT
2016-04-14 09:34:37 +03:00
if params:
if 'timeout' in params: read_timeout = params['timeout'] + 10
if 'connect-timeout' in params: connect_timeout = params['connect-timeout'] + 10
result = requests.request(method, request_url, params=params, files=files, timeout=(connect_timeout, read_timeout))
2015-09-18 21:53:10 +03:00
logger.debug("The server returned: '{0}'".format(result.text.encode('utf8')))
return _check_result(method_name, result)['result']
def _check_result(method_name, result):
"""
Checks whether `result` is a valid API response.
A result is considered invalid if:
- The server returned an HTTP response code other than 200
- The content of the result is invalid JSON.
- The method call was unsuccessful (The JSON 'ok' field equals False)
:raises ApiException: if one of the above listed cases is applicable
:param method_name: The name of the method called
:param result: The returned result of the method request
:return: The result parsed to a JSON dictionary.
"""
if result.status_code != 200:
2016-01-05 09:07:47 +03:00
msg = 'The server returned HTTP {0} {1}. Response body:\n[{2}]' \
.format(result.status_code, result.reason, result.text.encode('utf8'))
raise ApiException(msg, method_name, result)
try:
result_json = result.json()
except:
2016-01-05 09:07:47 +03:00
msg = 'The server returned an invalid JSON response. Response body:\n[{0}]' \
.format(result.text.encode('utf8'))
raise ApiException(msg, method_name, result)
if not result_json['ok']:
2016-01-05 09:07:47 +03:00
msg = 'Error code: {0} Description: {1}' \
.format(result_json['error_code'], result_json['description'])
raise ApiException(msg, method_name, result)
return result_json
2015-06-26 10:46:02 +03:00
def get_me(token):
method_url = r'getMe'
return _make_request(token, method_url)
2015-06-26 09:55:13 +03:00
2015-09-18 21:53:10 +03:00
def get_file(token, file_id):
method_url = r'getFile'
return _make_request(token, method_url, params={'file_id': file_id})
2015-06-26 17:35:52 +03:00
2015-09-18 21:53:10 +03:00
def download_file(token, file_path):
url = FILE_URL.format(token, file_path)
result = requests.get(url)
if result.status_code != 200:
2016-01-05 09:07:47 +03:00
msg = 'The server returned HTTP {0} {1}. Response body:\n[{2}]' \
2015-09-18 21:53:10 +03:00
.format(result.status_code, result.reason, result.text)
raise ApiException(msg, 'Download file', result)
return result.content
2015-09-08 22:51:45 +03:00
def send_message(token, chat_id, text, disable_web_page_preview=None, reply_to_message_id=None, reply_markup=None,
2016-02-27 06:17:35 +03:00
parse_mode=None, disable_notification=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)
2015-09-08 22:51:45 +03:00
if parse_mode:
payload['parse_mode'] = parse_mode
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
return _make_request(token, method_url, params=payload, method='post')
2015-06-26 13:02:30 +03:00
2015-06-26 17:35:52 +03:00
def set_webhook(token, url=None, certificate=None):
method_url = r'setWebhook'
payload = {
'url': url if url else "",
}
files = None
if certificate:
files = {'certificate': certificate}
return _make_request(token, method_url, params=payload, files=files)
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
2016-02-27 06:17:35 +03:00
def forward_message(token, chat_id, from_chat_id, message_id, disable_notification=None):
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}
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
return _make_request(token, method_url, params=payload)
2015-06-26 20:53:07 +03:00
2016-02-27 06:17:35 +03:00
def send_photo(token, chat_id, photo, caption=None, reply_to_message_id=None, reply_markup=None,
disable_notification=None):
2015-06-26 20:53:07 +03:00
method_url = r'sendPhoto'
payload = {'chat_id': chat_id}
files = None
if not util.is_string(photo):
files = {'photo': photo}
else:
payload['photo'] = photo
2015-06-26 20:53:07 +03:00
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)
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
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
2016-02-27 06:17:35 +03:00
def send_location(token, chat_id, latitude, longitude, reply_to_message_id=None, reply_markup=None,
disable_notification=None):
2015-06-27 17:11:18 +03:00
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)
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
return _make_request(token, method_url, params=payload)
2015-06-27 17:11:18 +03:00
2015-06-30 06:54:04 +03:00
2016-04-14 08:55:28 +03:00
def send_venue(token, chat_id, latitude, longitude, title, address, foursquare_id=None, disable_notification=None,
reply_to_message_id=None, reply_markup=None):
method_url = r'sendVenue'
payload = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude, 'title': title, 'address': address}
if foursquare_id:
payload['foursquare_id'] = foursquare_id
if disable_notification:
payload['disable_notification'] = disable_notification
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2016-04-16 10:07:52 +03:00
def send_contact(token, chat_id, phone_number, first_name, last_name=None, disable_notification=None,
reply_to_message_id=None, reply_markup=None):
method_url = r'sendContact'
payload = {'chat_id': chat_id, 'phone_number': phone_number, 'first_name': first_name}
if last_name:
payload['last_name'] = last_name
if disable_notification:
payload['disable_notification'] = disable_notification
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2016-04-14 08:55:28 +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
2016-02-27 06:17:35 +03:00
def send_video(token, chat_id, data, duration=None, caption=None, reply_to_message_id=None, reply_markup=None,
disable_notification=None, timeout=None):
2015-08-01 05:12:15 +03:00
method_url = r'sendVideo'
payload = {'chat_id': chat_id}
files = None
if not util.is_string(data):
2015-08-01 05:12:15 +03:00
files = {'video': data}
else:
payload['video'] = data
if duration:
payload['duration'] = duration
if caption:
payload['caption'] = caption
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
if timeout:
payload['connect-timeout'] = timeout
2015-08-01 05:12:15 +03:00
return _make_request(token, method_url, params=payload, files=files, method='post')
2016-02-27 06:17:35 +03:00
def send_voice(token, chat_id, voice, duration=None, reply_to_message_id=None, reply_markup=None,
disable_notification=None, timeout=None):
2015-08-19 13:08:01 +03:00
method_url = r'sendVoice'
payload = {'chat_id': chat_id}
files = None
if not util.is_string(voice):
2015-08-19 13:08:01 +03:00
files = {'voice': voice}
else:
payload['voice'] = voice
if duration:
payload['duration'] = duration
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
if timeout:
payload['connect-timeout'] = timeout
2015-08-19 13:08:01 +03:00
return _make_request(token, method_url, params=payload, files=files, method='post')
def send_audio(token, chat_id, audio, duration=None, performer=None, title=None, reply_to_message_id=None,
reply_markup=None, disable_notification=None, timeout=None):
2015-08-19 13:08:01 +03:00
method_url = r'sendAudio'
payload = {'chat_id': chat_id}
files = None
if not util.is_string(audio):
2015-08-19 13:08:01 +03:00
files = {'audio': audio}
else:
payload['audio'] = audio
if duration:
payload['duration'] = duration
if performer:
payload['performer'] = performer
if title:
payload['title'] = title
if reply_to_message_id:
payload['reply_to_message_id'] = reply_to_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
if timeout:
payload['connect-timeout'] = timeout
2015-08-19 13:08:01 +03:00
return _make_request(token, method_url, params=payload, files=files, method='post')
2016-06-02 08:15:22 +03:00
def send_data(token, chat_id, data, data_type, reply_to_message_id=None, reply_markup=None, disable_notification=None,
timeout=None, caption=None):
2015-06-26 21:14:45 +03:00
method_url = get_method_by_type(data_type)
2015-06-26 20:53:07 +03:00
payload = {'chat_id': chat_id}
files = None
if not util.is_string(data):
files = {data_type: data}
else:
payload[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)
2016-02-27 06:17:35 +03:00
if disable_notification:
payload['disable_notification'] = disable_notification
if timeout:
payload['connect-timeout'] = timeout
2016-06-02 08:15:22 +03:00
if caption:
payload['caption'] = caption
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 == 'document':
return r'sendDocument'
2015-06-26 21:14:45 +03:00
if data_type == 'sticker':
return r'sendSticker'
2015-06-27 16:55:45 +03:00
2016-04-14 09:48:26 +03:00
def kick_chat_member(token, chat_id, user_id):
method_url = 'kickChatMember'
payload = {'chat_id': chat_id, 'user_id': user_id}
return _make_request(token, method_url, params=payload, method='post')
def unban_chat_member(token, chat_id, user_id):
method_url = 'unbanChatMember'
payload = {'chat_id': chat_id, 'user_id': user_id}
return _make_request(token, method_url, params=payload, method='post')
2016-04-14 10:03:07 +03:00
# Updating messages
2016-04-14 10:06:46 +03:00
def edit_message_text(token, text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None,
2016-04-14 10:03:07 +03:00
disable_web_page_preview=None, reply_markup=None):
method_url = r'editMessageText'
2016-04-14 10:06:46 +03:00
payload = {'text': text}
if chat_id:
payload['chat_id'] = chat_id
2016-04-14 10:03:07 +03:00
if message_id:
payload['message_id'] = message_id
if inline_message_id:
payload['inline_message_id'] = inline_message_id
if parse_mode:
payload['parse_mode'] = parse_mode
if disable_web_page_preview:
payload['disable_web_page_preview'] = disable_web_page_preview
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2016-04-14 10:17:53 +03:00
def edit_message_caption(token, caption, chat_id=None, message_id=None, inline_message_id=None, reply_markup=None):
method_url = r'editMessageCaption'
payload = {'caption': caption}
if chat_id:
payload['chat_id'] = chat_id
if message_id:
payload['message_id'] = message_id
if inline_message_id:
payload['inline_message_id'] = inline_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2016-04-22 20:21:45 +03:00
def edit_message_reply_markup(token, chat_id=None, message_id=None, inline_message_id=None, reply_markup=None):
2016-04-14 10:17:53 +03:00
method_url = r'editMessageReplyMarkup'
payload = {}
if chat_id:
payload['chat_id'] = chat_id
if message_id:
payload['message_id'] = message_id
if inline_message_id:
payload['inline_message_id'] = inline_message_id
if reply_markup:
payload['reply_markup'] = _convert_markup(reply_markup)
return _make_request(token, method_url, params=payload)
2016-04-14 10:03:07 +03:00
# InlineQuery
2016-04-14 09:48:26 +03:00
def answer_callback_query(token, callback_query_id, text=None, show_alert=None):
method_url = 'answerCallbackQuery'
payload = {'callback_query_id': callback_query_id}
if text:
payload['text'] = text
if show_alert:
payload['show_alert'] = show_alert
return _make_request(token, method_url, params=payload, method='post')
2016-04-14 10:32:08 +03:00
def answer_inline_query(token, inline_query_id, results, cache_time=None, is_personal=None, next_offset=None,
switch_pm_text=None, switch_pm_parameter=None):
2016-01-05 09:07:47 +03:00
method_url = 'answerInlineQuery'
payload = {'inline_query_id': inline_query_id, 'results': _convert_inline_results(results)}
if cache_time:
payload['cache_time'] = cache_time
if is_personal:
payload['is_personal'] = is_personal
if next_offset is not None:
2016-01-05 09:07:47 +03:00
payload['next_offset'] = next_offset
2016-04-14 10:32:08 +03:00
if switch_pm_text:
payload['switch_pm_text'] = switch_pm_text
if switch_pm_parameter:
payload['switch_pm_parameter'] = switch_pm_parameter
return _make_request(token, method_url, params=payload, method='post')
2016-01-05 09:07:47 +03:00
def _convert_inline_results(results):
ret = ''
for r in results:
if isinstance(r, types.JsonSerializable):
ret = ret + r.to_json() + ','
if len(ret) > 0:
ret = ret[:-1]
return '[' + ret + ']'
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
2016-01-05 09:07:47 +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.
In addition to an informative message, it has a `function_name` and a `result` attribute, which respectively
contain the name of the failed function and the returned result that made the function to be considered as
failed.
2015-07-02 14:43:49 +03:00
"""
def __init__(self, msg, function_name, result):
super(ApiException, self).__init__("A request to the Telegram API was unsuccessful. {0}".format(msg))
2015-07-02 14:43:49 +03:00
self.function_name = function_name
2015-06-27 16:55:45 +03:00
self.result = result