mnlnk/telegram-bot-api

Библиотека для работы с Telegram Bot API.

2.1.0 2024-04-14 22:25 UTC

Requires

• php: >=8.0
• ext-curl: *
• ext-json: *
• mnlnk/curl-wrapper: ^0.1

MIT

• mnlnk

README

Описание:

Библиотека для работы с Bot API Telegram.

Требования:

• PHP >= 8.0
• ext-curl
• ext-json

Установка:

composer require mnlnk/telegram-bot-api

Примеры:

use Manuylenko\Telegram\Bot\Api\Api;
use Manuylenko\Telegram\Bot\Api\Entities\InputFile;


// ..

$token = '0123456789:AAFYmpDWKXs_qc-2Let7p2VaHIC-cLrXLtE';

$api = new Api($token);

// Отправка текстового сообщения
$api->sendMessage('@channelname', 'Привет, мир!');

// Отправка видео
$api->sendVideo('@channelname', 'https://veshok.com/dw/load.php?id=37188');

// Отправка документа 
$api->sendDocument('@channelname', InputFile::make('C:\Some\File.zip'));

Список доступных методов:

Обновления

• getUpdates() - Получает массив входящих обновлений.
• getWebhookInfo() - Получает информацию о текущем статусе Webhook.
• setWebhook() - Устанавливает Webhook.
• deleteWebhook() - Удаляет Webhook.

Чаты

• getChat() - Получает основную информацию о чате.
• getUserChatBoosts() - Получает список бустов, добавленных пользователем в чат.
• sendChatAction() - Сообщает пользователю, что что-то происходит на стороне бота.
• pinChatMessage() - Добавляет сообщение в список закрепленных сообщений чата.
• unpinChatMessage() - Открепляет закрепленное сообщение в чате.
• unpinAllChatMessages() - Очищает список всех закрепленных сообщений в чате.
• exportChatInviteLink() - Создает новую ссылку для приглашения в чат.
• revokeChatInviteLink() - Отзывает пригласительную ссылку, созданую ботом.
• createChatInviteLink() - Создает дополнительную ссылку для приглашения в чат.
• editChatInviteLink() - Редактирует дополнительную пригласительную ссылку.
• approveChatJoinRequest() - Одобряет запрос на присоединение пользователя к чату.
• declineChatJoinRequest() - Отклоняет запрос на присоединение пользователя к чату.
• leaveChat() - Выходит из группы, супергруппы или канала.

Пользователи чата

• getChatMemberCount() - Получает количество участников в чате.
• getChatMember() - Получает информацию о конкретном участнике чата.
• getChatAdministrators() - Получает список всех администраторов чата.
• restrictChatMember() - Ограничивает пользователя в супергруппе.
• promoteChatMember() - Изменяет права пользователя в супергруппе или канале.
• banChatMember() - Блокирует и удаляет пользователя из группы, супергруппы или канала.
• unbanChatMember() - Разблокирует ранее удаленного пользователя в супергруппе или канале.
• banChatSenderChat() - Блокирует канал в супергруппе или на канале.
• unbanChatSenderChat() - Разблокирует канал в супергруппе или на канале.

Параметры чата

• getChatMenuButton() - Получает текущее значение кнопки меню бота.
• setChatTitle() - Устанавливает заголовок чата.
• setChatPhoto() - Устанавливает фотографию чата.
• setChatDescription() - Устанавливает описание группы, супергруппы или канала.
• setChatPermissions() - Устанавливает разрешения по умолчанию для всех участников.
• setChatAdministratorCustomTitle() - Устанавливает пользовательское название (титул) для администратора в супергруппе.
• setChatMenuButton() - Устанавливает кнопку меню бота или кнопку меню по умолчанию.
• deleteChatPhoto() - Удаляет фотографию чата.

Форумы

• createForumTopic() - Создает тему форума.
• editForumTopic() - Редактирует тему форума.
• closeForumTopic() - Закрывает тему форума.
• reopenForumTopic() - Открывает закрытую ранее тему форума.
• deleteForumTopic() - Удаляет тему форума.
• unpinAllForumTopicMessages() - Очищает список закрепленных сообщений в теме форума.
• editGeneralForumTopic() - Редактирует название "Основной" темы форума.
• closeGeneralForumTopic() - Закрывает открытую "Основную" тему форума.
• reopenGeneralForumTopic() - Повторно открывает закрытую "Основную" тему форума.
• hideGeneralForumTopic() - Скрывает "Основную" тему форума.
• unhideGeneralForumTopic() - Отображает скрытую "Основную" тему форума.
• unpinAllGeneralForumTopicMessages() - Очищает список закрепленных сообщений в "Основной" теме форума.
• getForumTopicIconStickers() - Получает массив стикеров для использования в качестве значков темы форума.

Сообщения

