Purchase Number

POST

https://api.smsonline.cloud/cs/purchase

Request

Body Params application/json

userId

string

required

User Id linked to API key

key

string

required

API key

country

string

required

Country Code

service

string

required

Service Code

maximumPrice

string

required

Minimum Order Price provided by the Lookup API.

string

required

Hash value (m) provided by the Lookup API.

string

required

Hash value (n) provided by the Lookup API.

carrier

string

required

Carrier Name, provided at /cs/getListByCountry

Example

{
  "userId": "string",
  "key": "string",
  "country": "string",
  "service": "string",
  "maximumPrice": "string",
  "m": "string",
  "n": "string",
  "carrier": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.smsonline.cloud/cs/purchase' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

If the request is completed successfully, a 200 response code is returned.

Body

error

boolean

required

If the request fails, the status will be true.

orderId

string

required

Order ID. It is required when you request refund / another SMS

phoneNumber

string

required

E.164 Phone number that assigned to you

expiredAtUTC

string

required

Estimated time to be expired

purchasePrice

number

required

Actual paid amount to get the number

Example

{
  "error": false,
  "orderId": "17934774",
  "phoneNumber": "447508190549",
  "expiredAtUTC": "2025-02-15 16:40:27",
  "purchasePrice": 0.16
}

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Modified at 2025-02-26 19:56:17

Get Service Details

Return Number