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

Start a new conversation.

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

Path parameters

orgUUID*string

envUUID*string

botUUID*string

channelUUID*string

Query parameters

Header parameters

Body

application/json

textstring

codestring

intentstring

confidencenumber (double)

contextobject

entitiesobject

userInputstring

Response

200429460461462463500

Ok

Body

application/json

textstring

sessionCodestring

userInputUserInputDTO (object)

nlpResponseNlpResponseDTO (object)

answersarray of AnswerResponseDTO (object)

contextobject

contextReadOnlyobject

Request

JavaScriptCurl

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

Response

{
  "text": "text",
  "sessionCode": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "QUESTION",
    "name": "text",
    "score": 0,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "position": {}
      }
    ]
  },
  "answers": [
    {
      "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}/v1/conversations/{sessionCode}

Path parameters

sessionCode*string

orgUUID*string

envUUID*string

botUUID*string

channelUUID*string

Query parameters

Header parameters

Body

application/json

textstring

codestring

intentstring

confidencenumber (double)

contextobject

entitiesobject

userInputstring

Response

200429460461462463500

Ok

Body

application/json

textstring

sessionCodestring

userInputUserInputDTO (object)

nlpResponseNlpResponseDTO (object)

answersarray of AnswerResponseDTO (object)

contextobject

contextReadOnlyobject

Request

JavaScriptCurl

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

Response

{
  "text": "text",
  "sessionCode": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "QUESTION",
    "name": "text",
    "score": 0,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "position": {}
      }
    ]
  },
  "answers": [
    {
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": false
    }
  ]
}

Saves a satisfaction survey in an existing conversation.

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

Path parameters

sessionCode*string

orgUUID*string

envUUID*string

botUUID*string

Header parameters

Body

application/json

evaluationinteger (int32)

answeredboolean

userCommentsstring

expireSessionboolean

Response

200500

Ok

Body

application/json

textstring

sessionCodestring

userInputUserInputDTO (object)

nlpResponseNlpResponseDTO (object)

answersarray of AnswerResponseDTO (object)

contextobject

contextReadOnlyobject

Request

JavaScriptCurl

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

Response

{
  "text": "text",
  "sessionCode": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "QUESTION",
    "name": "text",
    "score": 0,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "position": {}
      }
    ]
  },
  "answers": [
    {
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": false
    }
  ]
}