Integrate Your Chatbot
Introduction
You can use Acquire as platform, by creating your own Bot with API endpoint that describe within this document. You can also make your Bot public, by this other people can use your Bot as service. These are few examples that show how Acquire platform will accept the request and give response, from API Endpoint for Bot uses. You can make your own Web API and put that into below popup with given request format.
Screenshots
1. Here you can setup you Bot’s Basic Details:
2. Here you can setup you Bot Interaction API with any dynamic parameters:
About ‘type’ Parameter:
We have various types for parameter ‘type’ like:
1. Request ‘type’ parameter:
init-chat
: To initiate the Bot chat.suggestion
:
To get the suggestions from Bot.message
:
To ask a question to Bot.more will be added soon(like: button press, etc)
2. Response ‘type’ parameter:
suggestion
:
It gives few matched questions for suggestion to visitor.message
:
It gives the response that generated by the Bot.quick-replies
:
If By this type, You can send replies buttons along with response message.transfer
:
If Bot stuck in any unanswered situation then it indicates that hat will be transfer to one of executive.redirect
:
Useful when you want that your visitor have to redirect any given URL.card :
Under this type, you can show carousel card and browse carousel card in chat widget.multiple-tasks
:
Indicates that response data have multiple actions or task.
Single API Endpoint with various example formats:
Example 1. To activate or refresh the Bot:
Here you can see that, we can activate our Bot for that particular session or just we can refresh our Bot when any updation of Bot setting will occur, Bot will retrieve the updated data.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
Body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| init-chat |
API Response will be:
Example 2. To get suggestions from Bot:
This example shows that, if a visitor types a query to the Bot, then this example is helpful to directly select that query from suggestions.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| suggestion |
| how bot |
API Response will be:
Example 3. To ask a message:
By this example a visitor can simply ask a question and get their response with given format.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| hi |
API Response will be:
Example 4. To ask a message that Bot doesn’t knows:
This example illustrate the condition when Bot have not any response for visitor, that time it gives response that given below. In the response we have two type of data(message, event), Bot gives the message as ‘Sorry, I am still learning...’ and then put a event that ‘Your chat is transferring...’. thenafter one of the executive pick that chat, and interact with that visitor directly.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| do you sell banana |
API Response will be:
Example 5. Quick Replies:
Here we can give choices to our visitor. in this section, we pass a bunch of quick replies buttons along with response message. It will show message and buttons on the chat widget, customer can click on that button and bot will get this as a reply.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| I want to buy this |
API Response will be:
Example 6. Basic Card:
In Basic Card, you can preview item like an article to your customer with banner, title, subtitle, description & button to redirect URL. By this interactive way, you can share many basic cards to visitors so they can redirect to particular that link.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| show basic cards |
API Response will be:
Example 7. Carousel Card:
In this section, you can give choices to your customer as quick-replies but in a visual format with Title, subtitle, lists of items with the picture. so the customer sees those visuals and it helps in his/her selection and Bot will get this as a reply.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| show cards |
API Response will be:
Example 7. Browse Carousel Card/List:
In this section, you can preview a bunch of items to your customer with title, description, footer, open URL & picture. whenever the customer clicks one of them, it redirects on that URL. it helps customer to explore that item by going on that URL link.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| show cards |
API Response will be:
Example 8. In case of multiple responses:
When visitor asks a query and we have multiple actions or tasks with that response message then Bot will manage that response like this below example.
POST /bot_interaction
Headers:
Parameter | Type |
| application/x-www-form-urlencoded |
body
Parameter | Description |
| Account ID on which Bot is running. (Internally managed) |
| Chat ID/Session ID (Internally managed) |
| message |
| describe co browsing |
API Response will be:
Last updated