bhavyanshu/chatbase-php

A PHP library for the Chatbase API that helps you integrate chatbase with your PHP app. Note: This is not an official Google product.

v1.2.0 2019-02-10 03:27 UTC

Requires

• php: ^5.3|^5.6|^7.0

Requires (Dev)

• phpunit/phpunit: ^4.8|^5.7|^6.3

MIT

• Bhavyanshu Parasher

• chatbase
• bot-analytics

README

• Master :

  

• Current Dev:

  

A PHP library for the Chatbase API that helps you integrate chatbase with your PHP app.

Note: This is not an official Google product.

For more information, read official documentation

Installing

composer require bhavyanshu/chatbase-php

Example Usage

• Initializing

  use ChatbaseAPI\Chatbase;
  $cb = new Chatbase('YOUR_AGENT_API_KEY');
  

• Logging what User asked for

  //userMessage($user_id, $platform, $message = "", $intent = "", $session_id = "", $version = "", $not_handled = false, $feedback = false)
  $cb_data = $cb->userMessage('userid', 'alexa', 'some message', 'some-intent');
  $result = $cb->send($cb_data); //returns json decoded object
  

• Logging what Agent/Bot replied

  //agentMessage($user_id, $platform, $message = "", $session_id = "", $version = "")
  $cb_data = $cb->agentMessage('userid', 'alexa', 'some message');
  $result = $cb->send($cb_data);
  

• Logging two way communication:

  //twoWayMessages($user_id, $platform, $user_message = "", $agent_message = "", $intent = "", $session_id = "", $user_version = "", $agent_version = "", $not_handled = false)
  $cb_data = $cb->twoWayMessages('user-xyz', 'alexa', 'about food options', 'Let me read todays menu', 'food-menu');
  $result = $cb->sendAll($cb_data);
  

  Example Response:

  {
    "all_succeeded": true,
    "responses": [{
    	"message_id": 1212121,
    	"status": "success"
    }, {
    	"message_id": 13131313,
    	"status": "success"
    }],
    "status": 200
  }
  

• Logging multiple messages at once

  $message1 = array(
   'type' => 'user',
   'user_id' => 'user-xyz',
   'platform' => 'alexa',
   'message' => 'travel to chicago',
   'intent' => 'travel-intent',
   'not_handled' => false
  );
  $message2 = array(
   'type' => 'agent',
   'user_id' => 'user-xyz',
   'platform' => 'alexa',
   'message' => 'Next flight at 4 PM'
  );
  $arr_messages = array($message1, $message2);
  $cb_data = $cb->rawMultipleMessages($arr_messages);
  $result = $cb->sendAll($cb_data);