Channel

The Channel API handles methods to create and manage each CHannel of a Virtual Agent.

PreviousBroker NextDashboard

Last updated 5 months ago

Was this helpful?

Retrieves all existing channels of bot

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

pageNamestringRequired

This parameter is a condition to return the channel All. Parameter that filters the channel all, when its value is 'channels' the channel all will not be returned

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

200

*/*

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}/channels/{pageName} HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "imageName": "text",
        "channelClassification": {
          "id": 1,
          "name": "text"
        }
      },
      "createdAt": "text",
      "deletable": true
    }
  ]
}

Retrieves all existing channels of bot

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

pageinteger · int32Required

It is the number of pages that will be returned, default value 0

Default: 0Example: 1

linesPerPageinteger · int32Required

It is the number of channels per page, default value 5

Default: 5Example: 1

orderBystringRequired

It is the channel attribute used for ordination the page, default attribute name

Default: createdAt

directionstringRequired

It is the sorting type, default value DESC

Default: DESC

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

200

*/*

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}/channels?page=1&linesPerPage=1&orderBy=text&direction=text HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "imageName": "text",
    "channelClassification": {
      "id": 1,
      "name": "text"
    }
  },
  "createdAt": "text",
  "deletable": true
}

Retrieves all existing channel types of bot, and aggregated within them each instance of channel using it in the same bot.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

200

*/*

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}/channels/dashboard HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "image": "text",
    "channelClassification": {
      "id": 1,
      "name": "text"
    },
    "channelsFromType": [
      {
        "uuid": "text",
        "name": "text"
      }
    ]
  }
]

Returns details from the channel uuid passed in the endpoint

get

Path parameters

orgUUIDstringRequired

A valid organization uuid

envUUIDstringRequired

A valid environment uuid

botUUIDstringRequired

A valid bot uuid

channelUUIDstringRequired

A valid channel uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used toidentify distributed logs.

Responses

200

*/*

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}/channels/{channelUUID}/view HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "imageName": "text",
    "channelClassification": {
      "id": 1,
      "name": "text"
    }
  },
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 1,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": {
        "text": "text",
        "code": "text",
        "intent": "text",
        "confidence": 1,
        "entities": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "context": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "conversationTimeout": 1,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 1,
      "maxCallDuration": 1
    },
    "ttsAudioConfiguration": {
      "mask": "text",
      "tts": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      },
      "flush": true,
      "bargeIn": true,
      "voiceBargeIn": true,
      "bargeInOffset": 1,
      "time": 1
    },
    "dtmfMenu": {
      "interdigitTimeout": 1,
      "numberOfDigits": 1,
      "timeoutInterval": 1,
      "terminationTimeout": 1,
      "terminationCharacter": "text"
    },
    "voiceMenu": {
      "timeoutInterval": 1,
      "sensitivity": 1,
      "confidence": 1,
      "maxSpeechTimeout": 1,
      "incompleteTimeout": 1,
      "asr": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      }
    },
    "vxml": true,
    "evg": true,
    "secretSizeValid": true
  },
  "createdAt": "2025-05-09T12:30:59.443Z",
  "updatedAt": "2025-05-09T12:30:59.443Z"
}

Delete all channels associated with a channelUUID.

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

channelUUIDstringRequired

A valid channel uuid for deleted

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID} HTTP/1.1
Host: 
Accept: */*

No content

Responsible to return the list of channel types that can be created grouped by classification

get

Path parameters

orgUUIDstringRequired

It is the organization uuid where the bot is.

envUUIDstringRequired

It is the environment uuid where the bot is.

Responses

200

*/*

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}/channels/type HTTP/1.1
Host: 
Accept: */*

{
  "groupChannel": [
    {
      "group": 1,
      "groupCode": "text",
      "channels": [
        {
          "id": 1,
          "name": "text",
          "imageName": "text"
        }
      ]
    }
  ]
}

Retrieves all ivr providers

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

vendorTypestringRequired

Vendor type

Pattern: EVG|VXML

audioConverterTypestringRequired

Audio converter type

Pattern: ASR|TTS

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

200

*/*

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}/channels/providers?vendorType=text&audioConverterType=text HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "imageName": "text",
        "channelClassification": {
          "id": 1,
          "name": "text"
        }
      },
      "createdAt": "text",
      "deletable": true
    }
  ]
}

