BotPenguin Resource Centre
What's NewDashboard
  • 🏠Introduction
  • 📒BotPenguin Resource Centre
    • 🏃‍♂️How BotPenguin works?
      • Onboarding
      • Create new chatbot
        • Website Chatbot
        • Landing Page Chatbot
        • WhatsApp Chatbot
        • Instagram Chatbot
        • Facebook Chatbot
        • Telegram Chatbot
        • Microsoft Teams Bot
        • Make Your Live Chat Chatbot
      • Edit Your Chat Flow
        • Multiple flows(Redirect component)
        • Components In Chatflow
          • Request Information
          • Send Information
          • Trigger Actions
        • Email Validation
      • Pre-Built Chatbot Templates
      • Train Your AI Chatbot
        • Website
        • File Upload
        • Google Sheets
        • FAQs
        • Unanswered Questions
        • Other Sources
      • Install your Chatbot
        • Install your Website Chatbot
        • Install Website Chatbot on Custom Build Website
        • Install Website Bot on WordPress
        • Install Website Chatbot on Wix
        • Install Website Chatbot on Squarespace
        • Widget Installation
      • Automation
        • Widget
        • WhatsApp Template Setup
        • WhatsApp Catalog Setup
        • WhatsApp Flows (Forms) Setup
        • WhatsApp Broadcast Setup
        • WhatsApp Drip Campaigns Setup
        • Facebook Auto-Reply Feature
        • Instagram Auto-Replies
        • Instagram Automation
          • Instagram Broadcast
      • Bot Settings
        • Website Chatbot Settings
          • Design
            • Customize Landing Page Bot
          • General
          • Alerts
          • Triggers
          • User Access
          • Chat Window
            • Transfer Chat to WhatsApp Functionality
          • AI settings
            • Configuring Chatbot Scenarios
        • WhatApp Chatbot Settings
          • General
          • Triggers
          • Alerts
          • API Key
          • WhatsApp Profile
          • AI settings
            • Configuring Chatbot Scenarios
        • Telegram Chatbot Settings
          • General
          • Telegram Profile
          • AI settings
        • Instagram Chatbot Settings
          • General
          • AI settings
            • Configuring Chatbot Scenarios
        • Facebook Chatbot Settings
          • General
          • AI settings
            • Configuring Chatbot Scenarios
        • Chatbot Persona
        • Creating Custom Instructions
        • How to configure and use AI Assistants
      • 3rd Party Apps Integrations
        • ChatGPT
        • BotPenguin Integrations
          • Integrate BotPenguin with Acuity Scheduling
          • Integrate BotPenguin with Microsoft Teams
          • Integrate BotPenguin with WooCommerce
          • Integrate BotPenguin with Autopilot
          • Integrate BotPenguin with Firmao CRM
          • Integrate BotPenguin with Capsule CRM
          • Integrate BotPenguin with Facebook Pixels
          • Integrate BotPenguin with Elevio CRM
          • Integrate BotPenguin with Close CRM
          • Integrate BotPenguin with CalendarHero CRM
          • Integrate BotPenguin with Extraaedge CRM
          • Integrate BotPenguin with Infobip CRM
          • Integrate BotPenguin with Google Sheets
          • Integrate BotPenguin with Google Calendar
          • Integrate BotPenguin with Google Task
          • Integrate BotPenguin with Google Gemini
          • Integrate BotPenguin with HelpShift CRM
          • Integrate BotPenguin with Zendesk CRM
          • Integrate BotPenguin with LeadSquared CRM
          • Integrate BotPenguin with Zoho Desk
          • Integrate BotPenguin with SupportBee CRM
          • Integrate BotPenguin with Wealthbox CRM
          • Integrate BotPenguin with Brevo (formally SendInBlue)
          • Integrate BotPenguin with Apptivo CRM
          • Integrate BotPenguin with Freshdesk CRM
          • Integrate BotPenguin with Help Desk CRM
          • Integrate BotPenguin with Helpcrunch CRM
          • Integrate BotPenguin with Jira CRM
          • Integrate BotPenguin with KarmaCRM
          • Integrate BotPenguin with LiveAgent CRM
          • Integrate BotPenguin with NetHunt CRM
          • Integrate BotPenguin with Plivo CRM
          • Integrate BotPenguin with Recurly CRM
          • Integrate BotPenguin with Shipway CRM
          • Integrate BotPenguin with TeamGate CRM
          • Integrate BotPenguin with Zoho Projects
          • Integrate BotPenguin with Zoho CRM
          • Integrate BotPenguin with Google Drive
          • Integrate BotPenguin with Agile CRM
          • Integrate BotPenguin with Pipedrive
          • Integrate BotPenguin with Drip CRM
          • Integrate BotPenguin with GetResponse
          • Integrate BotPenguin with Groove
          • Integrate BotPenguin with Helpdocs
          • Integrate BotPenguin with Bitrix24
          • Integrate BotPenguin with Freshworks CRM
          • Integrate BotPenguin with Insightly CRM
          • Integrate BotPenguin with Nimble CRM
          • Integrate BotPenguin with Nutshell CRM:-
          • Integrate BotPenguin with OntraPort CRM
          • Integrate BotPenguin with HubSpot
          • Integrate BotPenguin with WebHoper
          • Integrate BotPenguin with EngageBay
          • Integrate BotPenguin with FrontApp
          • Integrate BotPenguin with Copper CRM
          • Integrate BotPenguin with Salesflare
          • Integrate BotPenguin with No CRM
          • Integrate BotPenguin with Helprace
          • Integrate BotPenguin with Flowlu
          • Integrate BotPenguin with Pipeline
          • Integrate BotPenguin with Zingtree
          • Integrate BotPenguin with Salesforce CRM:-
          • Integrate BotPenguin with Chakra CRM:-
          • Integrate BotPenguin with SimplyBook:-
          • Integrate BotPenguin with Gitbook
          • Integrate BotPenguin with GoHigh Level
          • Integrate BotPenguin with Voxloud
          • Integrate BotPenguin with ViaSocket
          • Integrate BotPenguin with Twilio
          • Integrate BotPenguin with Shopify
          • Integrate BotPenguin with Razorpay
          • Integrate BotPenguin with Pabbly
          • Integrate BotPenguin with Outlook
          • Integrate BotPenguin with OnPipeline
          • Integrate BotPenguin with Notion
          • Integrate BotPenguin with MoEngage
          • Integrate BotPenguin with Kylas CRM
          • Integrate BotPenguin with Google Analytics
          • Integrate BotPenguin with FirstPromoter
          • Integrate Botpenguin with Google Contacts
          • Integrate Botpenguin with Zoho CRM
          • Integrate BotPenguin with Zapier
          • Integrate BotPenguin with Make.com
      • Inbox
        • Chats window
        • Orders
        • Contacts
        • Groups
        • Real-Time Customer Interaction
        • Importing WhatsApp Contacts
        • Creating Segments
        • Using Tags
      • Analytics
      • Teams
        • Departments
        • Business hours
        • Team
        • Role
        • Using Teams in Chatflow
      • Settings
        • Custom Attribute
        • Tags
        • Custom Status
        • Quick Replies
        • Custom Tabs
      • My Account
        • Account
        • Password
      • Subscription & Plans (Legacy Version)
      • Subscription & Plans (Latest Version)
    • ❓Frequently asked questions (FAQs)
      • Onboarding FAQs
      • Edit your chat flow
      • Bot Installation FAQs
      • Inbox FAQs
      • Profile, Team & Notifications FAQs
      • Analytics FAQs
      • Chat Flow FAQs
      • Bot Settings FAQs
      • WhatsApp FAQs
      • Subscription FAQs
      • Product Update FAQs
      • ChatGPT FAQs
    • 🛠️Common Errors & Troubleshooting
  • 📖Platform Guidelines & Training
    • 👩‍💻WhatsApp Cloud API by Meta
      • ⚙️Setting Up Your Facebook Business Manager
      • 💰Meta Conversation Pricing for WhatsApp Cloud API
      • 👧Update WhatsApp Bot Profile
      • ✅Getting a Blue Tick(previously Green Tick) on WhatsApp
    • 🔑WhatsApp Bot Creation with Manual Onboarding
      • ✅Prerequisites for WhatsApp Bots
      • 🔤Create a Meta App
      • ✔️Register & Verify your WhatsApp Number
      • 🔗Subscribe WA webhook with BotPenguin
      • 💳Update WA account Payment Method
      • 🦸‍♀️Assign System User to WhatsApp Account
      • 📃Getting all the necessary details from Meta Developer Dashboard
    • ⚙️WhatsApp Bot Creation with Automated onboarding
    • 🐧Migration Of Whatsapp Account from other platforms to BotPenguin.
    • ♻️Reconnect Whatsapp Bot
    • 🔏Recovering Your Restricted Meta Account
    • 💡Must know-how of BotPenguin
      • 🔤Manage & Use Custom Attributes
      • 🖥️Call external APIs in your chat flows
      • 👨‍💼Manging team roles & Users
      • 🪄Unlock BotPenguin AI
      • 🕵️‍♂️Support Agent guide
      • 📨Send WhatsApp notifications using the BotPenguin APIs
      • Chatbot User Authentication
  • ⚡Platform Updates & Info
    • 🔥What's New
    • 🐞Report a bug!
    • 🗒️Feature Requests
    • 🐧BotPenguin Roadmap
    • 🤝Connect With Us
  • 🛠️API References
    • 📄Contacts & Chats APIs
      • Get All Contacts
      • Getting Groups/Segments
      • Add WhatsApp Contact
      • Delete WhatsApp Contact
      • Website Contacts & Meta Data
    • 📄WhatsApp Cloud API
      • GET Templates List
      • POST WhatsApp Template Message
      • POST Send Message API
  • 🤝Partner Documentation
    • 🐧BotPenguin Partner Onboarding
      • Signup as a BotPenguin Partner
      • Setup your Pricing Plans
      • Connect to your Domain
      • Setup 3rd Party Integrations
        • Setup AWS SES Account
        • Setup Google reCAPTCHA
        • Setup ChatGPT Account
        • Setup Zoho Integrations
        • Setup Google OAuth App
        • Setup RazorPay Account
        • Setup Stripe Account
        • Setup Facebook App for WhatsApp & Facebook Bots
          • Create Facebook Login for Business Configuration
          • Meta System User Token
      • Setup your pricing plans (Legacy Version)
      • Setup your Pricing Plans (Latest Version)
    • 🙋‍♂️Partner FAQs
      • Onboarding
      • Affiliate Partner
      • Implementation Partner
      • Whitelabel Partner
      • WhatsApp Whitelabel Partner
      • Add-ons FAQs
      • Subscription FAQs
      • LTD FAQs
    • 📔Partner API References
      • Setting up environment
      • Get Customer
      • Create Customer
      • Update Customer
      • Delete Customer
      • Get Customer API Token
      • Get Team Members (Custom Users)
      • Get Custom User (Team Member) Token
      • Embedding the BotPenguin Inbox in 3rd Party Apps
