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

API Key

Likable

History

PreviousBot NextChannel

Last updated 3 months ago

Was this helpful?

Start a new conversation.

post

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

Path parameters

orgUUIDstringrequired

envUUIDstringrequired

botUUIDstringrequired

channelUUIDstringrequired

Query parameters

testboolean

It is the flag if the conversation is one test

Header parameters

API-KEYstringrequired

OSstringrequired

OS-VERSIONstring

BROWSERstring

BROWSER-VERSIONstring

USER-REFstringrequired

BUSINESS-KEYstring

LOCALEstringrequired

Originstring

The origin of the request

x-request-idstring

x-b3-traceidstring

x-b3-spanidstring

x-b3-parentspanidstring

x-b3-sampledstring

x-b3-flagsstring

x-ot-span-contextstring

Body

textstring

codestring

intentstring

confidencenumber · double

advancedOptionsobject

Represents an AdvancedOptionsDTO object that contains advanced options for a conversation

inputTextboolean

toApplyMultilanguageboolean

userInputstring

contextobject

entitiesobject

Responses

application/json

*/*

application/json

cURL

JavaScript

Python

HTTP

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 '{"advancedOptions":{"multilanguage":{}},"context":{"ANY_ADDITIONAL_PROPERTY":{}},"entities":{"ANY_ADDITIONAL_PROPERTY":{}}}'

200

400

401

403

404

409

422

429

460

461

462

463

500

{
  "text": "text",
  "sessionCode": "text",
  "userInteractionUUID": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "name": "text",
    "score": 1,
    "type": "QUESTION",
    "entities": [
      {
        "name": "text",
        "value": "text",
        "originalValue": "text",
        "position": {
          "start": 1,
          "end": 1
        }
      }
    ]
  },
  "answers": [
    {
      "content": {},
      "technicalText": {},
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": true,
      "masked": true,
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "contextReadOnly": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Continues a conversation with the specified session code.

post

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

Path parameters

sessionCodestringrequired

orgUUIDstringrequired

envUUIDstringrequired

botUUIDstringrequired

channelUUIDstringrequired

Query parameters

testboolean

It is the flag if the conversation is one test

Header parameters

API-KEYstringrequired

OSstringrequired

OS-VERSIONstring

BROWSERstring

BROWSER-VERSIONstring

USER-REFstringrequired

BUSINESS-KEYstring

LOCALEstringrequired

Originstring

The origin of the request

x-request-idstring

x-b3-traceidstring

x-b3-spanidstring

x-b3-parentspanidstring

x-b3-sampledstring

x-b3-flagsstring

x-ot-span-contextstring

Body

textstring

codestring

intentstring

confidencenumber · double

advancedOptionsobject

Represents an AdvancedOptionsDTO object that contains advanced options for a conversation

inputTextboolean

toApplyMultilanguageboolean

userInputstring

contextobject

entitiesobject

Responses

application/json

*/*

application/json

cURL

JavaScript

Python

HTTP

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 '{"advancedOptions":{"multilanguage":{}},"context":{"ANY_ADDITIONAL_PROPERTY":{}},"entities":{"ANY_ADDITIONAL_PROPERTY":{}}}'

200

400

401

403

404

409

422

429

460

461

462

463

500

{
  "text": "text",
  "sessionCode": "text",
  "userInteractionUUID": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "name": "text",
    "score": 1,
    "type": "QUESTION",
    "entities": [
      {
        "name": "text",
        "value": "text",
        "originalValue": "text",
        "position": {
          "start": 1,
          "end": 1
        }
      }
    ]
  },
  "answers": [
    {
      "content": {},
      "technicalText": {},
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": true,
      "masked": true,
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "contextReadOnly": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Saves a satisfaction survey in an existing conversation.

post

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

Path parameters

sessionCodestringrequired

orgUUIDstringrequired

envUUIDstringrequired

botUUIDstringrequired

Header parameters

API-KEYstringrequired

LOCALEstringrequired

x-request-idstring

x-b3-traceidstring

x-b3-spanidstring

x-b3-parentspanidstring

x-b3-sampledstring

x-b3-flagsstring

x-ot-span-contextstring

Body

evaluationinteger · int32

answeredboolean

userCommentsstring

expireSessionboolean

Responses

application/json

*/*

application/json

cURL

JavaScript

Python

HTTP

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'

200

400

401

403

404

409

422

500

{
  "text": "text",
  "sessionCode": "text",
  "userInteractionUUID": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "name": "text",
    "score": 1,
    "type": "QUESTION",
    "entities": [
      {
        "name": "text",
        "value": "text",
        "originalValue": "text",
        "position": {
          "start": 1,
          "end": 1
        }
      }
    ]
  },
  "answers": [
    {
      "content": {},
      "technicalText": {},
      "description": "text",
      "type": "text",
      "interactionId": "text",
      "evaluable": true,
      "masked": true,
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "type": "text",
          "action": "text"
        }
      ],
      "quickReply": [
        {
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "contextReadOnly": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

get

/org/{orgUUID}/env/{envUUID}/api-key

Path parameters

orgUUIDstringrequired

envUUIDstringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/api-key'

200

400

401

403

404

409

422

500

{
  "apiKey": "text"
}

post

/org/{orgUUID}/env/{envUUID}/likable

Path parameters

orgUUIDstringrequired

envUUIDstringrequired

Query parameters

requesterIdstringrequired

Header parameters

API-KEYstringrequired

Body

evaluationboolean

interactionIdstring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/likable?requesterId=text' \
  --header 'API-KEY: text' \
  --header 'Content-Type: application/json'

200

400

401

403

404

409

422

500

text

get

/org/{orgUUID}/env/{envUUID}/history/{businessKey}

Path parameters

businessKeystringrequired

orgUUIDstringrequired

envUUIDstringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/history/{businessKey}'

200

400

401

403

404

409

422

500

[
  {
    "session": {
      "sessionCode": "text",
      "createDate": "2025-02-21T18:02:12.633Z",
      "expireDate": "2025-02-21T18:02:12.633Z",
      "businessKey": "text",
      "botId": "text",
      "channelId": "text",
      "operatingSystem": "text",
      "operatingSystemVersion": "text",
      "browser": "text",
      "browserVersion": "text",
      "userRef": "text",
      "locale": "text",
      "test": true,
      "sessionType": "CREATED"
    },
    "userInteractions": [
      {
        "id": 1,
        "createDate": "2025-02-21T18:02:12.633Z",
        "sessionCode": "text",
        "userSent": true,
        "answerUuid": "text",
        "text": "text",
        "intent": "text",
        "confidence": 1,
        "entities": "text",
        "userSentId": "text",
        "evaluation": true,
        "uuid": "text"
      }
    ]
  }
]