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

The member API from Vonage — 3 operation(s) for member.

Vonage Member 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 Member. 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 3 paths, and defines 28 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 3 paths 28 schemas 3 GET1 PATCH1 POST

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 Member 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 3 paths, the API surfaces 5 operations — 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Member 5
GET
/conversations/{conversation_id}/members
List members
getMembers 4 params → 200401404500
POST
/conversations/{conversation_id}/members
Create a member
createMember 1 param body → 201400401404500
GET
/conversations/{conversation_id}/members/me
Retrieve your member
getMe 1 param → 200401404500
GET
/conversations/{conversation_id}/members/{member_id}
Retrieve a member
getMember 2 params → 200401404500
PATCH
/conversations/{conversation_id}/members/{member_id}
Update a member
updateMember 2 params body → 200400401404500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are member (11 properties), member_error_validation_state (6 properties), member_error_validation_state_invited (6 properties), member_error_already_joined (5 properties). Each schema is shown below with its type and property counts.

member_from
string
user_name
stringnull
Unique name for a user
member_initiator
member_error_validation_state
object
Validation fail
6 properties
member_error_not_found
object
Member not found
5 properties
member_channel_from
object
Which channel types this member accepts messages from (if not set, all are accepted)
1 property
member_timestamp
object
3 properties
member_error_already_joined
object
Member already joined
5 properties
member_id_inviting
string
Member ID of the member that sends the invitation
channel
object
A user who joins a conversation as a member can have one channel per membership. For more details see [channel concept docs](/voice/voice-api/concepts/in-app-c…
member_error_validation_state_invited
object
Validation fail
6 properties
member_lite
object
4 properties
conversation_error_not_found
object
Conversation not found
5 properties
member_error_invalid_state
object
Invalid member state
5 properties
user_links
object
1 property
user_lite
object
4 properties
conversation_id
string
The unique identifier for this conversation
page_size
integer
The amount of records returned in this response
member
object
11 properties
user_id
string
User ID
member_href
string
A link towards a member included in Conversation API
user_display_name
stringnull
A string to be displayed as user name. It does not need to be unique
member_id
string
Member ID
knocker_id
string
Knocker ID. A knocker is a pre-member of a conversation who does not exist yet
media
object
Details about the current media setting states
2 properties
timestamp
string
member_state
string
The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN
member_state_request
string
Invite or join a member to a conversation

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-member-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 Conversation API
Where this information came from

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