The SureVoIP RESTful API API

Overview

# Introduction Welcome to the SureVoIP RESTful hypermedia API (sometimes known as a VoIP REST API, Telecom REST API, SIP API, Hypermedia API or just VoIP API.) The SureVoIP API is a way for you to automate your interaction with the SureVoIP platforms. With the API, you can create your own scripts, applications or mashups which can: * List calls * create customers * search numbers * provision numbers * send SMS texts * create outbound calls * schedule announcements * schedule call hangups with an announcement * subscribe to events/alerts * track calls * retrieve invoices * grab your SIP details * check your IP address * be 100% self-sufficient * and much more!

The SureVoIP RESTful API is a phone API from surevoip.co.uk. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 28 endpoints.

At a glance

Authentication

HTTP Basic

HTTPS

Yes

CORS

Unknown

Category

Phone

Base URL

https://api.surevoip.co.uk

Version

9dcb0dc8

Endpoints

28

OpenAPI

Specification ↗

Spec updated

2021-07-11

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://api.surevoip.co.uk/" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"

const response = await fetch("https://api.surevoip.co.uk/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://api.surevoip.co.uk/",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions