Answer

User Guide

API DOCS VOICE GATEWAYSECURITY

Searches and paginates through expected answers -- those being of type 'TYPE_ANSWER' and 'WELCOME_MESSAGE'.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer

Path parameters

orgUUIDstringrequired

It is the organization where the answers are, it is used to connect to the correct database

envUUIDstringrequired

It is the environment where the answers are, it is used to connect to the correct database

botUUIDstringrequired

It is the bot where the answers are, it is used to filter answers

Query parameters

pageinteger · int32 · default: 1required

Current page, starting at 1

Example: 1

sizeinteger · int32 · default: 5required

Size of the page

Example: 1

rephrasingFilterstring · default: ANY

Whether you are filtering for ANY answer, STATIC_ONLY or REPHRASE_ONLY.

orderBystring · default: updatedAt

Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.

directionstring · default: DESC

Order direction(ASC/DESC), defaulted to DESC

searchTermstring

Term being searched. This expects one optional String matching the name of an answer.

maskingFilterstring · enum · default: ALL

Used to filter masked answers, defaulted to ALL

Options: ALL, MASKED, UNMASKED

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer?page=1&size=5'

200

400

401

403

404

409

422

500

{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageSize": 1,
    "paged": true,
    "pageNumber": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true,
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "evaluable": 1,
        "transactional": 1,
        "isMasked": true,
        "updatedAt": "2025-02-28T10:12:05.090Z",
        "updatedBy": "text",
        "webhook": "text",
        "type": "text",
        "headers": {},
        "executionLimit": 1,
        "rephraseEnabled": true,
        "rephrasingTemperature": 1,
        "rephrasingMemory": 1,
        "rephrasingBlacklist": "text",
        "user": {
          "name": "text",
          "imageUrl": "text"
        },
        "transactionalAuth": {
          "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
          "basicToken": "text",
          "bearerToken": "text",
          "oauthUrl": "text",
          "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
          "clientId": "text",
          "clientSecret": "text",
          "authUsername": "text",
          "authPassword": "text"
        },
        "tags": [
          {
            "uuid": "text",
            "name": "text"
          }
        ],
        "answerTemplates": [
          {
            "id": "text",
            "content": {
              "content": {},
              "description": "text",
              "type": "text",
              "name": "text",
              "buttons": [
                {}
              ],
              "quickReply": [
                {}
              ]
            },
            "type": "text",
            "channelTypeId": 1,
            "channelId": "text",
            "technicalText": "text",
            "translations": [
              {
                "answerTemplateUUID": "text",
                "locale": "text",
                "content": "text"
              }
            ]
          }
        ]
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Paginates through not expected answers -- those being of type 'FIRST_CELL' and 'TYPE_ANYTHING_ELSE'.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected

Path parameters

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

The UUID of the bot whose entities you are searching

Query parameters

pageinteger · int32 · default: 1required

Current page, starting at 1

Example: 1

sizeinteger · int32 · default: 5required

Size of the page

Example: 1

rephrasingFilterstring · default: ANY

Whether you are filtering for ANY answer, STATIC_ONLY or REPHRASING_ONLY.

orderBystring · default: updatedAt

Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.

directionstring · default: DESC

Order direction(ASC/DESC), defaulted to DESC

searchTermstring

Term being searched. This expects one optional String matching the name of an answer.

maskingFilterstring · enum · default: ALL

Used to filter masked answers, defaulted to ALL

Options: ALL, MASKED, UNMASKED

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected?page=1&size=5'

200

400

401

403

404

409

422

500

{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageSize": 1,
    "paged": true,
    "pageNumber": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true,
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "evaluable": 1,
        "transactional": 1,
        "isMasked": true,
        "updatedAt": "2025-02-28T10:12:05.090Z",
        "updatedBy": "text",
        "webhook": "text",
        "type": "text",
        "headers": {},
        "executionLimit": 1,
        "rephraseEnabled": true,
        "rephrasingTemperature": 1,
        "rephrasingMemory": 1,
        "rephrasingBlacklist": "text",
        "user": {
          "name": "text",
          "imageUrl": "text"
        },
        "transactionalAuth": {
          "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
          "basicToken": "text",
          "bearerToken": "text",
          "oauthUrl": "text",
          "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
          "clientId": "text",
          "clientSecret": "text",
          "authUsername": "text",
          "authPassword": "text"
        },
        "tags": [
          {
            "uuid": "text",
            "name": "text"
          }
        ],
        "answerTemplates": [
          {
            "id": "text",
            "content": {
              "content": {},
              "description": "text",
              "type": "text",
              "name": "text",
              "buttons": [
                {}
              ],
              "quickReply": [
                {}
              ]
            },
            "type": "text",
            "channelTypeId": 1,
            "channelId": "text",
            "technicalText": "text",
            "translations": [
              {
                "answerTemplateUUID": "text",
                "locale": "text",
                "content": "text"
              }
            ]
          }
        ]
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Creates a brand new answer

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Body

namestringrequired

The answer's name.

descriptionstring

A freeform description of this answer.

webhookstring

A freeform string to code up a webhook for this answer.

transactionalbooleanrequired

A boolean indicator representing if this answer is a transactional answer.

evaluablebooleanrequired

A boolean indicator representing if this answer is an evaluable answer.

isMaskedboolean

Whether or not this answer is masked.

headersobject

The answer's Headers. This object is a freeform JSON which must be parser as an object when receiving it.

typestring

The answer's type.

executionLimitinteger · int64

The number of times an answer can be executed.

rephraseEnabledboolean

Wether the rephrasing feature is active in this answer.

rephrasingTemperaturenumber · double

The temperature used in the rephrasing feature for this answer.

rephrasingMemoryinteger · int32

The ammount of previous user inputs used to modify the rephrasing feature.

rephrasingBlackliststring

A number os space-separated blacklisted words to evoid during rephrasing.

transactionalAuthobject

This class contains all the necessary information for different authentication types. It validates whether the provided authentication data is complete based on the specified type.

validAuthTypeboolean

tagsobject[]

A list of all tags associated to this answer.

answerTemplatesobject[]required

A list of the answer's templates.

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "webhook": "text",
    "transactional": true,
    "evaluable": true,
    "isMasked": true,
    "headers": {},
    "type": "text",
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    },
    "validAuthType": true,
    "tags": [
      {
        "uuid": "text",
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 1
      }
    ],
    "answerTemplates": [
      {
        "id": "text",
        "content": {},
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ]
  }'

200

400

401

403

404

409

422

500

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "isMasked": true,
    "updatedAt": "2025-02-28T10:12:05.090Z",
    "updatedBy": "text",
    "webhook": "text",
    "type": "text",
    "headers": {},
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "user": {
      "name": "text",
      "imageUrl": "text"
    },
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    },
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "name": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ]
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ]
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Retrieves info from a specific given answer.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}

