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
  • V2(Deprecated)
    • Warning: V2 API is deprecated
    • Account
      • Get Balance
      • Make a top-up with crypto
      • (Get direct wallet address) Make a top-up with crypto
    • Lookup
      • Get Available Countries
      • Get Available Services
      • Get Service Details
      • Get the country stats with success rates
    • Manage phone numbers
      • Purchase Number
      • Return Number
      • Request Another SMS
      • Get Status of A Single Number
      • Get Bulk Status of Numbers With Conditions
  1. Order API

Change order status

Developing
PATCH
https://api-x.smsonline.cloud/v3/numbers/{userId}/order/{orderId}/{next}
Change the status of the telephone number associated with the order.
Permissible actions:
Return the phone number and receive a refund.
Receive a new SMS on a phone number that has already received an SMS.

Request

Path Params
userId
string 
required
Example:
{{userid}}
orderId
string 
required
next
string 
required
Next status. refund / requestAnother
Example:
refund
Body Params application/json
apiKey
string 
required
Example
{
    "apiKey": "string"
}

Request 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 -g --request PATCH 'https://api-x.smsonline.cloud/v3/numbers/{{userid}}/order//refund' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "string"
}'

Responses

🟢200Success
application/json
Body
ok
boolean 
required
body
string 
required
Example
{
    "ok": true,
    "body": "refund-completed"
}
Modified at 2025-05-17 05:59:22
Previous
Get order data
Next
Get Popular list
Built with