Wipple CPaaS
Menu
Guide
Introduction Getting started
Functions
Overview Agent Alert Answer Conference Config Dequeue Dial Dialogflow DTMF Dub Enqueue Gather Hangup Leave Listen LLM Pause Play Rasa Recognizer Redirect Say SIP Decline SIP Refer SIP Request Synthesizer Tag Transcribe Transfer
REST API
About the REST API Create a call List calls Get a call Update a call Delete a call Get call count List conferences Start conference listen Stop conference listen List queues
Webhooks
Overview New Call (POST) New Call (GET) Client Authentication Client Tool Request
Functions / Rasa

Rasa

{
  "verb": "rasa",
  "url": "http://my-assitant.acme.com/webhooks/rest/webhook?token=foobarbazzle",
  "prompt": "Hello there!  What can I do for you today?",
  "eventHook": "/rasa/event",
  "actionHook": "/rasa/action"
}

Parameters

urlstringrequired

URL to connect to the Rasa assistant using the RestInput channel.

actionHookstring

A webhook that is called when the Rasa Function completes.

eventHookstring

A webhook that is called when the Rasa assistant returns either a user message or a bot message.

promptstring

An initial greeting to play to the user.

recognizerobject

If provided, the speech recognition settings to use (defaults to application settings).

recognizer.hintsarray

Array of words or phrases to assist speech detection.

recognizer.languagestring

Language code to use for speech detection.
Defaults to the application-level setting or 'en-US' if not set.

recognizer.profanityFilterboolean

If true, filter profanity from speech transcription.
Default: false.

recognizer.vendorstring

Speech vendor to use (currently only Google is supported).

ttsobject

If provided, audio prompts will be played using these text-to-speech choices rather than the application defaults.

tts.genderstring

(Google only) MALE, FEMALE, or NEUTRAL.

tts.languagestringrequired

Language code to use.

tts.vendorstring

Speech vendor to use: Google, AWS (alias: Polly), or default (for application default).

tts.voicestring

Voice to use. Note that the voice list differs depending on whether you are using AWS or Google.
Defaults to the application setting, if provided.

actionHook properties

The actionHook webhook will contain the following additional parameters:

  • rasaResult: the completion reason:
  • caller hungup - the caller hungup
  • redirect - a new application was returned from an event webhook and is now being executed
  • timeout - the user did not respond to a prompt
  • webhookError - an error was received attempting to call an event webhook

eventHook properties

The eventHook webhook will contain two parameters: event and message. The event parameter will be either userMessage or botMessage depending on whether the message comes from the user or the rasa assistant, and message will contain the message itself. Your event webhook may return a new application in a json payload, in which case the call will be redirected to that application.

← PlayRecognizer →