ChannelProfile

A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.

JSON representation 
{
  "profileId": string,
  "channelType": enum (ChannelProfile.ChannelType),
  "personaProperty": {
    object (ChannelProfile.PersonaProperty)
  },
  "disableDtmf": boolean,
  "disableBargeInControl": boolean,
  "webWidgetConfig": {
    object (ChannelProfile.WebWidgetConfig)
  },
  "noiseSuppressionLevel": string
}
Fields
profileId

string

Optional. The unique identifier of the channel profile.
channelType

enum (ChannelProfile.ChannelType)

Optional. The type of the channel profile.
personaProperty

object (ChannelProfile.PersonaProperty)

Optional. The persona property of the channel profile.
disableDtmf

boolean

Optional. Whether to disable DTMF (dual-tone multi-frequency).
disableBargeInControl

boolean

Optional. Whether to disable user barge-in control in the conversation. - true: User interruptions are disabled while the agent is speaking. - false: The agent retains automatic control over when the user can interrupt.
webWidgetConfig

object (ChannelProfile.WebWidgetConfig)

Optional. The configuration for the web widget.
noiseSuppressionLevel

string

Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".

ChannelProfile.ChannelType

The type of the channel profile.

Enums
UNKNOWN Unknown channel type.
WEB_UI Web UI channel.
API API channel.
TWILIO Twilio channel.
GOOGLE_TELEPHONY_PLATFORM Google Telephony Platform channel.
CONTACT_CENTER_AS_A_SERVICE Contact Center as a Service (CCaaS) channel.
FIVE9 Five9 channel.

ChannelProfile.PersonaProperty

Represents the persona property of a channel.

JSON representation 
{
  "persona": enum (ChannelProfile.PersonaProperty.Persona)
}
Fields
persona

enum (ChannelProfile.PersonaProperty.Persona)

Optional. The persona of the channel.

ChannelProfile.PersonaProperty.Persona

The persona of the channel.

Enums
UNKNOWN UNKNOWN persona.
CONCISE The agent keeps the responses concise and to the point
CHATTY The agent provides additional context, explanations, and details

ChannelProfile.WebWidgetConfig

Message for configuration for the web widget.

JSON representation 
{
  "modality": enum (ChannelProfile.WebWidgetConfig.Modality),
  "theme": enum (ChannelProfile.WebWidgetConfig.Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (ChannelProfile.WebWidgetConfig.SecuritySettings)
  }
}
Fields
modality

enum (ChannelProfile.WebWidgetConfig.Modality)

Optional. The modality of the web widget.
theme

enum (ChannelProfile.WebWidgetConfig.Theme)

Optional. The theme of the web widget.
webWidgetTitle

string

Optional. The title of the web widget.
securitySettings

object (ChannelProfile.WebWidgetConfig.SecuritySettings)

Optional. The security settings of the web widget.

ChannelProfile.WebWidgetConfig.Modality

Modality of the web widget.

Enums
MODALITY_UNSPECIFIED Unknown modality.
CHAT_AND_VOICE Widget supports both chat and voice input.
VOICE_ONLY Widget supports only voice input.
CHAT_ONLY Widget supports only chat input.

ChannelProfile.WebWidgetConfig.Theme

Theme of the web widget.

Enums
THEME_UNSPECIFIED Unknown theme.
LIGHT Light theme.
DARK Dark theme.

ChannelProfile.WebWidgetConfig.SecuritySettings

Security settings for the web widget.

JSON representation 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Fields
enablePublicAccess

boolean

Optional. Indicates whether public access to the web widget is enabled. If true, the web widget will be publicly accessible. If false, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
enableOriginCheck

boolean

Optional. Indicates whether origin check for the web widget is enabled. If true, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
allowedOrigins[]

string

Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
enableRecaptcha

boolean

Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.