ViniciusMRosa / facebot

A Java framework for building bots on Facebook's Messenger Platform.

FaceBot

A simple Java framework for building event-driven bots on Facebook's Messenger Platform.

The goal of FaceBot is making the Facebook's Messenger Platform easier: with FaceBot, you only need less than 5 lines of code to set up your own Messenger bot!

Premise

This tutorial will assume that you have already setup a Facebook page and application and you have a page token and a webhook validation token. If you don't, you can follow this link to Facebook's tutorial: https://developers.facebook.com/docs/messenger-platform/quickstart

QuickStart

First of all, you need to register the FaceBotServlet. To do that, create a Servlet project in your IDE and add this to your web.xml:

<servlet>
	  <servlet-name>myFaceBot</servlet-name>
	  <servlet-class>co.aurasphere.facebot.FaceBotServlet</servlet-class>
	  <init-param>
		  <param-name>bot-definition-class</param-name>
		  <param-value>com.mypackage.MyFaceBotDefinitionClass</param-value>
	  </init-param>
	  <load-on-startup>0</load-on-startup>
  </servlet>
  <servlet-mapping>
	  <servlet-name>myFaceBot</servlet-name>
	  <url-pattern>/myFaceBot</url-pattern>
  </servlet-mapping>

This will register a servlet named myFaceBot to the path /myFaceBot. The bot-definition-class parameters is a class that implements the FaceBotDefinition interface or extends the AbstractFaceBot class.

To complete your first bot, all you have to do is write the definition class. This class will describe your bot behavior. Here's an example:

public class MyFaceBotBehavior extends AbstractFaceBot {

  public void defineBehavior() {
 	// Setting my tokens from Facebook (page token and validation token for webhook).
	FaceBotContext.getInstance().setup("myFacebookPageToken", "myFacebookWebhookValidationToken");

 	// Defining a bot which will reply with "Hello World!" as soon as I write "Hi"
  	addActionFrame(new MessageEvent("Hi"),
			  new MessageAutoReply("Hello World!"));
  }
}

For more information on other callbacks, framework features or how to create a different kind of reply, check out the official wiki.

This project is a work in progress and any contribute is appreciated.

What's currently supported

FaceBot supports this Facebook Messenger Platform components:

• Callbacks
  • Message Received
  • Postback Received
  • Authentication
  • Account Linking
  • Message Delivered
  • Message Read
  • Message Echo
• Send API
  • Text Message
  • Image Attachment
  • Video Attachment
  • Audio Attachment
  • File Attachment
  • Generic Template
  • Button Template
  • Message Buttons
    • URL Buttons
    • Postback Buttons
    • Call Buttons
  • Quick Replies
  • Airline Itinerary Template
  • Airline Checkin Template
  • Airline Boarding Pass Template
  • Airline Flight Update Template
• Thread Settings
  • Greeting Text
  • Get Started Button
  • Persistent Menu

Coming next

Here's what you can expect coming up in the next updates:

• More documentation
• More examples
• Support for Share and Buy buttons
• Support for Receipt Template
• Support for Webview & Extesions
• Thread settings for Domain Whitelisting and Payment
• Support for Account Linking and Payment
• Support for retrieving User Account
• Possibility of attaching files instead of using links

Please notice that this list isn't ordered. If you don't find a feature you need in the list or you want me to give priority over one, just send me an e-mail.

_{Copyright (c) 2016 Donato Rimenti}