ticket
- POSTGet next ticket id to work on
- POSTGet a list of tickets
- POSTCreate a ticket
- PATCHUpdate a few tickets at once
- GETGet a ticket
- PATCHUpdate a ticket
- GETGet ticket variables
- GETGet a tickets history
- POSTForward a ticket
- POSTAuto-execute a ticket
- GETPing a ticket
- GETGet ticket activity
- GETGet ticket stats
- GETGet agent queue status
export
customer
intent
aiAgent
- GETList of all available AI agents as an array
- GETList of all available AI agents as an tree based on associated tag
- POSTLoad enneo default AI Agents
- POSTCreate a new aiAgent
- GETGet an AI Agent by id
- DELDelete an existing AI Agent
- PATCHUpdate an existing AI Agent
- GETGet similar tickets for an AI Agent
- POSTPreview an AI Agent
- POSTGet the outcome of an AI Agent
aiQualityCheck
- GETGet all test runs with pagination
- POSTSchedule a new AI quality check
- GETGet a specific test run by ID
- DELDelete a specific test run by ID
- PATCHUpdate the expected result of a test ticket
- PATCHAccept the expected result of a test ticket
- POSTAccept ALL the expected results of for a test run
- GETGet all AI agents for which test runs can be triggered
- GETGet all AI agents for which test runs can be triggered
- GETGet test cases by AI agent ID
- POSTAdd test cases for an AI agent
- DELDelete a test case by ID
- PATCHUpdate a test case by ID
intentTemplate
profile
team
reminder
settings
- GETGet settings of a client
- POSTUpdate multiple settings at once
- GETGet settings of a client and return the results in a compact form
- GETGet settings of a client in a grouped way for a category
- PUTUpdate setting
- GETSearch settings
- GETGet Subchannels
- POSTAdd a new Subchannel
- DELDelete a Subchannel
- GETGet User Defined Functions
- POSTAdd a new User Defined Function
- DELDelete a User Defined Function
- GETRedirect to Microsoft authorization page
- GETCallback for Microsoft authorization
tag
cron
version
knowledgeSourceStructure
knowledgeSource
telephony
cortex
intent
Update an intent with new, modified input data
intent
Update an intent with new, modified input data
PUT
/
intent
/
{intentId}
curl --request PUT \
--url https://demo.enneo.ai/api/mind/intent/{intentId} \
--header 'Content-Type: application/json' \
--data '{
"code": "process_meter_reading",
"ticketId": 1010,
"data": {}
}'
{
"id": 1211221,
"code": "process_meter_reading",
"name": "Process a meter reading",
"contractId": 746839,
"confidence": 0.95,
"confidenceColor": "warning",
"verified": false,
"context": {},
"messagePreview": "We have successfully processed your meter reading",
"recipient": "john@smith.com",
"tags": "prePopulated",
"data": {},
"options": [
{
"type": "enter_into_system",
"name": "Eintragen",
"icon": "check",
"recommended": true,
"order": 1
},
{
"type": "ignore",
"name": "Ignorieren",
"icon": "cancel",
"recommended": false,
"order": 2
},
{
"type": "forward_to_vnb",
"name": "An VNB verweisen",
"icon": "questionMark",
"recommended": false,
"order": 3
}
],
"infos": [
{
"type": "warning",
"message": "Reading is plausible",
"extraInfo": "Expected reading was 421 kWh. Plausbible because difference to 317 kWh is below threshold of 200 kWh"
}
],
"extraInfo": null,
"outcome": {
"aiAgentId": 1,
"success": true,
"messageLocalized": "Powercloud accepted meter reading",
"internalData": {
"requestEndpoint": "saveReadingByContractId",
"requestParams": "readingValue=21;date=2022-12-31"
},
"executedAt": "2022-12-13 22:18:06",
"userId": 1,
"sent": true,
"ticketClosed": true,
"recipient": "john@smith.com",
"message": "We successfully processed your meter reading of 21 kWh dated Dec 31, 2022",
"template": "<p>Dear John,</p><p>%MESSAGE%</p><i>Mike from your service team</i>",
"sources": [
{
"type": "knowledgeSource",
"id": 376189,
"name": "Opening hours",
"url": "https://company.com/faq/376189",
"text": "Our service hours are from 8am to 5pm. We are closed on weekends. [...]"
}
],
"txId": "c916167c94"
}
}
Authorizations
Cookie-based authentication
Path Parameters
The id of the intent that should be executed
Body
application/json
Parameters to override/validate the existing data in the intent
The body is of type object
.
Response
200
application/json
Intent was updated
An intent of a customer that he wants to be resolved by contacting us
curl --request PUT \
--url https://demo.enneo.ai/api/mind/intent/{intentId} \
--header 'Content-Type: application/json' \
--data '{
"code": "process_meter_reading",
"ticketId": 1010,
"data": {}
}'
{
"id": 1211221,
"code": "process_meter_reading",
"name": "Process a meter reading",
"contractId": 746839,
"confidence": 0.95,
"confidenceColor": "warning",
"verified": false,
"context": {},
"messagePreview": "We have successfully processed your meter reading",
"recipient": "john@smith.com",
"tags": "prePopulated",
"data": {},
"options": [
{
"type": "enter_into_system",
"name": "Eintragen",
"icon": "check",
"recommended": true,
"order": 1
},
{
"type": "ignore",
"name": "Ignorieren",
"icon": "cancel",
"recommended": false,
"order": 2
},
{
"type": "forward_to_vnb",
"name": "An VNB verweisen",
"icon": "questionMark",
"recommended": false,
"order": 3
}
],
"infos": [
{
"type": "warning",
"message": "Reading is plausible",
"extraInfo": "Expected reading was 421 kWh. Plausbible because difference to 317 kWh is below threshold of 200 kWh"
}
],
"extraInfo": null,
"outcome": {
"aiAgentId": 1,
"success": true,
"messageLocalized": "Powercloud accepted meter reading",
"internalData": {
"requestEndpoint": "saveReadingByContractId",
"requestParams": "readingValue=21;date=2022-12-31"
},
"executedAt": "2022-12-13 22:18:06",
"userId": 1,
"sent": true,
"ticketClosed": true,
"recipient": "john@smith.com",
"message": "We successfully processed your meter reading of 21 kWh dated Dec 31, 2022",
"template": "<p>Dear John,</p><p>%MESSAGE%</p><i>Mike from your service team</i>",
"sources": [
{
"type": "knowledgeSource",
"id": 376189,
"name": "Opening hours",
"url": "https://company.com/faq/376189",
"text": "Our service hours are from 8am to 5pm. We are closed on weekends. [...]"
}
],
"txId": "c916167c94"
}
}