Websnippet

The Web API handles you conversation with websnippet.

API SUBPATH: eva-web

Conversation

Returns conversations without session code

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations

Path parameters

orgUUID*string

It is the organization uuid where the bot is

envUUID*string

It is the environment uuid where the bot is

botUUID*string

It is the identification of the bot

channelUUID*string

It is the channel uuid of the bot that wants to speak

Query parameters

Header parameters

Body

multipart/form-dataapplication/json

file*string (binary)

It has the audio with text

Response

200400401403404409422429460461462463500

Ok

Body

application/json*/*

textstring

Text

sessionCodestring

Session code

userInputUserInputDTO (object)

User input

nlpResponseNlpResponseDTO (object)

Nlp response

answersarray of AnswerResponseDTO (object)

Answers

contextobject

Context

contextReadOnlyobject

Context read only

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations?conversationRequestJson=text', {
    method: 'POST',
    headers: {
      "OS": "text",
      "USER-REF": "text",
      "LOCALE": "text",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200400401403404409422429460461462463500

{
  "text": "text",
  "sessionCode": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "NlpResponseType.QUESTION(value=question)",
    "name": "text",
    "score": 0,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "position": {
          "start": 0,
          "end": 0
        }
      }
    ]
  },
  "answers": [
    {
      "answerName": "text",
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": false
    }
  ]
}

Continues a conversation with the specified session code.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations/{sessionCode}

Path parameters

sessionCode*string

A valid session code

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

channelUUID*string

A valid channel uuid

Query parameters

Header parameters

Body

application/jsonmultipart/form-data

textstring

Text

codestring

Code

intentstring

Intent

confidencenumber (double)

Confidence

contextobject

Map context

entitiesobject

Map entities

advancedOptionsAdvancedOptionsDTO (object)

Represents an AdvancedOptionsDTO object that contains advanced options for a conversation

Response

200400401403404409422429460461462463500

Ok

Body

*/*application/json

textstring

Text

sessionCodestring

Session code

userInputUserInputDTO (object)

User input

nlpResponseNlpResponseDTO (object)

Nlp response

answersarray of AnswerResponseDTO (object)

Answers

contextobject

Context

contextReadOnlyobject

Context read only

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations/{sessionCode}?conversationRequestJson=text', {
    method: 'POST',
    headers: {
      "OS": "text",
      "USER-REF": "text",
      "LOCALE": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422429460461462463500

{
  "text": "text",
  "sessionCode": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "NlpResponseType.QUESTION(value=question)",
    "name": "text",
    "score": 0,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "position": {
          "start": 0,
          "end": 0
        }
      }
    ]
  },
  "answers": [
    {
      "answerName": "text",
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": false
    }
  ]
}

Save the user's evaluation

POST/org/{orgUUID}/env/{envUUID}/likable

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

Header parameters

Body

application/json

evaluationboolean

interactionIdstring

Response

200400401403404409422500

Ok

Body

*/*

textstring

Text

sessionCodestring

Session code

userInputUserInputDTO (object)

User input

nlpResponseNlpResponseDTO (object)

Nlp response

answersarray of AnswerResponseDTO (object)

Answers

contextobject

Context

contextReadOnlyobject

Context read only

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/likable', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

{
  "text": "text",
  "sessionCode": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "NlpResponseType.QUESTION(value=question)",
    "name": "text",
    "score": 0,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "position": {
          "start": 0,
          "end": 0
        }
      }
    ]
  },
  "answers": [
    {
      "answerName": "text",
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": false
    }
  ]
}

Auxiliary Methods

Returns the javascript from the channel

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

channelUUID*string

A valid channel uuid

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

string (byte)

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

Ynl0ZXM=