Channel

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

API SUBPATH: eva-channel

Pagination and Listings

Retrieves all existing channels of bot

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

pageName*string

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

Response

Body

dataarray of ChannelListDataDTO (object)

List of bot's channel

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Retrieves all existing channels of bot

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Header parameters

Response

Body

uuidstring

Channel's uuid

namestring

Channel's name

descriptionstring

Channel's description

channelTypeChannelTypeDTO (object)

Information about the channel's type

createdAtstring

Channel's date of creation

deletableboolean

Boolean if it's deletable or not

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels?page=0&linesPerPage=5&orderBy=createdAt&direction=DESC', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 0,
    "name": "text",
    "imageName": "text",
    "channelClassification": {
      "id": 0,
      "name": "text"
    }
  },
  "createdAt": "text",
  "deletable": false
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Header parameters

Response

Body

idinteger (int64)

The channel type's id

namestring

The channel type's name

imagestring

The channel type's image name

channelClassificationChannelClassificationDTO (object)

Information about the channel's classification

channelsFromTypearray of ChannelDTO (object)

A list of all channels in this bot that belong to this channel type.

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Because both the listing at the flow tree and the pagination persist in the screen for a long period of time, the listing methods retrieve full information and should be locally stored to handle their data, rather than continuously requesting for each channel's data on a nominal GET info method.

CRUD Operatio

Endpoint responsible to create a new channel in bot

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels

Path parameters

orgUUID*string

It is the organization uuid where the bot is.

envUUID*string

It is the environment uuid where the bot is.

botUUID*string

It is the identification of the bot.

Body

name*string

Name of the channel

descriptionstring

Description of the channel

typeId*integer (int64)

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

ivrConfigurationIvrConfigurationDTO (object)

IVR Configuration

ivrTypeboolean

Response

Created

Body

uuidstring

Channel's uuid

botUuidstring

Channel's uuid of bot

namestring

Channel's name

descriptionstring

Channel's description

channelTypeChannelTypeDTO (object)

Information about the channel's type

ivrConfigurationIvrConfigurationDTO (object)

IVR Configuration

createdAtstring (date-time)

Channel's date of creation

updatedAtstring (date-time)

Channel's date of update

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "typeId": 0
    }),
});
const data = await response.json();

Response

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 0,
    "name": "text",
    "imageName": "text",
    "channelClassification": {
      "id": 0,
      "name": "text"
    }
  },
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 45000,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": false,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": false,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": {
        "text": "text",
        "code": "text",
        "intent": "text",
        "confidence": 0
      },
      "conversationTimeout": 40000,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 40000,
      "maxCallDuration": 300000
    },
    "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": false,
      "bargeIn": false,
      "voiceBargeIn": false,
      "bargeInOffset": 0,
      "time": 0
    },
    "dtmfMenu": {
      "interdigitTimeout": 5000,
      "numberOfDigits": 1,
      "timeoutInterval": 15000,
      "terminationTimeout": 2500,
      "terminationCharacter": "#"
    },
    "voiceMenu": {
      "timeoutInterval": 15000,
      "sensitivity": 0.25,
      "confidence": 0.6,
      "maxSpeechTimeout": 20000,
      "incompleteTimeout": 20000,
      "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": false,
    "evg": false,
    "secretSizeValid": false
  },
  "createdAt": "2025-01-21T00:47:10.600Z",
  "updatedAt": "2025-01-21T00:47:10.600Z"
}

Returns details from the channel uuid passed in the endpoint

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/view

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

channelUUID*string

A valid channel uuid

Header parameters

Response

Body

uuidstring

Channel's uuid

botUuidstring

Channel's uuid of bot

namestring

Channel's name

descriptionstring

Channel's description

channelTypeChannelTypeDTO (object)

Information about the channel's type

ivrConfigurationIvrConfigurationDTO (object)

IVR Configuration

createdAtstring (date-time)

Channel's date of creation

updatedAtstring (date-time)

Channel's date of update

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/view', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 0,
    "name": "text",
    "imageName": "text",
    "channelClassification": {
      "id": 0,
      "name": "text"
    }
  },
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 45000,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": false,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": false,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": {
        "text": "text",
        "code": "text",
        "intent": "text",
        "confidence": 0
      },
      "conversationTimeout": 40000,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 40000,
      "maxCallDuration": 300000
    },
    "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": false,
      "bargeIn": false,
      "voiceBargeIn": false,
      "bargeInOffset": 0,
      "time": 0
    },
    "dtmfMenu": {
      "interdigitTimeout": 5000,
      "numberOfDigits": 1,
      "timeoutInterval": 15000,
      "terminationTimeout": 2500,
      "terminationCharacter": "#"
    },
    "voiceMenu": {
      "timeoutInterval": 15000,
      "sensitivity": 0.25,
      "confidence": 0.6,
      "maxSpeechTimeout": 20000,
      "incompleteTimeout": 20000,
      "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": false,
    "evg": false,
    "secretSizeValid": false
  },
  "createdAt": "2025-01-21T00:47:10.600Z",
  "updatedAt": "2025-01-21T00:47:10.600Z"
}

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

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

