Getting Started

This page will help you get started with Telegram Bot SDK. You'll be up and running in a jiffy!

Overview

📘

Introduction

Telegram Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.

To learn how to create and set up a bot, please consult the Introduction to Bots and Bot FAQ on official Telegram site.

Telegram Bot API - PHP SDK

This is an Unofficial Telegram Bot API SDK for PHP language. Lets you develop Telegram Bots easily! Supports Laravel out of the box.

Please review the official documentation of Telegram Bot API to understand the usage better.

Requirements

• PHP 5.5+
• Composer
• Telegram Bot API Access Token - Talk to @BotFather and generate one.

• Laravel 5 or Lumen Installation (Optional only if you want to use with either of these frameworks).

Installation

The recommended way to install the SDK is with Composer. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.

Shell

curl -sS https://getcomposer.org/installer | php

You can add the SDK as a dependency using the composer.phar CLI:

Shell

php composer.phar require irazasyed/telegram-bot-sdk ^1.0

Or if you already have composer installed globally, then simply execute:

Shell

composer require irazasyed/telegram-bot-sdk ^1.0

Alternatively, you can specify the SDK as a dependency in your project's existing composer.json file:

composer.json

{
    "require": {
      "irazasyed/telegram-bot-sdk": "^1.0"
    }
}

After installing, you need to require Composer's autoloader if you want to use the library standalone:

PHP

require 'vendor/autoload.php';

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at getcomposer.org.

Laravel Additional Steps

If you're using Laravel and would like to use the SDK with it, then follow the below instructions. Otherwise, you can skip this part.

Step 1: Add the Service Provider

Open config/app.php and, to your providers array at the bottom, add:

config/app.php

Telegram\Bot\Laravel\TelegramServiceProvider::class

Step 2: Add Facade (Optional)

Optionally add an alias to make it easier to use the library. Open config/app.php and, to your "aliases" array at the bottom, add:

config/app.php

'Telegram'  => Telegram\Bot\Laravel\Facades\Telegram::class

Step 3: Publish Configuration File

Open your terminal window and fire the following command to publish config file to your config directory:

Shell

php artisan vendor:publish --provider="Telegram\Bot\Laravel\TelegramServiceProvider"

OR

Shell

php artisan vendor:publish

The former command publishes config file for just this package and the latter publishes vendor config files for other packages too. Depending on what you want to do, you can use any (Doesn't really matter).

Are You Using Telegram Bot SDK?

👍

Submit Your Bot!

If you're using this SDK to build your Telegram Bots, We'd love to know and share the bot with the world. Tell us about it - here

Check out the Who's Using Telegram Bot SDK wiki page to know more about what people have been building with this SDK.

Contributing

Thank you for considering contributing to the project. Please review the CONTRIBUTING guidelines before submitting any pull requests.

Credits

• Syed Irfaq R.
• All Contributors

Disclaimer

This project and its author is neither associated nor affiliated with Telegram in any way.

See License section for more details.

License

This project is released under the BSD 3-Clause License.

📘

Additional Information

The library takes advantage of the amazing Laravel Collection API to automatically map the data.

So it's a lot easier to work with the array of data. Supports all the methods listed on the official docs.

Any issues, feedback, suggestions or questions please use issue tracker here.