Nexmo

Dispatch API

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…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 1

  • POSTCreate a workflow/

API details

Base URL
https://api.nexmo.com/v0.1/dispatch
Authentication
HTTP Basic authentication (username and password)
A bearer token in the Authorization header
Operations
1 operation on 1 pathPOST 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.3.4
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Dispatch API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Dispatch API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create a workflow” (POST /), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Dispatch API?

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… It is listed under Other and has 1 endpoint.

Who publishes the Dispatch API?

It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Dispatch API?

Requests go to https://api.nexmo.com/v0.1/dispatch. Endpoint paths are added to this base URL.

How do I authenticate with the Dispatch API?

It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.

How many endpoints does the Dispatch API have?

1 operation on 1 path (1 POST).

Is forking the Dispatch API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.