Broker
Further described at the Conversation API section, those are the methods used on conversation.
The broker API is responsible for managing the conversations performed by your users. While it is listed here, we encourage you to visit it's specific page for a complete orientation of how to use it.
Conversation Methods
Ok
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}/v1/conversations HTTP/1.1
Host:
API-KEY: text
OS: text
USER-REF: text
LOCALE: text
Content-Type: application/json
Accept: */*
Content-Length: 162
{
"text": "text",
"code": "text",
"intent": "text",
"confidence": 1,
"context": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"entities": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"userInput": "text"
}
{
"text": "text",
"sessionCode": "text",
"userInput": {
"type": "text",
"callToAction": "text",
"pattern": "text"
},
"nlpResponse": {
"type": "QUESTION",
"name": "text",
"score": 1,
"entities": [
{
"name": "text",
"value": "text",
"position": {
"start": 1,
"end": 1
}
}
]
},
"answers": [
{
"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
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}/v1/conversations/{sessionCode} HTTP/1.1
Host:
API-KEY: text
OS: text
USER-REF: text
LOCALE: text
Content-Type: application/json
Accept: */*
Content-Length: 162
{
"text": "text",
"code": "text",
"intent": "text",
"confidence": 1,
"context": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"entities": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"userInput": "text"
}
{
"text": "text",
"sessionCode": "text",
"userInput": {
"type": "text",
"callToAction": "text",
"pattern": "text"
},
"nlpResponse": {
"type": "QUESTION",
"name": "text",
"score": 1,
"entities": [
{
"name": "text",
"value": "text",
"position": {
"start": 1,
"end": 1
}
}
]
},
"answers": [
{
"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
Internal Server Error
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/{sessionCode}/satisfactions HTTP/1.1
Host:
API-KEY: text
LOCALE: text
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"evaluation": 1,
"answered": true,
"userComments": "text",
"expireSession": true
}
{
"text": "text",
"sessionCode": "text",
"userInput": {
"type": "text",
"callToAction": "text",
"pattern": "text"
},
"nlpResponse": {
"type": "QUESTION",
"name": "text",
"score": 1,
"entities": [
{
"name": "text",
"value": "text",
"position": {
"start": 1,
"end": 1
}
}
]
},
"answers": [
{
"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": {}
}
}
Was this helpful?