Websnippet
The Web API handles you conversation with websnippet.
Conversation
It is the organization uuid where the bot is
It is the environment uuid where the bot is
It is the identification of the bot
It is the channel uuid of the bot that wants to speak
It is the flag if the conversation is one test
It is the provider service that want to execute the conversion. By default it will be 'WINDOWS'
WINDOWSPossible values: It is the data in json to use in the conversation
It is the operation system of the conversation
It is the operation system version of the conversation
It is the browser where the conversation happens
It is the browser version where the conversation happens
It is reference of the user that is calling the conversation
It is business key of the user that is calling the conversation
It is language that the bot speaks
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It has the audio with text
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Too many requests
Error while communicating with external webhooks
Misconfigured flows or bots
Error while communicating with nlp
Authentication/authorization error in nlp
Internal Server Error
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": {}
}
}A valid session code
A valid organization uuid
A valid environment uuid
A valid bot uuid
A valid channel uuid
It is the flag if the conversation is one test
falseIt is the provider service that want to execute the conversion. By default it will be 'WINDOWS'
WINDOWSPossible values: It is the data in json to use in the conversation
A valid OS
A valid OS version
A valid browser
A valid browser version
A valid user reference
A valid business key
A valid locale
It is an identifier provided by the API client that will be used to identify distributed logs.
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
It is one of the parameters for open-tracing
Contain user input and conversation context used for start conversation
Text
Code
Intent
Confidence
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Too many requests
Error while communicating with external webhooks
Misconfigured flows or bots
Error while communicating with nlp
Authentication/authorization error in nlp
Internal Server Error
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": {}
}
}A valid organization uuid
A valid environment uuid
It is an identifier provided by the API client that will be used to identify distributed logs.
Contain customer satisfaction data
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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": {}
}
}Auxiliary Methods
A valid organization uuid
A valid environment uuid
A valid bot uuid
A valid channel uuid
This is the flag if has to return the javascript obfuscate or not. The default value is true.
trueIt is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID} HTTP/1.1
Host:
Accept: */*
Ynl0ZXM=Last updated
Was this helpful?