• sendMessage() - Отправляет текстовое сообщение.
• sendAudio() - Отправляет аудиофайл.
• sendAnimation() - Отправляет анимацию.
• sendVideo() - Отправляет видео.
• sendContact() - Отправляет телефонный контакт.
• sendDice() - Отправляет игральную кость.
• sendDocument() - Отправляет документ (файл).
• sendMediaGroup() - Отправляет группу фотографий или видео в виде альбома.
• sendPhoto() - Отправляет фотографию.
• sendVideoNote() - Отправляет видеозаметку.
• sendVoice() - Отправляет голосовую заметку.
• sendVenue() - Отправляет место встречи.
• sendLocation() - Отправляет местоположение.
• sendPoll() - Отправляет опрос.
• forwardMessage() - Пересылает сообщение.
• forwardMessages() - Пересылает несколько сообщений.
• copyMessage() - Копирует сообщение.
• copyMessages() - Копирует несколько сообщение.

Редактирование сообщений

• editMessageText() - Редактирует текстовое или игровое сообщение.
• editMessageCaption() - Редактирует подпись сообщения.
• editMessageMedia() - Редактирует мультимедийное сообщение.
• editMessageReplyMarkup() - Редактирует клавиатуру сообщения.
• editMessageLiveLocation() - Редактирует сообщение о местоположении в реальном времени.
• stopMessageLiveLocation() - Останавливает обновление сообщения о текущем местоположении.
• stopPoll() - Останавливает отправленный ранее опрос.
• deleteMessage() - Удаляет сообщение.
• deleteMessages() - Удаляет несколько сообщений одновременно.

Реакции

• setMessageReaction() - Изменяет выбранные реакции у сообщения.

Игры

• sendGame() - Отправляет игру.
• getGameHighScores() - Получает данные из таблицы рекордов.
• setGameScore() - Устанавливает счет пользователя в игре.

Стикеры

• sendSticker() - Отправляет стикер.
• getStickerSet() - Получает набор стикеров.
• getCustomEmojiStickers() - Получает информацию о пользовательских эмоджи стикерах.
• uploadStickerFile() - Загружает файл стикера на сервер.
• createNewStickerSet() - Создает новый набор стикеров.
• addStickerToSet() - Добавляет стикер в набор стикеров.
• setStickerPositionInSet() - Устанавливает позицию стикера в наборе стикеров.
• setStickerSetThumbnail() - Устанавливает миниатюру для набора стикеров.
• setChatStickerSet() - Устанавливает набор стикеров для группы или супергруппы.
• setCustomEmojiStickerSetThumbnail() - Устанавливает миниатюру пользовательского набора стикеров с эмоджи.
• setStickerSetTitle() - Устанавливает название созданного набора стикеров.
• setStickerEmojiList() - Устанавливавет список смайлов, связанных со стикером.
• setStickerKeywords() - Устанавливает ключевые слова для поиска, связанные со стикером.
• setStickerMaskPosition() - Устанавливает положение маски стикера.
• replaceStickerInSet() - Заменяет существующий стикер в наборе стикеров на новый.
• deleteStickerFromSet() - Удаляет стикер из набора.
• deleteStickerSet() - Удаляет набор стикеров, созданный ботом.
• deleteChatStickerSet() - Удаляет набор стикеров для группы или супергруппы.

Запросы

• answerCallbackQuery() - Отправляет ответ на запрос обратного вызова.
• answerInlineQuery() - Отправляет ответ на встроенный запрос.
• answerWebAppQuery() - Отправляет сообщение о результате взаимодействия с веб-приложением.

Платежи

• sendInvoice() - Отправляет счет на оплату.
• createInvoiceLink() - Создает ссылку для счета-фактуры.
• answerPreCheckoutQuery() - Отправляет ответ на запросы предварительной проверки заказа.
• answerShippingQuery() - Отправляет ответ на запрос доставки.

Конфигурация бота

• getMe() - Получает основную информацию о боте.
• getMyName() - Получает текущее имя бота.
• getMyShortDescription() - Получает короткое описание бота.
• getMyDescription() - Получает описание бота.
• getMyCommands() - Получает список команд бота.
• getMyDefaultAdministratorRights() - Получает права администратора по умолчанию для бота.
• setMyName() - Изменяет имя бота.
• setMyShortDescription() - Изменяет короткое описание бота, которое отображается на странице профиля бота.
• setMyDescription() - Изменяет описание бота, которое отображается в чате с ботом, если чат пуст.
• setMyCommands() - Устанавливает список команд бота.
• setMyDefaultAdministratorRights() - Устанавливает права администратора по умолчанию, запрашиваемые ботом.
• deleteMyCommands() - Удаляет список команд бота.
• getBusinessConnection() - Получает информацию о подключеннии бота к бизнес-аккаунту.

Телеграм Паспорт

• setPassportDataErrors() - Сообщает пользователю, о возникших ошибках в элементах Телеграм Паспорт.

Разное

• getFile() - Получает основную информацию о файле и подготавливает его к загрузке.
• getFileUrl() - (#) Получает URL-ссылку на файл.
• getUserProfilePhotos() - Получает список всех изображений профиля пользователя.
• close() - Закрывает экземпляр бота перед перемещением его с одного локального сервера на другой.
• logOut() - Бот выходит с облачного сервера API бота перед локальным запуском бота.

Методы отмеченые символом (#) отсутствуют в нативном API сервера, но реализованы в данной библиотеке.