Getting Started

We are using JSON objects to transfer information between our engine & your API.

Request JSON

A sample request looks like this

{
  "bot_id": "E2LGaPoIISHvzDre",
  "block_id": "5817c67d312a91041b6aac7d",
  "user_information": {
    "name": "sender_name",
    "profile_picture": "profile_picture url"
  },
  "information": [
    {
      "label": "name",
      "value": "item value"
    }
  ]
}

Please note that user_information is an object but information is an array containing objects with label & value entities. You might wonder why we took this route. The answer is future-compatibility! We expect to supply more information like sentiment scores in future.

Response JSON

A sample response JSON is given below.

{
	"response": {
		"type": "send_message", 
		"message" : "response message to user"
	},
	"information": [
		{
			"label" :  "information label",
			"value" : "information value"
		}
		{
			"label" :  "information label",
			"value" : "information value"
		}
		...
	]
}

Right now we support two response types:

Message

"response": {
		"type": "send_message", 
		"message" : "response message to user"
	},
	

Quick Reply

"response": {
		"type": "send_quickreply", 
		"message" : "response message to user",
		"quick_reply_buttons: "button 1","button 2" // max 10
	},
	

Both are supported by Webwidget & FB Messenger. More response types like video, etc coming soon!