Skip to main content
GET
/
api
/
v1
/
customer
/
order
/
{orderId}
Get order status
curl --request GET \
  --url https://virtualsms.io/api/v1/customer/order/{orderId} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "order_id": "550e8400-e29b-41d4-a716-446655440000",
  "phone_number": "628123456789",
  "service": "tg",
  "country": "ID",
  "status": "waiting",
  "price": 0.4,
  "sms_received": false,
  "created_at": "2026-03-14T15:00:00+08:00",
  "expires_at": "2026-03-14T16:00:00+08:00",
  "messages": []
}

Authorizations

​
X-API-Key
string
header
required

API key from virtualsms.io dashboard (Settings -> API tab). Prefix: vsms_

Path Parameters

​
orderId
string<uuid>
required

Order ID from the purchase response

Response

Order status

​
success
boolean
​
order_id
string<uuid>
​
phone_number
string
​
service
string
​
country
string
​
status
enum<string>
Available options:
waiting,
completed,
cancelled,
expired
​
price
number<float>
​
sms_received
boolean
​
created_at
string<date-time>
​
expires_at
string<date-time>
​
messages
object[]