API-First Architecture

One API for your account, SIMs, numbers, traffic and billing, with number lookups, number routing and number orders, on an API key and an OpenAPI 3.1 contract.

Overview

What it
means

VoicePro Plus API v3 lives at api.voicepro.plus/v3, for business accounts. It reads your account and sub-accounts, SIMs and IoT SIMs with their usage, numbers and port requests, trunks, rates, calls and traffic, activity, invoices, balance and spend. It also runs number lookups, changes a number's routing and orders numbers; lookups and orders are paid from your prepaid balance before they run.

Every endpoint is described in one OpenAPI 3.1 contract, and the developer pages are generated from that same contract, so the documentation cannot drift from the API.

Owners and admins create API keys in the portal. Each key carries scopes (read, billing read, lookups, number changes and orders), lists are paged with a cursor, every action takes an Idempotency-Key so a retry never acts twice, and every answer carries clear rate-limit headers. Payments, plan changes and SIM changes stay in the portal.

Architecture

How it works

01

Authentication

An API key from the portal, with scopes: read for your services, billing read for invoices, balance and spend.

02

Rate limits

10 requests a second per key and 30 per account, with short bursts allowed. Every answer carries RateLimit headers; a refused request costs nothing.

03

Scoping

A key only ever sees its own account.

04

Response

JSON with consistent error codes, a request id on every error, and cursor paging on lists.

05

Contract

OpenAPI 3.1. Within v3 changes only add; nothing you rely on is removed.

Capabilities

Engineered for impact

01Read and route

Services

SIMs and IoT SIMs with usage and events, numbers with usage, port requests and trunks. Change a number's routing: ring the app, or forward to another number (a forward shows as pending until it is in effect).

02Read

Traffic

Calls, traffic totals and traffic by destination, plus your rates.

03Billing read

Billing

Invoices, balance and spend, behind their own billing-read scope.

04Lookups

Number lookups

Run a lookup on one number, paid from your prepaid balance at the portal prices, and read your results, batches and usage.

05Prepaid

Number orders

List the numbers on offer in a country with their prices, and order one; the first payment is taken from your account balance before the order is placed. Premium-rate numbers are never offered.

0610/s per key

Rate limiting

Clear headers showing what is left and when it resets.

07OpenAPI 3.1

OpenAPI contract

Every endpoint in one OpenAPI 3.1 contract; the developer pages are built from it.

Technical Specs

Under the hood

Base URLapi.voicepro.plus/v3
API StandardREST, JSON (OpenAPI 3.1)
AuthenticationAPI key with scopes
ActionsNumber lookups · number routing · number orders (prepaid); payments, plans and SIM changes in the portal
Rate Limits10 requests a second per key, 30 per account
SLA99.9% API availability
Learn More

Interested in API-First Architecture?

Our solutions team typically responds within 4 business hours. Get in touch to discuss how this fits your requirements.