GET NLU/GetIntentList

GetIntentList end point will be used to get a list of user intents that are defined in Jetlink dashboard.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

IntentResponse
NameDescriptionTypeAdditional information
Id

Returned process unique id

string

None.

Timestamp

Returned process time. (in unix timestamp format)

integer

None.

IntentResult

Jetlink platform intent result data

Collection of IntentResult

None.

Status

Returned status of process

Status

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Timestamp": 2,
  "IntentResult": [
    {
      "IntentId": "sample string 1",
      "IntentName": "sample string 2",
      "Priority": 1,
      "Action": "sample string 3",
      "IntentType": "sample string 4",
      "IntentIdToFollowUp": "sample string 5",
      "UserPhrases": {
        "UserPhraseDetail": [
          {
            "UserText": "sample string 1",
            "EntityNameList": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "UserText": "sample string 1",
            "EntityNameList": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "IgnoreCase": true
      },
      "TextResponseList": [
        "sample string 1",
        "sample string 2"
      ],
      "CreateDate": 6
    },
    {
      "IntentId": "sample string 1",
      "IntentName": "sample string 2",
      "Priority": 1,
      "Action": "sample string 3",
      "IntentType": "sample string 4",
      "IntentIdToFollowUp": "sample string 5",
      "UserPhrases": {
        "UserPhraseDetail": [
          {
            "UserText": "sample string 1",
            "EntityNameList": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "UserText": "sample string 1",
            "EntityNameList": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "IgnoreCase": true
      },
      "TextResponseList": [
        "sample string 1",
        "sample string 2"
      ],
      "CreateDate": 6
    }
  ],
  "Status": {
    "Code": 1,
    "ErrorType": "sample string 2",
    "ErrorId": "sample string 3",
    "ErrorDescription": "sample string 4"
  }
}