Returns all websnippet configurations associated to one channel of the bot.

get

Path parameters

orgUUIDstringRequired

A valid organization uuid

envUUIDstringRequired

A valid environment uuid

botUUIDstringRequired

A valid bot uuid

channelUUIDstringRequired

A valid channel uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

200

*/*

204

No content

*/*

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}/channels/{channelUUID}/websnippet HTTP/1.1
Host: 
Accept: */*

{
  "generalSettings": {
    "agentName": "text",
    "userInputPlaceholder": "text",
    "description": "text"
  },
  "contact": {
    "email": "text",
    "phone": "text"
  },
  "appearance": {
    "virtualAgent": {
      "components": {
        "avatar": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "background": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "dialogBox": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "header": {
          "background": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ],
          "icons": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "footer": {
          "background": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ],
          "theme": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "buttons": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "minimizedIcon": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ]
      },
      "texts": {
        "name": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "description": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "general": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "buttons": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        }
      }
    },
    "user": {
      "components": {
        "dialogBox": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ]
      },
      "texts": {
        "dialogBox": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        }
      }
    }
  }
}

Endpoint responsible to create a new channel in bot

post

Path parameters

orgUUIDstringRequired

It is the organization uuid where the bot is.

envUUIDstringRequired

It is the environment uuid where the bot is.

botUUIDstringRequired

It is the identification of the bot.

Body

DTO received to insert a channel with name, description and typeId

namestring · max: 45Required

Name of the channel

descriptionstring · max: 200Optional

Description of the channel

typeIdinteger · int64Required

Type of the channel. Types: 1 - Amazon Echo, 2 - Google Home, 5 - Alexa, 6 - Cortana, 7 - Google Assistant, 8 - Siri, 9 - Facebook Messenger, 10 - RCS, 11 - SMS, 12 - Skype, 13 - Augmented Reality, 17 - Phone, 18 - Virtual Reality, 19 - Web, 20 - Web Mobile, 21 - App Mobile, 22 - WhatsApp, 24 - Skype for Business, 25 - Telegram, 26 - X, 27 - Infobip, 33 - Apple Business Chat, 34 - Microsoft Teams, 35 - Wechat, 36 - Kakao, 37 - Line, 38 - Instagram, 39 - Amazon Connect, 40 - Genesys, 41 - Odigo, 42 - Twillio, 43 - Infobip Conversations, 44 - Naka, 45 - Digital Humans, 46 - Slack

ivrTypebooleanOptional

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}/channels HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1925

{
  "name": "text",
  "description": "text",
  "typeId": 1,
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 1,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": {
        "text": "text",
        "code": "text",
        "intent": "text",
        "confidence": 1,
        "entities": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "context": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "conversationTimeout": 1,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 1,
      "maxCallDuration": 1
    },
    "ttsAudioConfiguration": {
      "mask": "text",
      "tts": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      },
      "flush": true,
      "bargeIn": true,
      "voiceBargeIn": true,
      "bargeInOffset": 1,
      "time": 1
    },
    "dtmfMenu": {
      "interdigitTimeout": 1,
      "numberOfDigits": 1,
      "timeoutInterval": 1,
      "terminationTimeout": 1,
      "terminationCharacter": "text"
    },
    "voiceMenu": {
      "timeoutInterval": 1,
      "sensitivity": 1,
      "confidence": 1,
      "maxSpeechTimeout": 1,
      "incompleteTimeout": 1,
      "asr": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      }
    },
    "vxml": true,
    "evg": true,
    "secretSizeValid": true
  },
  "ivrType": true
}

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "imageName": "text",
    "channelClassification": {
      "id": 1,
      "name": "text"
    }
  },
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 1,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": {
        "text": "text",
        "code": "text",
        "intent": "text",
        "confidence": 1,
        "entities": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "context": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "conversationTimeout": 1,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 1,
      "maxCallDuration": 1
    },
    "ttsAudioConfiguration": {
      "mask": "text",
      "tts": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      },
      "flush": true,
      "bargeIn": true,
      "voiceBargeIn": true,
      "bargeInOffset": 1,
      "time": 1
    },
    "dtmfMenu": {
      "interdigitTimeout": 1,
      "numberOfDigits": 1,
      "timeoutInterval": 1,
      "terminationTimeout": 1,
      "terminationCharacter": "text"
    },
    "voiceMenu": {
      "timeoutInterval": 1,
      "sensitivity": 1,
      "confidence": 1,
      "maxSpeechTimeout": 1,
      "incompleteTimeout": 1,
      "asr": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      }
    },
    "vxml": true,
    "evg": true,
    "secretSizeValid": true
  },
  "createdAt": "2025-05-09T12:30:59.443Z",
  "updatedAt": "2025-05-09T12:30:59.443Z"
}

Update all channels associated with a object referenced within ChannelUpdatedDTO and channelUUID.

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

channelUUIDstringRequired

A valid channel uuid for update

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

A body containing a List of ChannelUpdatedDTO. Refer to the model for instructions on how to build them.

namestringRequired

Name of the channel

descriptionstringOptional

Description of the channel

Responses

200

*/*

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}/channels/{channelUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1899

{
  "name": "text",
  "description": "text",
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 1,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": {
        "text": "text",
        "code": "text",
        "intent": "text",
        "confidence": 1,
        "entities": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "context": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "conversationTimeout": 1,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 1,
      "maxCallDuration": 1
    },
    "ttsAudioConfiguration": {
      "mask": "text",
      "tts": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      },
      "flush": true,
      "bargeIn": true,
      "voiceBargeIn": true,
      "bargeInOffset": 1,
      "time": 1
    },
    "dtmfMenu": {
      "interdigitTimeout": 1,
      "numberOfDigits": 1,
      "timeoutInterval": 1,
      "terminationTimeout": 1,
      "terminationCharacter": "text"
    },
    "voiceMenu": {
      "timeoutInterval": 1,
      "sensitivity": 1,
      "confidence": 1,
      "maxSpeechTimeout": 1,
      "incompleteTimeout": 1,
      "asr": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": {
          "azureOpenAIKey": "your-azure-openai-key",
          "azureOpenAIEndpoint": "your-azure-openai-endpoint",
          "gptDeployment": "your-gpt-deployment",
          "whisperDeployment": "your-whisper-deployment",
          "languageCode": "your-language-code",
          "prompt": "your-prompt"
        }
      }
    },
    "vxml": true,
    "evg": true,
    "secretSizeValid": true
  }
}

