Mock sample for your project: Dispatch API

Integrate with "Dispatch API" from nexmo.com in no time with Mockoon's ready to use mock sample

Dispatch API

nexmo.com

Version: 0.3.4


Use this API in your project

Speed up your application development by using "Dispatch API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
It also improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.

Description

The Dispatch API enables the developer to specify a multiple message workflow. A workflow follows a template. The first one we are adding is the failover template. The failover template instructs the Messages API to first send a message to the specified channel. If that message fails immediately or if the condition_status is not reached within the given time period the next message is sent. The developer will also receive status webhooks from the messages resource for each delivery and read event. This API is currently in Beta.

Other APIs by nexmo.com

Redact API

The Redact API helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private information from transactional records in the long-term storage. Note, Redact API does not have the capability to redact the short-lived server logs that are retained for a few weeks. For SMS customers that need immediate redaction, Vonage suggests using Advanced Auto-redact.

Number Insight API

The Number Insight API delivers real-time intelligence about the validity, reachability and roaming status of a phone number and tells you how to format the number correctly in your application. There are three levels of Number Insight API available: Basic, Standard and Advanced. The advanced API is available asynchronously as well as synchronously.

Reports API

The Reports API enables you to request a report of activity for your Vonage account.
Depending on your query pattern, you can choose from one of the two versions of the Reports API: asynchronous and synchronous. The asynchronous version is optimized for infrequent and large data queries (from several records to tens of millions). The synchronous version is optimized for frequent and periodic retrievals of small batches of data records (from one record to tens of thousand per query).
Only synchronous version supports retrival of data records by message/record ID.
Vonage recommends that you limit asynchronous queries to a maximum of 20 million records, by setting the start and end dates accordingly. On average, the asynchronous Reports API takes 5 - 10 minutes to generate 1 million records.

Application API

Vonage provides an Application API to allow management of your Vonage Applications.
This API is backwards compatible with version 1. Applications created using version 1 of the API can also be managed using version 2 (this version) of the API.

Verify API

The Verify API helps you to implement 2FA (two-factor authentication) in your applications. This is useful for:
Protecting against spam, by preventing spammers from creating multiple accounts
Monitoring suspicious activity, by forcing an account user to verify ownership of a number
Ensuring that you can reach your users at any time because you have their correct phone number
More information is available at

Subaccounts API

The Subaccounts API enables you to create subaccounts under your primary account. Subaccounts facilitate differential product configuration, reporting, and billing. The Subaccounts API is released initially with restricted availability. You can read more about the API in the Subaccounts documentation.

Account API

Enables users to manage their Vonage API Account by programmable means. More information is available here:.

Voice API

The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls. More information about the Voice API can be found at.

External Accounts API

The External Accounts API is used to manage accounts for Viber Business Messages, Facebook Messenger and Whatsapp for use in the Messages and Dispatch APIs.

Nexmo Application API

Applications V1 is deprecated
This version of the API has been deprecated. Please use version 2 going forwards
A Nexmo application contains the security and configuration information you need to connect to Nexmo endpoints and easily use our products.

Numbers API

The Numbers API enables you to manage your existing numbers and buy new virtual numbers for use with the Vonage APIs. Further information is here:

Conversation API

The Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice, SMS and WebRTC Audio and Video. The context of the conversations is maintained though each communication event taking place within a conversation, no matter the medium.