API SMS-верифікації

Два API використовують один ключ: REST API з JSON та формат SMS-активації, який багато інструментів вже використовують. Створіть ключ на сторінці Ключ API в консолі; він показується один раз. Ліміт: 300 запитів на хвилину на ключ. Кожне замовлення має 20-хвилинне вікно для коду, таке ж, як у консолі.

# REST API (JSON)
curl https://virtualsns.com/api/v1/balance -H "Authorization: Bearer YOUR_KEY"

# SMS activation format
curl "https://virtualsns.com/stubs/handler_api.php?api_key=YOUR_KEY&action=getBalance"

Коди сервісів, це назви в адресах сторінок нашого сервісу, наприклад kakaotalk, line, wechat, zalo, naver, shopee та whatsapp. Коди країн, це ISO коди в нижньому регістрі: kr, jp, id, ph, vn, th, us. GET /services та GET /countries повертають повні списки.

1. Замовте номер з сервісом та країною. Збережіть id.
2. Введіть номер у додатку та попросіть надіслати SMS.
3. Читайте замовлення кожні 4 секунди, доки не з'явиться код.
4. Потрібно ще одне SMS? Запросіть інший код, а потім знову прочитайте. Готово: завершіть замовлення.
5. Немає коду? Скасуйте для повного повернення коштів. Без дзвінка повернення відбувається автоматично після завершення вікна.

Python

import os, time, requests

API = "https://virtualsns.com/api/v1"
H = {"Authorization": f"Bearer {os.environ['VIRTUALSNS_KEY']}"}

order = requests.post(f"{API}/orders", headers=H,
    data={"service": "kakaotalk", "country": "kr"}).json()["order"]
print("Use this number:", order["phone"])

while True:
    o = requests.get(f"{API}/orders/{order['id']}", headers=H).json()["order"]
    if o["code"] or o["status"] in ("refunded", "canceled"):
        break
    time.sleep(4)
print("Code:", o["code"])

Node.js

const API = "https://virtualsns.com/api/v1";
const H = { Authorization: `Bearer ${process.env.VIRTUALSNS_KEY}` };

const { order } = await fetch(`${API}/orders`, {
  method: "POST", headers: H,
  body: new URLSearchParams({ service: "line", country: "jp" }),
}).then((r) => r.json());
console.log("Use this number:", order.phone);

let o = order;
while (!o.code && !["refunded", "canceled"].includes(o.status)) {
  await new Promise((r) => setTimeout(r, 4000));
  ({ order: o } = await fetch(`${API}/orders/${order.id}`, { headers: H }).then((r) => r.json()));
}
console.log("Code:", o.code);

REST API

Помилки повертаються у форматі JSON: {"error":{"code","message"}} з такими статусами HTTP:

Формат SMS активації

Кожен код сервісу з його назвою, типом та найнижчою ціною. Ключ не потрібен.

curl "https://virtualsns.com/api/v1/services"

{"services":[{"code":"kakaotalk","name":"KakaoTalk","category":"social","from":"0.06"}]}

Кожен код країни (ISO, нижній регістр) з її назвою та телефонним кодом. Ключ не потрібен.

curl "https://virtualsns.com/api/v1/countries"

{"countries":[{"code":"kr","name":"South Korea","dial_code":"82"}]}

Ціни в USD. Додайте сервіс, країну або обидва. Ключ не потрібен.

curl "https://virtualsns.com/api/v1/prices?service=line&country=jp"

{"prices":[{"service":"line","country":"jp","price":"5.40"}]}

Ваш баланс у USD.

curl "https://virtualsns.com/api/v1/balance" \
  -H "Authorization: Bearer YOUR_KEY"

{"balance":"25.00","currency":"USD"}

Купує номер (201). Повертає замовлення з номером телефону та часом завершення вікна.

curl -X POST https://virtualsns.com/api/v1/orders \
  -H "Authorization: Bearer YOUR_KEY" \
  -d service=kakaotalk -d country=kr

{"order":{"id":"AC-7K2M9QX4PB","service":"kakaotalk","country":"kr","phone":"+821023456789","status":"waiting","code":null,"expires_at":"2026-11-03T12:20:00.000Z"},"window_minutes":20}

Одне замовлення з його статусом та кожним отриманим кодом. Статуси: очікування, отримано, завершено, повернено, скасовано.

curl "https://virtualsns.com/api/v1/orders/AC-7K2M9QX4PB" \
  -H "Authorization: Bearer YOUR_KEY"

{"order":{"id":"AC-7K2M9QX4PB","status":"received","code":"482193","sms":"[Kakao] Verification code [482193]"}}

Ваші відкриті замовлення (status=all для останніх 100).

curl "https://virtualsns.com/api/v1/orders?status=open" \
  -H "Authorization: Bearer YOUR_KEY"

{"orders":[...]}

Запитує інший код на тому ж номері, після першого коду та поки вікно відкрите. Без додаткової оплати.

curl -X POST https://virtualsns.com/api/v1/orders/AC-7K2M9QX4PB/resend \
  -H "Authorization: Bearer YOUR_KEY"

{"order":{"status":"received","waiting_for_resend":true}}

Закриває замовлення, яке отримало свій код.

curl -X POST https://virtualsns.com/api/v1/orders/AC-7K2M9QX4PB/finish \
  -H "Authorization: Bearer YOUR_KEY"

{"order":{"status":"finished"}}

Скасовує до отримання коду. Повна сума повертається на ваш баланс.

curl -X POST https://virtualsns.com/api/v1/orders/AC-7K2M9QX4PB/cancel \
  -H "Authorization: Bearer YOUR_KEY"

{"order":{"status":"canceled","refunded":"8.40"}}

Ваш баланс у USD.

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=getBalance

ACCESS_BALANCE:12.50

Коди сервісів, які ви можете купити (JSON).

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=getServicesList

{"status":"success","services":[{"code":"line","name":"LINE"}]}

Коди країн (ISO, нижній регістр) та телефонні коди (JSON).

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=getCountries

{"jp":{"name":"Japan","dial":"81"}}

Ціни в USD за країну та сервіс. Обидва фільтри є необов'язковими.

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=getPrices&service=line&country=jp

{"jp":{"line":{"cost":5.4,"count":100}}}

Купує номер. Повертає ідентифікатор активації та номер з його кодом країни.

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=getNumber&service=line&country=jp

ACCESS_NUMBER:AC-7K2M9QX4PB:819012345678

STATUS_WAIT_CODE (код ще не надійшов), STATUS_OK:<code>, STATUS_WAIT_RETRY:<останній код> (запитано ще один код), STATUS_CANCEL (скасовано або повернено кошти).

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=getStatus&id=AC-7K2M9QX4PB

STATUS_OK:482913

status=1 готово (ACCESS_READY), 3 інший код (ACCESS_RETRY_GET), 6 завершено (ACCESS_ACTIVATION), 8 скасування з повним поверненням, якщо код не надійшов (ACCESS_CANCEL).

GET https://virtualsns.com/stubs/handler_api.php?api_key=KEY&action=setStatus&id=AC-7K2M9QX4PB&status=3

ACCESS_RETRY_GET