How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vonage Phone Numbers API (via KPN)

The Numbers API lets you manage your numbers and buy new virtual numbers for use with Vonage's APIs. ## Prerequirement: Your project has to be in the production environment in order to use of this API. For any questions, please contact our support team.

Vonage Phone Numbers API (via KPN) is one of 38 APIs that KPN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Voice, Phone Numbers, CPaaS, and Resold API. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 5 operations across 5 paths, organized into 2 resource areas, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version v1.1.1.

Requests are made against a single base URL, https://api-prd.kpn.com/communication/nexmo/phone-numbers.

5 operations 5 paths 11 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.1.1
Base URL
https://api-prd.kpn.com/communication/nexmo/phone-numbers
Authentication
OAuth 2.0
Terms of Service
Resource Areas
2

Authentication & Security 1

Vonage Phone Numbers API (via KPN) declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. They span 2 resource areas: account, number. Each is listed below with its method, path, parameters, and response codes.

account 1

number management from accounts

GET
/account/numbers
List owned numbers
getNumbers 4 params → 200
number 4

numbers operations

GET
/number/search
Search available numbers
searchNumbers 7 params → 200
POST
/number/buy
Buy a number
buyNumber body → 200
POST
/number/cancel
Cancel a number
cancelNumber body → 200
POST
/number/update
Update a number
updateNumber body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are number (7 properties), update_number (7 properties), buy_cancel_number (2 properties). Each schema is shown below with its type and property counts.

number
object
7 properties 4 required
buy_cancel_number
object
The JSON object to request or cancel a number
2 properties 2 required
update_number
object
The JSON object to request an update of a phone number
7 properties 2 required
moHttpUrl_field
string
An URL encoded URI to the webhook endpoint that handles inbound messages. Your webhook endpoint must be active before you make this request, Vonage makes a GET…
moSmppSysType_field
string
The associated system type for your SMPP client. For example inbound.
voiceCallbackType_field
string
The voice webhook type. To be used together with voiceCallbackValue
voiceCallbackValue_field
string
A SIP URI, telephone number or Application ID. To be used together with voiceCallbackType
voiceStatusCallback_field
string
A webhook URI for Vonage to send a request to when a call ends.
country_field
string
The two character country code in ISO 3166-1 alpha-2 format.
msisdn_field
string
An available inbound virtual number.
feature_field
array
Available features are SMS and VOICE. For both features, use a comma-separated value SMS,VOICE.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-phone-numbers-openapi.yml Raw ↑

Other APIs KPN publishes across the network.

KPN Number Verify API
KPN SIM Swap API (Account Takeover Protection)
KPN Match API
KPN SMS API
KPN SMS Inbound API
KPN Mobile Services Management API
KPN FIAM API
KPN FIAM Eneco Data Products API
KPN Disturbance Check API
KPN Internet Speed Check API
KPN High Level Design FttX API
KPN LoRa Device Management API
Where this information came from

This is an independent, third-party profile of Vonage Phone Numbers API (via KPN), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.