Order a number - SMSOnline API Doc

Request

Path Params

userId

string

required

Body Params application/json

apiKey

string

required

country

string

required

Internal country code

service

string

required

Internal service name

carrier

string

required

carrier name

maximumPrice

string

required

Prices provided by the Lookup API.

m

string

required

Hash(m) provided by the Lookup API.

n

string

required

Hash(n) provided by the Lookup API.

failover

boolean

optional

If the parameter is set to true and the purchase attempt fails, the system will automatically try accessing a different provider within the same request. This increases the likelihood of successfully acquiring a phone number with fewer purchase attempts, but it may result in a slower response time.
If not specified, it will be interpreted as true.

Example

{
    "apiKey":"",
    "country":"",
    "service":"",
    "carrier":"",
    "maximumPrice":"",
    "m":"",
    "n":""
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api-x.smsonline.cloud/v3/numbers//order' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey":"",
    "country":"",
    "service":"",
    "carrier":"",
    "maximumPrice":"",
    "m":"",
    "n":""
}'

Responses

🟢200Success

application/json

Body

ok

boolean

required

body

object

required

orderId

string

required

Order Id

phoneNumber

string

required

Assigned telephone number (E.164)

expiredAtUTC

string

required

Estimated expiration date

purchasePrice

integer

required

Actual cost of the purchase

Example

{
    "ok": true,
    "body": {
        "orderId": "1",
        "phoneNumber": "86123456789",
        "expiredAtUTC": "2025-05-17 06:07:13",
        "purchasePrice": 16
    }
}

🟢222Additional action required