Path parameters

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

The UUID of the bot whose entity you are searching belong to

uuidstringrequired

The answer's uuid

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}'

200

400

401

403

404

409

422

500

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "isMasked": true,
    "updatedAt": "2025-02-28T10:12:05.090Z",
    "updatedBy": "text",
    "webhook": "text",
    "type": "text",
    "headers": {},
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "user": {
      "name": "text",
      "imageUrl": "text"
    },
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    },
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "name": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ]
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ]
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Updates an answer.

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}

Path parameters

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

The UUID of the bot whose entity you are searching belong to

uuidstringrequired

The answer's uuid

Body

namestringrequired

The answer's name.

descriptionstring

A freeform description of this answer.

webhookstring

A freeform string to code up a webhook for this answer.

transactionalbooleanrequired

A boolean indicator representing if this answer is a transactional answer.

evaluablebooleanrequired

A boolean indicator representing if this answer is an evaluable answer.

isMaskedboolean

Whether or not this answer is masked.

headersobject

The answer's Headers. This object is a freeform JSON which must be parser as an object when receiving it.

typestring

The answer's type.

executionLimitinteger · int64

The number of times an answer can be executed.

rephraseEnabledboolean

Wether the rephrasing feature is active in this answer.

rephrasingTemperaturenumber · double

The temperature used in the rephrasing feature for this answer.

