SMSOnline API Doc
  1. Order API
SMSOnline API Doc
  • Preparation
  • FAQ
  • V3
    • Customer API
      • Payments
        • Cryptocurrency via Cryptomus
          • Create new payment
          • Get direct wallet
          • Get transaction status
        • Credit Card via Pay4bit
          • Create new payment
      • Favourites
        • Get favourite services
        • Toggle favourite status
      • Get Account Balance
      • Get invoices
      • Get Coupons
    • Phones API
      • Lookup API
        • Get service list by country and carrier
        • Get service detail by country and carrier
      • Inventory API
        • Get inventory
      • Order API
        • Order a number
          PUT
        • Get order data
          GET
        • Change order status
          PATCH
      • Get Popular list
        GET
      • Get all available countries/carriers
        GET
    • Statistics API
      • Get statistics
  1. Order API

Order a number

Developing
PUT
https://api-x.smsonline.cloud/v3/numbers/{userId}/order
Purchase a telephone number by specifying the country, service and carrier.

Request

Path Params

Body Params application/json

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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

Example
{
    "ok": true,
    "body": {
        "orderId": "1",
        "phoneNumber": "86123456789",
        "expiredAtUTC": "2025-05-17 06:07:13",
        "purchasePrice": 16
    }
}
🟢222Additional action required
Modified at 2025-06-10 13:35:38
Previous
Get inventory
Next
Get order data
Built with