canonical: https://jentic.com/apis/nexmo.com

# Vonage APIs

Vonage (formerly Nexmo) is a communications platform whose APIs cover SMS, voice, multi-channel messaging, phone verification, number provisioning, and the account, application, reporting, and compliance surfaces that support them. This directory groups 19 Vonage APIs under the nexmo.com domain, spanning outbound SMS and MMS, voice calling with in-call TTS and DTMF control, WhatsApp, Viber, and Facebook Messenger sending, 2FA verification, number search and purchase, phone-number enrichment, activity reporting, audit trails, and GDPR redaction. Together they let a team send and orchestrate messages across channels, run verification flows, manage numbers and applications, and keep an account funded, audited, and compliant.

## For AI agents

An agent can send SMS, voice, and cross-channel messages, run 2FA verification, provision and configure virtual numbers and applications, and pull activity reports, all against a single Vonage account. It can also enrich phone numbers, check pricing before sending, and run compliance tasks such as audit-event retrieval and record redaction.

## Scope

Use for: Sending SMS, voice, and multi-channel messages, running phone verification, provisioning numbers and applications, and managing Vonage account reporting, auditing, and compliance

Not supported:
- inbound webhook handling
- carrier number porting
- audio transcription
- email sending
- KYC document checks

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| Vonage Conversation API | communications | 23 | Build multi-party chat, voice, SMS, and WebRTC conversations with shared persisted history across 23 endpoints. |
| Nexmo External Accounts API | communications | 9 | Manage Facebook Messenger, Viber Service Message, and WhatsApp sender accounts and link them to Nexmo applications. |
| Subaccounts API | communications | 9 | Create child subaccounts under a primary Vonage account, list and update their settings, and move balance, credit, or virtual numbers between accounts. |
| Voice API | communications | 9 | Place outbound voice calls, control in-progress calls with TTS, audio streaming, and DTMF, and retrieve historical call records by UUID. |
| Vonage Account API | finance | 8 | Read Vonage account balance, top up credit, manage API secrets, and configure default SMS and DLR callback URLs across a Vonage account. |
| Reports API | analytics | 6 | Generate, list, cancel, and download asynchronous activity reports across SMS, voice, and verification on a Vonage account, or query records synchronously for ad-hoc analytics. |
| Verify API | identity-auth | 6 | Run a 2FA verification flow by sending a PIN to a phone number, validating the user-entered code, and managing the request lifecycle without generating PINs in the application. |
| Numbers API | communications | 5 | Search Vonage's virtual number inventory, buy and cancel numbers, and configure their inbound SMS and voice webhooks programmatically. |
| Vonage Application API V1 | communications | 5 | Manage legacy Vonage V1 applications - list, create, update, and delete the application objects that route voice calls and webhook events. |
| Vonage Application API V2 | communications | 5 | Provision and manage Vonage v2 applications - the multi-capability container that binds voice, messages, and verify webhooks to a Vonage account. |
| Nexmo Media API | media | 4 | Manage audio media items used by Nexmo Voice - list, retrieve metadata, update metadata, and delete by id. |
| Number Insight API | data-enrichment | 4 | Look up validity, carrier, line type, country, and roaming status for any international phone number across four tiers of enrichment. |
| Pricing API | communications | 3 | Retrieve outbound SMS and voice pricing per country or per dialing prefix so an agent can estimate spend before sending traffic. |
| Nexmo Conversion API | communications | 2 | Report SMS and voice 2FA conversion outcomes back to Nexmo so the platform can tune routing and reliability for future verification traffic. |
| Vonage Audit API | security | 2 | Retrieve and filter Vonage account audit events for compliance, SIEM forwarding, and security investigation. |
| Nexmo Dispatch API | communications | 1 | Send a message that automatically retries on the next channel (WhatsApp, SMS, Viber, Messenger) when the previous attempt fails or is not read in time. |
| Nexmo Messages API | communications | 1 | Send a message over SMS, MMS, WhatsApp, Viber Service Message, or Facebook Messenger from a single POST endpoint that picks the channel via the request body. |
| Redact API | security | 1 | Redact the personally identifiable content of a specific Vonage transactional record (SMS, voice call, verification, message) from Vonage's logs. |
| SMS API | communications | 1 | Send transactional and notification SMS messages from a Vonage virtual number or alphanumeric sender to E.164 phone numbers worldwide, with optional Unicode, binary, and delivery-receipt support. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Send a single message on one channel | messages-api | One POST endpoint picks SMS, MMS, WhatsApp, Viber, or Messenger via the request body, so a single integration covers every channel. |
| Send plain SMS with the simplest parameters | sms-api | A dedicated SMS-only send endpoint with text, Unicode, and delivery-receipt support when you do not need multi-channel routing. |
| Reach a recipient with automatic channel failover | dispatch-api | Wraps Messages with an ordered failover template that retries the next channel when a step is not delivered or read in time. |
| Run a full 2FA flow with managed PIN and retries | verify-api | Vonage generates the PIN, handles SMS-to-voice fallback, and validates the code, so you only call request and check. |
| Send your own OTP code over SMS | sms-api | Use SMS directly when the application generates and validates the code itself rather than delegating the flow to Verify. |
| Manage a Vonage application and its capability webhooks | application-api | V2 is the current management surface for applications binding voice, messages, and verify webhooks; it is backwards compatible with v1. |
| Inventory or decommission legacy applications | application | V1 is deprecated but remains useful to list and migrate existing application objects before recreating them on v2. |

