Get Status of A Single Number

Developing

GET

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

This endpoint returns the message reception status of a phone number associated with a specific orderId.
To check the status of multiple numbers at once, please use the bulk status endpoint instead.

Request

Query Params

userId

string

required

Specify the userId of the user who purchased the phone number

Example:

key

string

required

Specify the API key

Example:

orderId

string

required

Specify the orderId for the purchase of the phone number

Example:

12345678

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://api.smsonline.cloud/cs/getPhoneStatus?userId={{userid}}&key={{APIKey}}&orderId=12345678'

Responses

🟢200Success

application/json

If a phone number matching the orderId exists, the status will be returned.

Body

error

boolean

required

body

object

required

orderId

string

required

phoneNumber

string

required

receivedSMS

string

required

status

string

required

orderedAt

string

required

expiredAt

string

required

lastCheckedAt

string

required

purchasePrice

integer

required

string

required

Example

{
    "error": false,
    "body": {
        "orderId": "1234567",
        "phoneNumber": "8512345678",
        "receivedSMS": "123456",
        "status": "completed",
        "orderedAt": "2025-02-08 17:30:25",
        "expiredAt": "2025-02-08 17:50:25",
        "lastCheckedAt": "2025-02-08 17:31:01",
        "purchasePrice": 27
    },
    "c": "undefined"
}

🟠401Unauthorized

Modified at 2025-04-19 08:05:53

Request Another SMS

Get Bulk Status of Numbers With Conditions