{
  "code": "text",
  "message": "text"
}

Endpoint for validating if a channel already exists with the provided name or DNIS

post

This endpoint performs validation based on the request type using corresponding Validator class (ChannelValidator or DnisValidator). It validates if a channel with the provided name or DNIS already exists.

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

valuestringRequired

Value that will be validated

typestringRequired

Validation type.

voiceProviderTypestring · enumOptional

Is required when the type is a vendor: ,'MICROSOFT','CISCO_GOOGLE','GOOGLE', 'AZURE_WHISPER', The type must be: 'ASR' or 'TTS'

Possible values:

channelUUIDstringOptional

Value that will be validated

Responses

204

No Content

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict. A channel with the provided name or DNIS already exists. The 'name' or 'DNIS' value in the message of the response should provide more information.

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "value": "text",
  "type": "text",
  "voiceProviderType": "ASR",
  "channelUUID": "text"
}

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "imageName": "text",
        "channelClassification": {
          "id": 1,
          "name": "text"
        }
      },
      "createdAt": "text",
      "deletable": true
    }
  ]
}

Validating the existence of a channel in the database

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

valuestringRequired

Value that will be validated

typestringRequired

Validation type.

voiceProviderTypestring · enumOptional

Is required when the type is a vendor: ,'MICROSOFT','CISCO_GOOGLE','GOOGLE', 'AZURE_WHISPER', The type must be: 'ASR' or 'TTS'

Possible values:

channelUUIDstringOptional

Value that will be validated

Responses

200

No Content

