Channel

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

PreviousBroker NextDashboard

Last updated 4 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

Query parameters

pageinteger · int32 · default: 0required

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

Example: 1

linesPerPageinteger · int32 · default: 5required

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

Example: 1

orderBystring · default: "createdAt"required

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

directionstring · default: "DESC"required

It is the sorting type, default value DESC

Header parameters

x-request-idstringoptional

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

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels?page=1&linesPerPage=1&orderBy=text&direction=text'

200

400

401

403

404

409

422

500

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "image": "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

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard'

200

400

401

403

404

409

422

500

[
  {
    "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

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/view'

200

400

401

403

404

409

422

500

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "image": "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-03-28T09:59:54.438Z",
  "updatedAt": "2025-03-28T09:59:54.438Z"
}

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

*/*

cURL

JavaScript

Python

HTTP

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

204

400

401

403

404

409

422

500

No body

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

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/channels/type'

200

400

401

403

404

409

422

500

{
  "groupChannel": [
    {
      "group": 1,
      "groupName": "text",
      "groupCode": "text",
      "channels": [
        {
          "id": 1,
          "classificationId": "text",
          "name": "text",
          "imageName": "text",
          "imageTitle": "text",
          "imagePath": "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

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/providers?vendorType=text&audioConverterType=text'

200

400

401

403

404

409

422

500

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "image": "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

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/websnippet'

200

204

400

401

403

404

409

422

500

{
  "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
            }
          ]
        }
      }
    }
  }
}

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

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName}'

200

400

401

403

404

409

422

500

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "image": "text",
        "imageName": "text",
        "channelClassification": {
          "id": 1,
          "name": "text"
        }
      },
      "createdAt": "text",
      "deletable": 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

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

ivrConfigurationobjectoptional

IVR Configuration

ivrTypebooleanoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

201

400

401

403

404

409

422

500

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "image": "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-03-28T09:59:54.438Z",
  "updatedAt": "2025-03-28T09:59:54.438Z"
}

Created

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

namestringrequired

Name of the channel

descriptionstringoptional

Description of the channel

ivrConfigurationobjectoptional

IVR Configuration

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

401

403

404

409

422

500

{
  "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'

Options: ASR, TTS

channelUUIDstringoptional

Value that will be validated

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text",
    "type": "text",
    "voiceProviderType": "ASR",
    "channelUUID": "text"
  }'

204

400

401

403

404

409

422

500

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

No Content

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'

Options: ASR, TTS

channelUUIDstringoptional

Value that will be validated

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate-template' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text",
    "type": "text",
    "voiceProviderType": "ASR",
    "channelUUID": "text"
  }'

200

400

401

403

404

409

422

500

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

No Content

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

generalSettingsobjectrequired

DTO with agent name, user input placeholder and description attributes.

contactobjectoptional

DTO with email and phone attributes.

appearanceobjectrequired

DTO with virtual agent and user attributes that has data about the chat appearance.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/websnippet' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
              }
            ]
          }
        }
      }
    }
  }'

200

400

401

403

404

409

422

500

{
  "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 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.

Retrieves all existing channels of 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 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.

Retrieves all existing channels of bot

Endpoint responsible to create a new channel in bot

Show child attributes

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

Show child attributes

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.

Show child attributes

Show child attributes

Show child attributes