Converse AI by Smartsheet

Nexmo plugin allows users to build and host IVR (Interactive Voice Response) systems with in Converse platform and handle SMS messages.

Getting Started

To use the Nexmo integration you will need a Nexmo account. After you have created the account you will be given API credentials, key and secret, that you include in the Converse plugin registration.

Settings

These settings are required for using any of the Nexmo modules or channel integration

API Key

The API credentials key.

API Secret

The API credentials secret.

Voice

These settings are required to support the Nexmo voice to text channel and modules.

Handle Incoming Calls

Options for handing incoming calls to your Nexmo virtual numbers.

Default Template
  • Template
    The intent of the template that is to be triggered on an inbound call.
  • States
    The name and values set on the template states when it is triggered.
Numbers

In order to redirect incoming calls you have to link one or more virtual numbers with the Nexmo application. You can purchase virtual numbers from your Nexmo dashboard.

  • Number
    The virtual number to be linked to the account.
  • Country
    The country code for the virtual number.
  • Voice
    The voice that you want to use by default with this number. A complete list of the available voices can be found here.
  • Template
    The intent of the template that is to be triggered on an inbound call to this number. If this is not set then the default intent will be used.
  • States
    The name and values set on the template states when it is triggered using this number, either for the number specific intent or overriding the default template state values.

Options

The default options for sending messages and waiting for responses.

  • Voice
    The voice that you want to use by default with this number. A complete list of the available voices can be found here.
  • Barge In
    State if you want your messages to be interrupted when the user presses a key.
  • Loop
    The number of times the message will be repeated. The default value is 1. Set to 0 to loop infinitely.
  • Timeout
    The timeout, in seconds, for the user to make an input. Defaults to 3.
  • Submit On Hash
    State if you want the users input to be sent on hash. If not set the users input will be sent after the timeout.
  • Max Digits
    The number of digits the user can press. The maximum value is 20 which is also the default.

Events

It is possible to trigger a new template whenever we receive an event callback from Nexmo. Events are sent when a call starts, when it is ringing, when it has been answered, and many more. We are able to trigger a new template from these events, these templates cannot have any user interaction but can be used to start conversations in other channels or keep track of user metadata.

Each different event type can have a different template and state values set.

  • Template
    The intent of the template that is to be triggered on the given event.
  • States
    The name and values set on the template states when it is triggered.

Application Id

The id of the Nexmo application that will be created when you supply valid API credentials. This is read-only, displayed for your reference only, and will be populated when you register the plugin.

SMS

These settings are required if you want to use Nexmo SMS as a channel and to set the default sender for the Send SMS module.

Numbers

In order to redirect SMS messages you have to link one or more virtual numbers with the Nexmo application. You can purchase virtual numbers from your Nexmo dashboard.

  • Number
    The virtual number to be linked to the account.
  • Country
    The country code for the virtual number.

Modules

Create Conference

Create a new conference call.

Delete Conference

Delete a conference call.

Join Conference

Join a conference call.

Forward Call

Forward an exitsing call to another call endpoint.

Start Call

Start an outgoing call with a specified endpoint.

Play Audio

Stream an audio file over an existing call.

Record Call

Allow users to record a message at the end of a call.

Send Message

Send text as a voice message over Nexmo Voice channel.

Send SMS

Send a SMS message.

2FA Send Code

Send a Two-Factor Authentication code that can be used to verify a users identify.

2FA Check Code

Check a Two-Factor Authentication code sent to a user is valid.

2FA Cancel Code

Cancel a Two-Factor Authentication code request so it can no longer be used.

Examples

Conference Bot

A bot that allows your users to create and join a conference call

IVR Bot

A bot showing a basic IVR system in Converse

Nexmo


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.