Nexmo Integration Overview

Applies to

Bridge by Smartsheet

With the Nexmo integration, you can build and host IVR (Interactive Voice Response) systems within Bridge and handle SMS messages.

Create your Nexmo account

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

Nexmo Register Welcome Page

Set up the integration in Bridge

The Settings tab

  1. Navigate to the Integrations page in Bridge. 
  2. Click on the Nexmo image to start the set up.
  3. Click Continue in the pop-up.
  4. In the Settings tab, enter the following:
    • API Key: The API credentials key.
    • API Secret: The API credentials secret.

Nexmo Settings Tab


The Voice tab

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

Nexmo voice tab

Handle Incoming Calls

Options for handing incoming calls to your Nexmo virtual numbers.

  • Default Workflow
    • Workflow: The workflow that is to be triggered on an inbound call.
    • States: The name and values set on the workflow states when it is triggered.

Nexmo Set Up Fields

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.
  • Workflow: The workflow that is to be triggered on an inbound call to this number. If this is not set then the default workflow will be used.
  • States: The name and values set on the workflow states when it is triggered using this number, either for the number specific workflow or overriding the default workflow state values.

Nexmo Set Up Fields continued

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.

Nexmo Set Up continued3

Events

It is possible to trigger a new workflow whenever you 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. You are able to trigger a new workflow from these events; these workflows cannot have any user interaction but can be used to start workflows in other integrations or keep track of user metadata.

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

  • Workflow: The workflow that is to be triggered on the given event.
  • States: The name and values set on the workflow 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.


The SMS tab

These settings are required if you want to use Nexmo SMS as a chat integration 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.

Nexmo Set Up Continued 4