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

contextobjectoptional

entitiesobjectoptional

userInputstringoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/v1/conversations' \
  --header 'API-KEY: text' \
  --header 'OS: text' \
  --header 'USER-REF: text' \
  --header 'LOCALE: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "text": "text",
    "code": "text",
    "intent": "text",
    "confidence": 1,
    "context": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "entities": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "userInput": "text"
  }'

200

429

460

461

462

463

500

200

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

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

contextobjectoptional

entitiesobjectoptional

userInputstringoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channel/{channelUUID}/v1/conversations/{sessionCode}' \
  --header 'API-KEY: text' \
  --header 'OS: text' \
  --header 'USER-REF: text' \
  --header 'LOCALE: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "text": "text",
    "code": "text",
    "intent": "text",
    "confidence": 1,
    "context": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "entities": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "userInput": "text"
  }'

200

429

460

461

462

463

500

200

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

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/{sessionCode}/satisfactions' \
  --header 'API-KEY: text' \
  --header 'LOCALE: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "evaluation": 1,
    "answered": true,
    "userComments": "text",
    "expireSession": true
  }'

200

500

200

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