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

Path parameters

orgUUIDstringRequired

envUUIDstringRequired

botUUIDstringRequired

channelUUIDstringRequired

Query parameters

testbooleanOptional

Header parameters

API-KEYstringRequired

OSstringRequired

OS-VERSIONstringOptional

BROWSERstringOptional

BROWSER-VERSIONstringOptional

USER-REFstringRequired

BUSINESS-KEYstringOptional

LOCALEstringRequired

x-request-idstringOptional

x-b3-traceidstringOptional

x-b3-spanidstringOptional

x-b3-parentspanidstringOptional

x-b3-sampledstringOptional

x-b3-flagsstringOptional

x-ot-span-contextstringOptional

Body

textstringOptional

codestringOptional

intentstringOptional

confidencenumber · doubleOptional

userInputstringOptional

Responses

200

Ok

application/json

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

application/json

post

HTTPcURLJavaScriptPython

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

Continues a conversation with the specified session code.

post

Path parameters

sessionCodestringRequired

orgUUIDstringRequired

envUUIDstringRequired

botUUIDstringRequired

channelUUIDstringRequired

Query parameters

testbooleanOptional

Header parameters

API-KEYstringRequired

OSstringRequired

OS-VERSIONstringOptional

BROWSERstringOptional

BROWSER-VERSIONstringOptional

USER-REFstringRequired

BUSINESS-KEYstringOptional

LOCALEstringRequired

x-request-idstringOptional

x-b3-traceidstringOptional

x-b3-spanidstringOptional

x-b3-parentspanidstringOptional

x-b3-sampledstringOptional

x-b3-flagsstringOptional

x-ot-span-contextstringOptional

Body

textstringOptional

codestringOptional

intentstringOptional

confidencenumber · doubleOptional

userInputstringOptional

Responses

200

Ok

application/json

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

application/json

post

HTTPcURLJavaScriptPython

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

Saves a satisfaction survey in an existing conversation.

post

Path parameters

sessionCodestringRequired

orgUUIDstringRequired

envUUIDstringRequired

botUUIDstringRequired

Header parameters

API-KEYstringRequired

LOCALEstringRequired

x-request-idstringOptional

x-b3-traceidstringOptional

x-b3-spanidstringOptional

x-b3-parentspanidstringOptional

x-b3-sampledstringOptional

x-b3-flagsstringOptional

x-ot-span-contextstringOptional

Body

evaluationinteger · int32Optional

answeredbooleanOptional

userCommentsstringOptional

expireSessionbooleanOptional

Responses

200

Ok

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

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