Nexmo Numbers API

Name: Numbers API
Brand: Numbers API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsVoice TelephonyapiKey5 EndpointsREST

Install Jentic One Beta

Connect the Numbers API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Numbers API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

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 | sh

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 instance

Jentic 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.

Capabilities

What an agent can do with Numbers API.

Search Vonage's inventory for available virtual numbers by country and feature

Buy a virtual number in a specific country and assign it to your account

Update an owned number's inbound SMS and voice webhook configuration

GET STARTED

Start building with Numbers API

Explore with Jentic

View OpenAPI Document

For Agents

Search Vonage's virtual number inventory, buy and cancel numbers, and configure their inbound SMS and voice webhooks programmatically.

Use for: I want to buy a US virtual number that supports SMS, Search for available toll-free numbers in the United Kingdom, List all the numbers my Nexmo account currently owns, Update the voice webhook URL for one of my numbers

Not supported: Does not send messages, place calls, or port existing numbers - use for virtual number provisioning and configuration only.

Use Cases

Patterns agents use Numbers API for, with concrete tasks.

★ Provisioning a new SMS sender

When an application needs a dedicated long-code or toll-free sender, the team calls /number/search to find available inventory in the target country, /number/buy to purchase it, and /number/update to wire the inbound webhook to their application. The whole provisioning flow takes three API calls and replaces a manual portal-based purchase.

Call GET /number/search?country=US&features=SMS, pick the first MSISDN, then POST /number/buy with country and msisdn

Inbound webhook reconfiguration

When a service migrates to a new domain or splits inbound SMS and voice handlers across services, operators call /number/update for each owned number to point moHttpUrl and voiceCallbackValue at the new endpoints. Doing this through the API rather than the portal keeps the configuration in version control and reproducible across environments.

POST /number/update with country, msisdn, and the new moHttpUrl pointing at https://api.example.com/inbound-sms

Number portfolio audit

Finance and operations teams call /account/numbers to list every number the account holds, including capabilities, country, and current webhook target. The output drives quarterly audits to cancel unused numbers, confirm two-region failover coverage, and reconcile the bill against the active inventory.

GET /account/numbers and group the response by country and feature to produce an inventory report

AI agent number provisioning via Jentic

An AI agent that orchestrates messaging campaigns can request a fresh sender programmatically through Jentic. The agent calls the search operation, picks an MSISDN that supports SMS in the target country, and executes the buy operation, all without ever holding the raw apiKey/apiSecret pair.

Search Jentic for 'buy a virtual phone number for sms', load /number/buy, and execute with country=US and the chosen msisdn

Key Endpoints

5 endpoints — the nexmo numbers api lets developers search, buy, configure, and cancel virtual phone numbers across the countries vonage supports.

METHOD

PATH

DESCRIPTION

GET

/account/numbers

List numbers owned by the account

GET

/number/search

Search available numbers in inventory

POST

/number/buy

Purchase a virtual number

POST

/number/update

Update webhook configuration on an owned number

POST

/number/cancel

Release a number and stop billing

GET

/account/numbers

List numbers owned by the account

GET

/number/search

Search available numbers in inventory

POST

/number/buy

Purchase a virtual number

POST

/number/update

Update webhook configuration on an owned number

POST

/number/cancel

Release a number and stop billing

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Nexmo API key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'buy a virtual phone number for SMS' or 'list my Nexmo numbers', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Numbers API through Jentic.

What authentication does the Nexmo Numbers API use?

The Numbers API uses apiKey and apiSecret query parameters on every request to rest.nexmo.com. Through Jentic those credentials live in the encrypted vault, so an agent only ever sees a scoped access token and never the raw api_secret.

Can I search and buy a number in a single API call?

No - purchase is a two-step flow on purpose. First call GET /number/search with the country and feature filters, then call POST /number/buy with a specific msisdn from the result. Splitting the steps lets the application show inventory to a user before charging the account.

What are the rate limits for the Numbers API?

Vonage does not encode a numeric rate limit in the OpenAPI spec. The provisioning endpoints are not designed for high concurrency - bulk buys should be serialised, and /account/numbers should be cached rather than polled aggressively.

How do I update an inbound SMS webhook through Jentic?

Run pip install jentic, search for 'update inbound sms webhook for nexmo number', and Jentic returns POST /number/update. Execute with country, msisdn, and moHttpUrl set to your new endpoint, and Jentic returns the updated number record.

Can I get a refund for a number I just bought?

Calling POST /number/cancel stops the monthly rental immediately, but Vonage's commercial terms govern any pro-rata refund and that policy is not exposed via the API. Numbers purchased and cancelled in quick succession should be reconciled against your account's billing rules.

What features can I filter on when searching numbers?

The /number/search endpoint accepts a features query parameter that supports SMS, VOICE, and MMS, plus a type parameter for landline, mobile-lvn, and toll-free. Combine them with country and pattern to narrow inventory to exactly what your application needs.

Can I limit what my agent is allowed to do with the Nexmo Numbers API?

Yes. Because your Jentic One instance is self-hosted, your own rules decide which operations and credentials the agent can use, and the Numbers API scopes by operation rather than by resource. You can allow the agent only the calls it needs, such as GET /number/search and POST /number/update to reconfigure webhooks, while withholding the destructive POST /number/buy and POST /number/cancel operations unless you explicitly add them. Your Nexmo API key and secret stay stored and injected at execution time, so the agent runs only the operations you permit and never sees the raw secret.

Nexmo Numbers API

Connect the Numbers API to your agent

Capabilities

Start building with Numbers API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs