ben.carrasco/next-static-site
1
0
Fork 0
mirror of https://github.com/jambonz/next-static-site.git synced 2025-12-19 04:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

V0.6.6 update (#18)

Browse Source 
* content updates for v06.6

* updated release notes
This commit is contained in:
Dave Horton
2021-09-22 15:15:24 -04:00
committed by GitHub
parent e3775b233a
commit 78dd1ba1d3
10 changed files with 156 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
data/docs.yml
View File

@@ -39,12 +39,18 @@ navi:
-
path: listen
title: listen
-
path: message
title: message
-
path: pause
title: pause
-
path: play
title: play
-
path: rasa
title: rasa
-
path: redirect
title: redirect
@@ -93,3 +99,13 @@ navi:
-
path: nodejs-sdk
title: Introduction to the Node.js SDK
-
path: release-notes
title: Release Notes
pages:
-
path: v0.6.6
title: v0.6.6
-
path: v0.6.5
title: v0.6.5

2
data/site.yml
View File

@@ -56,4 +56,4 @@ footer:
link: /privacy/
-
label: Terms of Service
link: /terms/
link: /terms/

18
markdown/docs/release-notes/v0.6.5.md Normal file
View File

@@ -0,0 +1,18 @@
# Release v0.6.5
> Release Date: August 13, 2021
#### New Features
- You can now monitor your queues in real-time. At the account level, you can specify a webhook that is called whenever a member joins or leaves a queue. This enables, for isntance, the possibility of building a webrtc client that shows active state of callers in queue.
- You can now retrieve pcap files from the web UI for your recent calls, in order to see the detailed SIP signaling.
#### Bug fixes
- if waitUrl of enqueue task includes leave but caller is dequeued before leave is reached, ignore leave
- enqueue queue_result = bridged if queued call was answered
- selecting FS to handle createMessage api was improved
- (hosted platform) add limits for adding account-level resources
#### Availability
- Available now on <a href="https://jambonz.us" target="_blank" >jambonz.us</a>
- Cloudformation templates at <a href="https://aws.amazon.com/marketplace/pp/prodview-55wp45fowbovo" target="_blank">AWS Marketplace</a>
**Questions?** Contact us at <a href="mailto:support@jambonz.org">support@jambonz.org</a>

24
markdown/docs/release-notes/v0.6.6.md Normal file
View File

@@ -0,0 +1,24 @@
# Release v0.6.6
> Release Date: Sept 22, 2021
#### New Features
- Added support for [Rasa](https://rasa.com) integration. Rasa is the premier open-source conversational AI platform. As an open-source alternative, Rasa nicely complements the support jambonz already has for [Google Dialogflow](https://cloud.google.com/dialogflow) and [AWS Lex](https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html). [See the docs](/docs/webhooks/rasa/) for details on how to connect voice calls to Rasa assistants.
- Added support for bidirectional audio when using the listen verb. You can now send audio back to jambonz through the websocket and drive the user interaction from your websocket server if you prefer.
- Added support for using Live Call Control/REST to put a party that is in conference on hold, or remove them from hold. While on hold, you can supply a waitHook to send music or speech to the party on hold. See the REST api docs relating to updateCall with the new [conf_hold_status](https://api.jambonz.org/#9c80ca99-4036-4a47-8823-4609e3fd4788) property for details.
- Added support for Dialogflow regional endpoints. You can now connect to Dialogflow agents in AWS regions outside of the US.
- Added beta support for sending and receiving SMS using the [smpp](https://smpp.org/SMPP_v5.pdf) protocol. The webapp now lets you configure BYOC carriers that support SMPP, and use them to send and receive SMS from your applications.
- Improved support for multi-tenant in the webapp. You can now add carriers and speech either at the account level or the higher-level service provider entity, allowing you support two different use cases: customer brings their own carriers/speech, and service provider provisions carriers and speech that are shared by a group of customers.
#### Bug fixes
- race condition: dial call killed just as called party picks up
- customerData in webhooks was being snake-cased
- bugfixes for queue events
- vulnerability fixes
- establish proper conference start time for parties that have been waiting for conference to start
- dont request unnecessary scope from google when doing oauth (hosted platform)
#### Availability
- Available now on <a href="https://jambonz.us" target="_blank" >jambonz.us</a>
- Cloudformation templates for AWS available shortly
**Questions?** Contact us at <a href="mailto:support@jambonz.org">support@jambonz.org</a>

2
markdown/docs/webhooks/listen.md
View File

@@ -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>

42
markdown/docs/webhooks/message.md Normal file
View File

@@ -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>

2
markdown/docs/webhooks/pause.md
View File

@@ -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>

2
markdown/docs/webhooks/play.md
View File

@@ -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>

49
markdown/docs/webhooks/rasa.md Normal file
View File

@@ -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>

6
yarn.lock
View File

@@ -754,9 +754,9 @@ callsites@^3.0.0:
integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==
caniuse-lite@^1.0.30001173, caniuse-lite@^1.0.30001179:
version "1.0.30001192"
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001192.tgz#b848ebc0ab230cf313d194a4775a30155d50ae40"
integrity sha512-63OrUnwJj5T1rUmoyqYTdRWBqFFxZFlyZnRRjDR8NSUQFB6A+j/uBORU/SyJ5WzDLg4SPiZH40hQCBNdZ/jmAw==
version "1.0.30001258"
resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001258.tgz"
integrity sha512-RBByOG6xWXUp0CR2/WU2amXz3stjKpSl5J1xU49F1n2OxD//uBZO4wCKUiG+QMGf7CHGfDDcqoKriomoGVxTeA==
caseless@~0.12.0:
version "0.12.0"