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

Fetch, Create and Modify voice calls

Vonage Calls 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 Calls. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

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

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

4 operations 2 paths 34 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.10.0
Base URL
https://api.nexmo.com/v1/calls
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Vonage Calls API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 4

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

Calls 4

Fetch, Create and Modify voice calls

GET
/
Get details of your calls
getCalls 7 params → 200
POST
/
Create an outbound call
createCall body → 201
GET
/{uuid}
Get detail of a specific call
getCall 1 param → 200
PUT
/{uuid}
Modify an in progress call
updateCall 1 param body → 204401404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are GetCallResponse (13 properties), CreateCallRequestBase (9 properties), GetCallsResponse (5 properties), EndpointWebsocket (5 properties). Each schema is shown below with its type and property counts.

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. This is…
UpdateCallRequestTransferNcco
object
2 properties 2 required
RequestTransferActionParam
string
Transfer the call to a new NCCO
CreateCallRequestNcco
duration
string
The time elapsed for the call to take place in seconds. This is only sent if status is completed.
end_time
string
The time the call started in the following format: YYYY-MM-DD HH:MM:SS. For xample, 2020-01-01 12:00:00. This is only sent if status is completed.
UpdateCallRequestHangup
object
1 property
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…
price
string
The total price charged for this call. This is only sent if status is completed.
UpdateCallRequestEarmuff
object
1 property
EndpointPhoneFrom
object
Connect to a Phone (PSTN) number. This property is mutually exclusive with randomfromnumber: you must specify one (from) or the other (randomfromnumber: true).
2 properties 2 required
EndpointPhoneTo
object
Connect to a Phone (PSTN) number
4 properties 2 required
direction
string
Possible values are outbound or inbound
conversation_uuid
string
The unique identifier for the conversation this call leg is part of.
GetCallsResponse
object
5 properties
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. This is only sent if status is completed.
EndpointWebsocket
object
Connect to a Websocket
5 properties 2 required
rate
string
The price per minute for this call. This is only sent if status is completed.
CreateCallRequestAnswerUrl
EndpointVBCExtension
object
Connect to a VBC extension
2 properties 2 required
UpdateCallRequestUnearmuff
object
1 property
UpdateCallRequestMute
object
1 property
status
string
The status of the call. [See possible values](https://developer.nexmo.com/voice/voice-api/guides/call-flowevent-objects)
EndpointApp
object
Connect to an App User
2 properties 2 required
AddressE164
string
The phone number to connect to
UpdateCallRequestUnmute
object
1 property
from
object
The endpoint you called from. Possible values are the same as to.
2 properties
CreateCallRequestBase
object
9 properties 1 required
GetCallResponse
object
13 properties
CreateCallResponse
object
4 properties
EndpointSip
object
Connect to a SIP Endpoint
4 properties 2 required
AddressWebsocket
string
UpdateCallRequestTransferAnswerUrl
object
2 properties 2 required
AddressSip
string
The SIP URI to connect to

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-calls-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
Vonage Advanced API
Vonage Application API
Vonage Applications API
Vonage Archives API
Vonage Audio Connector API
Vonage Balance API
Vonage Basic API
Vonage Broadcast 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 Calls 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.