User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • ๐Ÿš€GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • ๐Ÿ’ฌBUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • โœจGENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • ๐ŸŒCHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • โš™๏ธCONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • ๐Ÿ“ŠANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Broker

Further described at the Conversation API section, those are the methods used on conversation.

PreviousBotNextChannel

Last updated 5 months ago

Was this helpful?

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 for a complete orientation of how to use it.

Conversation Methods

API Key

Likable

History

specific page
get
Path parameters
orgUUIDstringRequired
envUUIDstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/api-key HTTP/1.1
Host: 
Accept: */*
{
  "apiKey": "text"
}
get
Path parameters
businessKeystringRequired
orgUUIDstringRequired
envUUIDstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/history/{businessKey} HTTP/1.1
Host: 
Accept: */*
[
  {
    "session": {
      "sessionCode": "text",
      "createDate": "2025-05-09T12:20:01.348Z",
      "expireDate": "2025-05-09T12:20:01.348Z",
      "businessKey": "text",
      "sessionType": "CREATED",
      "botId": "text",
      "channelId": "text",
      "operatingSystem": "text",
      "operatingSystemVersion": "text",
      "browser": "text",
      "browserVersion": "text",
      "userRef": "text",
      "locale": "text",
      "test": true
    },
    "userInteractions": [
      {
        "id": 1,
        "createDate": "2025-05-09T12:20:01.348Z",
        "sessionCode": "text",
        "userSent": true,
        "answerUuid": "text",
        "text": "text",
        "intent": "text",
        "confidence": 1,
        "entities": "text",
        "userSentId": "text",
        "evaluation": true,
        "uuid": "text"
      }
    ]
  }
]
  • Conversation Methods
  • POSTStart a new conversation.
  • POSTContinues a conversation with the specified session code.
  • POSTSaves a satisfaction survey in an existing conversation.
  • API Key
  • GET/org/{orgUUID}/env/{envUUID}/api-key
  • Likable
  • POST/org/{orgUUID}/env/{envUUID}/likable
  • History
  • GET/org/{orgUUID}/env/{envUUID}/history/{businessKey}

Start a new conversation.

post
Path parameters
orgUUIDstringRequired
envUUIDstringRequired
botUUIDstringRequired
channelUUIDstringRequired
Query parameters
testbooleanOptional

It is the flag if the conversation is one test

Default: false
Header parameters
API-KEYstringRequired
OSstringRequired
OS-VERSIONstringOptional
BROWSERstringOptional
BROWSER-VERSIONstringOptional
USER-REFstringRequired
BUSINESS-KEYstringOptional
LOCALEstringRequired
OriginstringOptional

The origin of the request

Default: ""
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
inputTextbooleanOptional
toApplyMultilanguagebooleanOptional
userInputstringOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
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
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: 267

{
  "text": "text",
  "code": "text",
  "intent": "text",
  "confidence": 1,
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "entities": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "advancedOptions": {
    "multilanguage": {
      "translateInput": true
    }
  },
  "inputText": true,
  "toApplyMultilanguage": true,
  "userInput": "text"
}
{
  "text": "text",
  "sessionCode": "text",
  "userInteractionUUID": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "QUESTION",
    "name": "text",
    "score": 1,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "originalValue": "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,
      "masked": 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

It is the flag if the conversation is one test

Default: false
Header parameters
API-KEYstringRequired
OSstringRequired
OS-VERSIONstringOptional
BROWSERstringOptional
BROWSER-VERSIONstringOptional
USER-REFstringRequired
BUSINESS-KEYstringOptional
LOCALEstringRequired
OriginstringOptional

The origin of the request

Default: ""
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
inputTextbooleanOptional
toApplyMultilanguagebooleanOptional
userInputstringOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
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
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: 267

{
  "text": "text",
  "code": "text",
  "intent": "text",
  "confidence": 1,
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "entities": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "advancedOptions": {
    "multilanguage": {
      "translateInput": true
    }
  },
  "inputText": true,
  "toApplyMultilanguage": true,
  "userInput": "text"
}
{
  "text": "text",
  "sessionCode": "text",
  "userInteractionUUID": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "QUESTION",
    "name": "text",
    "score": 1,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "originalValue": "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,
      "masked": 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
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
application/json
post
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",
  "userInteractionUUID": "text",
  "userInput": {
    "type": "text",
    "callToAction": "text",
    "pattern": "text"
  },
  "nlpResponse": {
    "type": "QUESTION",
    "name": "text",
    "score": 1,
    "entities": [
      {
        "name": "text",
        "value": "text",
        "originalValue": "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,
      "masked": true
    }
  ],
  "context": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "contextReadOnly": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
post
Path parameters
orgUUIDstringRequired
envUUIDstringRequired
Query parameters
requesterIdstringRequired
Header parameters
API-KEYstringRequired
Body

Contain customer satisfaction data

evaluationbooleanOptional
interactionIdstringOptional
Responses
200
OK
*/*
Responsestring
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/likable?requesterId=text HTTP/1.1
Host: 
API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "evaluation": true,
  "interactionId": "text"
}
text