Sending DTMF digits

At any stage of the conversation, VoiceAI Connect can receive DTMF digits from the bot.

This feature is supported only by VoiceAI Connect Enterprise (and from Version 3.12 and later).

How do I use it?

For sending DTMF digits to VoiceAI Connect, the bot should send a sendDtmf event.

The DTMF digits should be specified on the dtmfDigits parameter.

See Sending activities page for instructions on how to send events using your bot framework.

Example:

AudioCodes Bot API
{
  "type": "event",
  "name": "sendDtmf",
  "activityParams": {
    "dtmfDigits": "12345*#"    
  }
}
Microsoft Bot Framework
{
  "type": "event",
  "name": "sendDtmf",
  "channelData": {
    "activityParams": {
      "dtmfDigits": "12345*#"
    }
  }
}
Microsoft Copilot Studio

Send event named sendDtmf (see Sending event to VoiceAI Connect Enterprise)

{
  "activityParams": {
    "dtmfDigits": "12345*#"
  }
}
Microsoft Copilot Studio legacy
[Activity
    type = event
    name = sendDtmf
    channelData = ${json('
{
  "activityParams": {
   "dtmfDigits": "12345*#"
  }
}
')}
Dialogflow CX
{
  "activities": [
    {
      "type": "event",
      "activityParams": {
        "dtmfDigits": "12345*#"
      },
      "name": "sendDtmf"
    }
  ]
}
Dialogflow ES
{
  "activities": [
    {
      "type": "event",
      "name": "sendDtmf",
      "activityParams": {
        "dtmfDigits": "12345*#"
      }
    }
  ]
}
Amazon Lex
{
  "type": "event",
  "name": "sendDtmf",
  "activityParams": {
    "dtmfDigits": "12345*#"
  }
}

Event parameters

The following table lists the parameters associated with this event:

See Changing call settings for details on how these parameters can be applied.

Parameter

Type

Description

dtmfDigits

String

Defines the DTMF digits to send.

The valid value is a string that can include only digits, *, and/or #, and can be to 20 characters.

If empty or illegal characters are received, the “sendDtmf” event is ignored.