APIHub
Back to Explore

The SureVoIP RESTful API

The SureVoIP RESTful API provides a hypermedia‑driven interface for managing telecom resources such as customers, phone numbers, SIP accounts, announcements, calls, SMS, faxes, billing, charges, top‑ups and related service status information.

Telecom
basic
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

1551ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/

List global resources

  • hypermedia (query) — Disable Hypermedia
  • content-type (query) — Content Type
GET

/announcements

List global announcements

POST

/announcements

Add a new announcement audio file

GET

/areacodes

List areacodes

GET

/billing

List global billing detail

GET

/calls

Validate a phone number by calling it once

  • validate (query) — Validate a phone number by calling it for one ring. Note; not 100% proof the number is in service.
POST

/calls

Create phone calls with or without announcements and scheduled hangups

GET

/charges

List charges

POST

/charges

Create charges for invoices

GET

/contacts

List contacts

GET

/customers

List all customers or find your own account

GET

/customers/{account}

Represents a customer

  • account (path, required) — Account ID of customer
GET

/customers/{account}/announcements

List of announcement audio files

  • account (path, required) — Account ID of customer
DELETE

/customers/{account}/announcements/{announcement_id}

Delete an announcement audio file

GET

/customers/{account}/announcements/{announcement_id}

Represents an announcement audio file

  • announcement_id (path, required) — Announcement ID of audio file
GET

/faxes

List global ongoing faxes

GET

/hosted

List Hosted VoIP domains

GET

/ip-address

Return the IP address from where your API request originated

GET

/mobile

List mobile accounts

GET

/numbers

List available SureVoIP Ofcom number allocations for purchase

GET

/numbers/areacodes

Search available numbers by areacode

GET

/partners

List SureVoIP Partner accounts

GET

/porting

List ported numbers

GET

/service-status

List all Service Status messages

GET

/sip

List all SIP accounts

GET

/sms

List SMS

POST

/support/echo

Return your POSTed data for testing

GET

/topups

List all account credit topups

28 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://api.surevoip.co.uk/"

api.surevoip.co.uk · HTTPS only