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

Auth

Download schema

OAuth 2.0 authentication using the Client Credentials grant type (RFC 6749 §4.4). Use your Client ID and Client Secret from OmaxTelecom Console to obtain an access token.

Verify token and organization context

GET

https://api.omaxtelecom.com/numbers

/me

Verify token and organization context › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Verify token and organization context › Responses

Authenticated context

MeSuccessResponse

success

boolean · enum · required

Enum values:

object · required

Get Access Token

POST

https://api.omaxtelecom.com

/auth/token

Get Access Token

Obtain a Bearer access token using the OAuth 2.0 Client Credentials grant (RFC 6749 §4.4).

Setup

Get your client_id from OmaxTelecom Console
Get your client_secret from OmaxTelecom Console

Request

Code
POST https://api.omaxtelecom.com/auth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id={client_id}&client_secret={client_secret}

Response (200 OK)


Code
{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "expires_in": 300,
  "token_type": "Bearer",
  "scope": "openid"
}

Token Usage

Include the token in the Authorization header:

Code
Authorization: Bearer {access_token}

Get Access Token › Headers

Content-Type

string

Accept

string

Get Access Token › Request Body

grant_type

string

OAuth 2.0 grant type (RFC 6749 §4.4)

Example: client_credentials

client_id

string

Your Client ID

Example: {{client_id}}

client_secret

string

Your Client Secret

Example: {{client_secret}}

Get Access Token › Responses

200

Successful response

No data returned

Health

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

Auth

Download schema

OAuth 2.0 authentication using the Client Credentials grant type (RFC 6749 §4.4). Use your Client ID and Client Secret from OmaxTelecom Console to obtain an access token.

Verify token and organization context

GET

https://api.omaxtelecom.com/numbers

/me

Verify token and organization context › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Verify token and organization context › Responses

Authenticated context

MeSuccessResponse

success

boolean · enum · required

Enum values:

object · required

Get Access Token

POST

https://api.omaxtelecom.com

/auth/token

Get Access Token

Obtain a Bearer access token using the OAuth 2.0 Client Credentials grant (RFC 6749 §4.4).

Setup

Get your client_id from OmaxTelecom Console
Get your client_secret from OmaxTelecom Console

Request

Code
POST https://api.omaxtelecom.com/auth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id={client_id}&client_secret={client_secret}

Response (200 OK)


Code
{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "expires_in": 300,
  "token_type": "Bearer",
  "scope": "openid"
}

Token Usage

Include the token in the Authorization header:

Code
Authorization: Bearer {access_token}

Get Access Token › Headers

Content-Type

string

Accept

string

Get Access Token › Request Body

grant_type

string

OAuth 2.0 grant type (RFC 6749 §4.4)

Example: client_credentials

client_id

string

Your Client ID

Example: {{client_id}}

client_secret

string

Your Client Secret

Example: {{client_secret}}

Get Access Token › Responses

200

Successful response

No data returned

Health