Customer API

Get order status

Get the current status of an order. Poll every 3-5 seconds until SMS arrives, or use WebSocket for real-time delivery.

The messages array will be empty while waiting, and populated once SMS is received.

get/api/v1/customer/order/{orderId}

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/customer/order/{orderId}
  • Auth: API key in header X-API-Key

Path parameters

orderIdstring uuid required

Order ID from the purchase response

Response

Order status

successboolean
order_idstring uuid
phone_numberstring
servicestring
countrystring
status'waiting' | 'completed' | 'cancelled' | 'expired'
pricenumber float
sms_receivedboolean
created_atstring date-time
expires_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.