PHP sdk for Viber api
Library to develop a bot for the Viber platform. Create you first Viber bot step by step, see demo at viber://pa?chatURI=viber-bot-php&context=github.com
Installation
composer require bogdaan/viber-bot-php
Example
<?php
require_once("../vendor/autoload.php");
use Viber\Bot;
use Viber\Api\Sender;
$apiKey = '<PLACE-YOU-API-KEY-HERE>';
// reply name
$botSender = new Sender([
'name' => 'Whois bot',
'avatar' => 'https://developers.viber.com/img/favicon.ico',
]);
try {
$bot = new Bot(['token' => $apiKey]);
$bot
->onConversation(function ($event) use ($bot, $botSender) {
// this event fires if user open chat, you can return "welcome message"
// to user, but you can't send more messages!
return (new \Viber\Api\Message\Text())
->setSender($botSender)
->setText("Can i help you?");
})
->onText('|whois .*|si', function ($event) use ($bot, $botSender) {
// match by template, for example "whois Bogdaan"
$bot->getClient()->sendMessage(
(new \Viber\Api\Message\Text())
->setSender($botSender)
->setReceiver($event->getSender()->getId())
->setText("I do not know )")
);
})
->run();
} catch (Exception $e) {
// todo - log exceptions
}
See more in examples directory.
Library structure
.
โโโ Api
โย ย โโโ Entity.php
โย ย โโโ Event # all remote events ("callbacks")
โย ย โย ย โโโ Conversation.php # fires when user open 1v1 chat
โย ย โย ย โโโ Delivered.php # fires when message delivered (for each device)
โย ย โย ย โโโ Factory.php # Event factory
โย ย โย ย โโโ Failed.php # fires when delivery failed (for each device)
โย ย โย ย โโโ Message.php # fires when user send message
โย ย โย ย โโโ Seen.php # fires when user read message (for each device)
โย ย โย ย โโโ Subscribed.php # fires when user subscribe to PA
โย ย โย ย โโโ Type.php # available types
โย ย โย ย โโโ Unsubscribed.php # fires when user unsubscribed
โย ย โโโ Event.php # base class for all events
โย ย โโโ Exception #
โย ย โย ย โโโ ApiException.php # remote or logic error
โย ย โโโ Keyboard #
โย ย โย ย โโโ Button.php # all types of buttons here
โย ย โโโ Keyboard.php # button container
โย ย โโโ Message #
โย ย โย ย โโโ CarouselContent.php #
โย ย โย ย โโโ Contact.php #
โย ย โย ย โโโ Factory.php #
โย ย โย ย โโโ File.php #
โย ย โย ย โโโ Location.php #
โย ย โย ย โโโ Picture.php #
โย ย โย ย โโโ Sticker.php #
โย ย โย ย โโโ Text.php #
โย ย โย ย โโโ Type.php # available message types
โย ย โย ย โโโ Url.php #
โย ย โย ย โโโ Video.php #
โย ย โโโ Message.php # base class for all messages
โย ย โโโ Response.php # wrap api response
โย ย โโโ Sender.php # represent bot-sender
โย ย โโโ Signature.php # signature helper (verify or create sign)
โย ย โโโ User #
โย ย โย ย โโโ State.php # user state (online/offline etc)
โย ย โโโ User.php # viber user
โโโ Bot #
โย ย โโโ Manager.php # manage bot closures
โโโ Bot.php # bot class
โโโ Client.php # api client
Read more
Features
- all api entities
- validate request and response signs
- provide webhook interface
- provide event interface
- wrap all api response to entities
- validate api entities before submit?
- implement log levels with monolog?
- post on public page
Contributing
Pull requests are welcome.