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

Number Lookup API

Schemas

Download schema

E164PhoneNumber

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

Phone number in E.164 format

Example: +38766000111

CarrierInfo

Carrier information returned for a valid lookup

name

string

type

string

Carrier line type, for example mobile or landline

Example: mobile

mcc

string

Mobile Country Code

Example: 218

mnc

string

Mobile Network Code

Example: 90

NumberLookupResult

Sanitized carrier lookup result

phone_number

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

Phone number in E.164 format

Example: +38766000111

country_code

string

ISO 3166-1 alpha-2 country code

Example: BA

national_format

string

Nationally formatted phone number

Example: 066 000-111

valid

boolean

Whether the phone number is considered valid

Example: true

CarrierInfo

Carrier information returned for a valid lookup

SingleNumberLookupRequest

phone_number

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

Phone number in E.164 format

Example: +38766000111

SingleNumberLookupSuccessResponse

success

boolean · enum · required

Enum values:

NumberLookupResult · required

Sanitized carrier lookup result

BulkNumberLookupRequest

phone_numbers

E164PhoneNumber[] · minItems: 1 · maxItems: 1000 · unique · required

List of E.164 phone numbers to look up. Must be unique. Maximum 1000 items.

Example: ["+38766000111","+38761111222"]

BulkNumberLookupAcceptedResponse

success

boolean · enum · required

Enum values:

object · required

BulkJobStatus

string · enum

Enum values:

pending

processing

completed

failed

Overall bulk job status

BulkJobItemStatus

string · enum

Enum values:

pending

completed

failed

Per-number item status

BulkNumberLookupJobItem

phone_number

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

Phone number in E.164 format

Example: +38766000111

status

BulkJobItemStatus · enum · required

Per-number item status

Enum values:

pending

completed

failed

object

Lookup result when status is completed

error

string | null

Error message when status is failed

Example: Number lookup service unavailable

BulkNumberLookupJobResponse

success

boolean · enum · required

Enum values:

object · required

ApiError

code

string · required

Machine-readable error code

Example: NUMBER_LOOKUP_UNAVAILABLE

message

string · required

Human-readable error message

Example: Number lookup service unavailable

ErrorResponse

success

boolean · enum · required

Enum values:

ApiError · required

LaravelValidationErrorResponse

Standard Laravel validation error format returned for invalid request bodies

message

string · required

object · required

ServiceHealthResponse

ok

boolean · required

Whether the service is globally operational

timestamp

string · date-time · required

UTC timestamp of the health check

NumberLookupResult

Sanitized carrier lookup result

phone_number

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

Phone number in E.164 format

Example: +38766000111

country_code

string

ISO 3166-1 alpha-2 country code

Example: BA

national_format

string

Nationally formatted phone number

Example: 066 000-111

valid

boolean

Whether the phone number is considered valid

Example: true

CarrierInfo

Carrier information returned for a valid lookup

BulkNumberLookupJobItem

phone_number

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

Phone number in E.164 format

Example: +38766000111

status

BulkJobItemStatus · enum · required

Per-number item status

Enum values:

pending

completed

failed

object

Lookup result when status is completed

error

string | null

Error message when status is failed

Example: Number lookup service unavailable