API aktywacji SMS
Dwie drogi: endpoint zgodny z protokołem sms-activate, dzięki któremu istniejące oprogramowanie przechodzi po zmianie URL i klucza, oraz JSON REST API do nowych integracji. Oba używają tego samego klucza API z panelu.
Zdobądź klucz API
Załóż konto, otwórz panel i wygeneruj klucz w sekcji Dostęp API. Zachowaj go w tajemnicy: każdy, kto ma klucz, może wydawać twoje saldo.
Zarejestruj sięTypowy przebieg
- Wywołaj getNumber z usługą i krajem.
- Użyj numeru w docelowej aplikacji.
- Odpytuj getStatus co kilka sekund, aż dostaniesz STATUS_OK.
- Wywołaj setStatus z 6, aby zakończyć, lub z 8, aby anulować, jeśli kod nie przyszedł.
Endpoint zgodny z sms-activate
Wysyłaj żądania GET lub POST z parametrami api_key i action. Odpowiedzi to zwykły tekst, dokładnie jak w sms-activate.
https://smsrota.com/stubs/handler_api.php?api_key=KEY&action=getNumber&service=wa&country=187
Akcje
| Akcja | Parametry | Odpowiedź |
|---|---|---|
| getBalance | — | ACCESS_BALANCE:12.5000 |
| getPrices | service?, country? | {"187":{"wa":{"cost":0.4,"count":1563}}} |
| getNumber | service, country, maxPrice? | ACCESS_NUMBER:48151623:15550123456 |
| getStatus | id | STATUS_WAIT_CODE · STATUS_WAIT_RETRY:code · STATUS_OK:code · STATUS_CANCEL |
| setStatus | id, status | ACCESS_RETRY_GET · ACCESS_ACTIVATION · ACCESS_CANCEL |
| getRentNumber | service, country, rent_time (4/24/72/168/720) | {"status":"success","phone":{"id":31,"endDate":"…","number":"447700900001"}} |
| getRentStatus | id | {"status":"success","quantity":"1","values":{"0":{"phoneFrom":"WhatsApp","text":"…"}}} |
| setRentStatus | id, status (1 = finish, 2 = cancel) | {"status":"success"} |
| continueRentNumber | id, rent_time | {"status":"success","phone":{…}} |
Wartości setStatus
- 3
- Poproś o kolejny kod na ten sam numer
- 6
- Zakończ aktywację
- 8
- Anuluj i zwróć (możliwe dwie minuty po zakupie)
JSON REST API
Wyślij klucz w nagłówku Authorization jako "Bearer KEY". Kwoty to ciągi znaków w dolarach amerykańskich z czterema miejscami po przecinku.
GET https://smsrota.com/v1/balance
GET https://smsrota.com/v1/prices?service=wa
POST https://smsrota.com/v1/activations {"service":"wa","country":"187"}
GET https://smsrota.com/v1/activations/:id
POST https://smsrota.com/v1/activations/:id/retry
POST https://smsrota.com/v1/activations/:id/complete
POST https://smsrota.com/v1/activations/:id/cancel
GET https://smsrota.com/v1/rent/prices?service=wa&hours=24
POST https://smsrota.com/v1/rentals {"service":"full","country":"16","hours":24}
GET https://smsrota.com/v1/rentals/:id
POST https://smsrota.com/v1/rentals/:id/extend {"hours":24}
POST https://smsrota.com/v1/rentals/:id/finish
POST https://smsrota.com/v1/rentals/:id/cancel
POST https://smsrota.com/v1/rentals/:id/dispute {"reason":"no_sms"}
PUT https://smsrota.com/v1/webhook {"url":"https://example.com/sms-webhook"}
POST https://smsrota.com/v1/webhook/test
GET https://smsrota.com/v1/webhook/eventsWebhooki
Ustaw URL w sekcji Dostęp API w swoim panelu. Dla każdego zdarzenia wysyłamy POST z treścią JSON. Odpowiedz dowolnym statusem 2xx w ciągu 10 sekund; w przeciwnym razie ponowimy próbę po 1, 5, 30, 120, 360 i 720 minutach.
- activation.sms_received
- Przyszedł kod dla kupionego numeru.
- activation.cancelled
- Numer został anulowany lub wygasł, a pieniądze wróciły na Twoje saldo.
- rental.sms_received
- Przyszedł SMS na wynajęty numer.
- rental.ended
- Wynajem zakończył się lub został anulowany.
Przykładowa treść
{
"id": "evt_1042",
"type": "activation.sms_received",
"createdAt": "2026-11-01T10:00:00.000Z",
"data": {
"activationId": 48151623,
"service": "wa",
"country": "187",
"phone": "15550123456",
"code": "123456"
}
}Sprawdzanie podpisu
Każde żądanie ma nagłówek X-Webhook-Signature w postaci t=1730000000,v1=…, gdzie v1 to szesnastkowy HMAC-SHA256 z "t.body" obliczony Twoim kluczem podpisu. Odrzuć żądanie, jeśli podpis się nie zgadza lub t jest starsze niż 5 minut.
import { createHmac, timingSafeEqual } from "node:crypto";
// rawBody: the request body exactly as received, before JSON parsing.
function verify(rawBody, header, secret) {
const { t, v1 } = Object.fromEntries(header.split(",").map((p) => p.split("=")));
const expected = createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex");
const fresh = Math.abs(Date.now() / 1000 - Number(t)) < 300;
return fresh && v1.length === expected.length && timingSafeEqual(Buffer.from(v1), Buffer.from(expected));
}Błędy
- BAD_KEY
- Klucz API jest nieprawidłowy lub został zastąpiony.
- NO_NUMBERS
- Brak dostępności dla tej usługi i kraju w tej chwili.
- NO_BALANCE
- Twoje saldo jest za niskie na ten numer.
- EARLY_CANCEL_DENIED
- Anulowanie jest możliwe dwie minuty po zakupie.
- NO_ACTIVATION
- Identyfikator aktywacji nie istnieje lub nie należy do ciebie.