rephrasingMemoryinteger · int32

The ammount of previous user inputs used to modify the rephrasing feature.

rephrasingBlackliststring

A number os space-separated blacklisted words to evoid during rephrasing.

transactionalAuthobject

This class contains all the necessary information for different authentication types. It validates whether the provided authentication data is complete based on the specified type.

validAuthTypeboolean

tagsobject[]

A list of all tags associated to this answer.

answerTemplatesobject[]required

A list of the answer's templates.

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "webhook": "text",
    "transactional": true,
    "evaluable": true,
    "isMasked": true,
    "headers": {},
    "type": "text",
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    },
    "validAuthType": true,
    "tags": [
      {
        "uuid": "text",
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 1
      }
    ],
    "answerTemplates": [
      {
        "id": "text",
        "content": {},
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ]
  }'

200

400

401

403

404

409

422

500

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "isMasked": true,
    "updatedAt": "2025-02-28T10:12:05.090Z",
    "updatedBy": "text",
    "webhook": "text",
    "type": "text",
    "headers": {},
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "user": {
      "name": "text",
      "imageUrl": "text"
    },
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    },
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "name": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ]
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ]
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANSWER' and 'WELCOME_MESSAGE', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/quicksearch

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot uuid to search

Query parameters

searchTermstringrequired

Term being searched

limitinteger · int32 · default: 6

How many items will be returned in the list. Defaults to 6.

Example: 1

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "text"
]

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANYTHING_ELSE' and 'FIRST_CELL', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected/quicksearch

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot uuid to search

Query parameters

searchTermstringrequired

Term being searched

limitinteger · int32 · default: 6

How many items will be returned in the list. Defaults to 6.

Example: 1

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "text"
]

Searches through all answers recently used on a given bot to start a flow.

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/list-on-flow

Path parameters

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

The UUID of the bot whose entities you are searching

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/list-on-flow'

200

400

401

403

404

409

422

500

[
  {
    "id": "text",
    "name": "text",
    "type": "text",
    "executionLimit": 1,
    "rephraseEnabled": true,
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "name": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ]
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ],
    "tags": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
]

Deletes an answer. The answer is disabled via the 'removed' parameter rather than deleted from the DB.

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

uuidstringrequired

The answer's uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}'

200

400

401

403

404

409

422

500

No body

CRUD Methods

CRUD Methods

Searches and paginates through expected answers -- those being of type 'TYPE_ANSWER' and 'WELCOME_MESSAGE'.

Paginates through not expected answers -- those being of type 'FIRST_CELL' and 'TYPE_ANYTHING_ELSE'.

Creates a brand new answer

Retrieves info from a specific given answer.

Updates an answer.

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANSWER' and 'WELCOME_MESSAGE', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANYTHING_ELSE' and 'FIRST_CELL', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

Searches through all answers recently used on a given bot to start a flow.

Deletes an answer. The answer is disabled via the 'removed' parameter rather than deleted from the DB.

Pagination and Listing

CRUD Methods

Pagination and Listing

CRUD Methods

Searches and paginates through expected answers -- those being of type 'TYPE_ANSWER' and 'WELCOME_MESSAGE'.

Paginates through not expected answers -- those being of type 'FIRST_CELL' and 'TYPE_ANYTHING_ELSE'.

Creates a brand new answer

Retrieves info from a specific given answer.

Updates an answer.

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANSWER' and 'WELCOME_MESSAGE', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANYTHING_ELSE' and 'FIRST_CELL', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

Searches through all answers recently used on a given bot to start a flow.

Deletes an answer. The answer is disabled via the 'removed' parameter rather than deleted from the DB.