Nexmo

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:

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 Numbers API enables you to manage your existing numbers and buy new virtual numbers for use with the Vonage APIs. Further information is here:

Endpoints 5

  • GETList the numbers you own/account/numbers?application_id=aaaaaaaa-bbbb-cccc-dddd-0123456789ab&has_application=false&country=GB&pattern=12345&search_pattern=1&size=10&index=1Retrieve all the inbound numbers associated with your Vonage account.
  • POSTBuy a number/number/buyRequest to purchase a specific inbound number.
  • POSTCancel a number/number/cancelCancel your subscription for a specific inbound number.
  • GETSearch available numbers/number/search?country=GB&type=mobile-lvn&pattern=12345&search_pattern=1&features=SMS&size=10&index=1Retrieve inbound numbers that are available for the specified country.
  • POSTUpdate a number/number/updateChange the behaviour of a number that you own.

API details

Base URL
https://rest.nexmo.com
Authentication
An API key in the api_key query parameter
An API key in the api_secret query parameter
Operations
5 operations on 5 pathsPOST 3GET 2
Response formats
application/json text/xml
Description format
OpenAPI 3.0.0, API version 1.0.20
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Numbers 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 Numbers API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List the numbers you own” (GET /account/numbers?application_id=aaaaaaaa-bbbb-cccc-dddd-0123456789ab&has_application=false&country=GB&pattern=12345&search_pattern=1&size=10&index=1), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

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

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

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

How do I authenticate with the Numbers API?

It accepts 2 methods: an API key in the api_key query parameter; an API key in the api_secret query parameter.

How many endpoints does the Numbers API have?

5 operations on 5 paths (3 POST, 2 GET).

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