Reference documentation and code samples for the Google Cloud Ces V1 Client class ChannelProfile.
A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.
Generated from protobuf message google.cloud.ces.v1.ChannelProfile
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ profile_id |
string
Optional. The unique identifier of the channel profile. |
↳ channel_type |
int
Optional. The type of the channel profile. |
↳ persona_property |
ChannelProfile\PersonaProperty
Optional. The persona property of the channel profile. |
↳ disable_dtmf |
bool
Optional. Whether to disable DTMF (dual-tone multi-frequency). |
↳ disable_barge_in_control |
bool
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. |
↳ web_widget_config |
ChannelProfile\WebWidgetConfig
Optional. The configuration for the web widget. |
↳ noise_suppression_level |
string
Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". |
getProfileId
Optional. The unique identifier of the channel profile.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProfileId
Optional. The unique identifier of the channel profile.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChannelType
Optional. The type of the channel profile.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ChannelType. |
setChannelType
Optional. The type of the channel profile.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ChannelType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPersonaProperty
Optional. The persona property of the channel profile.
| Returns | |
|---|---|
| Type | Description |
ChannelProfile\PersonaProperty|null |
|
hasPersonaProperty
clearPersonaProperty
setPersonaProperty
Optional. The persona property of the channel profile.
| Parameter | |
|---|---|
| Name | Description |
var |
ChannelProfile\PersonaProperty
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableDtmf
Optional. Whether to disable DTMF (dual-tone multi-frequency).
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableDtmf
Optional. Whether to disable DTMF (dual-tone multi-frequency).
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableBargeInControl
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableBargeInControl
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWebWidgetConfig
Optional. The configuration for the web widget.
| Returns | |
|---|---|
| Type | Description |
ChannelProfile\WebWidgetConfig|null |
|
hasWebWidgetConfig
clearWebWidgetConfig
setWebWidgetConfig
Optional. The configuration for the web widget.
| Parameter | |
|---|---|
| Name | Description |
var |
ChannelProfile\WebWidgetConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNoiseSuppressionLevel
Optional. The noise suppression level of the channel profile.
Available values are "low", "moderate", "high", "very_high".
| Returns | |
|---|---|
| Type | Description |
string |
|
setNoiseSuppressionLevel
Optional. The noise suppression level of the channel profile.
Available values are "low", "moderate", "high", "very_high".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|