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 Advanced API

The Advanced API from Vonage — 2 operation(s) for advanced.

Vonage Advanced API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 74 JSON Schema definitions.

Tagged areas include Advanced. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.2.1.

Requests are made against a single base URL, https://api.nexmo.com/ni.

2 operations 2 paths 10 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.1
Base URL
https://api.nexmo.com/ni
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Vonage Advanced API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Advanced 2
GET
/advanced/async/{format}
Advanced Number Insight (async)
getNumberInsightAsync 6 params → 200
GET
/advanced/{format}
Advanced Number Insight (sync)
getNumberInsightAdvanced 6 params → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are niResponseJsonAdvancedSync (22 properties), niResponseJsonAdvancedRoamingUnknown (21 properties), niResponseXmlAdvanced (19 properties), niResponseAsync (6 properties). Each schema is shown below with its type and property counts.

niResponseAsync
object
Async Response
6 properties
niRealtimeData
objectnull
[This parameter is deprecated] Real time data about the number
2 properties
niResponseXmlAdvanced
object
Advanced
19 properties
niResponseJsonAdvancedRoamingUnknown
object
Unknown Roaming
21 properties 9 required
niStandardAdvancedStatus
integer
Code | Text -- | -- 0 | Success - request accepted for delivery by . 1 | Busy - you have made more requests in the last second than are permitted by your accou…
niInitialCarrierProperties
objectnull
Information about the network number was initially connected to.
4 properties
niCallerIdentity
object
Information about the network number is currently connected to.
4 properties
niResponseJsonAdvancedSync
object
Advanced Response (sync)
22 properties 9 required
niCurrentCarrierProperties
objectnull
Information about the network number is currently connected to. While in some cases and regions it may return information for non-mobile numbers, this field is…
4 properties
niRoaming
objectnull
Information about the roaming status for number. This is applicable to mobile numbers only. If unknown, this may return a string of unknown instead of an objec…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-advanced-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
Vonage Application API
Vonage Applications API
Vonage Archives API
Vonage Audio Connector API
Vonage Balance API
Vonage Basic API
Vonage Broadcast API
Vonage Calls API
Vonage Configuration API
Vonage Conversation API
Vonage Dial In Numbers API
Where this information came from

This is an independent, third-party profile of Vonage Advanced 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.