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

KPN Voice API

Call related resource management

KPN Voice API is one of 104 APIs that KPN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 9 operations across 5 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1.1.1.

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

9 operations 5 paths 20 schemas 2 DELETE2 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.1.1
Base URL
https://api-prd.kpn.com/communication/kpn/numberverify
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 1 POST, 4 PUT. 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

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are call (13 properties), endpoints (3 properties), addresses (3 properties), error401 (2 properties). Each schema is shown below with its type and property counts.

fields_digits
string
The digits to send
addresses
object
3 properties
fields_duration
string
The time elapsed for the call to take place in seconds. This is only sent if status is completed.
fields_to
array
The single or mixed collection of endpoint types you connected to
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_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_call_link
object
1 property
endpoints
object
3 properties
fields_rate
string
The price per minute for this call. This is only sent if status is completed.
fields_call_link_self
object
1 property
fields_conversation_uuid
string
The unique identifier for the conversation this call leg is part of.
error401
object
2 properties 2 required
call
object
13 properties
fields_price
string
The total price charged for this call. This is only sent if status is completed.
voiceNames
string
The voice & language to use
fields_status
string
The status of the call. [See possible values](/voice/voice-api/guides/call-flowevents)
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_direction
string
Possible values are outbound or inbound
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_from
array
The endpoint you called from. Possible values are the same as to.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kpn-voice-api-openapi.yml Raw ↑

Other APIs KPN publishes across the network.

KPN GRIP API
KPN PIM ID API
KPN SMS Campaigns API
KPN Email-to-SMS API
KPN Account API
KPN Activation API
KPN Alarm API
KPN Appliance.configure API
KPN Appliance.monitor API
KPN Application API
KPN Application Keys API
KPN Applications API
Where this information came from

This is an independent, third-party profile of KPN Voice API, 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.