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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vonage

Vonage Messages API

Send message Operation

Documentation Provider Profile APIs.io OpenAPI GitHub

Vonage Messages 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 Message. 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 102 schemas. It is described by OpenAPI 3.2.0, at version 1.20.0.

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

2 operations 2 paths 102 schemas 1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.20.0
Base URL
https://rest.nexmo.com
Authentication
HTTP Bearer, HTTP Basic
Contact
Vonage Developer Relations
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Vonage Messages API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP basic authentication (basicAuth).

Paths & Operations 2

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

Messages 2

Send message Operation

POST
/messages
Send a message to the given channel
SendMessage body → 202401402404422429500
PATCH
/messages/{message_uuid}
Update a message for the given channel
UpdateMessage 1 param body → 202401422429

Schemas 102

The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are RCSCardProperties (8 properties), channelOptionsRcsStandard (7 properties), channelOptionsSms (7 properties), channelOptionsMms (7 properties). Each schema is shown below with its type and property counts.

OutboundReaction
mmsMessageObject
object
An object of optional settings for the MMS message.
1 property
ErrorMessageParams
object
Invalid message parameters
5 properties 4 required
channelOptionsWhatsapp
object
4 properties
WebhookVersion
string
Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message. For example, if v0.1 is set, then the JSO…
OutboundRCSCard
OutboundWhatsAppFile
RCSSuggestedActionShareLocation
AnyOutboundMessage
HTML
ErrorChannelParams
object
Invalid channel parameters
5 properties 4 required
OutboundRCSVideo
ErrorClientReference
object
Invalid client reference
4 properties 4 required
RCSSuggestedActionDial
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,…
FromId
string
The ID of the message sender
Content
channelOptionsMessenger
object
4 properties
OutboundWhatsAppReaction
vCard
channelOptionsRcsCarousel
object
1 property
OutboundEmailFrom
string
The email address of the message sender. The domain will be need to be verified by Vonage prior to sending emails. See the [documentation](https://developer.vo…
TrustedRecipient
boolean
Setting this parameter to true overrides, on a per-message basis, any protections set up via [Fraud Defender](https://developer.vonage.com/en/fraud-defender/ov…
channelOptionsViberWithButton
object
4 properties
OutboundEmailText
object
Custom
RCSSenderId
string
Specifies the Sender ID that will be displayed to the message recipient. This identifier should be alphanumeric and must match exactly the Sender ID registered…
OutboundWhatsAppText
RCSSuggestedActionViewLocation
OutboundRCSCarousel
channelOptionsEmail
object
4 properties 1 required
OutboundMMSAudio
StickerWithID
object
Sticker with ID (deprecated)
1 property 1 required
ErrorRecipient
object
Invalid recipient
4 properties 4 required
TrustedSender
boolean
DEPRECATED This parameter is deprecated and will be removed in future. Please use trustedrecipient instead.
OutboundRCSCustom
OutboundSMSText
object
OutboundRCSFile
OutboundViberFile
WorkflowId
string
The ID of the failover workflow. Only present if the request was sent with the failover property.
baseMessageType
object
4 required
File
ErrorInvalidJson
object
Invalid JSON
4 properties 4 required
OutboundWhatsAppAudio
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…
MessageUuid
string
The UUID of the message
channelOptionsMms
object
7 properties
OutboundMMSImage
object
OutboundMessengerImage
EmailContent
OutboundMMSvCard
object
Failover
object
1 property
Video
OutboundMMSFile
OutboundMessengerText
OutboundViberText
OutboundWhatsAppImage
StickerWithURL
object
Sticker with URL
1 property 1 required
OutboundRCSImage
RCSSuggestedActionCreateCalendarEvent
OutboundMessengerVideo
OutboundMessengerAudio
OutboundMMSText
object
Audio
RCSSuggestedReply
object
3 properties 3 required
Image
OutboundMessengerFile
OutboundViberImage
Sticker
OutboundMMSVideo
OutboundEmailContent
object
outboundMessageCommon
object
3 properties
channelOptionsRcsStandard
object
7 properties
ErrorResponse
object
Base error response following RFC 7807
4 properties 3 required
OutboundWhatsAppCustom
RCSSuggestedActionOpenURL
ReactionUnreact
object
Unreact
1 property 1 required
channelOptionsViberVideo
object
4 properties 1 required
OutboundWhatsAppSticker
ReactionReact
object
React
2 properties 2 required
channelOptionsRcsRichCard
object
1 property
ErrorSender
object
Invalid sender
4 properties 4 required
OutboundEmailTo
string
The email address of the message recipient. This field is for defining the email address only. A display name, if needed, must be set using the email.toname pa…
RCSSuggestedActionOpenURLWebview
ErrorMessageType
object
Invalid message type
4 properties 4 required
OutboundViberVideo
OutboundRCSText
Template
EmailContentHtml
object
2 properties 2 required
Text
OutboundMMSContent
RCSSuggestedActionStandardProperties
object
2 properties 2 required
EmailContentText
object
2 properties 2 required
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
RCSCardProperties
object
8 properties 3 required
OutboundWhatsAppVideo
OutboundEmailHtml
object
channelOptionsViber
object
4 properties
ErrorChannel
object
Unsupported channel
4 properties 4 required
OutboundWhatsAppTemplate
channelOptionsSms
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-messages-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
AE Profile APIs.io
Vonage Advanced API
AE Profile APIs.io
Vonage Application API
AE Profile APIs.io
Vonage Applications API
AE Profile APIs.io
Vonage Archives API
AE Profile APIs.io
Vonage Audio Connector API
AE Profile APIs.io
Vonage Balance API
AE Profile APIs.io
Vonage Basic API
AE Profile APIs.io
Vonage Broadcast API
AE Profile APIs.io
Vonage Calls API
AE Profile APIs.io
Vonage Configuration API
AE Profile APIs.io
Vonage Conversation API
AE Profile APIs.io
#Message
← Back to V APIs
API Details
ID
vonage:vonage-messages-api
Base URL
https://rest.nexmo.com
Docs
https://developer.vonage.com/en/api/sms
Provider
Vonage
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vonage-messages-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vonage-messages-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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