Nexmo

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…

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 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 .

Endpoints 9

Calls

  • GETGet details of your calls/?status=started&date_start=2016-11-14T07:45:14Z&date_end=2016-11-14T07:45:14Z&page_size=10&record_index=0&order=asc&conversation_uuid=CON-f972836a-550f-45fa-956c-12a2ab5b7d22Get details of your calls
  • POSTCreate an outbound call/Create an outbound Call
  • GETGet detail of a specific call/:uuidGet detail of a specific call
  • PUTModify an in progress call/:uuidModify an in progress call

Stream Audio

  • PUTPlay an audio file into a call/:uuid/streamPlay an audio file into a call
  • DELETEStop playing an audio file into a call/:uuid/streamStop playing an audio file into a call

Play TTS

  • PUTPlay text to speech into a call/:uuid/talkPlay text to speech into a call
  • DELETEStop text to speech in a call/:uuid/talkStop text to speech in a call

Play DTMF

  • PUTPlay DTMF tones into a call/:uuid/dtmfPlay DTMF tones into a call

API details

Base URL
https://api.nexmo.com/v1/calls
Authentication
A bearer token in the Authorization header
Operations
9 operations on 5 pathsPUT 4GET 2DELETE 2POST 1
Main resources
Calls 4Play TTS 2Stream Audio 2Play DTMF 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.3.10
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Voice 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 Voice API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get details of your calls” (GET /?status=started&date_start=2016-11-14T07:45:14Z&date_end=2016-11-14T07:45:14Z&page_size=10&record_index=0&order=asc&conversation_uuid=CON-f972836a-550f-45fa-956c-12a2ab5b7d22), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the 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… It is listed under Other and has 9 endpoints.

Who publishes the Voice 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 Voice API?

Requests go to https://api.nexmo.com/v1/calls. Endpoint paths are added to this base URL.

How do I authenticate with the Voice API?

With A bearer token in the Authorization header.

How many endpoints does the Voice API have?

9 operations on 5 paths (4 PUT, 2 GET, 2 DELETE, 1 POST). The largest groups are Calls, Play TTS, Stream Audio, Play DTMF.

Is forking the Voice 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.