---
title: "WebSocket - Real-time SMS delivery"
method: GET
path: "/ws/orders"
tags: ["WebSocket"]
---

# WebSocket - Real-time SMS delivery

`GET /ws/orders`

## Request

- Base URL: `https://virtualsms.io`
- URL: `https://virtualsms.io/ws/orders`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

## WebSocket Connection

Connect via WebSocket for instant SMS delivery - zero polling delay.

**Endpoint:** `wss://virtualsms.io/ws/orders`

**Query parameters:**
- `api_key` - Your VirtualSMS API key (required)
- `order_id` - Specific rental ID to subscribe to (required)

**Example connection:**
```javascript
const ws = new WebSocket(
  `wss://virtualsms.io/ws/orders?api_key=${API_KEY}&order_id=${rentalId}`
);

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  
  if (data.type === 'sms') {
    console.log('Code:', data.code);
    console.log('Full SMS:', data.text);
    console.log('Received at:', data.ts);
  } else if (data.type === 'expired') {
    console.log('Rental expired');
  }
};
```

**Message types:**

**SMS received:**
```json
{
  "type": "sms",
  "rental_id": 12345,
  "code": "438271",
  "text": "Your WhatsApp code is 438271. Don't share this code.",
  "ts": "2026-03-03T14:22:11Z"
}
```

**Rental expired:**
```json
{
  "type": "expired",
  "rental_id": 12345,
  "ts": "2026-03-03T14:35:00Z"
}
```

**Advantage over polling:** Instant delivery, no wasted requests, no 3-second delay.
This is our competitive advantage over legacy sms-activate style polling.

## Query parameters

- `api_key` string, required
- `order_id` integer, required

## Other responses

- `101`: Switching Protocols - WebSocket connection established
- `401`: Invalid API key

---

[API](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and.md) · [All operations](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/llms.txt) · [OpenAPI document](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/revisions/be89af981be1?raw)