> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/vonage.md).

# Vonage

Connect to Vonage (formerly Nexmo) to send SMS messages, verify phone numbers, and look up number insights.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Vonage    | Credentials    |

### Vonage

Connect to Vonage (formerly Nexmo), a communications platform for SMS messaging and phone number verification, using an API key and secret.

#### Set up in Vonage

1. Sign in to the [Vonage API Dashboard](https://dashboard.nexmo.com/) (create a free account if you don't have one).
2. On the dashboard, view your **API key** and **API secret**.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Vonage**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                             |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Vonage API key from the API settings page of the Vonage dashboard. [Provider instructions](https://dashboard.nexmo.com/settings).    |
| API Secret    | Yes      | Your Vonage API secret, shown next to the API key on the Vonage dashboard. [Provider instructions](https://dashboard.nexmo.com/settings). |

**Provider documentation:** [Setup reference](https://developer.vonage.com/en/getting-started/overview).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Vonage** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Send SMS

Send an SMS text message to a phone number.

#### Inputs

| Field   | Type   | Required | Description                                                   |
| ------- | ------ | -------- | ------------------------------------------------------------- |
| To      | string | Yes      | Recipient phone number in E.164 format (digits only).         |
| From    | string | Yes      | Sender: a Vonage virtual number or an alphanumeric sender ID. |
| Message | string | Yes      | The text body of the SMS.                                     |

#### Outputs

| Field  | Type   | Description                                                 |
| ------ | ------ | ----------------------------------------------------------- |
| Result | object | The SMS submission result, including message id and status. |

### Verify Phone Number

Send a verification code to a phone number and get a request id.

#### Inputs

| Field        | Type            | Required | Description                                                                                                    |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| Phone Number | string          | Yes      | The phone number to verify, in E.164 format (digits only).                                                     |
| Brand        | string          | Yes      | The brand or app name shown in the verification message.                                                       |
| Channel      | select (string) | No       | Delivery channel: sms, voice, whatsapp, or email. Available values: SMS, Voice, WhatsApp, Email. Default: sms. |

#### Outputs

| Field      | Type   | Description                                                |
| ---------- | ------ | ---------------------------------------------------------- |
| Request ID | string | The verification request id, used to check the code later. |

### Check Verification Code

Confirm a verification code against a verification request.

#### Inputs

| Field      | Type   | Required | Description                                                |
| ---------- | ------ | -------- | ---------------------------------------------------------- |
| Request ID | string | Yes      | The request id returned by the Verify Phone Number action. |
| Code       | string | Yes      | The verification code the user received.                   |

#### Outputs

| Field      | Type   | Description                                   |
| ---------- | ------ | --------------------------------------------- |
| Request ID | string | The verification request id that was checked. |
| Status     | string | The verification status, e.g. completed.      |

### Get Number Insight

Look up formatting, country, and carrier details for a phone number.

#### Inputs

| Field        | Type            | Required | Description                                                                                              |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| Phone Number | string          | Yes      | The phone number to look up, in E.164 format (digits only).                                              |
| Level        | select (string) | No       | Lookup depth: basic, standard, or advanced. Available values: Basic, Standard, Advanced. Default: basic. |
| Country Code | string          | No       | Optional ISO 3166-1 alpha-2 country code for a national number. Default: .                               |

#### Outputs

| Field  | Type   | Description                                                 |
| ------ | ------ | ----------------------------------------------------------- |
| Result | object | The number insight result: formatting, country, and status. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/vonage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
