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

Transactional Service

The Transactional Service API handles all transactional services used in your flows.

PreviousTrainingNextRest Connector

Last updated 2 months ago

Was this helpful?

API SUBPATH: eva-transactional-service

Pagination and Listing

CRUD Operations

Find a service

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

serviceUUIDstringRequired

A valid service Uuid

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}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host: 
Accept: */*
{
  "name": "text",
  "description": "text",
  "webhook": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "content": [
    {
      "id": "text",
      "option": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "buttonText": "text",
      "buttonType": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "cockpitUUID": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "authType": "AUTH_NONE",
  "basicToken": "text",
  "bearerToken": "text",
  "oauthUrl": "text",
  "grantType": "CLIENT_CREDENTIALS",
  "clientId": "text",
  "clientSecret": "text",
  "authUsername": "text",
  "authPassword": "text",
  "uuid": "text",
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "updatedAt": "2025-05-09T11:16:08.305Z",
  "updatedBy": "text"
}

Create new services

post
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

A body containing all necessary data to create a new Transactional Service

namestringRequired

Name of the transactional service

descriptionstringOptional

Description of the transactional service

webhookstringRequired

Webhook of the transactional service

authTypestring ยท enumOptional

Enum describing if cell uses an auth method, and which.

Possible values:
basicTokenstringOptional

Basic Token for Basic Auth Header

bearerTokenstringOptional

Bearer Token for Bearer Token Auth Header

oauthUrlstringOptional

URL for authentication with oAuth Method

grantTypestring ยท enumOptional

Grant type to be used with oAuth Method

Possible values:
clientIdstringOptional

Client Id to be used with oAuth Method

clientSecretstringOptional

Client Secret to be used with oAuth Method and grant type 'client_credentials'

authUsernamestringOptional

Username to be used with oAuth Method and grant type 'password'

authPasswordstringOptional

Password to be used with oAuth Method and grant type 'password'

Responses
201
Created
*/*
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}/bot/{botUUID}/services HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 508

{
  "name": "text",
  "description": "text",
  "webhook": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "content": [
    {
      "id": "text",
      "option": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "buttonText": "text",
      "buttonType": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "cockpitUUID": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "authType": "AUTH_NONE",
  "basicToken": "text",
  "bearerToken": "text",
  "oauthUrl": "text",
  "grantType": "CLIENT_CREDENTIALS",
  "clientId": "text",
  "clientSecret": "text",
  "authUsername": "text",
  "authPassword": "text"
}
{
  "uuid": "text"
}

Update service

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

serviceUUIDstringRequired

A valid service Uuid

Body

A body containing all necessary data to create a new Transactional Service

namestringRequired

Name of the transactional service

descriptionstringOptional

Description of the transactional service

webhookstringRequired

Webhook of the transactional service

authTypestring ยท enumOptional

Enum describing if cell uses an auth method, and which.

Possible values:
basicTokenstringOptional

Basic Token for Basic Auth Header

bearerTokenstringOptional

Bearer Token for Bearer Token Auth Header

oauthUrlstringOptional

URL for authentication with oAuth Method

grantTypestring ยท enumOptional

Grant type to be used with oAuth Method

Possible values:
clientIdstringOptional

Client Id to be used with oAuth Method

clientSecretstringOptional

Client Secret to be used with oAuth Method and grant type 'client_credentials'

authUsernamestringOptional

Username to be used with oAuth Method and grant type 'password'

authPasswordstringOptional

Password to be used with oAuth Method and grant type 'password'

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 508

{
  "name": "text",
  "description": "text",
  "webhook": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "content": [
    {
      "id": "text",
      "option": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "buttonText": "text",
      "buttonType": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "cockpitUUID": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "authType": "AUTH_NONE",
  "basicToken": "text",
  "bearerToken": "text",
  "oauthUrl": "text",
  "grantType": "CLIENT_CREDENTIALS",
  "clientId": "text",
  "clientSecret": "text",
  "authUsername": "text",
  "authPassword": "text"
}
{
  "message": "text",
  "data": "text"
}
  • Pagination and Listing
  • GETReturng a pagination list of bot's transactional services
  • GETReturning a list of possible words to autocomplete in search
  • GETReturng a list of bot's transactional services not removed
  • CRUD Operations
  • POSTCreate new services
  • GETFind a service
  • PUTUpdate service
  • DELETERemoves service

Returng a pagination list of bot's transactional services

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
pageinteger ยท int32Optional

The number of page and the default is 1

Default: 1Example: 1
linesPerPageinteger ยท int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1
orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt
directionstringOptional

Direction of ordenation, ASC or DESC. The default is DESC

Default: DESC
searchTermsstring[]Optional

Names or tags to filter the search

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get

Returning a list of possible words to autocomplete in search

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
searchTermstringRequired

Word or part of word to get suggestion names of transactional services

limitinteger ยท int64Optional

The limit of suggestions names in the response. The default value is 6

Default: 6Example: 1
Responses
200
Ok
*/*
Responsestring[]
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get

Returng a list of bot's transactional services not removed

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get

Removes service

delete
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

serviceUUIDstringRequired

A valid service Uuid

Responses
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
delete

No content

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/pagination HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "unpaged": true,
    "offset": 1,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "updatedAt": "text",
      "updatedBy": "text",
      "user": {
        "image": "text",
        "username": "text"
      }
    }
  ],
  "number": 1,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*
[
  "text"
]
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/list HTTP/1.1
Host: 
Accept: */*
{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "content": [
        {
          "id": "text",
          "option": "text",
          "expressionCode": "text",
          "connectedTo": "text",
          "buttonText": "text",
          "buttonType": "text",
          "urlRedirect": true,
          "buttonUrl": "text",
          "cockpitUUID": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ]
    }
  ]
}
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID} HTTP/1.1
Host: 
Accept: */*