AzbotPushToXBot

Azure Bot push the message to XBot

post

Query parameters

param.header.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: 7cc88fb5f4af7421ae777252b92de42a62f61b49b20a88867f8a66247d3872ad

Header parameters

Content-Typestring · enumRequiredExample: application/jsonPossible values:

Body

idstringOptional

Unique identifier for the message

textstringOptional

Message text

typestringOptional

Type of the message

localestringOptional

Locale of the message

channelIdstringOptional

Channel identifier

timestampstringOptional

Timestamp of the message

serviceUrlstringOptional

Service URL

textFormatstringOptional

Format of the text

attachmentsobject[]Optional

Attachments of the message

localTimezonestringOptional

Local timezone

localTimestampstringOptional

Local timestamp

Responses

200

Message pushed to Azure Bot successfully

application/json

default

Unexpected error

application/json

post

HTTPcURLJavaScriptPython

POST /webhook/xpbot/api/azbot/push HTTP/1.1
Host: xbot-i3p-uat.a4b.vn
Content-Type: application/json
Accept: */*
Content-Length: 693

{
  "id": "FQ37dWZy9vGBuomoRSuQdq-as|0005050",
  "from": {
    "id": "936212645525#[e-mail]",
    "name": "Thế Anh Cao",
    "role": "user"
  },
  "text": "chào bạn",
  "type": "message",
  "locale": "vi-VN",
  "entities": [
    {
      "type": "ClientCapabilities",
      "supportsTts": true,
      "requiresBotState": true,
      "supportsListening": true
    }
  ],
  "channelId": "webchat",
  "recipient": {
    "id": "isign_bot_uat@1vmyMBwSvYw",
    "name": "isign_bot_uat"
  },
  "timestamp": "2024-03-18T09:31:36.5788951Z",
  "serviceUrl": "https://directline.botframework.com/",
  "textFormat": "plain",
  "attachments": [],
  "channelData": {
    "clientActivityID": "li8a9x2ugak"
  },
  "conversation": {
    "id": "FQ37dWZy9vGBuomoRSuQdq-as"
  },
  "localTimezone": "Asia/Saigon",
  "localTimestamp": "2024-03-18T16:31:36.208+07:00"
}

{
  "status": "text",
  "message": "text"
}