https://github.com/kiwari-engineering/bot-sdk-php
Kiwari Bot SDK PHP
https://github.com/kiwari-engineering/bot-sdk-php
bot-api bot-sdk kiwari kiwari-bot kiwari-bot-sdk kiwari-sdk sdk
Last synced: 3 months ago
JSON representation
Kiwari Bot SDK PHP
- Host: GitHub
- URL: https://github.com/kiwari-engineering/bot-sdk-php
- Owner: kiwari-engineering
- License: mit
- Created: 2019-05-03T10:44:28.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-03T10:53:33.000Z (almost 7 years ago)
- Last Synced: 2025-07-27T06:52:05.980Z (8 months ago)
- Topics: bot-api, bot-sdk, kiwari, kiwari-bot, kiwari-bot-sdk, kiwari-sdk, sdk
- Language: PHP
- Homepage: https://www.kiwari.chat
- Size: 1.07 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kiwari Bot SDK [PHP]
## Requirements
* PHP
* Composer
* Kiwari Account for Bot
* ngrok _(for running the example)_
## How to use
### Setup
* Please add this SDK to your Bot PHP usng composer
```bash
$ composer require kiwari/kiwari-bot-sdk
```
* Get your `acces_token` of Kiwari Bot Account, you can find in Kiwari Dashboard
* Init Kiwari Bot SDK
```php
enableLog(true); // you can enable log, the log file is inside your tmp
//now you need to run the bot
$bot->run();
```
* After you init Kiwari Bot, you can get `message`, `chatroom`, `sender`, and `myaccount`
```php
getSender();
/**
* to get the sender
* example data for method : $bot->getSender()
*
* {
* "id": 287,
* "phone_number": "+6285123123123",
* "fullname": "Jarjit Singh",
* "qiscus_email": "jarjitid@kiwari-prod.com",
* "qiscus_id": 11
* }
*/
$myAccount = $bot->getMyAccount();
/**
* to get the my account or the bot
* example data for method : $bot->getMyAccount()
*
* {
* "id": 22,
* "phone_number": "+628681234567",
* "fullname": "Cuti Bot",
* "qiscus_email": "cutibot_id@kiwari-prod.com"
* }
*/
$room = $bot->getChatRoom();
/**
* to get chatroom
* example data for method : $bot->getChatRoom()
*
* {
* "id": 1510,
* "qiscus_room_name": "Name of Chat Room",
* "qiscus_room_id": 8777,
* "is_group_chat": false,
* "created_at": "2017-06-02T01:33:12.233Z",
* "updated_at": "2017-06-02T01:33:12.233Z",
* "application_id": 3,
* "group_avatar_url": "",
* "is_official_chat": false,
* "target_user_id": 443,
* "is_public_chat": false,
* "is_channel": false,
* "users": [
* {
* "id": 287,
* "phone_number": "+6285123123123",
* "fullname": "Jarjit Singh",
* "qiscus_email": "jarjitid@kiwari-prod.com",
* "qiscus_id": 784
* },
* {
* "id": 22,
* "phone_number": "+628681234567",
* "fullname": "Cuti Bot",
* "qiscus_email": "cutibot_id@kiwari-prod.com",
* "qiscus_id": 2039
* }
* ],
* "chat_name": "Group Chat Name",
* "chat_avatar_url": ""
* }
*/
$message = $bot->getMessage();
/**
* to get the message
* example data for method : $bot->getMessage()
*
* {
* "payload": {},
* "text": "halo bro",
* "type": "text"
* }
*/
```
* Now you can send the message into the opponent user by call the method that provided like below
* **Send Message Text**
```php
sendText($room['qiscus_room_id'], 'Hello, this is from Kiwari Bot SDK PHP');
var_dump($response); //you can see the response if you need to debug or something to handle in your bot
```
* **Send Button**
_More example, please see the test [here](tests/Model/ButtonTest.php)_
```php
sendButton($room['qiscus_room_id'], 'This is message Example', [
\Kiwari\Model\Button::create()
->setLabel('Google')
->setUrl('https://google.com'),
\Kiwari\Model\Button::create()
->setLabel('Facebook')
->setUrl('https://facebook.com'),
\Kiwari\Model\Button::create()
->setLabel('Twitter')
->setUrl('https://twitter.com')
]);
var_dump($response);
```
* **Send Document**
_If you want to send document message, you need to upload the document or file first by using `$bot->upload()` function_
```php
upload($path);
var_dump($upload->body->data->url); // you can get the file url here
//now you can send the document like below
$response = $bot->sendDocument($room['qiscus_room_id'], $upload->body->data->url);
var_dump($response);
```
* **Send Card**
```php
sendCard($room['qiscus_room_id'], 'ini teks',
Card::create()
->setText('Ini contoh textnya')
->setImageUrl('https://vignette.wikia.nocookie.net/upinipin/images/1/13/4_jarjit.png/revision/latest?cb=20180203141217')
->setTitle('ini contoh judulnya')
->setDescription('ini contoh deskripsi')
->setUrl('https://www.google.com/search?q=jarjit+singh&safe=off&rlz=1C5CHFA_enID828ID828&tbm=isch&source=iu&ictx=1&fir=fHecVrBhuDLpcM%253A%252CUAvPHuNZ8waOSM%252C_&vet=1&usg=AI4_-kR5h1JaCrqS6jGfMR41LepSu6XoWg&sa=X&ved=2ahUKEwi4qZW8-_7hAhVo63MBHS_NCrwQ9QEwA3oECAcQCg#imgrc=_&vet=1')
->setButtons([
Button::create()
->setLabel('Jarjit Singh')
->setUrl('https://www.google.com/search?safe=off&source=hp&ei=rgbIXL6ZF8GEvQS1z5y4BQ&q=jarjit+singh&btnK=Google+Search&oq=jarjit+singh&gs_l=psy-ab.3..0l3j0i10l7.1892.2423..2633...0.0..0.110.518.5j1......0....1..gws-wiz.9PGvoF92CXU'),
Button::create()
->setLabel('Jarjit Singh')
->setUrl('https://www.google.com/search?safe=off&source=hp&ei=rgbIXL6ZF8GEvQS1z5y4BQ&q=jarjit+singh&btnK=Google+Search&oq=jarjit+singh&gs_l=psy-ab.3..0l3j0i10l7.1892.2423..2633...0.0..0.110.518.5j1......0....1..gws-wiz.9PGvoF92CXU')
]));
```
* **Send Carousel**
```php
sendCarousel($room['qiscus_room_id'],
Carousel::create()
->setCards([
Card::create()
->setText('Ini contoh textnya')
->setImageUrl('https://vignette.wikia.nocookie.net/upinipin/images/1/13/4_jarjit.png/revision/latest?cb=20180203141217')
->setTitle('ini contoh judulnya')
->setDescription('ini contoh deskripsi')
->setUrl('https://www.google.com/search?q=jarjit+singh&safe=off&rlz=1C5CHFA_enID828ID828&tbm=isch&source=iu&ictx=1&fir=fHecVrBhuDLpcM%253A%252CUAvPHuNZ8waOSM%252C_&vet=1&usg=AI4_-kR5h1JaCrqS6jGfMR41LepSu6XoWg&sa=X&ved=2ahUKEwi4qZW8-_7hAhVo63MBHS_NCrwQ9QEwA3oECAcQCg#imgrc=_&vet=1')
->setButtons([
Button::create()
->setLabel('Jarjit Singh')
->setUrl('https://www.google.com/search?safe=off&source=hp&ei=rgbIXL6ZF8GEvQS1z5y4BQ&q=jarjit+singh&btnK=Google+Search&oq=jarjit+singh&gs_l=psy-ab.3..0l3j0i10l7.1892.2423..2633...0.0..0.110.518.5j1......0....1..gws-wiz.9PGvoF92CXU'),
Button::create()
->setLabel('Jarjit Singh')
->setUrl('https://www.google.com/search?safe=off&source=hp&ei=rgbIXL6ZF8GEvQS1z5y4BQ&q=jarjit+singh&btnK=Google+Search&oq=jarjit+singh&gs_l=psy-ab.3..0l3j0i10l7.1892.2423..2633...0.0..0.110.518.5j1......0....1..gws-wiz.9PGvoF92CXU')
]),
Card::create()
->setText('Ini contoh textnya')
->setImageUrl('https://vignette.wikia.nocookie.net/upinipin/images/1/13/4_jarjit.png/revision/latest?cb=20180203141217')
->setTitle('ini contoh judulnya')
->setDescription('ini contoh deskripsi')
->setUrl('https://www.google.com/search?q=jarjit+singh&safe=off&rlz=1C5CHFA_enID828ID828&tbm=isch&source=iu&ictx=1&fir=fHecVrBhuDLpcM%253A%252CUAvPHuNZ8waOSM%252C_&vet=1&usg=AI4_-kR5h1JaCrqS6jGfMR41LepSu6XoWg&sa=X&ved=2ahUKEwi4qZW8-_7hAhVo63MBHS_NCrwQ9QEwA3oECAcQCg#imgrc=_&vet=1')
->setButtons([
Button::create()
->setLabel('Jarjit Singh')
->setUrl('https://www.google.com/search?safe=off&source=hp&ei=rgbIXL6ZF8GEvQS1z5y4BQ&q=jarjit+singh&btnK=Google+Search&oq=jarjit+singh&gs_l=psy-ab.3..0l3j0i10l7.1892.2423..2633...0.0..0.110.518.5j1......0....1..gws-wiz.9PGvoF92CXU'),
Button::create()
->setLabel('Jarjit Singh')
->setUrl('https://www.google.com/search?safe=off&source=hp&ei=rgbIXL6ZF8GEvQS1z5y4BQ&q=jarjit+singh&btnK=Google+Search&oq=jarjit+singh&gs_l=psy-ab.3..0l3j0i10l7.1892.2423..2633...0.0..0.110.518.5j1......0....1..gws-wiz.9PGvoF92CXU')
])
]));
```
* **Send Custom**
```php
sendCustom($room['qiscus_room_id'],
Custom::create()
->setType('promo')
->setContent([
'product' => [
'id' => 123,
'name' => 'sandal mahal',
'price' => 5000000
],
'discount' => 0.1
]));
```
* **Send Location**
```php
setName($name)
->setAddress($address)
->setLatitude($latitude)
->setLongitude($longitude)
->setMapUrl($mapUrl);
$bot->sendLocation($room['qiscus_room_id'], $location);
```
```php
sendReply($room['qiscus_room_id'],
Reply::create()
->setText('ini contoh reply')
->setRepliedCommentId(22092099));
```
## Example
You can try example by using [this example](./example)
## Run Webhook Example
* Run webhook example by executing
```bash
$ make run-example
```
* After you run webhook in the local, you need to bring online using ngrok
```bash
$ ngrok http 3000
```
* Now you can access your webhook url online in the internet like below
```
Forwarding https://xxxxxxxx.ngrok.io -> localhost:3000
```
* Register the url in the Kiwari dashboard
* Now you can chat with your Bot
## Test
```bash
$ make test
```