Nexmo APIs
39 APIs212 Endpoints8 Categories
Categories
API Catalog
Account API
The Vonage Account API (account) lets you manage a Vonage (formerly Nexmo) communications account programmatically. It exposes balance checks, auto-reload top-ups, default SMS and delivery-receipt callback configuration, registered email sender management, and full lifecycle control over the API secrets attached to each Vonage API key. The 8 endpoints cover the operational surface needed to keep a messaging or voice account funded, configured, and credentialed.
8 endpointsAccount API
The Vonage Account API (account-api) lets you manage a Vonage (formerly Nexmo) communications account programmatically. It exposes balance checks, auto-reload top-ups, default SMS and delivery-receipt callback configuration, registered email sender management, and full lifecycle control over the API secrets attached to each Vonage API key. The 8 endpoints cover the operational surface needed to keep a messaging or voice account funded, configured, and credentialed.
8 endpointsApplication API
The Vonage Application API V2 (application-api) is the current management surface for Vonage Applications — the container that bundles webhook URLs, signing keys, and capability flags across Voice, Messages, RTC, and Verify. It is backwards compatible with v1 applications. The 5 endpoints provide create, list, retrieve, update, and delete operations against /v2/applications and return the public key plus capability webhooks needed to drive Vonage's product APIs.
5 endpointsApplication API
The Vonage Application API V2 (application.v2) is the current management surface for Vonage Applications — the container that bundles webhook URLs, signing keys, and capability flags across Voice, Messages, RTC, and Verify. It is backwards compatible with v1 applications. The 5 endpoints provide create, list, retrieve, update, and delete operations against /v2/applications and return the public key plus capability webhooks needed to drive Vonage's product APIs.
5 endpointsAudit API
The Vonage Audit API (audit) exposes a read-only stream of changes made to a Vonage account. It records application configuration changes, user secret creations and deletions, and account-level setting updates with timestamps, actor identifiers, and before/after diffs. The 2 endpoints — paginated list and single-event retrieval — cover the surface needed to drive compliance dashboards, SIEM integration, and incident triage. Vonage flags this API as beta on the /beta/audit base path.
2 endpointsAudit API
The Vonage Audit API (audit-api) exposes a read-only stream of changes made to a Vonage account. It records application configuration changes, user secret creations and deletions, and account-level setting updates with timestamps, actor identifiers, and before/after diffs. The 2 endpoints — paginated list and single-event retrieval — cover the surface needed to drive compliance dashboards, SIEM integration, and incident triage. Vonage flags this API as beta on the /beta/audit base path.
2 endpointsConversation API
The Vonage Conversation API (conversation) lets you build multi-party communication features that span IP messaging, PSTN voice, SMS, and WebRTC audio and video on a single shared conversation object. Conversation content is persisted, allowing playback or pickup later. The 23 endpoints cover conversations, members, events, users, legs, and call recording — enough surface to power in-app chat, recorded sales calls, agent-routed support threads, and omnichannel customer experiences.
23 endpointsConversation API
The Vonage Conversation API (conversation-api) lets you build multi-party communication features that span IP messaging, PSTN voice, SMS, and WebRTC audio and video on a single shared conversation object. Conversation content is persisted, allowing playback or pickup later. The 23 endpoints cover conversations, members, events, users, legs, and call recording — enough surface to power in-app chat, recorded sales calls, agent-routed support threads, and omnichannel customer experiences.
23 endpointsConversation API
The Vonage Conversation API V2 (conversation.v2) is a read-only surface over the conversation object model. It exposes GET endpoints for conversations, members, events, and users, designed for analytics, compliance review, and admin tooling. The 4 endpoints complement the v0.1 surface, which carries the full create, update, and delete operations.
4 endpointsNexmo Application API
The Vonage Application API V1 (application) provides CRUD operations for Vonage Applications, the container resource that binds voice answer URLs, event callback URLs, and assigned virtual numbers. This V1 surface is deprecated by Vonage in favour of v2 at /v2/applications, but remains useful for inventory and migration. The 5 endpoints cover list, create, retrieve, update, and delete on the application resource.
5 endpointsNexmo Application API
Jentic publishes the only available OpenAPI specification for Nexmo Application API, keeping it validated and agent-ready. This is version 1 of the Nexmo Application API and is marked deprecated by Vonage in favour of v2; it remains documented here for legacy integrations. A Nexmo application is the security and configuration container that binds together Voice answer URLs, event URLs, public key material, and channel-specific permissions. The five endpoints under /v1/applications cover full CRUD on the application resource: list, create, retrieve, update, and destroy.
5 endpointsNexmo Conversion API
Jentic publishes the only available OpenAPI specification for Nexmo Conversion API, keeping it validated and agent-ready. The Conversion API lets senders report whether a 2FA SMS or voice call ultimately reached and was acted on by the recipient. Nexmo (now Vonage) feeds these signals into its Adaptive Routing system, which continuously rebalances carrier paths to favour those producing higher real-world delivery success. The surface is intentionally tiny: two POST endpoints, one for SMS conversions and one for voice conversions.
2 endpointsNexmo Conversion API
The Nexmo Conversion API lets developers report back to Vonage whether a 2FA SMS or voice verification message was actually delivered and acted on by the recipient. Feeding this conversion signal back into the Nexmo platform helps optimise carrier routes, improve future delivery reliability, and surface fraudulent traffic patterns. The API exposes two simple POST endpoints, one for SMS and one for voice, each accepting a message-id, a delivered flag, and an optional timestamp.
2 endpointsNexmo Dispatch API
Jentic publishes the only available OpenAPI specification for Nexmo Dispatch API, keeping it validated and agent-ready. The Dispatch API orchestrates multi-channel message workflows on top of Nexmo's Messages API. The current template is failover: an ordered list of message attempts (for example WhatsApp, then SMS) where Dispatch automatically tries the next channel if the previous one fails immediately or does not reach the configured condition_status within a time window. The whole API is one POST endpoint that accepts a workflow definition.
1 endpointsNexmo Dispatch API
Jentic publishes the only available OpenAPI specification for Nexmo Dispatch API, keeping it validated and agent-ready. This dispatch-api slug is the alternate-named copy of Nexmo's Dispatch service, which orchestrates multi-channel failover workflows on top of Messages. A workflow follows a template; the failover template specifies an ordered list of channel attempts where each step has a success condition and a per-step expiry. The single POST endpoint accepts the full workflow body and returns a dispatch_uuid for status tracking.
1 endpointsNexmo External Accounts API
Jentic publishes the only available OpenAPI specification for Nexmo External Accounts API, keeping it validated and agent-ready. The External Accounts API manages the per-channel chat-app identities that Nexmo's Messages and Dispatch APIs send through — Facebook Messenger pages, Viber Service Message senders, and WhatsApp business numbers. It exposes nine endpoints for creating Messenger accounts, retrieving Viber and WhatsApp account state, updating tokens, and linking or unlinking each account to a Nexmo application so that messages routed via that application can use the right sender identity.
9 endpointsNexmo External Accounts API
Jentic publishes the only available OpenAPI specification for Nexmo External Accounts API, keeping it validated and agent-ready. This external-accounts-api slug is the alternate-named copy of Nexmo's chat-app account service. It exposes the same nine endpoints under /beta/chatapp-accounts for managing Facebook Messenger, Viber Service Message, and WhatsApp sender identities, plus the link/unlink operations that bind those identities to a Nexmo application so the Messages and Dispatch APIs route through the right sender.
9 endpointsNexmo Media API
Jentic publishes the only available OpenAPI specification for Nexmo Media API, keeping it validated and agent-ready. The Media API stores and retrieves media items — most often audio files used by Nexmo's Voice API for prompts and recordings. Four endpoints cover listing and searching items, retrieving an item's metadata, updating that metadata, and deleting an item by id. The API is the storage layer that other Nexmo products read from when they need to play, record, or attach a media file.
4 endpointsNexmo Media API
Jentic publishes the only available OpenAPI specification for Nexmo Media API, keeping it validated and agent-ready. This media-api slug is the alternate-named copy of the Media service. The same four endpoints under /v3/media cover listing and searching media items, retrieving and updating per-item metadata, and deleting items. Voice applications reference these stored audio files for prompts and recordings.
4 endpointsNexmo Messages API
Jentic publishes the only available OpenAPI specification for Nexmo Messages API, keeping it validated and agent-ready. The Messages API is Nexmo's normalised cross-channel send endpoint: a single POST / accepts a request whose channel field selects SMS, MMS, WhatsApp, Viber Service Message, or Facebook Messenger. The same envelope carries the to/from fields and a channel-specific message_type (text, image, audio, video, file, template) so applications can reach a recipient on whichever channel they are reachable on without integrating each one separately.
1 endpointsNexmo Messages API
Jentic publishes the only available OpenAPI specification for Nexmo Messages API, keeping it validated and agent-ready. This messages-olympus slug indexes the same Messages 1.4.0 service exposed at /v1/messages — a single POST / endpoint that sends a message over SMS, MMS, WhatsApp, Viber Service Message, or Facebook Messenger based on the channel field in the request body. The slug name reflects an internal Vonage codename and is functionally identical to the messages-api slug.
1 endpointsNumber Insight API
The Nexmo Number Insight API delivers real-time intelligence about phone numbers, including validity, line type, carrier, country, roaming status, and whether the number is currently reachable. It comes in three tiers — Basic for formatting and country lookup, Standard for carrier and line-type data, and Advanced for live network reachability and roaming detection — plus an asynchronous variant for high-volume Advanced lookups. Applications use it to validate sign-ups, score fraud risk, and choose the right channel before sending an SMS or voice call.
4 endpointsNumber Insight API
The Nexmo Number Insight API delivers real-time intelligence about phone numbers, including validity, line type, carrier, country, roaming status, and whether the number is currently reachable. It comes in three tiers — Basic for formatting and country lookup, Standard for carrier and line-type data, and Advanced for live network reachability and roaming detection — plus an asynchronous variant for high-volume Advanced lookups. Applications use it to validate sign-ups, score fraud risk, and choose the right channel before sending an SMS or voice call.
4 endpointsNumbers API
The Nexmo Numbers API lets developers search, buy, configure, and cancel virtual phone numbers across the countries Vonage supports. Each number can be wired to receive SMS or voice traffic and routed to a webhook, an application, or a SIP endpoint. The API exposes five operations covering inventory search, purchase, update, cancellation, and listing of currently owned numbers, and is the foundation that the SMS, Voice, and Messages APIs sit on top of.
5 endpointsNumbers API
The Nexmo Numbers API lets developers search, buy, configure, and cancel virtual phone numbers across the countries Vonage supports. Each number can be wired to receive SMS or voice traffic and routed to a webhook, an application, or a SIP endpoint. The API exposes five operations covering inventory search, purchase, update, cancellation, and listing of currently owned numbers, and is the foundation that the SMS, Voice, and Messages APIs sit on top of.
5 endpointsPricing API
The Nexmo Pricing API exposes outbound SMS, voice, and other Vonage service rates so applications can calculate cost before sending traffic. It returns full pricing tables, per-country pricing, and per-prefix pricing for any service type, which lets billing dashboards, finance teams, and routing systems make cost-aware decisions in real time. The endpoint is rate-limited to one request per second, so the typical pattern is to fetch the full pricing table once and cache locally.
3 endpointsPricing API
The Nexmo Pricing API exposes outbound SMS, voice, and other Vonage service rates so applications can calculate cost before sending traffic. It returns full pricing tables, per-country pricing, and per-prefix pricing for any service type, which lets billing dashboards, finance teams, and routing systems make cost-aware decisions in real time. The endpoint is rate-limited to one request per second, so the typical pattern is to fetch the full pricing table once and cache locally.
3 endpointsRedact API
The Nexmo Redact API gives privacy and compliance teams a controlled way to scrub the personally identifiable content of a specific transactional record from Vonage's logs. A single POST endpoint accepts a transaction id and product type and removes the message body, recipient number, and other PII from Vonage's retained records, helping organisations meet GDPR right-to-erasure and similar privacy obligations on demand.
1 endpointsRedact API
The Nexmo Redact API gives privacy and compliance teams a controlled way to scrub the personally identifiable content of a specific transactional record from Vonage's logs. A single POST endpoint accepts a transaction id and product type and removes the message body, recipient number, and other PII from Vonage's retained records, helping organisations meet GDPR right-to-erasure and similar privacy obligations on demand.
1 endpointsReports API
The Nexmo Reports API exposes activity reporting across SMS, voice, verification, and other Vonage products on a single Vonage account. It supports two patterns — synchronous record loads for ad-hoc queries and asynchronous report generation for large date ranges — plus listing, status checking, cancelling, and downloading the resulting media file. Finance, operations, and growth teams use it to reconcile spend, audit traffic, and export data into a warehouse without scraping the dashboard.
6 endpointsReports API
Jentic publishes the only available OpenAPI specification for Reports API, keeping it validated and agent-ready. The Vonage Reports API exposes activity records for SMS, voice, verify, conversion, and number-insight traffic on a Vonage account, supporting both asynchronous bulk exports and synchronous lookups. Asynchronous reports are tuned for batches of millions of records (Vonage recommends capping each request at 20 million rows) while synchronous reports return small windows of records or a single record fetched by ID. Generated report files are downloaded through the media endpoint as CSV.
6 endpointsSMS API
Jentic publishes the only available OpenAPI specification for SMS API, keeping it validated and agent-ready. The Vonage SMS API sends one-way SMS messages from a Vonage virtual number or alphanumeric sender ID to mobile recipients in E.164 format, with support for text, Unicode, binary, WAP push, and vCard payloads. A single POST endpoint accepts the message, optional message class, status report request, callback URL, and TTL, and returns delivery status and message reference IDs for each segment. API key and secret are passed as query parameters or form fields per Vonage's documented auth flow.
1 endpointsSMS API
Jentic publishes the only available OpenAPI specification for SMS API, keeping it validated and agent-ready. The Vonage SMS API sends one-way SMS messages from a Vonage virtual number or alphanumeric sender ID to mobile recipients in E.164 format, supporting text, Unicode, binary, WAP push, and vCard payloads. A single POST endpoint accepts the message, optional message class, status-report-request flag, callback URL, and TTL, returning delivery status and message reference IDs for each segment. API key and secret are passed as request parameters per Vonage's documented auth flow.
1 endpointsSubaccounts API
Jentic publishes the only available OpenAPI specification for Subaccounts API, keeping it validated and agent-ready. The Vonage Subaccounts API lets a primary Vonage account create and manage child subaccounts with isolated configuration, reporting, and billing. The 9 endpoints cover subaccount CRUD, balance and credit transfers between primary and subaccount, and number transfers so a virtual number can be reassigned from one subaccount to another. The API is currently released with restricted availability — primary accounts must be enabled by Vonage before the endpoints will respond.
9 endpointsSubaccounts API
Jentic publishes the only available OpenAPI specification for Subaccounts API, keeping it validated and agent-ready. The Vonage Subaccounts API lets a primary Vonage account create and manage child subaccounts with isolated configuration, reporting, and billing. The 9 endpoints cover subaccount CRUD, balance and credit transfers between primary and subaccount, and number transfers so a virtual number can be reassigned from one subaccount to another. The API is currently released with restricted availability — primary accounts must be enabled by Vonage before the endpoints will respond.
9 endpointsVerify API
Jentic publishes the only available OpenAPI specification for Verify API, keeping it validated and agent-ready. The Vonage Verify API runs end-to-end two-factor authentication flows by sending a PIN to a phone number over SMS, falling back to TTS voice if the SMS is not entered, and validating the user-entered code. The 6 endpoints cover request, check, search, control, network unblock, and the PSD2 Strong Customer Authentication variant for payment confirmation. Vonage manages PIN generation, retry workflow, and per-recipient throttling so the application only handles request and check.
6 endpointsVerify API
Jentic publishes the only available OpenAPI specification for Verify API, keeping it validated and agent-ready. The Vonage Verify API runs end-to-end two-factor authentication flows by sending a PIN to a phone number over SMS, falling back to TTS voice if the SMS is not entered, and validating the user-entered code. The 6 endpoints cover request, check, search, control, network unblock, and the PSD2 Strong Customer Authentication variant for payment confirmation. Vonage manages PIN generation, retry workflow, and per-recipient throttling so the application only handles request and check.
6 endpointsVoice API
Jentic publishes the only available OpenAPI specification for Voice API, keeping it validated and agent-ready. The Vonage Voice API places outbound calls, controls in-progress calls, and surfaces historical call records through 9 endpoints. Calls are driven by a Nexmo Call Control Object that defines the connect, talk, stream, and input actions, and live calls can be muted, hung up, or sent DTMF tones, audio streams, and TTS prompts mid-call. The API is authenticated with JWT bearer tokens scoped to a Vonage application that holds the public key.
9 endpointsVoice API
Jentic publishes the only available OpenAPI specification for Voice API, keeping it validated and agent-ready. The Vonage Voice API places outbound calls, controls in-progress calls, and surfaces historical call records through 9 endpoints. Calls are driven by a Nexmo Call Control Object that defines the connect, talk, stream, and input actions, and live calls can be muted, hung up, or sent DTMF tones, audio streams, and TTS prompts mid-call. The API is authenticated with JWT bearer tokens scoped to a Vonage application that holds the public key.
9 endpointsConnect Your Agent
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.