## Cross-API use cases

### Provision a number and send from it

Search Vonage inventory for an SMS-capable virtual number, buy it, then send a transactional message from that number. Numbers provisions the sender and SMS delivers the traffic, so an agent can stand up a new sending identity end to end.

Example prompt: Call numbers-api GET /number/search for an SMS-capable number, POST /number/buy to purchase it, then call sms-api POST /{format} with that number in the from field.

### Validate a number before verifying it

Check that a phone number is valid, mobile, and reachable before starting a 2FA flow, so verification spend is not wasted on malformed or fixed-line numbers. Number Insight validates and Verify runs the PIN challenge.

Example prompt: Call number-insight-api GET /standard/{format} to confirm the number is a reachable mobile, then call verify-api POST /{format} to send the PIN and POST /check/{format} to validate the code.

### Estimate spend, fund the account, then report on it

Look up outbound pricing for a destination, confirm the account has enough credit, send traffic, then export an activity report for reconciliation. Pricing and Account gate the send while Reports closes the loop.

Example prompt: Call pricing-api GET /get-pricing/outbound/sms for the destination, account-api GET /account/get-balance to confirm funds, then after sending call reports POST /v2/reports to export the activity CSV.

### Verify a phone number, then report and redact on request

Run a verification, report its conversion outcome so Vonage can tune routing, and later redact the verification record when a data-subject erasure request is approved. Verify runs the flow, Conversion feeds the signal back, and Redact scrubs the record.

Example prompt: Call verify-api POST /{format} and POST /check/{format}, post the outcome via nexmo-conversion-api POST /sms, then on an erasure request call redact-api POST /transaction with the verify transaction id.

## Why Jentic

- **Setup:** Install Jentic One once, then have your agent find and add any Vonage API from the Jentic directory into your workspace. Instead of wiring HTTP Basic, application JWTs, and several host paths per API by hand, you store your Vonage credentials once in your own instance and the agent calls whichever Vonage API it needs.
- **Permission scoping:** Your own rules in your Jentic One instance decide which Vonage operations an agent may call. You can allow read-only surfaces such as pricing, account balance, or audit events while withholding state-changing ones such as buying numbers, transferring balance, redacting records, or deleting applications until you add them.
- **Credential handling:** Your Vonage account key and secret and any application private key are stored encrypted by your own Jentic One instance, which assembles the Basic header or mints the per-call JWT at execution time. The raw credentials never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search the Jentic directory by intent, such as send an SMS message, place an outbound voice call, or verify a phone number, and Jentic returns the matching Vonage operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related vendors

- **Twilio** — The closest full-platform alternative, with equivalent SMS, voice, verification, number provisioning, and lookup APIs.
- **Plivo** — A communications platform offering comparable SMS, voice, and number management as a Vonage alternative.
- **Sinch** — Provides cross-channel messaging and verification with a conversation API comparable to Vonage's multi-channel send and failover.
- **SendGrid** — Complements Vonage telephony with an email channel plus account and API-key management for notification stacks.

## FAQ

### What can I build across the Vonage APIs?

You can send SMS, voice, and cross-channel messages, run 2FA verification, provision and configure virtual numbers and applications, enrich phone numbers, check pricing, and manage account balance, activity reporting, audit trails, and record redaction. The APIs share a single Vonage account, so messaging, voice, and verification traffic all bill and report against the same balance.

### Do all Vonage APIs use the same credentials?

Most use one Vonage account API key and secret, sent as HTTP Basic or as request parameters. The application-scoped APIs such as Voice and Conversation, plus the JWT paths of Messages and Dispatch, also need a JWT signed with a Vonage application private key. One account can hold multiple applications, each with its own key pair.

### Should I use SMS API, Messages API, or Dispatch API?

Use the SMS API for plain SMS-only sending with the simplest parameters. Use the Messages API when one endpoint should send across SMS, MMS, WhatsApp, Viber, or Messenger by channel. Use the Dispatch API when a send should automatically retry on the next channel if the first is not delivered or read in time.

### What is a Vonage application and when do I need one?

An application is the container that binds webhook URLs, capability flags, and a signing key pair for Voice, Messages, and Verify. You create it with the Application API V2, then reference its application id to mint JWTs for the Voice and Conversation APIs and the JWT paths of Messages and Dispatch. The V1 Application API remains only for inventorying and migrating older applications.

### How do the communications and compliance APIs fit together?

The Audit API gives a read-only trail of account changes for compliance and incident review, and the Redact API scrubs PII from a specific transactional record to support right-to-erasure requests. Both operate on the same account whose SMS, voice, and verification traffic the messaging APIs generate, so a compliance agent can trace a change and then redact the underlying record.

### Which APIs help an agent control spend before sending?

The Pricing API returns outbound SMS and voice rates per country or dialing prefix, and the Account API exposes the current balance and auto-reload top-up. Together they let an agent estimate the cost of a campaign and confirm the account has enough credit before any traffic flows.

### Are these the official Vonage OpenAPI specs?

Vonage does not publish OpenAPI specifications for several of these services, so Jentic generates and maintains those specs and keeps them validated against the live API. The remaining specs are third-party sourced. Either way each API in this directory carries a provenance label so you can see how its spec was produced.