Surevoip

The SureVoIP RESTful API

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

Communication#openapi#telecom

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

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!

Endpoints 30

announcements

  • GETList global announcements/announcements
  • POSTAdd a new announcement audio file/announcements
  • GETList of announcement audio files/customers/:account/announcements
  • GETRepresents an announcement audio file/customers/:account/announcements/:announcement_id
  • DELETEDelete an announcement audio file/customers/:account/announcements/:announcement_id

areacodes

  • GETList areacodes/areacodes
  • GETSearch available numbers by areacode/numbers/areacodesYou can search by area name, area code or filter using both.

billing

  • GETList global billing detail/billing

calls

  • GETValidate a phone number by calling it once/calls?validate=441224900123
  • POSTCreate phone calls with or without announcements and scheduled hangups/calls

charges

  • GETList charges/charges
  • POSTCreate charges for invoices/charges

contacts

  • GETList contacts/contacts

customers

  • GETList all customers or find your own account/customers
  • GETRepresents a customer/customers/:account

echo

  • POSTReturn your POSTed data for testing/support/echo

faxes

  • GETList global ongoing faxes/faxes

hosted

  • GETList Hosted VoIP domains/hosted

mobile

  • GETList mobile accounts/mobile

numbers

  • GETList available SureVoIP Ofcom number allocations for purchase/numbers

partners

  • GETList SureVoIP Partner accounts/partners

porting

  • GETList ported numbers/porting

sip

  • GETList all SIP accounts/sip

sms

  • GETList SMS/sms

support

  • GETReturn the IP address from where your API request originated/ip-address
  • GETList all Service Status messages/service-status
  • GETReturn the IP address from where your API request originated/support/ip-address
  • GETList all Service Status messages/support/service-status

topups

  • GETList all account credit topups/topups

global

  • GETList global resources/?hypermedia=yes&content-type=application/json

API details

Base URL
https://api.surevoip.co.uk
https://sandbox.surevoip.co.uk
Authentication
HTTP Basic authentication (username and password)
OAuth 2.0 (authorization code, client credentials, implicit flows) with 3 scopes
OpenID Connect
Operations
28 operations on 26 pathsGET 23POST 4DELETE 1
Main resources
announcements 5areacodes 2calls 2charges 2customers 2support 2billing 1contacts 1echo 1faxes 1
Response formats
application/json text/xml
Description format
OpenAPI 3.0.3, API version 9dcb0dc8
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the The SureVoIP RESTful 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 The SureVoIP RESTful 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 “List global announcements” (GET /announcements), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the The SureVoIP RESTful API?

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.)… It is listed under Communication and has 30 endpoints.

Who publishes the The SureVoIP RESTful API?

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

What is the base URL of the The SureVoIP RESTful API?

Its description lists 2 base URLs: https://api.surevoip.co.uk, https://sandbox.surevoip.co.uk. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the The SureVoIP RESTful API?

It accepts 3 methods: HTTP Basic authentication (username and password); OAuth 2.0 (authorization code, client credentials, implicit flows) with 3 scopes; OpenID Connect.

How many endpoints does the The SureVoIP RESTful API have?

28 operations on 26 paths (23 GET, 4 POST, 1 DELETE). The largest groups are announcements, areacodes, calls, charges.

Is forking the The SureVoIP RESTful 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.