*/*

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}/channels/validate-template HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "value": "text",
  "type": "text",
  "voiceProviderType": "ASR",
  "channelUUID": "text"
}

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "imageName": "text",
        "channelClassification": {
          "id": 1,
          "name": "text"
        }
      },
      "createdAt": "text",
      "deletable": true
    }
  ]
}

Saves all websnippet configurations associated to one channel of the bot.

post

Path parameters

orgUUIDstringRequired

A valid organization uuid

envUUIDstringRequired

A valid environment uuid

botUUIDstringRequired

A valid bot uuid

channelUUIDstringRequired

A valid channel uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

DTO with general settings, contact and appearance attributes that has data about the websnippet configuration.

Responses

200

*/*

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}/channels/{channelUUID}/websnippet HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1588

{
  "generalSettings": {
    "agentName": "text",
    "userInputPlaceholder": "text",
    "description": "text"
  },
  "contact": {
    "email": "text",
    "phone": "text"
  },
  "appearance": {
    "virtualAgent": {
      "components": {
        "avatar": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "background": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "dialogBox": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "header": {
          "background": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ],
          "icons": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "footer": {
          "background": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ],
          "theme": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "buttons": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "minimizedIcon": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ]
      },
      "texts": {
        "name": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "description": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "general": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "buttons": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        }
      }
    },
    "user": {
      "components": {
        "dialogBox": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ]
      },
      "texts": {
        "dialogBox": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        }
      }
    }
  }
}

{
  "generalSettings": {
    "agentName": "text",
    "userInputPlaceholder": "text",
    "description": "text"
  },
  "contact": {
    "email": "text",
    "phone": "text"
  },
  "appearance": {
    "virtualAgent": {
      "components": {
        "avatar": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "background": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "dialogBox": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "header": {
          "background": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ],
          "icons": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "footer": {
          "background": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ],
          "theme": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "buttons": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ],
        "minimizedIcon": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ]
      },
      "texts": {
        "name": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "description": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "general": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        },
        "buttons": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        }
      }
    },
    "user": {
      "components": {
        "dialogBox": [
          {
            "value": "text",
            "type": "text",
            "position": 1,
            "selected": true
          }
        ]
      },
      "texts": {
        "dialogBox": {
          "fontFamily": "text",
          "fontSize": "text",
          "colors": [
            {
              "value": "text",
              "type": "text",
              "position": 1,
              "selected": true
            }
          ]
        }
      }
    }
  }
}

Channel

Channel

CRUD Operatio

Auxiliary Methods

Websnippet CRUD

CRUD Operatio

Auxiliary Methods

Websnippet CRUD

Retrieves all existing channels of bot

Retrieves all existing channels of bot

Retrieves all existing channel types of bot, and aggregated within them each instance of channel using it in the same bot.

Returns details from the channel uuid passed in the endpoint

Delete all channels associated with a channelUUID.

Responsible to return the list of channel types that can be created grouped by classification

Retrieves all ivr providers

Returns all websnippet configurations associated to one channel of the bot.

Endpoint responsible to create a new channel in bot

Update all channels associated with a object referenced within ChannelUpdatedDTO and channelUUID.

Endpoint for validating if a channel already exists with the provided name or DNIS

Validating the existence of a channel in the database

Saves all websnippet configurations associated to one channel of the bot.

Pagination and Listings

CRUD Operatio

Auxiliary Methods

Websnippet CRUD

Pagination and Listings

CRUD Operatio

Auxiliary Methods

Websnippet CRUD

Retrieves all existing channels of bot

Retrieves all existing channels of bot

Retrieves all existing channel types of bot, and aggregated within them each instance of channel using it in the same bot.

Returns details from the channel uuid passed in the endpoint

Delete all channels associated with a channelUUID.

Responsible to return the list of channel types that can be created grouped by classification

Retrieves all ivr providers

Returns all websnippet configurations associated to one channel of the bot.

Endpoint responsible to create a new channel in bot

Update all channels associated with a object referenced within ChannelUpdatedDTO and channelUUID.

Endpoint for validating if a channel already exists with the provided name or DNIS

Validating the existence of a channel in the database

Saves all websnippet configurations associated to one channel of the bot.