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

Schemas

Download schema

TokenRequest

client_id

string · required

client_secret

string · required

grant_type

string · enum

Enum values:

client_credentials

Default: client_credentials

TokenResponse

access_token

string

expires_in

integer

token_type

string

scope

string

OAuthErrorResponse

error

string

error_description

string

MeSuccessResponse

success

boolean · enum · required

Enum values:

object · required

OrganizationContext

id

string · uuid

name

string

slug

string

services

object

SuccessResponse

success

boolean · enum · required

Enum values:

data

object · required

ApiError

code

string · required

message

string · required

ErrorResponse

success

boolean · enum · required

Enum values:

ApiError · required

LaravelValidationErrorResponse

message

string · required

object · required

ServiceHealthResponse

ok

boolean · required

timestamp

string · date-time · required

E164PhoneNumber

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

Example: +447700900001

PhoneNumberType

string · enum

Enum values:

local

mobile

national

toll_free

PhoneNumberStatus

string · enum

Enum values:

pending_kyc

provisioning

active

suspended

releasing

released

failed

KycStatus

string · enum

Enum values:

draft

pending

approved

rejected

TrafficDirection

string · enum

Enum values:

inbound_only

inbound_and_outbound

EndpointType

string · enum

Enum values:

voice

sms

InboundSmsStatus

string · enum

Enum values:

received

forward_pending

forwarded

forward_failed

OutboundSmsStatus

string · enum

Enum values:

pending

sent

failed

delivered

undelivered

BillingPeriod

string · enum

Enum values:

monthly

quarterly

annually

CatalogPhoneNumber

id

string · uuid · required

Opaque catalog selection ID returned by search or preview

e164

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

phone_number

string · required

country_iso

string · minLength: 2 · maxLength: 2 · required

number_type

PhoneNumberType · enum · required

Enum values:

local

mobile

national

toll_free

connection_fee

string · required

monthly_fee

string · required

total_fee

string · required

billing_period

BillingPeriod · enum · required

Enum values:

monthly

quarterly

annually

currency

string · required

national_format

string | null

value_tier

string | null

PhoneNumberSummary

id

string · uuid

e164

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

phone_number

string

national_format

string | null

country_iso

string

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

connection_fee

string

monthly_fee

string

total_fee

string

status

PhoneNumberStatus · enum

Enum values:

pending_kyc

provisioning

active

suspended

releasing

released

failed

kyc_status

KycStatus · enum

Enum values:

draft

pending

approved

rejected

traffic_direction

TrafficDirection · enum

Enum values:

inbound_only

inbound_and_outbound

voice_endpoint_id

string | null · uuid

sms_endpoint_id

string | null · uuid

next_billing_date

string | null · date

billing_period

BillingPeriod · enum

Enum values:

monthly

quarterly

annually

currency

string

purchased_by_keycloak_id

string | null

Present on detailed responses only

PurchaseQuote

connection_cost

number · float

monthly_cost

number · float

total_cost

number · float

currency

string

quote_token

string | null

expected_total_cost_minor

integer | null

first_billing_date

string | null

next_billing_date

string | null

CatalogNumberSelectionRequest

number_id

string · uuid

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: number_id
	type = object · requires: number_ids

Properties for Variant 1:

number_id

string · uuid · required

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

PurchasePhoneNumbersRequest

number_id

string · uuid

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

quote_token

string | null

expected_total_cost_minor

integer | null · min: 0

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: number_id
	type = object · requires: number_ids

Properties for Variant 1:

number_id

string · uuid · required

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

quote_token

string | null

expected_total_cost_minor

integer | null · min: 0

Endpoint

id

string · uuid

type

EndpointType · enum

Enum values:

voice

sms

name

string

destination_uri

string · uri

is_default

boolean

is_secondary

boolean

created_by_keycloak_id

string | null

created_at

string | null · date-time

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

UpdateEndpointRequest

name

string · maxLength: 128 · required

destination_uri

string · uri · maxLength: 2048 · required

is_default

boolean

UpdateRoutingRequest

voice_endpoint_id

string | null · uuid

sms_endpoint_id

string | null · uuid

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

InboundSmsMessage

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

InboundSmsStatus · enum

Enum values:

received

forward_pending

forwarded

forward_failed

received_at

string | null · date-time

InboundSmsMessageDetail

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

InboundSmsStatus · enum

Enum values:

received

forward_pending

forwarded

forward_failed

received_at

string | null · date-time

sell_amount

string | null

billing_reference

string | null

InboundSmsDelivery[]

InboundSmsDelivery

id

string · uuid

attempt

integer

status

string

http_status

integer | null

error

string | null

delivered_at

string | null · date-time

next_retry_at

string | null · date-time

OutboundSmsMessage

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

OutboundSmsStatus · enum

Enum values:

pending

sent

failed

delivered

undelivered

sent_at

