XBot
  • Overview
    • Introduction
    • How xBot Works
    • Target Audience
    • Key Benefits of xBot
    • Core Concepts of xBot
  • Quick Start
    • Quick Setup
    • Getting Started
      • Zalo Channel
      • Azure Bot Framework
      • FaceBook Channel
      • Team Channel
      • Webchat Channel
      • Email Channel
    • Basic Configuration
    • First AI Flow Setup
    • Initial Testing and Go Live
  • Features
    • Using xBot to Handle End-User Queries
    • Communication Channels
      • Zalo OA
      • Facebook
      • Teams
      • WebChat
      • Email
    • Understanding the Message Handling Flow
    • Understanding AI Bots in xBot
    • Configuring Dispatch Rules in xBot
    • User Functions and Permissions
      • Custom Roles and Permissions
      • Auditing and Monitoring User Activities
    • Cross-Platform Message Type Compatibility
    • AI Flow
      • Core Concepts
      • AI Services
        • Knowledge Base Agent
        • AI Agent
        • AI Proxy Agent
      • Knowledge Base
      • Functions
      • Evaluation Metrics
        • Essential Information
        • Basic Metrics
        • Extra Metrics
  • Integration Guide
    • Integrates with multiple channels
      • API reference
        • Webhook
          • ZaloPushToXBot
          • AzbotPushToXBot
        • Webchat
          • InitForClient
  • References
    • Industry-Specific Use Cases
      • Media and Entertainment
      • Wholesale
      • Transportation and Logistics
      • Manufacturing
      • Energy and Utilities
      • Real Estate
      • Agriculture
      • Travel and Hospitality
      • Healthcare and Wellness
      • Retail and E-Commerce
      • Public Administration
      • Legal
      • Training
      • Education
      • xBot Use Case: Insurance
      • Securities -Use Case
      • Banking - Use Case
      • xBot Use Case: Finance
Powered by GitBook
On this page
  1. Integration Guide
  2. Integrates with multiple channels
  3. API reference
  4. Webchat

InitForClient

PreviousWebchatNextReferences

Initialize for Client

post
Header parameters
Content-Typestring · enumRequiredExample: application/jsonPossible values:
x-api-keystringRequired

Api Key Gateway

Example: x-apikey-01
xp-api-keystringRequired

XBot will generate an xp-api-key and provide it to you. This key is used for authentication when XBot interacts with your system

Example: xp-apikey-01
Body
Responses
200
Token initialized successfully
application/json
default
Unexpected error
application/json
post
POST /partner/xpbot/api/webchat/initForClient HTTP/1.1
Host: xbot-i3p-uat.a4b.vn
Content-Type: application/json
x-api-key: x-apikey-01
xp-api-key: xp-apikey-01
Accept: */*
Content-Length: 255

{
  "userInfo": {
    "id": "nguyenvana",
    "name": "Nguyen Van A",
    "email": "nguyenvana@gmai.com",
    "phone": "84988883434",
    "address": "z06, Tân Thuận Đông, Quận 7, Tp HCM",
    "avatarUrl": "https://cdn.britannica.com/mendel/eb-logo/MendelNewThistleLogo.png",
    "extData": {}
  }
}
{
  "conversationId": "text",
  "userId": "text",
  "token": "text",
  "expiresIn": 1
}