Interactive Playground credentials

Enter your Console OAuth credentials to test API requests in the playground below. Select OmaxTelecom Client Credentials as the auth identity before sending.

Client IDClient Secret

Phone Numbers API

Download schema

Quick Start

Get your client_id and client_secret from OmaxTelecom Console
Run Auth → Get Access Token to obtain a Bearer token
All other endpoints use the access_token in the Authorization header

Authentication (OAuth 2.0)

This API uses the OAuth 2.0 Client Credentials grant type (RFC 6749 §4.4).

Token endpoint:

Code
POST https://api.omaxtelecom.com/auth/token

Send Authorization: Bearer <access_token> on all endpoints except health.

For M2M clients without an organization claim, include X-Organization-Id: <organization_id>.

Partner API for purchasing and managing phone numbers, voice/SMS routing endpoints, inbound/outbound SMS, and KYC.

Billing

Number purchases, inbound SMS, and outbound SMS may be charged via the Console Wallet API depending on configured sell rates.

Response envelope

Success: { "success": true, "data": { ... } }

Error: { "success": false, "error": { "code": "...", "message": "..." } }

Phone number format

All phone numbers must be in E.164 format, for example +447700900001.

Purchase workflow

GET /available — search the supplier catalog
POST /preview — get a cost quote for selected catalog number IDs
POST / — purchase using the catalog number ID(s) from step 1 or 2