channelUUID*string

A valid channel uuid for update

Header parameters

Body

name*string

Name of the channel

descriptionstring

Description of the channel

ivrConfigurationIvrConfigurationDTO (object)

IVR Configuration

Response

Body

codestring

Return the text: 'resource.updated'

messagestring

Return the text: 'This resource is updated'

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

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

Delete all channels associated with a channelUUID.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

channelUUID*string

A valid channel uuid for deleted

Header parameters

Response

No Content

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Auxiliary Methods

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

GET/org/{orgUUID}/env/{envUUID}/channels/type

Path parameters

orgUUID*string

It is the organization uuid where the bot is.

envUUID*string

It is the environment uuid where the bot is.

Response

Body

groupChannelarray of GroupDTO (object)

List of channel groups

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/channels/type', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Retrieves all ivr providers

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/providers

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Header parameters

Response

Body

dataarray of ChannelListDataDTO (object)

List of bot's channel

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/providers?vendorType=text&audioConverterType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

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.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Header parameters

Body

value*string

Value that will be validated

type*string

Validation type.

voiceProviderTypeenum

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

ASRTTS

channelUUIDstring

Value that will be validated

Response

No Content

Body

dataarray of ChannelListDataDTO (object)

List of bot's channel

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

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

Validating the existence of a channel in the database

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate-template

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Header parameters

Body

value*string

Value that will be validated

type*string

Validation type.

voiceProviderTypeenum

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

ASRTTS

channelUUIDstring

Value that will be validated

Response

No Content

Body

dataarray of ChannelListDataDTO (object)

List of bot's channel

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/validate-template', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

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

Websnippet CRUD

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

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/websnippet

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

channelUUID*string

A valid channel uuid

Header parameters

Body

generalSettings*GeneralSettingsDTO (object)

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

contactContactDTO (object)

DTO with email and phone attributes.

appearance*AppearanceDTO (object)

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

Response

Body

generalSettings*GeneralSettingsDTO (object)

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

contactContactDTO (object)

DTO with email and phone attributes.

appearance*AppearanceDTO (object)

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

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/websnippet', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "appearance": {
        "user": {
          "components": {
            "dialogBox": [
              {
                "position": 0,
                "selected": false,
                "type": "text",
                "value": "text"
              }
            ]
          },
          "texts": {
            "dialogBox": {
              "colors": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "fontFamily": "text",
              "fontSize": "text"
            }
          }
        },
        "virtualAgent": {
          "components": {
            "avatar": [
              {
                "position": 0,
                "selected": false,
                "type": "text",
                "value": "text"
              }
            ],
            "background": [
              {
                "position": 0,
                "selected": false,
                "type": "text",
                "value": "text"
              }
            ],
            "buttons": [
              {
                "position": 0,
                "selected": false,
                "type": "text",
                "value": "text"
              }
            ],
            "dialogBox": [
              {
                "position": 0,
                "selected": false,
                "type": "text",
                "value": "text"
              }
            ],
            "footer": {
              "background": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "theme": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ]
            },
            "header": {
              "background": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "icons": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ]
            },
            "minimizedIcon": [
              {
                "position": 0,
                "selected": false,
                "type": "text",
                "value": "text"
              }
            ]
          },
          "texts": {
            "buttons": {
              "colors": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "fontFamily": "text",
              "fontSize": "text"
            },
            "description": {
              "colors": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "fontFamily": "text",
              "fontSize": "text"
            },
            "general": {
              "colors": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "fontFamily": "text",
              "fontSize": "text"
            },
            "name": {
              "colors": [
                {
                  "position": 0,
                  "selected": false,
                  "type": "text",
                  "value": "text"
                }
              ],
              "fontFamily": "text",
              "fontSize": "text"
            }
          }
        }
      },
      "generalSettings": {
        "agentName": "text"
      }
    }),
});
const data = await response.json();

Response

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

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/websnippet

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

channelUUID*string

A valid channel uuid

Header parameters

Response

Body

generalSettings*GeneralSettingsDTO (object)

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

contactContactDTO (object)

DTO with email and phone attributes.

appearance*AppearanceDTO (object)

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

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}/websnippet', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

PreviousBroker NextDashboard

Last updated 2 months ago