Defining parameters and events to ignore from bot

As the administrator, you can define a list (blacklist) of parameters (e.g., transferTarget and playUrlUrl) or events (e.g., transfer and playUrl) that you want VoiceAI Connect to ignore if received from a specific bot. Alternatively, you can define a list (whitelist) of parameters or events that you want VoiceAI Connect to handle if received from the bot. Therefore, this allows you to limit what the bot can control and change in the VoiceAI Connect system.

This is configured per bot using the following administrative parameters:

• Events:

  Parameter	Type	Description
  botEventsWhitelist	String	Defines a list of VoiceAI Connect events that the bot can use. All other events not specified are ignored by VoiceAI Connect. If the parameter is configured with an empty list [ ], all incoming events are ignored. For more information, see Defining parameters and events to ignore from bot.
  botEventsBlacklist	String	Defines a list of VoiceAI Connect events that the bot cannot use. All other events not specified are allowed. If the parameter is configured with an empty list [ ], all incoming events are handled by VoiceAI Connect. For more information, see Defining parameters and events to ignore from bot.

• Parameters:

  Parameter	Type	Description
  botParametersWhitelist	String	Defines a list of VoiceAI Connect parameters that the bot can control. All other parameters not specified are forbidden and ignored by VoiceAI Connect. If the parameter is configured with an empty list [ ], VoiceAI Connect ignores all parameters in the incoming event. For more information, see Defining parameters and events to ignore from bot.
  botParametersBlacklist	String	Defines a list of VoiceAI Connect parameters that the bot cannot control. If the bot sends any of these parameters as activity/session params, these parameters are ignored and have no influence. All other parameters not specified are allowed. If the parameter is configured with an empty list [ ], all parameters in incoming events are handled by VoiceAI Connect. For more information, see Defining parameters and events to ignore from bot.

Below shows an example of a bot that is configured with a whitelist for events and a blacklist for parameters:

{
  "name": "my_bot",
  "provider": "my_provider",
  "botEventsWhitelist": [
    "config",
    "transfer",
    "playUrl"
  ],
  "botParametersBlacklist": [
    "sendDTMF",
    "transferTarget"
  ]
}

If the following event message is received from the bot, VoiceAI Connect will handle only the handoverReason parameter, while ignoring the transferTarget parameter:

{
  "type": "event",
  "name": "transfer",
  "activityParams": {
    "handoverReason": "My handover reason",
    "transferTarget": "tel:+119001234567"
  }
}