Connectors / Service / Vonage

The world’s most flexible cloud communications platform. (updated: 1633096026884)

Vonage

The world’s most flexible cloud communications platform.

Overview

Vonage is a flexible cloud communications platform helping companies to engage their customers across messaging, voice, video, and other channels.

API INFO: The Base URL used for the vonage connector is https://api.nexmo.com/v1. More information can be found on their main API documentation (v1) site.

Below is an example of a way in which you could potentially use the Vonage connector, to retrieve information about your calls.

The steps will be as follows:

  1. Setup using a manual trigger and Vonage connector to list calls

  2. Loop through the list of calls

  3. Get information on each call

vonage-complete-workflow

1 - Setup Trigger & Vonage connector to list payments

Once you have clicked 'Create new workflow' from your main Tray.io dashboard named it, select the Manual trigger from the trigger options available:

vonage-manual-trigger

From the connectors panel on the left, add a Vonage connector to your workflow. Set the operation to 'List calls'.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users. The operation names themselves often suffice.

You can also filter the list of calls using the available fields on the properties panel. In our example, we will retrieve all the calls with 'Ringing' status.

vonage-step-1

Once this is setup, we are now returning all the ringing calls.

2 - Loop through the list of calls

Next, search for the Loop collection connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous Vonage connector step.

In order to specify the list you want to loop through, start by using the list mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List calls' step (with the tail end of the connector-snake), select calls from the list of output properties displayed. This will auto-populate a jsonpath within your list input field, and update the type selector to jsonpath.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

vonage-step-2-loop

3 - Get information on each call

The last step is to drag a Vonage connector inside of the Loop Collection step itself. Set the operation to 'Get call'. As you can see, the 'Call ID' field is required.

Again use the 'Call ID' mapping icon to generate the connector-snake, this time hover the tail over the 'loop-2' step and select uuid from the output properties.

vonage-step-3

The step is now setup and this will return each call with 'ringing' status.

By running the workflow and going to the 'Debug' panel, you will be able to see the result. The 'Loop Collection' will result in potentially running the 'Vonage-1' step multiple times for all the items found in the 'Vonage-2' step.

vonage-debug

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

2.2

Create call

Create an outbound call.

Create member

Create a member.

Create user

Create a user.

Delete member

Delete a member of a conversation.

Delete user

Delete a user.

Get call

Retrieve the details of a specific call.

Get event

Retrieve the details of a specific event.

List calls

Retrieve the details of your calls.

List conversations

Retrieve the details of your conversations.

List conversations DDL

List conversations next page

Retrieve the next page of the list of your conversations.

List events

Retrieve the details of your events belonging to a specific conversation.

List members

Retrieve the members of the conversation.

List members DDL

List members with joined state DDL

List users

Retrieve a list of users.

List users DDL

List users conversations

Retrieve a list of user's conversations.

List users conversations next page

Retrieve the next page of a list of user's conversations.

List users next page

Retrieve the next page of a list of users.

Modify call

Modify an in-progress call.