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

SMS

Download schema

Inbound and outbound SMS, pricing, and partner webhooks

List inbound and outbound SMS rates

GET

https://api.omaxtelecom.com/numbers

/sms/pricing

List inbound and outbound SMS rates › Headers

X-Organization-Id

string

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

List inbound and outbound SMS rates › Responses

SMS rates for the organization

success

boolean · enum · required

Enum values:

SmsPricing · required

Send outbound SMS

POST

https://api.omaxtelecom.com/numbers

/sms/send

Send outbound SMS › Headers

X-Organization-Id

string

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

Send outbound SMS › Request Body

SendOutboundSmsRequest

from

E164PhoneNumber · pattern: ^\+[1-9]\d{1,14}$ · required

Owned active sender number

Example: +447700900001

to

E164PhoneNumber · pattern: ^\+[1-9]\d{1,14}$ · required

body

string · maxLength: 1600 · required

Send outbound SMS › Responses

SMS sent

success

boolean · enum · required

Enum values:

OutboundSmsMessage · required

POST/sms/send

curl https://api.omaxtelecom.com/numbers/sms/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "from": "+447700900001",
  "to": "+447911123456",
  "body": "Your verification code is 123456"
}'

Example Request Body

{
  "from": "+447700900001",
  "to": "+447911123456",
  "body": "Your verification code is 123456"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
    "phone_number_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "from": "+447700900001",
    "to": "+447911123456",
    "body": "Your verification code is 123456",
    "segments": 1,
    "status": "sent",
    "sent_at": "2026-09-17T09:20:00+00:00",
    "delivered_at": null
  }
}

json

application/json

List inbound SMS messages

GET

https://api.omaxtelecom.com/numbers

/sms/messages

List inbound SMS messages › query Parameters

phone_number_id

string · uuid

since

string · date-time

limit

integer · min: 1 · max: 100

Default: 50

List inbound SMS messages › Headers

X-Organization-Id

string

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

List inbound SMS messages › Responses

Inbound messages

success

boolean · enum · required

Enum values:

object · required

Get inbound SMS message detail

GET

https://api.omaxtelecom.com/numbers

/sms/messages/{messageId}

Get inbound SMS message detail › path Parameters

messageId

string · uuid · required

Get inbound SMS message detail › Headers

X-Organization-Id

string

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

Get inbound SMS message detail › Responses

Inbound message with delivery attempts

success

boolean · enum · required

Enum values:

InboundSmsMessageDetail · required

GET/sms/messages/{messageId}

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

Example Responses

{
  "success": true,
  "data": {
    "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "phone_number_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "from": "+447911123456",
    "to": "+447700900001",
    "body": "Hello, I need support",
    "segments": 1,
    "status": "forwarded",
    "received_at": "2026-09-17T09:15:00+00:00",
    "sell_amount": "0.020000",
    "billing_reference": "pn-sms-in-abc123",
    "deliveries": [
      {
        "id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
        "attempt": 1,
        "status": "delivered",
        "http_status": 200,
        "error": null,
        "delivered_at": "2026-09-17T09:15:02+00:00",
        "next_retry_at": null
      }
    ]
  }
}

json

application/json

Retry forwarding inbound SMS

POST

https://api.omaxtelecom.com/numbers

/sms/messages/{messageId}/retry

Re-queues delivery of an inbound SMS to the configured partner webhook endpoint.

Retry forwarding inbound SMS › path Parameters

messageId

string · uuid · required

Retry forwarding inbound SMS › Headers

X-Organization-Id

string

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

Retry forwarding inbound SMS › Responses

Forward retry accepted

success

boolean · enum · required

Enum values:

object · required

List outbound SMS messages

GET

https://api.omaxtelecom.com/numbers

/sms/sent

List outbound SMS messages › query Parameters

phone_number_id

string · uuid

since

string · date-time

limit

integer · min: 1 · max: 100

Default: 50

List outbound SMS messages › Headers

X-Organization-Id

string

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

List outbound SMS messages › Responses

Outbound messages

success

boolean · enum · required

Enum values:

object · required

Get outbound SMS message detail

GET

https://api.omaxtelecom.com/numbers

/sms/sent/{messageId}

Get outbound SMS message detail › path Parameters

messageId

string · uuid · required

Get outbound SMS message detail › Headers

X-Organization-Id

string

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

Get outbound SMS message detail › Responses

Outbound message detail

success

boolean · enum · required

Enum values:

OutboundSmsMessageDetail · required

Get partner inbound SMS webhook settings

GET

https://api.omaxtelecom.com/numbers

/sms/webhook

Get partner inbound SMS webhook settings › Headers

X-Organization-Id

string

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

Get partner inbound SMS webhook settings › Responses

Webhook settings

success

boolean · enum · required

Enum values:

PartnerSmsWebhook · required

Update partner inbound SMS webhook settings

PUT

https://api.omaxtelecom.com/numbers

/sms/webhook

Update partner inbound SMS webhook settings › Headers

X-Organization-Id

string

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

Update partner inbound SMS webhook settings › Request Body

UpdatePartnerSmsWebhookRequest

url

string · uri · maxLength: 2048 · required

enabled

boolean · required

secret

string | null · minLength: 16 · maxLength: 255

Update partner inbound SMS webhook settings › Responses

Webhook updated

success

boolean · enum · required

Enum values:

PartnerSmsWebhook · required

Phone Numbers Endpoints

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