string | null · date-time

delivered_at

string | null · date-time

OutboundSmsMessageDetail

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

OutboundSmsStatus · enum

Enum values:

pending

sent

failed

delivered

undelivered

sent_at

string | null · date-time

delivered_at

string | null · date-time

sell_amount

string | null

billing_reference

string | null

error_message

string | null

sent_by_keycloak_id

string | null

SmsPricing

enabled

boolean · required

object[] · required

PartnerSmsWebhook

url

string | null · uri

enabled

boolean

has_secret

boolean

UpdatePartnerSmsWebhookRequest

url

string · uri · maxLength: 2048 · required

enabled

boolean · required

secret

string | null · minLength: 16 · maxLength: 255

KycSubmission

id

string · uuid

status

KycStatus · enum

Enum values:

draft

pending

approved

rejected

data

object

documents

string[]

submitted_at

string | null · date-time

reviewed_at

string | null · date-time

rejection_reason

string | null

PhoneNumberKycSubmission

id

string · uuid

status

KycStatus · enum

Enum values:

draft

pending

approved

rejected

data

object

documents

string[]

submitted_at

string | null · date-time

reviewed_at

string | null · date-time

rejection_reason

string | null

phone_number_id

string · uuid

SubmitKycRequest

data

object · required

KYC payload fields as required by your regulator

documents

string[]

URLs to supporting documents

SupplierInboundSmsWebhookRequest

to

string · required

Receiving number in E.164

from

string

Sender E.164 or alphanumeric sender ID

content

string

country

string

country_name

string

parts

integer · min: 1

sid

string

SupplierDlrWebhookRequest

sid

string · required

status

string · enum · required

Enum values:

delivered

rejected

timestamp

string · date-time · required

WebhookAcceptedResponse

success

boolean · enum · required

Enum values:

CatalogPhoneNumber

id

string · uuid · required

Opaque catalog selection ID returned by search or preview

e164

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

phone_number

string · required

country_iso

string · minLength: 2 · maxLength: 2 · required

number_type

PhoneNumberType · enum · required

Enum values:

local

mobile

national

toll_free

connection_fee

string · required

monthly_fee

string · required

total_fee

string · required

billing_period

BillingPeriod · enum · required

Enum values:

monthly

quarterly

annually

currency

string · required

national_format

string | null

value_tier

string | null

PhoneNumberSummary

id

string · uuid

e164

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

phone_number

string

national_format

string | null

country_iso

string

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

connection_fee

string

monthly_fee

string

total_fee

string

status

PhoneNumberStatus · enum

Enum values:

pending_kyc

provisioning

active

suspended

releasing

released

failed

kyc_status

KycStatus · enum

Enum values:

draft

pending

approved

rejected

traffic_direction

TrafficDirection · enum

Enum values:

inbound_only

inbound_and_outbound

voice_endpoint_id

string | null · uuid

sms_endpoint_id

string | null · uuid

next_billing_date

string | null · date

billing_period

BillingPeriod · enum

Enum values:

monthly

quarterly

annually

currency

string

purchased_by_keycloak_id

string | null

Present on detailed responses only

CatalogNumberSelectionRequest

number_id

string · uuid

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: number_id
	type = object · requires: number_ids

Properties for Variant 1:

number_id

string · uuid · required

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

PurchasePhoneNumbersRequest

number_id

string · uuid

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

quote_token

string | null

expected_total_cost_minor

integer | null · min: 0

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: number_id
	type = object · requires: number_ids

Properties for Variant 1:

number_id

string · uuid · required

Single catalog number ID

number_ids

string[] · minItems: 1 · maxItems: 10

country_iso

string · minLength: 2 · maxLength: 2

number_type

PhoneNumberType · enum

Enum values:

local

mobile

national

toll_free

quote_token

string | null

expected_total_cost_minor

integer | null · min: 0

InboundSmsMessage

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

InboundSmsStatus · enum

Enum values:

received

forward_pending

forwarded

forward_failed

received_at

string | null · date-time

InboundSmsMessageDetail

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

InboundSmsStatus · enum

Enum values:

received

forward_pending

forwarded

forward_failed

received_at

string | null · date-time

sell_amount

string | null

billing_reference

string | null

InboundSmsDelivery[]

OutboundSmsMessage

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

OutboundSmsStatus · enum

Enum values:

pending

sent

failed

delivered

undelivered

sent_at

string | null · date-time

delivered_at

string | null · date-time

OutboundSmsMessageDetail

id

string · uuid

phone_number_id

string · uuid

from

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

to

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

body

string

segments

integer

status

OutboundSmsStatus · enum

Enum values:

pending

sent

failed

delivered

undelivered

sent_at

string | null · date-time

delivered_at

string | null · date-time

sell_amount

string | null

billing_reference

string | null

error_message

string | null

sent_by_keycloak_id

string | null