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

Encapsulates multiple APIs to interact with our various channels such as WhatsApp Business, SMS, MMS, Viber, Facebook Messenger, etc. The API normalises information across all channels to abstracted to, from and content. This API is for outbound messages.

Vonage Messages 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 Messaging, 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 3 paths, organized into 2 resource areas, and defines 70 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.

5 operations 3 paths 70 schemas 1 DELETE2 GET2 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
Authentication
OAuth 2.0, HTTP Bearer
Terms of Service
Resource Areas
2

Authentication & Security 2

Vonage Messages API (via KPN) declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (JWTAuth).

Paths & Operations 5

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

applications 4

Application related resource management

POST
/applications/v2
Creates new application
createApplication 1 param body → 201400401403404429500503
GET
/applications/v2
Retrieves details of your applications.
getApplications 3 params → 200400401403404429500503
GET
/applications/v2/{uuid}
Retrieves details of a specific application.
getApplication 2 params → 200400401403404429500503
DELETE
/applications/v2/{uuid}
Deletes application.
deleteApplication 2 params → 204400401403404429500503
messages 1

Message related resource management

POST
/messages
Sends a message.
NewMessage 1 param body → 202400401403404429500503

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are inboundWhatsAppMessageCommon (9 properties), inboundMessageSMS (8 properties), MessageStatus (8 properties), messageStatusBase (8 properties). Each schema is shown below with its type and property counts.

application
object
6 properties 6 required
application_detail_ok
object
5 properties 5 required
application_list_ok
object
5 properties
new_application
object
3 properties 1 required
TemplateParameters
array
The parameters are an array of strings, with the first string being used for {{1}} in the template, with the second being {{2}} etc. Only required if the templ…
Image
Audio
Video
vCard
Unsupported
File
Template
Custom
Reply
Location
Order
Sticker
StickerWithURL
object
Sticker with URL
1 property 1 required
StickerWithID
object
Sticker with ID
1 property 1 required
InboundSticker
Text
MessageUuid
string
The UUID of the message
ToNumber
string
The phone number of the message recipient in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone number,…
FromNumber
string
The phone number of the message sender in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone number, st…
ToId
string
The ID of the message recipient
FromId
string
The ID of the message sender
outboundMessageCommon
object
3 properties
baseMessageType
object
4 required
channelOptionsSms
object
5 properties
channelOptionsMms
object
3 properties
channelOptionsMessenger
object
4 properties
channelOptionsViber
object
4 properties
channelOptionsViberVideo
object
4 properties 1 required
channelOptionsViberWithButton
object
4 properties
channelOptionsWhatsapp
object
4 properties
messageStatusBase
object
8 properties 6 required
messageStatusSMS
messageStatusMMS
messageStatusWhatsApp
messageStatusMessenger
messageStatusViber
Timestamp
string
The datetime of when the event occurred, in ISO 8601 format.
Destination
object
1 property
InboundViberMessageCommon
object
6 properties 5 required
InboundMessengerMessageCommon
object
5 properties 5 required
inboundWhatsAppMessageCommon
object
9 properties 6 required
Profile
object
1 property 1 required
Context
object
This is only present for the Inbound Message where the user is quoting another message. It provides information about the quoted message and/or the product mes…
2 properties 2 required
WhatsAppNodeReferral
object
1 property
WhatsAppNodeOrder
object
1 property
Usage
object
2 properties
inboundMessageMMS
object
5 properties 5 required
inboundMessageSMS
object
8 properties 6 required
error401
object
2 properties 2 required
NewMessage
object
4 properties 3 required
Response
object
1 property 1 required
Error
object
The error format is standardized to the 4xx/5xx range with a code and a human readable explanation.
3 properties 3 required
MessageStatus
object
8 properties 5 required
InboundMessage
object
5 properties 4 required
ToProperty
object
3 properties 1 required
FromProperty
object
3 properties 1 required
MessageProperty
object
3 properties 1 required
TimestampProperty
string
The datetime of when the event occurred.
ImageProperty
object
1 property
AudioProperty
object
1 property
VideoProperty
object
1 property
FileProperty
object
1 property
TemplateProperty
object
3 properties
LocationProperty
object
5 properties
error
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-messages-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 Messages 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.