Websnippet

User Guide

API DOCS VOICE GATEWAY SECURITY

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

obfuscatebooleanOptional

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

Default: true

Header parameters

x-request-idstringOptional

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

Responses

200

*/*

Responsestring · byte

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID} HTTP/1.1
Host: 
Accept: */*

Ynl0ZXM=

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 · enumOptional

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

Default: WINDOWSPossible values:

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

filestring · binaryRequired

It has the audio with text

Responses

200

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

429

Too many requests

application/json

460

Error while communicating with external webhooks

application/json

461

Misconfigured flows or bots

application/json

462

Error while communicating with nlp

application/json

463

Authentication/authorization error in nlp

application/json

500

Internal Server Error

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations?conversationRequestJson=text HTTP/1.1
Host: 
OS: text
USER-REF: text
LOCALE: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "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": {}
  }
}

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

testbooleanOptional

It is the flag if the conversation is one test

Default: false

providerstring · enumOptional

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

Default: WINDOWSPossible values:

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

Contain user input and conversation context used for start conversation

textstringOptional

Text

codestringOptional

Code

intentstringOptional

Intent

confidencenumber · doubleOptional

Confidence

Responses

200

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

429

Too many requests

application/json

460

Error while communicating with external webhooks

application/json

461

Misconfigured flows or bots

application/json

462

Error while communicating with nlp

application/json

463

Authentication/authorization error in nlp

application/json

500

Internal Server Error

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/conversations/{sessionCode}?conversationRequestJson=text HTTP/1.1
Host: 
OS: text
USER-REF: text
LOCALE: text
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "text": "text",
  "code": "text",
  "intent": "text",
  "confidence": 1,
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "entities": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "advancedOptions": {
    "multilanguage": {
      "translateInput": true
    }
  }
}

{
  "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": {}
  }
}

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

Contain customer satisfaction data

evaluationbooleanOptional

interactionIdstringOptional

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/likable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "evaluation": true,
  "interactionId": "text"
}

{
  "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": {}
  }
}

Conversation

Auxiliary Methods

Conversation

Auxiliary Methods

Returns the javascript from the channel

Returns conversations without session code

Continues a conversation with the specified session code.

Save the user's evaluation