API

The API is the product.

We've been API-first since 1996, before they were called APIs. The portal you log into is built on the same public API we give you, so anything you can click, you can automate: provision numbers, change routing, pull CDRs, send messages and drive AI - by hand or by code, in seconds.

One gateway

One contract across services.

Carrier Services

Numbers & voice.

Provision UK and US numbers, automate porting, change routing and pull CDRs. Wholesale termination, origination and SMS on the network we own. Wholesale API reference →

Conversational AI

Agents on tap.

Stand up unscripted, goal-driven voice agents and feed them per-call context. Conversational AI docs →

Conversation Intelligence

Signals mid-call.

Define your own Operators, receive the typed signals they emit by webhook, and query vCon memory in your own storage. Conversation Intelligence docs →

API-first since 1996 · one authenticated gateway · industry-standard SMPP for messaging

Getting started

An API key and a Bearer token.

Generate a key in the Customer Portal. The full key is shown once, at creation - we keep only a hash and can't show it to you again, so store it securely. Each key carries a set of scopes that control what it can do.

Send it as a Bearer token in the Authorization header. Every service on the gateway lives behind the same host, versioned independently:

curl https://api.simwood.com/... \
  -H "Authorization: Bearer YOUR_API_KEY"

Services share the same authentication, versioning and error conventions, so once you've integrated one, the next is familiar. Start with Getting started and Authentication.

The full API reference lives at docs.simwood.com. One exception: Hosted PBX currently has its own API on a separate site, developer.simwood.com - not to be confused with the main docs - and is set to merge into the main API in due course.

What you can do

If you can click it, you can code it.

Numbers & portingProvision UK and US numbers in seconds, host number ranges for free, and run automated 24x7x365 porting - all by API.
Routing & CDRsChange routing on the fly and pull call detail records programmatically, the same operations the portal performs.
MessagingSend A2P SMS over direct routes from the API, with industry-standard SMPP supported - one message or a million.
Conversational AICreate and configure voice agents and feed them per-call information via webhooks.
Conversation IntelligenceRegister the Operators you define and receive the typed signals they emit mid-call - a fraud score, an intent, a compliance flag or anything you specify - then query vCon memory.
Hosted PBXWhite-label Hosted PBX - and everything to do with it, from provisioning and billing to call control - currently runs on its own API, documented on a separate site at developer.simwood.com (not the main docs.simwood.com). It will fold into the main Simwood API in due course.
FAQ

Questions, answered.

Does Simwood have an API?

Yes. Simwood has been API-first since 1996, and the customer portal is built on the same public API given to customers, so anything you can click you can automate. Full documentation is at docs.simwood.com.

How do I authenticate to the Simwood API?

Generate an API key in the Customer Portal at portal.simwood.com - the full key is shown once at creation and Simwood keeps only a hash, so store it securely - then send it as a Bearer token in the Authorization header. Each key carries a set of scopes that control what it can do.

What is the Simwood API base URL and how is it versioned?

Services sit behind a unified gateway at https://api.simwood.com, and each service is versioned independently so you can adopt new capabilities without breaking existing integrations. Each service's exact paths are in its reference documentation at docs.simwood.com.

What can I do with the Simwood API?

Provision numbers, change routing and pull CDRs in seconds, automate porting, build client apps and intelligent routing, send SMS (industry-standard SMPP is supported), and drive Conversational AI and Conversation Intelligence - by hand in the portal or by code.

Is Hosted PBX on the same API?

Not yet. Hosted PBX - and everything to do with it, including the portal, provisioning, billing and routing - currently runs on its own separate API, documented on a separate site at developer.simwood.com/docs/direct/introduction (not the main docs.simwood.com). It is set to merge into the main Simwood API in due course.

Do the gateway services share the same conventions?

Yes. Services on the api.simwood.com gateway share the same authentication, versioning and error conventions, while each owns its own contract, so integrating a second service is familiar once you have integrated the first. See docs.simwood.com/conventions.

Is there a legacy Simwood API?

Yes. The Wholesale API v3 remains available and documented alongside the newer service-specific APIs for Conversational AI and Conversation Intelligence. All of it is documented at docs.simwood.com.

Next step

Everything here runs on the Simwood Potato®.

Same core, same API, same intelligence - whatever door you come in through.