📄

Leads & Chats API

This section contains the Leads and Chat API references

Get the essentials first!
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
1
// Chatbot Page URL Structure
2
​
3
https://page.botpenguin.com/BotId/CustomerId
4
​
5
// The first value after .com is the BotId and second value is the CustomerId.
For Chatbot Script
1
// Chatbot Script Structure
2
​
3
<script id="BotPenguin-messenger-widget" src="https://cdn.botpenguin.com/botpenguin.js" defer>BotId,CustomerId</script>
4
​
5
// 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
API References
Please use the below APIs in order to play with your leads and chat data. 
Create a lead in the BotPenguin
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. 
put
https://api.v7.botpenguin.com
/inbox/direct/lead
API to update a chat/lead data
Get leads listing and Its meta data
To get the listing of the leads and its meta data, Hit the below API with mandatory details. 
get
https://api.v7.botpenguin.com
/inbox/direct/chats
API to get listing of chats/leads

Product Updates - Previous

Report a bug!

Next - Partner Documentation

Partner FAQs

Last modified 1mo ago