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

The Dispatch API API from Vonage — 1 operation(s) for dispatch api.

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

This API exposes 1 operation across 1 path, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 0.4.0.

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

1 operations 1 paths 17 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.4.0
Base URL
https://api.nexmo.com/v0.1/dispatch
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

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

Paths & Operations 1

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

Dispatch API 1
POST
/
Create a workflow
createWorkflow body → 202400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are MessageStatus (8 properties), finalReport (6 properties), sendWithFailoverMessage (4 properties), MessageProperty (4 properties). Each schema is shown below with its type and property counts.

MessageStatus
object
The callbacks for the message status are the same as defined in the Messaging API. The only difference will be that dispatchuuid and link will be appended.
8 properties
Response
object
1 property 1 required
finalReport
object
6 properties
FileProperty
object
2 properties
createWorkflow
object
2 properties
VideoProperty
object
1 property
ToProperty
object
3 properties 1 required
FromProperty
object
3 properties 1 required
MessageProperty
object
4 properties 1 required
AudioProperty
object
1 property
TemplateProperty
object
2 properties
TimestampProperty
string
The datetime of when the event occurred.
ImageProperty
object
2 properties
FailoverProperty
object
Please note that last message does not have failover attribute inside it. All other messages must contain a failover attribute.
2 properties
sendMessage
object
Send Message
3 properties 3 required
sendWithFailoverMessage
object
Send With Failover Message
4 properties 3 required
Error
object
The error format is standardized to the 4xx/5xx range with a code and a human readable explanation.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-dispatch-api-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 Dispatch 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.