POST NLU/Parse

Request Information

URI Parameters

None.

Body Parameters

Query
NameDescriptionTypeAdditional information
Text

string

None.

SessionId

string

None.

JetBotMainId

string

None.

Language

string

None.

TimeZone

string

None.

Location

Location

None.

Request Formats

application/json, text/json

Sample:
{
  "Text": "sample string 1",
  "SessionId": "sample string 2",
  "JetBotMainId": "sample string 3",
  "Language": "sample string 4",
  "TimeZone": "sample string 5",
  "Location": {
    "Latitude": "sample string 1",
    "Longitude": "sample string 2"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Query'.

Response Information

Resource Description

QueryResponse
NameDescriptionTypeAdditional information
Id

string

None.

Timestamp

integer

None.

Language

string

None.

SessionId

string

None.

Result

QueryResult

None.

Status

Status

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Timestamp": 2,
  "Language": "sample string 3",
  "SessionId": "sample string 4",
  "Result": {
    "ResolvedQuery": "sample string 1",
    "IntentId": "sample string 2",
    "IntentName": "sample string 3",
    "IntentType": 1,
    "Action": "sample string 4",
    "Parameters": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "TextResponse": "sample string 5",
    "Responses": [
      {},
      {}
    ],
    "Confidence": 6.1,
    "HumanTakeOver": true,
    "SendContactInfoCollector": true,
    "SendContactInfoCollectorDelayTime": 9.1,
    "HumanTakeOverDelayTime": 10.1,
    "IsInBusinessHour": true,
    "OnlineMessage": "sample string 12",
    "OfflineMessage": "sample string 13"
  },
  "Status": {
    "Code": 1,
    "ErrorType": "sample string 2",
    "ErrorId": "sample string 3",
    "ErrorDescription": "sample string 4"
  }
}