Powered by GitBook
On this page
  • Get the essentials first!
  • API References
  • Create a lead in the BotPenguin
  • API to update a chat/lead data
  • Get leads listing and Its meta data
  • API to get listing of chats/leads
  • Got any questions?

Was this helpful?

  1. API References
  2. Contacts & Chats APIs

Website Contacts & Meta Data

This section contains the Leads and Chat API references

PreviousDelete WhatsApp ContactNextWhatsApp Cloud API

Last updated 2 months ago

Was this helpful?

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:

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

https://page.botpenguin.com/BotId/CustomerId

// 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

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.

API to update a chat/lead data

PUT https://api.v7.botpenguin.com/inbox/direct/lead

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.

Headers

Name
Type
Description

x-bp-token*

String

API Token

Request Body

Name
Type
Description

uuid*

String

Unique ID of a chat user

botId*

String

Unique ID of the bot

customerId*

String

Unique ID of the customer account

agentId

Boolean

Unique ID of the agent assigned

name

String

Name of the lead

email

String

Email of the lead

phone

String

Phone number of the lead

dialCode

String

Dial Code including "+" sign

notes

Array<{title: string, description: string}>

Additional notes for the chat

status

String

Valid status for the chat. Available values: 'OPEN', 'INPROGRESS', 'REVIEW', 'ONHOLD', 'DEPENDANCY', 'CLOSED'

