> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Vonage

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZATWVPMNCXAF3XB72FNHKS)
*v1.0.4*

![](https://mintcdn.com/botpress/KbMT91f_P0tr2fc3/integrations/integration-guides/assets/vonage.png?fit=max\&auto=format\&n=KbMT91f_P0tr2fc3\&q=85\&s=9909ea23c5e93ea336430d2babdc1d61)

## Prerequisites

* A [Vonage Account](https://dashboard.nexmo.com/sign-up)
* A [Vonage Application](https://dashboard.nexmo.com/applications/new)
* A [Botpress Cloud account](https://sso.botpress.cloud) and a [Botpress Bot](https://botpress.com/docs/get-started/quick-start.md)

## Setup in Botpress

1. Go to the [Integration Hub](https://app.botpress.cloud/hub) in Botpress Cloud (if you don't have the integration installed yet).
2. Find and open the Vonage integration then click on the "Install to Bot" button, now go back to your bot.

## Setup in Vonage

### API credentials

1. Go to your [API Settings](https://dashboard.nexmo.com/settings).
2. Copy paste the API key to the **API Key** channel configuration
3. Copy paste the API secret from the **Account credentials** section to the **API Secret** channel configuration
4. Copy paste the signature secret from the **Signed webhooks** section to the **Signature Secret** channel configuration

### Save Configuration

Channel configuration is complete, you can now click **Save**

## Webhook Configuration

### Sandbox

You can use the Vonage sandbox to test your channel with WhatsApp

1. Check the **Use Testing API** box in your channel configuration
2. Go to your [Sandbox Settings](https://dashboard.nexmo.com/messages/sandbox)
3. Copy paste the webhook URL provided in the channel configuration UI to the **Inbound** and **Status** fields in the **Webhooks** section

That's it, you may now start chatting with your bot on Vonage!

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Get or create user

Get or create a user in the Vonage channel

**input** `object`

**name** `string`

The name of the user

**pictureUrl** `string`

The URL of the user profile picture

**email** `string`

The email of the user

**user** `object` *required*

**channel** `string` *required*

The channel of the user

**userId** `string` *required*

The user id

**output** `object`

**userId** `string` *required*

The Botpress ID of the created user

### Start proactive conversation

Start a proactive conversation given a user

**input** `object`

**conversation** `object` *required*

**userId** `string` *required*

**channelId** `string` *required*

**channel** `string` *required*

**output** `object`

**conversationId** `string` *required*

The Botpress ID of the created conversation


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.