Leads & Chats API
This section contains the Leads and Chat API references
To use the BotPenguin APIs, You need to insure that you have following details with you.
A. UUID - You can get the UUID from the local web session storage as show in the image below:
How to get the UUDI
B. Bot ID & User ID: One can get the Bot ID and User ID from your Bot Script or Bot page URL. Below is the sample Example.
For Chatbot page URL
// Chatbot Page URL Structure
// The first value after .com is the BotId and second value is the CustomerId.
For Chatbot Script
// Chatbot Script Structure
<script id="BotPenguin-messenger-widget" src="https://cdn.botpenguin.com/botpenguin.js" defer>BotId,CustomerId</script>
// The first value after defer> is the BotId & second value is the CustomerId.
C. Auth Token: We haven't automated everything yet. Please contact our support team to get the same.
Now you are ready to run the POC
Please use the below APIs in order to play with your leads and chat data.
As soon as any user opens up the Bot, It creates one UUId; pass the same along with the other required details to create and update the lead's details.
API to update a chat/lead data
To get the listing of the leads and its meta data, Hit the below API with mandatory details.
API to get listing of chats/leads
To get the chat of a specific user, Hit the below API with mandatory details.
API to get chat of a user