README

Simple Telegram Bot API library for PHP

Quick Start

Initiate with setToken and end with run method.

Sample 1: Start

require 'Bot.php';

Bot::setToken(BOT_TOKEN, BOT_USERNAME); //init (required)
Bot::start('Welcome, I am a bot.'); //event
Bot::run(); //launch (required)

Sample 2: Keyboard

Bot::chat('/help', function(){
    $keyboard = Bot::keyboard('
    [/info] [/admin]
    [/help]
    ');
    $options = ['reply_markup' => $keyboard];
    return Bot::sendMessage("List of Commands:", $options);
});

Sample 3: Inline Keyboard

Bot::chat('/inline_keyboard', function(){
    $inline_keyboard = Bot::inline_keyboard('
    [Google|https://www.google.com] [Facebook|https://www.facebook.com]
    [More|more_data]
    ');
    $options = ['reply_markup' => $inline_keyboard];
    return Bot::sendMessage("Options:", $options);
});

Sample 4: Sending Document

Bot::chat('/send', function($file){
    if (file_exists($file)) return Bot::sendDocument($file);
    return Bot::sendMessage("$file not exists");
});

Sample 5: Chat Array

$help = function(){
    return Bot::sendMessage("This is <b>bold</b> and <i>italic</i> text.", ['parse_mode' => 'html']);
};

$info = function() {
    Bot::sendChatAction('typing');
    Bot::sendDocument('composer.json', ['caption' => 'for composer']);
};

Bot::chat_array([
    '/help' => $help,
    '/info' => $info,
]);

Sample 6: Regex

Bot::regex('/^\/start (\d+)$/', function($m){
    return Bot::sendMessage($m[1]);
});

Bot::start(function(){
    return Bot::sendMessage('Press button bellow:',
        [
            'reply_markup' => Bot::inline_keyboard('
                [BUTTON|https://t.me/Testing58384bot?start=1234567890]
            ')
        ]
    );
});

Documentation

Note that all properties and methods are static. For example: Bot::$property or Bot::method().

Bot Properties

Bot Methods

Telegram Events

Note that event parameters up to 2 parameters. For example: Bot::start($param1, $param2).

• all (when user sends anything, it's similar with on('*', $response) method)
• start (when user sends /start text message or presses START button)
• text (see: docs)
• animation
• audio
• document
• photo
• sticker
• video
• video_note
• voice
• contact
• dice
• game
• poll
• venue
• location
• message_auto_delete_timer_changed
• pinned_message
• invoice
• successful_payment
• user_shared
• chat_shared
• write_access_allowed
• passport_data
• proximity_alert_triggered
• forum_topic_created
• forum_topic_edited
• forum_topic_closed
• forum_topic_reopened
• general_forum_topic_hidden
• general_forum_topic_unhidden
• voice_chat_scheduled
• voice_chat_started
• voice_chat_ended
• voice_chat_participants_invited
• inline_query
• callback_query
• edited_message
• channel_post
• edited_channel_post

Telegram Methods

All Telegram methods are compatible with this bot. For example:

echo Bot::getMe();
echo Bot::setWebhook(WEBHOOK_URL);
echo Bot::getWebhookInfo();
echo Bot::deleteWebhook(true); //default is `false` for `drop_pending_updates`, see: https://core.telegram.org/bots/api#deletewebhook

See more: https://core.telegram.org/bots/api#available-methods