Skip to content
23 Telecom 23 Telecom Docs

OpenAPI specification

Copy page
View as Markdown Open in ChatGPT ↗ Open in Claude ↗ View llms-full.txt

The entire public API is described in one OpenAPI 3.1 document — the same source that powers the API playground and the Postman collection.

Download openapi.yaml ↓

Stable URL for tooling:

https://docs.23telecom.co.uk/openapi.yaml

What you can do with it

Section titled “What you can do with it”

Generate a typed client in your language:

Terminal window
# TypeScript (fetch-based)
npx openapi-typescript https://docs.23telecom.co.uk/openapi.yaml -o ./api-types.ts


# Any of 50+ languages via OpenAPI Generator
openapi-generator-cli generate \
  -i https://docs.23telecom.co.uk/openapi.yaml \
  -g python -o ./23telecom-python

Mock the API for local development:

Terminal window
npx @stoplight/prism-cli mock https://docs.23telecom.co.uk/openapi.yaml

Contract-test your integration — validate your requests and our responses against the spec in CI (Schemathesis, Dredd, Spectral).

Import into API clients — Insomnia, Bruno, Hoppscotch and Postman all accept OpenAPI 3.1 directly.

Coverage

Section titled “Coverage”

The spec describes all public endpoints (SMS, messages, statistics, account, webhooks), the X-API-Key security scheme, every documented error shape, and the delivery webhook as an OpenAPI webhooks entry — so code generators can type your DLR receiver too.

Versioning

Section titled “Versioning”

The spec follows the live API. Breaking changes would ship as a new major version with a migration period — additive changes (new fields, new endpoints) land in place. Pin to fields you use, ignore unknown fields.