V0.6.6 update (#18)

* content updates for v06.6 * updated release notes
2026-11-02 01:24:39 +00:00 · 2021-09-22 15:15:24 -04:00
1 parent e3775b233a
commit 78dd1ba1d3
@@ -43,5 +43,5 @@ You can use the following options in the `listen` action:

 <p class="flex">
 <a href="/docs/webhooks/lex">Prev: lex</a>
-<a href="/docs/webhooks/pause">Next: pause</a>
+<a href="/docs/webhooks/message">Next: message</a>
 </p>
@@ -0,0 +1,42 @@
+# message
+> New in v0.6.6 (beta)
+The `message` verb is used to send an SMS via a carrier using the [SMPP](https://smpp.org/) protocol.  It requires that you have added a BYOC carrier configured that supports SMS.
+
+> You can also send SMS via the REST API.  [See here](https://api.jambonz.org/#54f1de57-3740-49f3-bd29-e68541d63dc3) for more details on that.
+
+```json
+{
+  "verb": "message",
+  "to": "15083084809",
+  "from": "16173334567",
+  "text": "Your one-time passcode is 1234",
+  "actionHook": "/sms/action"
+}
+```
+
+You can use the following options in the `message` verb:
+
+| option        | description | required  |
+| ------------- |-------------| -----|
+| from | sending number | yes |
+| to | destination number | yes |
+| text | text message to send | yes |
+| carrier | name of BYOC carrier to use (useful only when you have multiple carriers configured with SMPP support, otherwise leave out) | no |
+| actionHook | A webhook that is called when the message verb completes | no |
+
+<h5 id="message-action-properties">actionHook properties</h5>
+
+The actionHook that is invoked when the `message` command completes will include the following properties:
+
+| property name  | description | 
+| ------------- |-------------|
+| message_sid | the unique identifier for the message assigned by jambonz |
+| message_status | the final status of the message attempt; will be one of:<ul><li>- success</li><li>- failure</li><li>- no carriers</li><li>- smpp configuration error, or</li><li>- system error</li></ul>|
+| message_failure_reason | in the case of message_status 'failure', this will contain detail describing why the outbound smpp request failed|
+| carrier | the name of the carrier selected to send the SMS|
+| carrier_message_id | the message identifier assigned by the carrier for this SMS|
+
+<p class="flex">
+<a href="/docs/webhooks/listen">Prev: listen</a>
+<a href="/docs/webhooks/pause">Next: pause</a>
+</p>
@@ -15,6 +15,6 @@ You can use the following options in the `pause` action:
 | length | number of seconds to wait before continuing the app | yes |

 <p class="flex">
-<a href="/docs/webhooks/listen">Prev: listen</a>
+<a href="/docs/webhooks/message">Prev: message</a>
 <a href="/docs/webhooks/play">Next: play</a>
 </p>
@@ -18,5 +18,5 @@ You can use the following options in the `play` action:

 <p class="flex">
 <a href="/docs/webhooks/pause">Prev: pause</a>
-<a href="/docs/webhooks/redirect">Next: redirect</a>
+<a href="/docs/webhooks/rasa">Next: rasa</a>
 </p>
@@ -0,0 +1,49 @@
+# rasa
+> New in v0.6.6
+The `rasa` verb is used to connect a call to a [Rasa](https://rasa.com/) assistant.
+
+```json
+{
+  "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"
+}
+```
+
+You can use the following options in the `rasa` verb:
+
+| option        | description | required  |
+| ------------- |-------------| -----|
+| url | URL to connect to the Rasa assistant using the [RestInput](https://rasa.com/docs/rasa/connectors/your-own-website) channel | yes |
+| prompt | an initial greeting to play to the user | no |
+| eventHook | a webhook that is called when the rasa assistant returns either a user message or a bot message | no |
+| actionHook | A webhook that is called when the rasa verb completes | no |
+| tts | if provided, audio prompts will be played using these text-to-speech choices rather than the application defaults | no |
+| tts.vendor | speech vendor to use: Google, aws (alias: polly), or default (for application default) | no |
+| tts.language | language code to use.  | yes |
+| tts.gender | (Google only) MALE, FEMALE, or NEUTRAL.  | no |
+| recognizer | if provided, the speech recognition settings to use (defaults to application settings) | no |
+| tts.voice | voice to use.  Note that the voice list differs whether you are using aws or Google. Defaults to application setting, if provided. | no |
+| recognizer.hints | array of words or phrases to assist speech detection | no |
+| recognizer.language | language code to use for speech detection.  Defaults to the application level setting, or 'en-US' if not set | no |
+| recognizer.profanityFilter | if true, filter profanity from speech transcription.  Default:  no| no |
+| recognizer.vendor | speech vendor to use (currently only Google supported) | no |
+
+The rasa verb performs speech recognition on the caller audio stream and sends it as text input to the rasa assistant using the rasa [RestInput](https://rasa.com/docs/rasa/connectors/your-own-website) channel.  Text returned from the assistant is played to the caller using text-to-speech.  As the conversation proceeds, webhook events can be sent to notify of all of the messages being exchanged between the user and the bot, allowing your application to intercede at any point, e.g. to transfer the call to an agent.
+
+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
+
+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.
+
+<p class="flex">
+<a href="/docs/webhooks/play">Prev: play</a>
+<a href="/docs/webhooks/redirect">Next: redirect</a>
+</p>