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
        • WhatsApp Payment Components
      • 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 Google Tag Manager
          • 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
          • Guidelines for Google Tag Manager
          • 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
      • Developer
        • 3rd Party Apps API
        • API Access Token
        • Webhooks
      • 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
    • 📄Your New AI Training Engine
    • 💡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

Was this helpful?

  1. Platform Guidelines & Training
  2. Must know-how of BotPenguin

Chatbot User Authentication

This page contains all the necessary information regrading how you can authenticate users which are coming to your chatbot.

PreviousSend WhatsApp notifications using the BotPenguin APIsNextWhat's New

Last updated 7 months ago

Was this helpful?

Phone Number Authentication Setup

This guide walks you through integrating an API for phone number verification within your flow. You’ll set up two APIs—one to send the OTP and another to verify it. Follow these steps carefully.

Step 1: Create the API for Sending OTP

  1. Navigate to Developer Section

Go to your platform's Developer Section.

  1. Add a New API

Click on the Add API button as shown in the screenshot

  • Enter an API Name (e.g., "Send OTP").

  1. Configure API Details

    • Choose the appropriate Method from the dropdown that is POST

  • In the API URL field, enter the API endpoint provided for sending OTP.

API : https://api.v7.botpenguin.com/integrations/custom-feature/send-otp-sms

  1. Set Headers

    • Go to the Headers section.

    • Add the required authorization fields:

      • Authorization Key: Enter the authorization key provided by the service.

      • Value: Your token or key.

  1. Define Request Body Parameters

    • In the Body section, enter the parameters as shown in the screenshot:

      • accountSID: Obtain from Twilio.

      • authToken: Obtain from Twilio.

      • fromNumber: Your Twilio phone number.

      • toNumber: Map this to the user’s phone number attribute.

  1. Save API

    • Click Save to store the API configuration.

Map Phone Number Attribute

  • In the Attributes section, select the user’s phone number attribute.

  1. Save Custom Attribute

    • In the Manage API Response section, choose Save to Custom Attribute.

  • If not already created, create a custom attribute to store the verification status or OTP code.


Step 2: Create the API for OTP Verification

  1. Add Another API for OTP Verification

    • Click Add API again.

    • Name this API (e.g., "Verify OTP").

  1. Set Method and URL

    • Choose the appropriate Method (POST).

    • Enter the API URL for verifying OTP.

API : https://api.v7.botpenguin.com/integrations/custom-feature/verify-user-otp

  1. Set Headers

    • Fill in the header details similar to Step 1.

  1. Define Request Body Parameters

    • In the Body section, pass:

      • systemOtp: The OTP sent to the user.

      • userOtp: The OTP entered by the user.

  1. Save API

    • Click Save.


Step 3: Integrate APIs into the Chat Flow

  1. Edit the Chat Flow

    • Go to Edit Flow and open the chat flow you want to edit.

  1. Add API Components

    • Send OTP API:

      • Add the API component and select the API created in Step 1.

Phone Number Input:

  • Add a component to capture the user’s phone number.

  • Verify OTP API:

    • Add the API component again and select the Verify OTP API from Step 2.

  1. Add Delays

    • Add a delay of 5 seconds between sending and verifying OTP, and 2 seconds if re-verifying.

  1. Response Messages

    • Configure messages to display whether the OTP was verified successfully or if the user should re-enter it.


This setup enables you to authenticate a user’s phone number seamlessly by sending and verifying an OTP.

📖
💡
Dashboard
Developers
Configure API
Configure API
Headers
Body
Body
Mange API Response
Configure API
Headers
Body
Configure API