SMS

Download schema

Inbound and outbound SMS, pricing, and partner webhooks

List inbound and outbound SMS rates

GET

https://api.omaxtelecom.com/numbers

/sms/pricing

List inbound and outbound SMS rates › Headers

X-Organization-Id

string

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

List inbound and outbound SMS rates › Responses

SMS rates for the organization

success

boolean · enum · required

Enum values:

SmsPricing · required

Send outbound SMS

POST

https://api.omaxtelecom.com/numbers

/sms/send

Send outbound SMS › Headers

X-Organization-Id

string

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

Send outbound SMS › Request Body

SendOutboundSmsRequest

from

E164PhoneNumber · pattern: ^\+[1-9]\d{1,14}$ · required

Owned active sender number

Example: +447700900001

to

E164PhoneNumber · pattern: ^\+[1-9]\d{1,14}$ · required

body

string · maxLength: 1600 · required

Send outbound SMS › Responses

SMS sent

success

boolean · enum · required

Enum values:

OutboundSmsMessage · required

POST/sms/send

curl https://api.omaxtelecom.com/numbers/sms/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "from": "+447700900001",
  "to": "+447911123456",
  "body": "Your verification code is 123456"
}'

Example Request Body

{
  "from": "+447700900001",
  "to": "+447911123456",
  "body": "Your verification code is 123456"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
    "phone_number_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "from": "+447700900001",
    "to": "+447911123456",
    "body": "Your verification code is 123456",
    "segments": 1,
    "status": "sent",
    "sent_at": "2026-09-17T09:20:00+00:00",
    "delivered_at": null
  }
}

json

application/json

List inbound SMS messages

GET

https://api.omaxtelecom.com/numbers

/sms/messages

List inbound SMS messages › query Parameters

phone_number_id

string · uuid

since

string · date-time

limit

integer · min: 1 · max: 100

Default: 50

List inbound SMS messages › Headers

X-Organization-Id

string

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

List inbound SMS messages › Responses

Inbound messages

success

boolean · enum · required

Enum values:

object · required

Get inbound SMS message detail

GET

https://api.omaxtelecom.com/numbers

/sms/messages/{messageId}

Get inbound SMS message detail › path Parameters

messageId

string · uuid · required

Get inbound SMS message detail › Headers

X-Organization-Id

string

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

Get inbound SMS message detail › Responses

Inbound message with delivery attempts

success

boolean · enum · required

Enum values:

InboundSmsMessageDetail · required

GET/sms/messages/{messageId}

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

Example Responses

{
  "success": true,
  "data": {
    "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "phone_number_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "from": "+447911123456",
    "to": "+447700900001",
    "body": "Hello, I need support",
    "segments": 1,
    "status": "forwarded",
    "received_at": "2026-09-17T09:15:00+00:00",
    "sell_amount": "0.020000",
    "billing_reference": "pn-sms-in-abc123",
    "deliveries": [
      {
        "id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
        "attempt": 1,
        "status": "delivered",
        "http_status": 200,
        "error": null,
        "delivered_at": "2026-09-17T09:15:02+00:00",
        "next_retry_at": null
      }
    ]
  }
}

json

application/json

Retry forwarding inbound SMS

POST

https://api.omaxtelecom.com/numbers

/sms/messages/{messageId}/retry

Re-queues delivery of an inbound SMS to the configured partner webhook endpoint.

Retry forwarding inbound SMS › path Parameters

messageId

string · uuid · required

Retry forwarding inbound SMS › Headers

X-Organization-Id

string

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

Retry forwarding inbound SMS › Responses

Forward retry accepted

success

boolean · enum · required

Enum values:

object · required

List outbound SMS messages

GET

https://api.omaxtelecom.com/numbers

/sms/sent

List outbound SMS messages › query Parameters

phone_number_id

string · uuid

since

string · date-time

limit

integer · min: 1 · max: 100

Default: 50

List outbound SMS messages › Headers

X-Organization-Id

string

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

List outbound SMS messages › Responses

Outbound messages

success

boolean · enum · required

Enum values:

object · required

Get outbound SMS message detail

GET

https://api.omaxtelecom.com/numbers

/sms/sent/{messageId}

Get outbound SMS message detail › path Parameters

messageId

string · uuid · required

Get outbound SMS message detail › Headers

X-Organization-Id

string

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

Get outbound SMS message detail › Responses

Outbound message detail

success

boolean · enum · required

Enum values:

OutboundSmsMessageDetail · required

Get partner inbound SMS webhook settings

GET

https://api.omaxtelecom.com/numbers

/sms/webhook

Get partner inbound SMS webhook settings › Headers

X-Organization-Id

string

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

Get partner inbound SMS webhook settings › Responses

Webhook settings

success

boolean · enum · required

Enum values:

PartnerSmsWebhook · required

Update partner inbound SMS webhook settings

PUT

https://api.omaxtelecom.com/numbers

/sms/webhook

Update partner inbound SMS webhook settings › Headers

X-Organization-Id

string

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

Update partner inbound SMS webhook settings › Request Body

UpdatePartnerSmsWebhookRequest

url

string · uri · maxLength: 2048 · required

enabled

boolean · required

secret

string | null · minLength: 16 · maxLength: 255

Update partner inbound SMS webhook settings › Responses

Webhook updated

success

boolean · enum · required

Enum values:

PartnerSmsWebhook · required

Phone Numbers Endpoints