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/jsonAvailable options:

Content-Typestring · enumrequiredExample: application/jsonAvailable options:

Body

idstringoptional

Unique identifier for the message

fromobjectoptional

textstringoptional

Message text

typestringoptional

Type of the message

localestringoptional

Locale of the message

entitiesobject[]optional

channelIdstringoptional

Channel identifier

recipientobjectoptional

timestampstringoptional

Timestamp of the message

serviceUrlstringoptional

Service URL

textFormatstringoptional

Format of the text

attachmentsobject[]optional

Attachments of the message

channelDataobjectoptional

conversationobjectoptional

localTimezonestringoptional

Local timezone

localTimestampstringoptional

Local timestamp

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xbot-i3p-uat.a4b.vn/webhook/xpbot/api/azbot/push?param.header.xp-api-key=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

default

200

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

Message pushed to Azure Bot successfully