Websnippet

The Web API handles you conversation with websnippet.

API SUBPATH: eva-web

Conversation

Returns conversations without session code

post

Path parameters

orgUUIDstringrequired

It is the organization uuid where the bot is

envUUIDstringrequired

It is the environment uuid where the bot is

botUUIDstringrequired

It is the identification of the bot

channelUUIDstringrequired

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

Query parameters

testbooleanoptional

It is the flag if the conversation is one test

providerstring · enum · default: "WINDOWS"optional

It is the provider service that want to execute the conversion. By default it will be 'WINDOWS'

Options: WINDOWS

conversationRequestJsonstringrequired

It is the data in json to use in the conversation

Header parameters

OSstringrequired

It is the operation system of the conversation

OS-VERSIONstringoptional

It is the operation system version of the conversation

BROWSERstringoptional

It is the browser where the conversation happens

BROWSER-VERSIONstringoptional

It is the browser version where the conversation happens

USER-REFstringrequired

It is reference of the user that is calling the conversation

BUSINESS-KEYstringoptional

It is business key of the user that is calling the conversation

LOCALEstringrequired

It is language that the bot speaks

x-request-idstringoptional

It is one of the parameters for open-tracing

x-b3-traceidstringoptional

It is one of the parameters for open-tracing

x-b3-spanidstringoptional

It is one of the parameters for open-tracing

x-b3-parentspanidstringoptional

It is one of the parameters for open-tracing

x-b3-sampledstringoptional

It is one of the parameters for open-tracing

x-b3-flagsstringoptional

It is one of the parameters for open-tracing

x-ot-span-contextstringoptional

It is one of the parameters for open-tracing

Body

multipart/form-dataapplication/json

filestring · binaryrequired

It has the audio with text

Responses

application/json*/*

*/*

*/*

*/*

*/*

*/*

*/*

application/json

application/json

application/json

application/json

application/json

application/json*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations?conversationRequestJson=text' \
  --header 'OS: text' \
  --header 'USER-REF: text' \
  --header 'LOCALE: text' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

multipart/form-dataapplication/json

200

400

401

403

404

409

422

429

460

461

462

463

500

200

application/json

*/*

application/json

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

Ok

Continues a conversation with the specified session code.

post

Path parameters

sessionCodestringrequired

A valid session code

orgUUIDstringrequired

A valid organization uuid

envUUIDstringrequired

A valid environment uuid

botUUIDstringrequired

A valid bot uuid

channelUUIDstringrequired

A valid channel uuid

Query parameters

testboolean · default: falseoptional

It is the flag if the conversation is one test

providerstring · enum · default: "WINDOWS"optional

It is the provider service that want to execute the conversion. By default it will be 'WINDOWS'

Options: WINDOWS

conversationRequestJsonstringrequired

It is the data in json to use in the conversation

Header parameters

OSstringrequired

A valid OS

OS-VERSIONstringoptional

A valid OS version

BROWSERstringoptional

A valid browser

BROWSER-VERSIONstringoptional

A valid browser version

USER-REFstringrequired

A valid user reference

BUSINESS-KEYstringoptional

A valid business key

LOCALEstringrequired

A valid locale

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

x-b3-traceidstringoptional

It is one of the parameters for open-tracing

x-b3-spanidstringoptional

It is one of the parameters for open-tracing

x-b3-parentspanidstringoptional

It is one of the parameters for open-tracing

x-b3-sampledstringoptional

It is one of the parameters for open-tracing

x-b3-flagsstringoptional

It is one of the parameters for open-tracing

x-ot-span-contextstringoptional

It is one of the parameters for open-tracing

Body

application/jsonmultipart/form-data

textstringoptional

Text

codestringoptional

Code

intentstringoptional

Intent

confidencenumber · doubleoptional

Confidence

contextobjectoptional

Map context

entitiesobjectoptional

Map entities

advancedOptionsobjectoptional

Represents an AdvancedOptionsDTO object that contains advanced options for a conversation

Responses

*/*application/json

*/*

*/*

*/*

*/*

*/*

*/*

application/json

application/json

application/json

application/json

application/json

*/*application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations/{sessionCode}?conversationRequestJson=text' \
  --header 'OS: text' \
  --header 'USER-REF: text' \
  --header 'LOCALE: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "text": "text",
    "code": "text",
    "intent": "text",
    "confidence": 1,
    "context": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "entities": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "advancedOptions": {
      "multilanguage": {
        "translateInput": true
      }
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

409

422

429

460

461

462

463

500

200

*/*

application/json

*/*

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

Ok

Save the user's evaluation

post

Path parameters

orgUUIDstringrequired

A valid organization uuid

envUUIDstringrequired

A valid environment uuid

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

evaluationbooleanoptional

interactionIdstringoptional

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/likable' \
  --header 'Content-Type: application/json' \
  --data '{
    "evaluation": true,
    "interactionId": "text"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

Auxiliary Methods

Returns the javascript from the channel

get

Path parameters

orgUUIDstringrequired

A valid organization uuid

envUUIDstringrequired

A valid environment uuid

botUUIDstringrequired

A valid bot uuid

channelUUIDstringrequired

A valid channel uuid

Query parameters

obfuscateboolean · default: trueoptional

This is the flag if has to return the javascript obfuscate or not. The default value is true.

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}'

200

400

401

403

404

409

422

500

200

Ynl0ZXM=

Ok