picture

String

A valid image HTTP URL

tags

Array<String>

Additional tags for the chat

attributes

Array<{key: string, value: string}>

Custom attributes for the chat

{
    "success": true,
    "message": "ok",
    "code": 200
}
{
    // Response
}
{
    // Response
}

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.

API to get listing of chats/leads

GET https://api.v7.botpenguin.com/inbox/direct/chats

To get the listing of the leads and its meta data, Hit the below API with mandatory details.

Query Parameters

Name
Type
Description

botId*

String

Unique ID of the bot

customerId*

String

Unique ID of the customer account

page*

String

Page number

type*

String

"lead" to fetch only leads

"non-lead" to fetch non lead chats

Headers

Name
Type
Description

x-bot-token*

String

API Token

{
    "success": true,
    "message": "ok",
    "data": [
        {
            "_id": "63d9ffa77a8d152facbe2f2f",
            "uuid": "7e88d192-9b20-4035-9b68-d4ac3d58a34f",
            "createdAt": "2023-02-01T05:59:03.533Z",
            "isOnline": false,
            "lastMessage": {
                "at": "2023-02-01T06:00:20.000Z",
                "by": "bot",
                "text": "Welcome to BotPenguin. I am here to help you."
            },
            "lastSeenAt": "2023-02-01T06:00:21.000Z",
            "profile": {
                "notes": [
                    {
                        "title": "Sample title",
                        "description": "Sample description",
                        "_id": "63db5c4abcbc3be2e95b20ae"
                    }
                ],
                "userDetails": {
                    "name": "Sample name",
                    "picture": "my-picture",
                    "contact": {
                        "email": "Sample email",
                        "phone": {
                            "number": "Sample number",
                            "prefix": "91"
                        }
                    },
                    "city": "Sample city",
                    "country": "Sample country",
                    "gender": "MALE",
                    "tags": [
                        "Sample tag"
                    ],
                    "attributes": [
                        {
                            "key": "ID",
                            "value": "BP001"
                        }
                    ]
                }
            },
            "status": "INPROGRESS",
            "updatedAt": "2023-02-02T06:46:34.119Z",
            "websiteVisits": 1,
            "_agentAssigned": "631aa793bcfa100487d13d0d"
        }
    ],
    "code": 200
}
{
    // Response
}
{
    // Response
}

Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at .

🛠️
📄
❓
support@botpenguin.com
How to get the UUDI
How to get the UUDI