Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DtmfSettings.
Define behaviors for DTMF (dual tone multi frequency).
Generated from protobuf message google.cloud.dialogflow.cx.v3.AdvancedSettings.DtmfSettings
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3 \ AdvancedSettingsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enabled |
bool
If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). |
↳ max_digits |
int
Max length of DTMF digits. |
↳ finish_digit |
string
The digit that terminates a DTMF digit sequence. |
↳ interdigit_timeout_duration |
Google\Protobuf\Duration
Interdigit timeout setting for matching dtmf input to regex. |
↳ endpointing_timeout_duration |
Google\Protobuf\Duration
Endpoint timeout setting for matching dtmf input to regex. |
getEnabled
If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnabled
If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxDigits
Max length of DTMF digits.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxDigits
Max length of DTMF digits.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinishDigit
The digit that terminates a DTMF digit sequence.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFinishDigit
The digit that terminates a DTMF digit sequence.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInterdigitTimeoutDuration
Interdigit timeout setting for matching dtmf input to regex.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasInterdigitTimeoutDuration
clearInterdigitTimeoutDuration
setInterdigitTimeoutDuration
Interdigit timeout setting for matching dtmf input to regex.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpointingTimeoutDuration
Endpoint timeout setting for matching dtmf input to regex.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasEndpointingTimeoutDuration
clearEndpointingTimeoutDuration
setEndpointingTimeoutDuration
Endpoint timeout setting for matching dtmf input to regex.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|