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 Voice API (via KPN)

The Voice API lets you create outboud calls, control in progress calls and get information about current and historical calls. The API is divided in 2 big resources blocks: - Application: Manage application level options - Call: Manage call level options ## Call Guidelines 1. Create an application 2. Make a call ## Guidelines to create an application In order to create an application, we need to provide 3 values: - name - type (voice) - answer_url - event_url For more information regarding the meaning of each field, refer to the POST /application endpoint. Among the return values of this call, there is the application identifier (uuid). It is needed to make calls or to operate with the application. ## Guidelines to make a call In order to make a call, we must include the identifier of the application in the **header** and fill the basic fields from the...

Vonage Voice 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, CPaaS, and Resold API. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 15 operations across 8 paths, organized into 3 resource areas, and defines 25 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/.

15 operations 8 paths 25 schemas 3 DELETE5 GET2 POST5 PUT

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/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
3

Authentication & Security 1

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

Paths & Operations 15

Across 8 paths, the API surfaces 15 operations — 3 DELETE, 5 GET, 2 POST, 5 PUT. They span 3 resource areas: voice, applications, JWT. Each is listed below with its method, path, parameters, and response codes.

voice 9

Call related resource management

POST
/voice/calls
Outbound call
createCall 2 params body → 201401
GET
/voice/calls
Details of your calls
getCalls 9 params → 200401
GET
/voice/calls/{uuid}
Details of a specific call
getCall 3 params → 200401
PUT
/voice/calls/{uuid}
Modify an in progress call
updateCall 3 params body → 204401
PUT
/voice/calls/{uuid}/stream
Play an audio file into a call
startStream 3 params body → 200401
DELETE
/voice/calls/{uuid}/stream
Stop playing an audio file into a call
stopStream 3 params → 200401
PUT
/voice/calls/{uuid}/talk
Play text to speech into a call
startTalk 3 params body → 200401
DELETE
/voice/calls/{uuid}/talk
Stop text to speech in a call
stopTalk 3 params → 200401
PUT
/voice/calls/{uuid}/dtmf
Play DTMF tones into a call
startDTMF 3 params body → 200401
applications 5

Application related resource management

POST
/applications
New Application
createApplication 1 param body → 201401
GET
/applications
Details of your applications.
getApplications 3 params → 200401
GET
/applications/{uuid}
Details of a specific application
getApplication 2 params → 200401
PUT
/applications/{uuid}
Modify an existing application
updateApplication 8 params → 200401
DELETE
/applications/{uuid}
Delete application
deleteApplication 2 params → 204
JWT 1

Call to generate JWT.

GET
/jwt
Generate JWT Call
createJWT 2 params → 200401

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are call (13 properties), callEvent (7 properties), application (5 properties), NCCO (4 properties). Each schema is shown below with its type and property counts.

fields_network
string
The Mobile Country Code Mobile Network Code ([MCCMNC](https://en.wikipedia.org/wiki/Mobilecountrycode)) for the carrier network used to make this call.
fields_start_time
string
The time the call started in the following format: YYYY-MM-DD HH:MM:SS. For example, 2020-01-01 12:00:00.
fields_end_time
string
The time the call started in the following format: YYYY-MM-DD HH:MM:SS. For example, 2020-01-01 12:00:00. This is only sent if status is completed.
fields_duration
string
The time elapsed for the call to take place in seconds. This is only sent if status is completed.
fields_price
string
The total price charged for this call. This is only sent if status is completed.
fields_rate
string
The price per minute for this call. This is only sent if status is completed.
fields_direction
string
Possible values are outbound or inbound
fields_uuid
string
The unique identifier for this call leg. The UUID is created when your call request is accepted by Vonage. You use the UUID in all requests for individual live…
fields_conversation_uuid
string
The unique identifier for the conversation this call leg is part of.
fields_from
array
The endpoint you called from. Possible values are the same as to.
fields_to
array
The single or mixed collection of endpoint types you connected to
fields_status
string
The status of the call. [See possible values](/voice/voice-api/guides/call-flowevents)
fields_digits
string
The digits to send
fields_http_method
string
The HTTP method used to send event information to eventurl.
fields_call_link
object
1 property
fields_call_link_self
object
1 property
endpoints
object
3 properties
addresses
object
3 properties
callEvent
object
7 properties 5 required
voiceNames
string
The voice & language to use
application
object
5 properties
call
object
13 properties
error401
object
2 properties 2 required
NCCO
object
4 properties 1 required
jwt_created
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-voice-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 Voice 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.