Get inventory - SMSOnline API Doc

Request

Path Params

userId

string

required

Example:

limit

string

required

Specify the maximum number of expired numbers to be shown.

Example:

25

Query Params

apiKey

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api-x.smsonline.cloud/v3/numbers/{{userid}}/inventory/25?apiKey={{APIKey}}'

Responses

🟢200Success

application/json

Body

ok

boolean

required

body

object

required

active

array [object {15}]

required

Array of currently active numbers.

expire

array [object {15}]

required

Array of expired numbers, showing the total number specified by limit.

expireCount

integer

required

Total number of expired numbers. Used for paging.

Example

{
    "ok": true,
    "body": {
        "active": [
            {
                "orderId": "20046875",
                "orderedAt": "2025-05-17 05:47:13",
                "expiredAt": "2025-05-17 06:07:13",
                "country": "United States",
                "purchasePrice": 16,
                "service": "Discord",
                "phoneNumber": "12345678901",
                "receivedSMS": "123456",
                "status": "completed",
                "increment": 0,
                "originalPrice": 16,
                "carrier": "any",
                "favourite": 1,
                "sShort": "ds",
                "parse": {
                    "number": {
                        "input": "+12345678901",
                        "international": "+1 234-567-8901",
                        "national": "(234) 567-8901",
                        "e164": "+12345678901",
                        "rfc3966": "tel:+1-234-567-8901",
                        "significant": "2345678901"
                    },
                    "regionCode": "US",
                    "valid": true,
                    "possible": true,
                    "possibility": "is-possible",
                    "shortValid": false,
                    "shortPossible": false,
                    "type": "fixed-line-or-mobile",
                    "typeIsMobile": true,
                    "typeIsFixedLine": true,
                    "canBeInternationallyDialled": true,
                    "countryCode": 1
                }
            }
        ],
        "expire": [
            {
                "orderId": "20046875",
                "orderedAt": "2025-05-17 05:47:13",
                "expiredAt": "2025-05-17 06:07:13",
                "country": "United States",
                "purchasePrice": 16,
                "service": "Discord",
                "phoneNumber": "12345678901",
                "receivedSMS": "123456",
                "status": "completed",
                "increment": 0,
                "originalPrice": 16,
                "carrier": "any",
                "favourite": 1,
                "sShort": "ds",
                "parse": {
                    "number": {
                        "input": "+12345678901",
                        "international": "+1 234-567-8901",
                        "national": "(234) 567-8901",
                        "e164": "+12345678901",
                        "rfc3966": "tel:+1-234-567-8901",
                        "significant": "2345678901"
                    },
                    "regionCode": "US",
                    "valid": true,
                    "possible": true,
                    "possibility": "is-possible",
                    "shortValid": false,
                    "shortPossible": false,
                    "type": "fixed-line-or-mobile",
                    "typeIsMobile": true,
                    "typeIsFixedLine": true,
                    "canBeInternationallyDialled": true,
                    "countryCode": 1
                }
            }
        ],
        "expireCount": 273
    }
}