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

Endpoints

Download schema

Voice and SMS routing endpoints

List routing endpoints

GET

https://api.omaxtelecom.com/numbers

/endpoints

List routing endpoints › query Parameters

type

EndpointType · enum

Filter by endpoint type

Enum values:

voice

sms

List routing endpoints › Headers

X-Organization-Id

string

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

List routing endpoints › Responses

Endpoints list

success

boolean · enum · required

Enum values:

object · required

GET/endpoints

curl https://api.omaxtelecom.com/numbers/endpoints \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "success": true,
  "data": {
    "endpoints": [
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "type": "voice",
        "name": "Primary SIP trunk",
        "destination_uri": "sip:trunk.example.com:5060",
        "is_default": true,
        "is_secondary": false,
        "created_by_keycloak_id": "user-123",
        "created_at": "2026-09-01T10:00:00+00:00"
      },
      {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "type": "sms",
        "name": "SMS webhook",
        "destination_uri": "https://api.example.com/sms/inbound",
        "is_default": true,
        "is_secondary": false,
        "created_by_keycloak_id": "user-123",
        "created_at": "2026-09-01T10:00:00+00:00"
      }
    ]
  }
}

json

application/json

Create routing endpoint

POST

https://api.omaxtelecom.com/numbers

/endpoints

Create routing endpoint › Headers

X-Organization-Id

string

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

Create routing endpoint › Request Body

CreateEndpointRequest

name

string · maxLength: 128 · required

type

EndpointType · enum · required

Enum values:

voice

sms

destination_uri

string · uri · maxLength: 2048 · required

is_default

boolean

Default: false

is_secondary

boolean

Default: false

Create routing endpoint › Responses

Endpoint created

success

boolean · enum · required

Enum values:

Endpoint · required

POST/endpoints

curl https://api.omaxtelecom.com/numbers/endpoints \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Primary SIP trunk",
  "type": "voice",
  "destination_uri": "sip:trunk.example.com:5060",
  "is_default": true
}'

Example Request Body

{
  "name": "Primary SIP trunk",
  "type": "voice",
  "destination_uri": "sip:trunk.example.com:5060",
  "is_default": true
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "type": "voice",
    "name": "Primary SIP trunk",
    "destination_uri": "sip:trunk.example.com:5060",
    "is_default": true,
    "is_secondary": false,
    "created_by_keycloak_id": "user-123",
    "created_at": "2026-09-01T10:00:00+00:00"
  }
}

json

application/json

Get routing endpoint

GET

https://api.omaxtelecom.com/numbers

/endpoints/{endpointId}

Get routing endpoint › path Parameters

endpointId

string · uuid · required

Get routing endpoint › Headers

X-Organization-Id

string

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

Get routing endpoint › Responses

Endpoint details

success

boolean · enum · required

Enum values:

Endpoint · required

Update routing endpoint

PUT

https://api.omaxtelecom.com/numbers

/endpoints/{endpointId}

Update routing endpoint › path Parameters

endpointId

string · uuid · required

Update routing endpoint › Headers

X-Organization-Id

string

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

Update routing endpoint › Request Body

UpdateEndpointRequest

name

string · maxLength: 128 · required

destination_uri

string · uri · maxLength: 2048 · required

is_default

boolean

Update routing endpoint › Responses

Endpoint updated

success

boolean · enum · required

Enum values:

Endpoint · required

PUT/endpoints/{endpointId}

curl https://api.omaxtelecom.com/numbers/endpoints/:endpointId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Updated SIP trunk",
  "destination_uri": "sip:new-trunk.example.com:5060",
  "is_default": true
}'

Example Request Body

{
  "name": "Updated SIP trunk",
  "destination_uri": "sip:new-trunk.example.com:5060",
  "is_default": true
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "type": "voice",
    "name": "Updated SIP trunk",
    "destination_uri": "sip:new-trunk.example.com:5060",
    "is_default": true,
    "is_secondary": false,
    "created_by_keycloak_id": "user-123",
    "created_at": "2026-09-01T10:00:00+00:00"
  }
}

json

application/json

Delete routing endpoint

DELETE

https://api.omaxtelecom.com/numbers

/endpoints/{endpointId}

Delete routing endpoint › path Parameters

endpointId

string · uuid · required

Delete routing endpoint › Headers

X-Organization-Id

string

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

Delete routing endpoint › Responses

Endpoint deleted

success

boolean · enum · required

Enum values:

object · required

SMS KYC

List routing endpoints

GET

https://api.omaxtelecom.com/numbers

/endpoints

List routing endpoints › query Parameters

type

EndpointType · enum

Filter by endpoint type

Enum values:

voice

sms

List routing endpoints › Headers

X-Organization-Id

string

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

List routing endpoints › Responses

Endpoints list

success

boolean · enum · required

Enum values:

object · required

Create routing endpoint

POST

https://api.omaxtelecom.com/numbers

/endpoints

Create routing endpoint › Headers

X-Organization-Id

string

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

Create routing endpoint › Request Body

CreateEndpointRequest

name

string · maxLength: 128 · required

type

EndpointType · enum · required

Enum values:

voice

sms

destination_uri

string · uri · maxLength: 2048 · required

is_default

boolean

Default: false

is_secondary

boolean

Default: false

Create routing endpoint › Responses

Endpoint created

success

boolean · enum · required

Enum values:

Endpoint · required

Get routing endpoint

GET

https://api.omaxtelecom.com/numbers

/endpoints/{endpointId}

Get routing endpoint › path Parameters

endpointId

string · uuid · required

Get routing endpoint › Headers

X-Organization-Id

string

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

Get routing endpoint › Responses

Endpoint details

success

boolean · enum · required

Enum values:

Endpoint · required

Update routing endpoint

PUT

https://api.omaxtelecom.com/numbers

/endpoints/{endpointId}

Update routing endpoint › path Parameters

endpointId

string · uuid · required

Update routing endpoint › Headers

X-Organization-Id

string

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

Update routing endpoint › Request Body

UpdateEndpointRequest

name

string · maxLength: 128 · required

destination_uri

string · uri · maxLength: 2048 · required

is_default

boolean

Update routing endpoint › Responses

Endpoint updated

success

boolean · enum · required

Enum values:

Endpoint · required

Delete routing endpoint

DELETE

https://api.omaxtelecom.com/numbers

/endpoints/{endpointId}

Delete routing endpoint › path Parameters

endpointId

string · uuid · required

Delete routing endpoint › Headers

X-Organization-Id

string

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

Delete routing endpoint › Responses

Endpoint deleted

success

boolean · enum · required

Enum values:

object · required