erfanvahabpour / bale-bot-sdk
The Unofficial Bale Bot API PHP SDK
Fund package maintenance!
Aqayepardakht
Requires
- php: ^8.0
- ext-json: *
- guzzlehttp/guzzle: ^7.5.1
- guzzlehttp/psr7: ^2.5
- illuminate/support: 9 - 11
- league/event: ^2.2 || ^3.0
- psr/container: ^1.1 || ^2.0
- psr/event-dispatcher: ^1.0
README
Bale Bot PHP SDK lets you develop Bale Bots in PHP easily! Supports Laravel out of the box.
Bale Bot API is an HTTP-based interface created for developers keen on building bots for Bale.
To learn more about the Bale Bot API, please consult the Introduction to Bots and Bot FAQ on official Bale site.
To get started writing your bots using this SDK, Please refer the documentation.
Documentation
Documentation for the SDK can be found on the website.
Installation
composer require erfanvahabpour/bale-bot-sdk
Examples
getMe Method
A simple method for testing your bot's auth token.
Returns basic information about the bot in form of a User object.
$Bale = new Api($token); $response = $Bale->getMe(); // return User object
sendMessage Method
Send text messages.
$Bale = new Api($token); $response = $Bale->sendMessage([ 'chat_id' => '2100855301', 'text' => 'This is a text.' ]); // return Message object
sendMessage Method in Laravel
Send text messages.
use EFive\Balle\Laravel\Facades\Bale; $response = Bale::sendMessage([ 'chat_id' => '2100855301', 'text' => 'This is a text.' ]); // return Message object
Get first name of a chat
Show the first name of a chat(private chats only)
$Bale = new Api($token); $response = $Bale->getChat([ 'chat_id' => '2100855301' ]); // return User object echo $response->getFirstName();
Setting multiple bots
For setting multiple bots in a single application
use EFive\Bale\BotsManager; $config = [ 'bots' => [ 'firstBot' => [ 'token' => $firstBotToken, ], 'secondBot' => [ 'token' => $secondBotToken, ], ] ]; $bale = new BotsManager($config); // getMe Method $response = $bale->bot('firstBot')->getMe(); // return User object
Disclaimer
This project and its author are neither associated nor affiliated with Bale in any way. Please see the License for more details.
License
This project is released under the BSD 4-Clause License.