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

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

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

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

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

5 operations 2 paths 15 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Vonage Conversation API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

conversation 5
GET
/conversations
List conversations
listConversations 5 params → 200400401500
POST
/conversations
Create a conversation
createConversation body → 201401409500
GET
/conversations/{conversation_id}
Retrieve a conversation
retrieveConversation 1 param → 200401404500
PUT
/conversations/{conversation_id}
Update a conversation
replaceConversation 1 param body → 200400401404409500
DELETE
/conversations/{conversation_id}
Delete a conversation
deleteConversation 1 param → 204401404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are conversation (9 properties), conversation_lite (6 properties), conversation_error_not_found (5 properties), conversation_callback (4 properties). Each schema is shown below with its type and property counts.

conversation_state
string
The state the conversation is in.
conversation_lite
object
6 properties
conversation_numbers
array
An array containing number on different channels.
conversation_image_url
stringnull
An image URL that you associate with the conversation
conversation_display_name
stringnull
The public facing name of the conversation
conversation_error_not_found
object
Conversation not found
5 properties
conversation_callback
object
4 properties
conversation_id
string
The unique identifier for this conversation
conversation_links
object
1 property
page_size
integer
The amount of records returned in this response
conversation_properties
object
Conversation properties
2 properties
conversation_sequence_number
integer
The last Event ID in this conversation. This ID can be used to [retrieve a specific event](getEvent).
conversation_timestamp
object
3 properties
conversation
object
Conversation Object
9 properties
conversation_name
string
Your internal conversation name. Must be unique. If not supplied a randomly generated name will be used.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-conversation-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 Calls API
Vonage Configuration API
Vonage Dial In Numbers API
Where this information came from

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