> For the complete documentation index, see [llms.txt](https://codemash.gitbook.io/codemash/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codemash.gitbook.io/codemash/cloud/sms/integrations/providers/vonage.md).

# Vonage

Connect Vonage to SMS — coming soon; Norbix cannot send through Vonage yet.

Vonage (formerly Nexmo) reaches mobile networks worldwide and can send from an alphanumeric name such as `Acme` where the destination network allows it.

{% hint style="warning" %}
Cloud has no screen for this yet. On **Add New Integration** the Vonage card shows **COMING SOON**, the note *Sending SMS through Vonage is not supported yet.* and a turned-off **Connect** button, and Norbix refuses every send and every test through Vonage (`CM-ERRORS-SMS-005`, *Sending SMS through Vonage is not supported yet. Use Twilio or the Fake provider.*). To send SMS today, use [Twilio](/codemash/cloud/sms/integrations/providers/twilio.md), or [Fake SMS (Test Me)](/codemash/cloud/sms/integrations/providers/fake-sms.md) for practice. The settings below can already be saved with the SDK, the CLI or the API.
{% endhint %}

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-830afc0d8b7cb479289b298375e05d6c6ee7a1f9%2Fvonage-card-1.png?alt=media" alt="The Vonage card on Select SMS Integration: COMING SOON badge, a grey Connect button and the note Sending SMS through Vonage is not supported yet."><figcaption><p>The Vonage card is not connectable yet.</p></figcaption></figure>

## Get your credentials

1. Sign in to the [Vonage API dashboard](https://dashboard.nexmo.com/).
2. Copy the **API key** and the **API secret** from the dashboard home page.
3. Pick a sender: a Vonage virtual number (**Numbers → Your numbers**) in E.164 format, or an alphanumeric sender ID where the destination allows one.

## Connect it in Cloud

**Where:** SMS → Integrations → **Add New Integration** → Vonage — **Connect** is turned off for now.

The form exists in Cloud and opens only by its address, `/projects/<project>/sms/integrations/new/vonage`; it starts with the note *Sending SMS through Vonage is not supported yet.* An integration saved there (or from code) stays in the [integrations list](/codemash/cloud/sms/integrations.md) with **SENDING NOT SUPPORTED YET**, can be edited and deleted, and is not offered on campaigns, trigger actions or template tests.

| Field            | Required | What it does                                           | Example                  |
| ---------------- | -------- | ------------------------------------------------------ | ------------------------ |
| API Key          | yes      | Names your Vonage account; paired with the API Secret. | `a1b2c3d4`               |
| Sender           | yes      | The number or alphanumeric name the SMS comes from.    | `Acme`                   |
| API Secret       | yes      | Secret; encrypted on save and never shown again.       | `your-vonage-api-secret` |
| Integration Name | yes      | The name in your integrations list.                    | `Vonage production`      |

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-4a6d6a4e135cd3f4c2f971db2963b49844866184%2Fvonage-form-1.png?alt=media" alt="New Vonage Integration form with the note Sending SMS through Vonage is not supported yet. and the empty fields"><figcaption><p>The Vonage form, opened by its address.</p></figcaption></figure>

## Test and set as default

**Test integration** answers *Test failed* with `Sending SMS through Vonage is not supported yet. Use Twilio or the Fake provider.`, and the integration is not offered as a sender, so setting it as default has no use yet. See [Test an integration](/codemash/cloud/sms/integrations/test.md) and [Set an integration as default](/codemash/cloud/sms/integrations/set-default.md) for the flow once Vonage goes live.

## Common errors

| Message                                                                           | Cause                                    | Fix                                                                                                                                                 |
| --------------------------------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Sending SMS through Vonage is not supported yet. Use Twilio or the Fake provider. | Every send or test through Vonage today. | Use [Twilio](/codemash/cloud/sms/integrations/providers/twilio.md) or [Fake SMS (Test Me)](/codemash/cloud/sms/integrations/providers/fake-sms.md). |
| Secret is not provided (`CM-ERRORS-SECRETS-001`)                                  | An update without the secret fields.     | Send every secret again on each save.                                                                                                               |
| Required                                                                          | An empty field on the form.              | Fill every field.                                                                                                                                   |

## Do it from code

```ts
const { id } = await norbix.hub.notifications.saveSmsIntegration({
  integration: {
    provider: 'Vonage',
    integrationName: 'Vonage production',
    isEnabled: true,
    apiKey: 'a1b2c3d4',
    fromSender: 'Acme',
    apiSecret: 'your-vonage-api-secret',
  } as any, // the TS type knows only the shared fields
});
```

```sh
norbix hub notifications sms integration save --integration '{"provider":"Vonage","integrationName":"Vonage production","isEnabled":true,"apiKey":"a1b2c3d4","fromSender":"Acme","apiSecret":"your-vonage-api-secret"}'
```

The client setup is on the [SMS page](/codemash/cloud/sms.md#use-it-from-code). API: [Save Sms Integration](/codemash/api-reference/notifications/sms/save-sms-integration.md)
