InitForClient

Initialize for Client

post

Authorizations

apiKeyAuth

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

application/json

Responses

200

Token initialized successfully

application/json

conversationIdstringOptional

Unique identifier for the conversation

userIdstringOptional

Unique identifier for the user

tokenstringOptional

Authentication token for the session

expiresInintegerOptional

Token expiration time in seconds

default

Unexpected error

application/json

post

/partner/xpbot/api/webchat/initForClient

HTTPcURLJavaScriptPython

POST /partner/xpbot/api/webchat/initForClient HTTP/1.1
Host: xbot-i3p-uat.a4b.vn
x-api-key: x-apikey-01
xp-api-key: xp-apikey-01
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "userInfo": {
    "id": "nguyenvana",
    "name": "Nguyen Van A",
    "email": "[email protected]",
    "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
}